Show / Hide Table of Contents

Class BaseKingdomUIRootConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Kingdom.KingdomUIRoot.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseKingdomUIRootConfigurator<T, TBuilder>
KingdomUIRootConfigurator
Inherited Members
BaseBlueprintConfigurator<T, TBuilder>.CopyFrom(Blueprint<BlueprintReference<BlueprintScriptableObject>>, Type[])
BaseBlueprintConfigurator<T, TBuilder>.CopyFrom(Blueprint<BlueprintReference<BlueprintScriptableObject>>, Predicate<BlueprintComponent>)
BaseBlueprintConfigurator<T, TBuilder>.AddDlcCondition(Blueprint<BlueprintDlcRewardReference>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddBuffOnCorruptionClear(Blueprint<BlueprintBuffReference>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Int32>)
BaseBlueprintConfigurator<T, TBuilder>.AddIgnoreArmorGroupComponent(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddPrerequisiteConditionForWeaponCategory(Condition, List<WeaponCategory>)
BaseBlueprintConfigurator<T, TBuilder>.AddDamageDecline(Nullable<DamageDeclineType>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddPlayerLeaveCombatTrigger(ActionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddTimerContextActions(ActionsBuilder, Nullable<Single>, Nullable<TimeSpan>, Nullable<Boolean>)
BaseBlueprintConfigurator<T, TBuilder>.AddCustomImmuneMessageComponent(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, GameLogMessage)
BaseBlueprintConfigurator<T, TBuilder>.AddInitiatorAttackRollTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponCategory>)
BaseBlueprintConfigurator<T, TBuilder>.AddInitiatorAttackWithWeaponTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<PhysicalDamageForm>, Nullable<Boolean>, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, Nullable<Boolean>, Blueprint<BlueprintItemWeaponReference>, Blueprint<BlueprintWeaponTypeReference>)
BaseBlueprintConfigurator<T, TBuilder>.AddTargetAttackRollTrigger(ActionsBuilder, ActionsBuilder, Nullable<Boolean>, WeaponCategory[], Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
BaseBlueprintConfigurator<T, TBuilder>.AddTargetBeforeAttackRollTrigger(ActionsBuilder, ActionsBuilder, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<Boolean>, Nullable<SpellDescriptorWrapper>)
BaseBlueprintConfigurator<T, TBuilder>.AdditionalDiceOnAttack(Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<AdditionalDiceOnAttack.WeaponOptions>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, List<AdditionalDiceOnAttack.DamageEntry>, DamageTypeDescription, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, ConditionsBuilder, Nullable<Boolean>, ContextDiceValue, Blueprint<BlueprintWeaponTypeReference>)
BaseBlueprintConfigurator<T, TBuilder>.AdditionalDiceOnDamage(List<Blueprint<BlueprintAbilityReference>>, Nullable<AbilityType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<CompareOperation.Type>, List<AdditionalDiceOnDamage.DamageEntry>, Nullable<AdditionalDiceOnDamage.DamageEntriesUse>, DamageTypeDescription, ContextDiceValue, Nullable<DamageEnergyType>, Nullable<Boolean>, ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<SpellDescriptorWrapper>, ConditionsBuilder, Nullable<Boolean>, ContextValue, Nullable<Boolean>, Blueprint<BlueprintWeaponTypeReference>)
BaseBlueprintConfigurator<T, TBuilder>.AdditionalStatBonusOnAttackDamage(Nullable<Single>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ConditionEnum>, Nullable<ConditionEnum>, Nullable<GripType>)
BaseBlueprintConfigurator<T, TBuilder>.AddAllAttacksEnhancement(Nullable<Int32>, Nullable<ModifierDescriptor>)
BaseBlueprintConfigurator<T, TBuilder>.AddRuleCalculateDamageWithWeaponTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<PhysicalDamageForm>, Nullable<Boolean>, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, Nullable<Boolean>, Blueprint<BlueprintItemWeaponReference>, Blueprint<BlueprintWeaponTypeReference>)
BaseBlueprintConfigurator<T, TBuilder>.AddMarkUsableWhileCan(ConditionsBuilder, Nullable<Boolean>)
BaseBlueprintConfigurator<T, TBuilder>.AddArmyBattleResultsTrigger(Nullable<RegionId>, Blueprint<BlueprintArmyLeaderReference>, List<Blueprint<BlueprintArmyPresetReference>>, Nullable<ArmyType>, Nullable<Boolean>, ActionsBuilder, ActionsBuilder, Nullable<Boolean>)
BaseBlueprintConfigurator<T, TBuilder>.AddKingdomRegionClaimedTrigger(ActionsBuilder, List<Blueprint<BlueprintRegionReference>>)
BaseBlueprintConfigurator<T, TBuilder>.AddSettlementSiegeTrigger(ActionsBuilder, ActionsBuilder, ActionsBuilder, Blueprint<BlueprintGlobalMapPointReference>, Nullable<Boolean>)
BaseBlueprintConfigurator<T, TBuilder>.AddArmyUnitRecruitedTrigger(ActionsBuilder, Nullable<ArmyProperties>, List<Blueprint<BlueprintUnitReference>>, Nullable<Boolean>, Nullable<Boolean>, Nullable<MercenariesIncludeOption>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Int32>)
BaseBlueprintConfigurator<T, TBuilder>.AddLeaderRecruitedTrigger(ActionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddSummonUnitsAfterArmyBattle(SummonUnitsAfterArmyBattle.SummonGroup[], Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddGarrisonDefeatedTrigger(ActionsBuilder, Blueprint<BlueprintGlobalMapPoint.Reference>)
BaseBlueprintConfigurator<T, TBuilder>.AddPlayerVisitGlobalMapLocationTrigger(ActionsBuilder, Blueprint<BlueprintGlobalMapPoint.Reference>)
BaseBlueprintConfigurator<T, TBuilder>.AddOnIsleStateEnterTrigger(ActionsBuilder, IsleEvaluator, String)
BaseBlueprintConfigurator<T, TBuilder>.AddOnIsleStateExitTrigger(ActionsBuilder, IsleEvaluator, String)
BaseBlueprintConfigurator<T, TBuilder>.AddActivateTrigger(ActionsBuilder, Nullable<Boolean>, ConditionsBuilder, Nullable<Boolean>)
BaseBlueprintConfigurator<T, TBuilder>.AddAreaDidLoadTrigger(ActionsBuilder, ConditionsBuilder)
BaseBlueprintConfigurator<T, TBuilder>.AddDeactivateTrigger(ActionsBuilder, ConditionsBuilder)
BaseBlueprintConfigurator<T, TBuilder>.AddDeviceInteractionTrigger(ActionsBuilder, ActionsBuilder)
BaseBlueprintConfigurator<T, TBuilder>.AddEvaluatedUnitCombatTrigger(ActionsBuilder, Nullable<Boolean>, UnitEvaluator)
BaseBlueprintConfigurator<T, TBuilder>.AddEvaluatedUnitDeathTrigger(ActionsBuilder, Nullable<Boolean>, UnitEvaluator)
BaseBlueprintConfigurator<T, TBuilder>.AddEvaluatedUnitHealthTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, UnitEvaluator)
BaseBlueprintConfigurator<T, TBuilder>.AddExperienceTrigger(ActionsBuilder, ConditionsBuilder, Nullable<Int32>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddGenericInteractionTrigger(ActionsBuilder, EntityReference, ActionsBuilder, Nullable<Boolean>)
BaseBlueprintConfigurator<T, TBuilder>.AddItemInContainerTrigger(Blueprint<BlueprintItemReference>, MapObjectEvaluator, ActionsBuilder, ActionsBuilder)
BaseBlueprintConfigurator<T, TBuilder>.AddLevelUpTrigger(ActionsBuilder, ConditionsBuilder, UnitEvaluator, Nullable<LevelUpTrigger.UnitEntryType>)
BaseBlueprintConfigurator<T, TBuilder>.AddPartyInventoryTrigger(Blueprint<BlueprintItemReference>, ActionsBuilder, ActionsBuilder)
BaseBlueprintConfigurator<T, TBuilder>.AddPerceptionTrigger(MapObjectEvaluator, ActionsBuilder, UnitEvaluator)
BaseBlueprintConfigurator<T, TBuilder>.AddRestTrigger(ActionsBuilder, ConditionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<RestResult>)
BaseBlueprintConfigurator<T, TBuilder>.AddScriptZoneTrigger(ActionsBuilder, ConditionsBuilder, ActionsBuilder, ConditionsBuilder, EntityReference, String)
BaseBlueprintConfigurator<T, TBuilder>.AddSpawnUnitTrigger(ActionsBuilder, Blueprint<BlueprintUnitReference>)
BaseBlueprintConfigurator<T, TBuilder>.AddSpellCastTrigger(ActionsBuilder, EntityReference, List<Blueprint<BlueprintAbilityReference>>)
BaseBlueprintConfigurator<T, TBuilder>.AddSummonPoolTrigger(ActionsBuilder, Nullable<SummonPoolTrigger.ChangeTypes>, ConditionsBuilder, Nullable<Int32>, Blueprint<BlueprintSummonPoolReference>)
BaseBlueprintConfigurator<T, TBuilder>.AddTimeOfDayChangedTrigger(ActionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddUIEventTrigger(ActionsBuilder, ConditionsBuilder, Nullable<UIEventType>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
BaseBlueprintConfigurator<T, TBuilder>.AddUnitHealthTrigger(ActionsBuilder, Nullable<Int32>, Blueprint<BlueprintUnitReference>)
BaseBlueprintConfigurator<T, TBuilder>.AddTrapTrigger(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, ActionsBuilder, ActionsBuilder, MapObjectEvaluator)
BaseBlueprintConfigurator<T, TBuilder>.AddVendorDealTrigger(ActionsBuilder, Nullable<VendorDealTrigger.DealType>, Blueprint<BlueprintItemReference>, UnitEvaluator)
RootConfigurator<T, TBuilder>.Logger
RootConfigurator<T, TBuilder>.Self
RootConfigurator<T, TBuilder>.Blueprint
RootConfigurator<T, TBuilder>.Configured
RootConfigurator<T, TBuilder>.ConfigureDelayedBlueprints()
RootConfigurator<T, TBuilder>.Configure(Boolean)
RootConfigurator<T, TBuilder>.AddComponent(BlueprintComponent)
RootConfigurator<T, TBuilder>.AddComponent<C>(Action<C>)
RootConfigurator<T, TBuilder>.AddUniqueComponent(BlueprintComponent, ComponentMerge, Action<BlueprintComponent, BlueprintComponent>)
RootConfigurator<T, TBuilder>.EditComponent<C>(Action<C>)
RootConfigurator<T, TBuilder>.EditComponents<C>(Action<C>, Func<C, Boolean>)
RootConfigurator<T, TBuilder>.RemoveComponents(Func<BlueprintComponent, Boolean>)
RootConfigurator<T, TBuilder>.OnConfigure(Action<T>[])
RootConfigurator<T, TBuilder>.CopyFrom(Blueprint<BlueprintReference<BlueprintScriptableObject>>, Type[])
RootConfigurator<T, TBuilder>.CopyFrom(Blueprint<BlueprintReference<BlueprintScriptableObject>>, Predicate<BlueprintComponent>)
RootConfigurator<T, TBuilder>.OnConfigureInternal(Action<T>[])
RootConfigurator<T, TBuilder>.OnConfigureCompleted()
RootConfigurator<T, TBuilder>.Validate(Object)
Namespace: BlueprintCore.Blueprints.Configurators.Kingdom
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseKingdomUIRootConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : KingdomUIRoot where TBuilder : BaseKingdomUIRootConfigurator<T, TBuilder>
Type Parameters
Name Description
T
TBuilder
Remarks

Each supported blueprint type has a corresponding Configurator class to create and modify blueprints of that type, e.g. FeatureConfigurator supports BlueprintFeature. Configurators exist for all blueprint types inheriting from Kingmaker.Blueprints.BlueprintScriptableObject, excluding any that are not used in the base game.

Creating a Blueprint

Use New(string, string) to create a blueprint:

FeatureConfigurator.New(MyBlueprintName, MyBlueprintGuid)

Once New() is called the blueprint is added to the game library and can be referenced.

Using the Configurator

New() returns a configurator with methods to set or modify blueprint fields and add or modify Kingmaker.Blueprints.BlueprintComponent:

FeatureConfigurator.New(MyBlueprintName, MyBlueprintGuid).AddToGroups(FeatureGroup.Feat).AddPrerequisiteAlignment(AlignmentMaskType.LawfulGood).Configure();

Each method call returns the configurator allowing you to chain calls. Nothing is modified on the blueprint until Configure() is called, at which point the changes are applied and validated. Potential problems with the blueprint are logged as warnings.

Modifying an Existing Blueprint

Use For(Blueprint) to modify existing blueprints:

CharacterClassConfigurator.For(WizardClassGuid)

Usage is otherwise identical to creating a new blueprint.

For more information see Using BlueprintCore.

Constructors

| Improve this Doc View Source

BaseKingdomUIRootConfigurator(Blueprint<BlueprintReference<T>>)

Declaration
protected BaseKingdomUIRootConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> blueprint

Methods

| Improve this Doc View Source

AddToEventResultMarginDescriptions(KingdomUIRoot.EventResultMarginDescription[])

Adds to the contents of Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescriptions

Declaration
public TBuilder AddToEventResultMarginDescriptions(params KingdomUIRoot.EventResultMarginDescription[] eventResultMarginDescriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescription[] eventResultMarginDescriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToKingdomStatusChangeReasons(KingdomUIRoot.KingdomStatusChangeReasonEntity[])

Adds to the contents of Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasons

Declaration
public TBuilder AddToKingdomStatusChangeReasons(params KingdomUIRoot.KingdomStatusChangeReasonEntity[] kingdomStatusChangeReasons)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasonEntity[] kingdomStatusChangeReasons
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToKingdomStautsDesriptions(KingdomUIRoot.KingdomStatusDescription[])

Adds to the contents of Kingmaker.Kingdom.KingdomUIRoot.KingdomStautsDesriptions

Declaration
public TBuilder AddToKingdomStautsDesriptions(params KingdomUIRoot.KingdomStatusDescription[] kingdomStautsDesriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusDescription[] kingdomStautsDesriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToLeaderDescriptions(KingdomUIRoot.KingdomLeaderDescription[])

Adds to the contents of Kingmaker.Kingdom.KingdomUIRoot.LeaderDescriptions

Declaration
public TBuilder AddToLeaderDescriptions(params KingdomUIRoot.KingdomLeaderDescription[] leaderDescriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomLeaderDescription[] leaderDescriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToResources(KingdomUIRoot.KingdomResourceElement[])

Adds to the contents of Kingmaker.Kingdom.KingdomUIRoot.Resources

Declaration
public TBuilder AddToResources(params KingdomUIRoot.KingdomResourceElement[] resources)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomResourceElement[] resources
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToStats(KingdomUIRoot.KingdomStatElement[])

Adds to the contents of Kingmaker.Kingdom.KingdomUIRoot.Stats

Declaration
public TBuilder AddToStats(params KingdomUIRoot.KingdomStatElement[] stats)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatElement[] stats
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearEventResultMarginDescriptions()

Removes all elements from Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescriptions

Declaration
public TBuilder ClearEventResultMarginDescriptions()
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearKingdomStatusChangeReasons()

Removes all elements from Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasons

Declaration
public TBuilder ClearKingdomStatusChangeReasons()
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearKingdomStautsDesriptions()

Removes all elements from Kingmaker.Kingdom.KingdomUIRoot.KingdomStautsDesriptions

Declaration
public TBuilder ClearKingdomStautsDesriptions()
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearLeaderDescriptions()

Removes all elements from Kingmaker.Kingdom.KingdomUIRoot.LeaderDescriptions

Declaration
public TBuilder ClearLeaderDescriptions()
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearResources()

Removes all elements from Kingmaker.Kingdom.KingdomUIRoot.Resources

Declaration
public TBuilder ClearResources()
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearStats()

Removes all elements from Kingmaker.Kingdom.KingdomUIRoot.Stats

Declaration
public TBuilder ClearStats()
Returns
Type Description
TBuilder
| Improve this Doc View Source

CopyFrom(Blueprint<BlueprintReference<KingdomUIRoot>>, Predicate<BlueprintComponent>)

Copies fields and components of the specified types from the blueprint.

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<KingdomUIRoot>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Kingdom.KingdomUIRoot>> blueprint
System.Predicate<Kingmaker.Blueprints.BlueprintComponent> componentMatcher

Any components in blueprint matching the predicate are copied. These are shallow copies that are shared by both blueprints.

Returns
Type Description
TBuilder
Remarks

NOT A DEEP COPY. This means objects copied are shared between blueprints. Changes to copied objects affect both blueprints.

Recommended when you need to create a nearly identical ability but change some parts such as a ContextRankConfig.

// Copy the Undead Bloodline's Incorporeal Form ability, replacing the duration w/ Character Level rounds
AbilityConfigurator.New(NewIncorporealForm, Guids.NewIncorporealForm)
  .CopyFrom(
    AbilityRefs.BloodlineUndeadIncorporealFormAbility,
    typeof(AbilityEffectRunAction),
    typeof(AbilityResourceLogic),
    typeof(SpellComponent))
  .AddContextRankConfig(ContextRankConfigs.CharacterLevel())
  .Configure();
| Improve this Doc View Source

CopyFrom(Blueprint<BlueprintReference<KingdomUIRoot>>, Type[])

Copies fields and components of the specified types from the blueprint.

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<KingdomUIRoot>> blueprint, params Type[] componentTypes)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Kingdom.KingdomUIRoot>> blueprint
System.Type[] componentTypes

Any components in blueprint of the listed types are copied. These are shallow copies that are shared by both blueprints.

Returns
Type Description
TBuilder
Remarks

NOT A DEEP COPY. This means objects copied are shared between blueprints. Changes to copied objects affect both blueprints.

Recommended when you need to create a nearly identical ability but change some parts such as a ContextRankConfig.

// Copy the Undead Bloodline's Incorporeal Form ability, replacing the duration w/ Character Level rounds
AbilityConfigurator.New(NewIncorporealForm, Guids.NewIncorporealForm)
  .CopyFrom(
    AbilityRefs.BloodlineUndeadIncorporealFormAbility,
    typeof(AbilityEffectRunAction),
    typeof(AbilityResourceLogic),
    typeof(SpellComponent))
  .AddContextRankConfig(ContextRankConfigs.CharacterLevel())
  .Configure();
| Improve this Doc View Source

ModifyDefaultOpportunityMapMarker(Action<KingdomUIEventMapMarker>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.DefaultOpportunityMapMarker by invoking the provided action.

Declaration
public TBuilder ModifyDefaultOpportunityMapMarker(Action<KingdomUIEventMapMarker> action)
Parameters
Type Name Description
System.Action<Kingmaker.UI.Kingdom.KingdomUIEventMapMarker> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyDefaultProblemMapMarker(Action<KingdomUIEventMapMarker>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.DefaultProblemMapMarker by invoking the provided action.

Declaration
public TBuilder ModifyDefaultProblemMapMarker(Action<KingdomUIEventMapMarker> action)
Parameters
Type Name Description
System.Action<Kingmaker.UI.Kingdom.KingdomUIEventMapMarker> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyEventResultMarginDescriptions(Action<KingdomUIRoot.EventResultMarginDescription>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescriptions by invoking the provided action on each element.

Declaration
public TBuilder ModifyEventResultMarginDescriptions(Action<KingdomUIRoot.EventResultMarginDescription> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescription> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyExResourceStateTypeStrings(Action<KingdomUIRoot.ResourceStateTypeStrings>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.ExResourceStateTypeStrings by invoking the provided action.

Declaration
public TBuilder ModifyExResourceStateTypeStrings(Action<KingdomUIRoot.ResourceStateTypeStrings> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.ResourceStateTypeStrings> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyKingdomStatusChangeReasons(Action<KingdomUIRoot.KingdomStatusChangeReasonEntity>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasons by invoking the provided action on each element.

Declaration
public TBuilder ModifyKingdomStatusChangeReasons(Action<KingdomUIRoot.KingdomStatusChangeReasonEntity> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasonEntity> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyKingdomStautsDesriptions(Action<KingdomUIRoot.KingdomStatusDescription>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.KingdomStautsDesriptions by invoking the provided action on each element.

Declaration
public TBuilder ModifyKingdomStautsDesriptions(Action<KingdomUIRoot.KingdomStatusDescription> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusDescription> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyLeaderDescriptions(Action<KingdomUIRoot.KingdomLeaderDescription>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.LeaderDescriptions by invoking the provided action on each element.

Declaration
public TBuilder ModifyLeaderDescriptions(Action<KingdomUIRoot.KingdomLeaderDescription> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomLeaderDescription> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyMotto(Action<KingdomUIRoot.KingdomMotto>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.Motto by invoking the provided action.

Declaration
public TBuilder ModifyMotto(Action<KingdomUIRoot.KingdomMotto> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomMotto> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyRavenTexts(Action<KingdomUIRoot.KingdomRavenText>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.RavenTexts by invoking the provided action.

Declaration
public TBuilder ModifyRavenTexts(Action<KingdomUIRoot.KingdomRavenText> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomRavenText> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyResources(Action<KingdomUIRoot.KingdomResourceElement>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.Resources by invoking the provided action on each element.

Declaration
public TBuilder ModifyResources(Action<KingdomUIRoot.KingdomResourceElement> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomResourceElement> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifySettlement(Action<KingdomUIRoot.SettlementRoot>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.Settlement by invoking the provided action.

Declaration
public TBuilder ModifySettlement(Action<KingdomUIRoot.SettlementRoot> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.SettlementRoot> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyStats(Action<KingdomUIRoot.KingdomStatElement>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.Stats by invoking the provided action on each element.

Declaration
public TBuilder ModifyStats(Action<KingdomUIRoot.KingdomStatElement> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomStatElement> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyTexts(Action<KingdomUIRoot.KingdomUITexts>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.Texts by invoking the provided action.

Declaration
public TBuilder ModifyTexts(Action<KingdomUIRoot.KingdomUITexts> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomUITexts> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyTooltip(Action<KingdomUIRoot.KingdomUITooltip>)

Modifies Kingmaker.Kingdom.KingdomUIRoot.Tooltip by invoking the provided action.

Declaration
public TBuilder ModifyTooltip(Action<KingdomUIRoot.KingdomUITooltip> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomUIRoot.KingdomUITooltip> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

OnConfigureCompleted()

Declaration
protected override void OnConfigureCompleted()
Overrides
BlueprintCore.Blueprints.CustomConfigurators.RootConfigurator<T, TBuilder>.OnConfigureCompleted()
| Improve this Doc View Source

RemoveFromEventResultMarginDescriptions(KingdomUIRoot.EventResultMarginDescription[])

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescriptions

Declaration
public TBuilder RemoveFromEventResultMarginDescriptions(params KingdomUIRoot.EventResultMarginDescription[] eventResultMarginDescriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescription[] eventResultMarginDescriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromEventResultMarginDescriptions(Func<KingdomUIRoot.EventResultMarginDescription, Boolean>)

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescriptions that match the provided predicate.

Declaration
public TBuilder RemoveFromEventResultMarginDescriptions(Func<KingdomUIRoot.EventResultMarginDescription, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescription, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromKingdomStatusChangeReasons(KingdomUIRoot.KingdomStatusChangeReasonEntity[])

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasons

Declaration
public TBuilder RemoveFromKingdomStatusChangeReasons(params KingdomUIRoot.KingdomStatusChangeReasonEntity[] kingdomStatusChangeReasons)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasonEntity[] kingdomStatusChangeReasons
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromKingdomStatusChangeReasons(Func<KingdomUIRoot.KingdomStatusChangeReasonEntity, Boolean>)

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasons that match the provided predicate.

Declaration
public TBuilder RemoveFromKingdomStatusChangeReasons(Func<KingdomUIRoot.KingdomStatusChangeReasonEntity, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasonEntity, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromKingdomStautsDesriptions(KingdomUIRoot.KingdomStatusDescription[])

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.KingdomStautsDesriptions

Declaration
public TBuilder RemoveFromKingdomStautsDesriptions(params KingdomUIRoot.KingdomStatusDescription[] kingdomStautsDesriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusDescription[] kingdomStautsDesriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromKingdomStautsDesriptions(Func<KingdomUIRoot.KingdomStatusDescription, Boolean>)

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.KingdomStautsDesriptions that match the provided predicate.

Declaration
public TBuilder RemoveFromKingdomStautsDesriptions(Func<KingdomUIRoot.KingdomStatusDescription, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusDescription, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromLeaderDescriptions(KingdomUIRoot.KingdomLeaderDescription[])

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.LeaderDescriptions

Declaration
public TBuilder RemoveFromLeaderDescriptions(params KingdomUIRoot.KingdomLeaderDescription[] leaderDescriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomLeaderDescription[] leaderDescriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromLeaderDescriptions(Func<KingdomUIRoot.KingdomLeaderDescription, Boolean>)

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.LeaderDescriptions that match the provided predicate.

Declaration
public TBuilder RemoveFromLeaderDescriptions(Func<KingdomUIRoot.KingdomLeaderDescription, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Kingdom.KingdomUIRoot.KingdomLeaderDescription, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromResources(KingdomUIRoot.KingdomResourceElement[])

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.Resources

Declaration
public TBuilder RemoveFromResources(params KingdomUIRoot.KingdomResourceElement[] resources)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomResourceElement[] resources
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromResources(Func<KingdomUIRoot.KingdomResourceElement, Boolean>)

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.Resources that match the provided predicate.

Declaration
public TBuilder RemoveFromResources(Func<KingdomUIRoot.KingdomResourceElement, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Kingdom.KingdomUIRoot.KingdomResourceElement, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromStats(KingdomUIRoot.KingdomStatElement[])

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.Stats

Declaration
public TBuilder RemoveFromStats(params KingdomUIRoot.KingdomStatElement[] stats)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatElement[] stats
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromStats(Func<KingdomUIRoot.KingdomStatElement, Boolean>)

Removes elements from Kingmaker.Kingdom.KingdomUIRoot.Stats that match the provided predicate.

Declaration
public TBuilder RemoveFromStats(Func<KingdomUIRoot.KingdomStatElement, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Kingdom.KingdomUIRoot.KingdomStatElement, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDefaultOpportunityMapMarker(KingdomUIEventMapMarker)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.DefaultOpportunityMapMarker

Declaration
public TBuilder SetDefaultOpportunityMapMarker(KingdomUIEventMapMarker defaultOpportunityMapMarker)
Parameters
Type Name Description
Kingmaker.UI.Kingdom.KingdomUIEventMapMarker defaultOpportunityMapMarker
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDefaultProblemMapMarker(KingdomUIEventMapMarker)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.DefaultProblemMapMarker

Declaration
public TBuilder SetDefaultProblemMapMarker(KingdomUIEventMapMarker defaultProblemMapMarker)
Parameters
Type Name Description
Kingmaker.UI.Kingdom.KingdomUIEventMapMarker defaultProblemMapMarker
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetEventResultMarginDescriptions(KingdomUIRoot.EventResultMarginDescription[])

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescriptions

Declaration
public TBuilder SetEventResultMarginDescriptions(params KingdomUIRoot.EventResultMarginDescription[] eventResultMarginDescriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.EventResultMarginDescription[] eventResultMarginDescriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetExResourceStateTypeStrings(KingdomUIRoot.ResourceStateTypeStrings)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.ExResourceStateTypeStrings

Declaration
public TBuilder SetExResourceStateTypeStrings(KingdomUIRoot.ResourceStateTypeStrings exResourceStateTypeStrings)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.ResourceStateTypeStrings exResourceStateTypeStrings
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetKingdomHistoryEntitisCount(Int32)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.KingdomHistoryEntitisCount

Declaration
public TBuilder SetKingdomHistoryEntitisCount(int kingdomHistoryEntitisCount)
Parameters
Type Name Description
System.Int32 kingdomHistoryEntitisCount
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetKingdomStatusChangeReasons(KingdomUIRoot.KingdomStatusChangeReasonEntity[])

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasons

Declaration
public TBuilder SetKingdomStatusChangeReasons(params KingdomUIRoot.KingdomStatusChangeReasonEntity[] kingdomStatusChangeReasons)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusChangeReasonEntity[] kingdomStatusChangeReasons
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetKingdomStautsDesriptions(KingdomUIRoot.KingdomStatusDescription[])

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.KingdomStautsDesriptions

Declaration
public TBuilder SetKingdomStautsDesriptions(params KingdomUIRoot.KingdomStatusDescription[] kingdomStautsDesriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatusDescription[] kingdomStautsDesriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLeaderDescriptions(KingdomUIRoot.KingdomLeaderDescription[])

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.LeaderDescriptions

Declaration
public TBuilder SetLeaderDescriptions(params KingdomUIRoot.KingdomLeaderDescription[] leaderDescriptions)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomLeaderDescription[] leaderDescriptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMotto(KingdomUIRoot.KingdomMotto)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.Motto

Declaration
public TBuilder SetMotto(KingdomUIRoot.KingdomMotto motto)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomMotto motto
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetRavenTexts(KingdomUIRoot.KingdomRavenText)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.RavenTexts

Declaration
public TBuilder SetRavenTexts(KingdomUIRoot.KingdomRavenText ravenTexts)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomRavenText ravenTexts
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetResources(KingdomUIRoot.KingdomResourceElement[])

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.Resources

Declaration
public TBuilder SetResources(params KingdomUIRoot.KingdomResourceElement[] resources)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomResourceElement[] resources
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSettlement(KingdomUIRoot.SettlementRoot)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.Settlement

Declaration
public TBuilder SetSettlement(KingdomUIRoot.SettlementRoot settlement)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.SettlementRoot settlement
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetStats(KingdomUIRoot.KingdomStatElement[])

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.Stats

Declaration
public TBuilder SetStats(params KingdomUIRoot.KingdomStatElement[] stats)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomStatElement[] stats
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTexts(KingdomUIRoot.KingdomUITexts)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.Texts

Declaration
public TBuilder SetTexts(KingdomUIRoot.KingdomUITexts texts)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomUITexts texts
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTooltip(KingdomUIRoot.KingdomUITooltip)

Sets the value of Kingmaker.Kingdom.KingdomUIRoot.Tooltip

Declaration
public TBuilder SetTooltip(KingdomUIRoot.KingdomUITooltip tooltip)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomUIRoot.KingdomUITooltip tooltip
Returns
Type Description
TBuilder
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX