Show / Hide Table of Contents

Class BaseDungeonArmyConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseDungeonArmyConfigurator<T, TBuilder>
DungeonArmyConfigurator
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.Dungeon
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseDungeonArmyConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintDungeonArmy where TBuilder : BaseDungeonArmyConfigurator<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

BaseDungeonArmyConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToExcludeTags(UnitTag[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeTags

Declaration
public TBuilder AddToExcludeTags(params UnitTag[] excludeTags)
Parameters
Type Name Description
Kingmaker.Enums.UnitTag[] excludeTags
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToExcludeUnits(Blueprint<BlueprintUnitReference>[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeUnits

Declaration
public TBuilder AddToExcludeUnits(params Blueprint<BlueprintUnitReference>[] excludeUnits)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[] excludeUnits

Blueprint of type BlueprintUnit. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToIncludeTags(UnitTag[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeTags

Declaration
public TBuilder AddToIncludeTags(params UnitTag[] includeTags)
Parameters
Type Name Description
Kingmaker.Enums.UnitTag[] includeTags
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToIncludeUnits(Blueprint<BlueprintUnitReference>[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeUnits

Declaration
public TBuilder AddToIncludeUnits(params Blueprint<BlueprintUnitReference>[] includeUnits)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[] includeUnits

Blueprint of type BlueprintUnit. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToModificatorsExclude(Blueprint<BlueprintDungeonModificatorReference>[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsExclude

Declaration
public TBuilder AddToModificatorsExclude(params Blueprint<BlueprintDungeonModificatorReference>[] modificatorsExclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference>[] modificatorsExclude

Tooltip: Restrict this army to specific island modificators.

Blueprint of type BlueprintDungeonModificator. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToModificatorsInclude(Blueprint<BlueprintDungeonModificatorReference>[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsInclude

Declaration
public TBuilder AddToModificatorsInclude(params Blueprint<BlueprintDungeonModificatorReference>[] modificatorsInclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference>[] modificatorsInclude

Tooltip: Restrict this army to specific island modificators.

Blueprint of type BlueprintDungeonModificator. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToPseudoCRUnits(BlueprintDungeonArmy.CrUnits[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.PseudoCRUnits

Declaration
public TBuilder AddToPseudoCRUnits(params BlueprintDungeonArmy.CrUnits[] pseudoCRUnits)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits[] pseudoCRUnits
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToSettingsExclude(Blueprint<BlueprintDungeonSettingReference>[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsExclude

Declaration
public TBuilder AddToSettingsExclude(params Blueprint<BlueprintDungeonSettingReference>[] settingsExclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference>[] settingsExclude

Tooltip: Restrict this army to specific island settings.

Blueprint of type BlueprintDungeonSetting. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToSettingsInclude(Blueprint<BlueprintDungeonSettingReference>[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsInclude

Declaration
public TBuilder AddToSettingsInclude(params Blueprint<BlueprintDungeonSettingReference>[] settingsInclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference>[] settingsInclude

Tooltip: Restrict this army to specific island settings.

Blueprint of type BlueprintDungeonSetting. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToThemes(Blueprint<BlueprintDungeonThemeReference>[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Themes

Declaration
public TBuilder AddToThemes(params Blueprint<BlueprintDungeonThemeReference>[] themes)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonThemeReference>[] themes

Blueprint of type BlueprintDungeonTheme. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToTiers(Blueprint<BlueprintDungeonTierReference>[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Tiers

Declaration
public TBuilder AddToTiers(params Blueprint<BlueprintDungeonTierReference>[] tiers)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonTierReference>[] tiers

Tooltip: This army should appear only in these tiers.

Blueprint of type BlueprintDungeonTier. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToUnits(BlueprintDungeonArmy.CrUnits[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.Units

Declaration
public TBuilder AddToUnits(params BlueprintDungeonArmy.CrUnits[] units)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits[] units
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToUnitsCount(IntegerWeighted[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.UnitsCount

Declaration
public TBuilder AddToUnitsCount(params IntegerWeighted[] unitsCount)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.IntegerWeighted[] unitsCount
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearExcludeTags()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeTags

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

ClearExcludeUnits()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeUnits

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

ClearIncludeTags()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeTags

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

ClearIncludeUnits()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeUnits

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

ClearModificatorsExclude()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsExclude

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

ClearModificatorsInclude()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsInclude

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

ClearPseudoCRUnits()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.PseudoCRUnits

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

ClearSettingsExclude()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsExclude

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

ClearSettingsInclude()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsInclude

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

ClearThemes()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Themes

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

ClearTiers()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Tiers

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

ClearUnits()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.Units

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

ClearUnitsCount()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.UnitsCount

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

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

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

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonArmy>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy>> 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<BlueprintDungeonArmy>>, Type[])

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

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintDungeonArmy>> blueprint, params Type[] componentTypes)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy>> 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

ModifyCrUnitsFromPseudoCR(Action<Dictionary<Int32, BlueprintDungeonArmy.CrUnits>>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_CrUnitsFromPseudoCR by invoking the provided action.

Declaration
public TBuilder ModifyCrUnitsFromPseudoCR(Action<Dictionary<int, BlueprintDungeonArmy.CrUnits>> action)
Parameters
Type Name Description
System.Action<System.Collections.Generic.Dictionary<System.Int32, Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits>> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyExcludeTags(Action<UnitTag>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeTags by invoking the provided action on each element.

Declaration
public TBuilder ModifyExcludeTags(Action<UnitTag> action)
Parameters
Type Name Description
System.Action<Kingmaker.Enums.UnitTag> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyExcludeUnits(Action<BlueprintUnitReference>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeUnits by invoking the provided action on each element.

Declaration
public TBuilder ModifyExcludeUnits(Action<BlueprintUnitReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.BlueprintUnitReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyIncludeTags(Action<UnitTag>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeTags by invoking the provided action on each element.

Declaration
public TBuilder ModifyIncludeTags(Action<UnitTag> action)
Parameters
Type Name Description
System.Action<Kingmaker.Enums.UnitTag> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyIncludeUnits(Action<BlueprintUnitReference>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeUnits by invoking the provided action on each element.

Declaration
public TBuilder ModifyIncludeUnits(Action<BlueprintUnitReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.BlueprintUnitReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyModificatorsExclude(Action<BlueprintDungeonModificatorReference>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsExclude by invoking the provided action on each element.

Declaration
public TBuilder ModifyModificatorsExclude(Action<BlueprintDungeonModificatorReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyModificatorsInclude(Action<BlueprintDungeonModificatorReference>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsInclude by invoking the provided action on each element.

Declaration
public TBuilder ModifyModificatorsInclude(Action<BlueprintDungeonModificatorReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyPseudoCRUnits(Action<BlueprintDungeonArmy.CrUnits>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.PseudoCRUnits by invoking the provided action on each element.

Declaration
public TBuilder ModifyPseudoCRUnits(Action<BlueprintDungeonArmy.CrUnits> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifySettingsExclude(Action<BlueprintDungeonSettingReference>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsExclude by invoking the provided action on each element.

Declaration
public TBuilder ModifySettingsExclude(Action<BlueprintDungeonSettingReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifySettingsInclude(Action<BlueprintDungeonSettingReference>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsInclude by invoking the provided action on each element.

Declaration
public TBuilder ModifySettingsInclude(Action<BlueprintDungeonSettingReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyThemes(Action<BlueprintDungeonThemeReference>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Themes by invoking the provided action on each element.

Declaration
public TBuilder ModifyThemes(Action<BlueprintDungeonThemeReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonThemeReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyTiers(Action<BlueprintDungeonTierReference>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Tiers by invoking the provided action on each element.

Declaration
public TBuilder ModifyTiers(Action<BlueprintDungeonTierReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonTierReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyUnits(Action<BlueprintDungeonArmy.CrUnits>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.Units by invoking the provided action on each element.

Declaration
public TBuilder ModifyUnits(Action<BlueprintDungeonArmy.CrUnits> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyUnitsCount(Action<IntegerWeighted>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.UnitsCount by invoking the provided action on each element.

Declaration
public TBuilder ModifyUnitsCount(Action<IntegerWeighted> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.IntegerWeighted> 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

RemoveFromExcludeTags(UnitTag[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeTags

Declaration
public TBuilder RemoveFromExcludeTags(params UnitTag[] excludeTags)
Parameters
Type Name Description
Kingmaker.Enums.UnitTag[] excludeTags
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromExcludeTags(Func<UnitTag, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeTags that match the provided predicate.

Declaration
public TBuilder RemoveFromExcludeTags(Func<UnitTag, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Enums.UnitTag, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromExcludeUnits(Blueprint<BlueprintUnitReference>[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeUnits

Declaration
public TBuilder RemoveFromExcludeUnits(params Blueprint<BlueprintUnitReference>[] excludeUnits)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[] excludeUnits

Blueprint of type BlueprintUnit. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromExcludeUnits(Func<BlueprintUnitReference, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeUnits that match the provided predicate.

Declaration
public TBuilder RemoveFromExcludeUnits(Func<BlueprintUnitReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Blueprints.BlueprintUnitReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromIncludeTags(UnitTag[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeTags

Declaration
public TBuilder RemoveFromIncludeTags(params UnitTag[] includeTags)
Parameters
Type Name Description
Kingmaker.Enums.UnitTag[] includeTags
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromIncludeTags(Func<UnitTag, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeTags that match the provided predicate.

Declaration
public TBuilder RemoveFromIncludeTags(Func<UnitTag, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Enums.UnitTag, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromIncludeUnits(Blueprint<BlueprintUnitReference>[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeUnits

Declaration
public TBuilder RemoveFromIncludeUnits(params Blueprint<BlueprintUnitReference>[] includeUnits)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[] includeUnits

Blueprint of type BlueprintUnit. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromIncludeUnits(Func<BlueprintUnitReference, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeUnits that match the provided predicate.

Declaration
public TBuilder RemoveFromIncludeUnits(Func<BlueprintUnitReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Blueprints.BlueprintUnitReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromModificatorsExclude(Blueprint<BlueprintDungeonModificatorReference>[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsExclude

Declaration
public TBuilder RemoveFromModificatorsExclude(params Blueprint<BlueprintDungeonModificatorReference>[] modificatorsExclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference>[] modificatorsExclude

Tooltip: Restrict this army to specific island modificators.

Blueprint of type BlueprintDungeonModificator. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromModificatorsExclude(Func<BlueprintDungeonModificatorReference, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsExclude that match the provided predicate.

Declaration
public TBuilder RemoveFromModificatorsExclude(Func<BlueprintDungeonModificatorReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromModificatorsInclude(Blueprint<BlueprintDungeonModificatorReference>[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsInclude

Declaration
public TBuilder RemoveFromModificatorsInclude(params Blueprint<BlueprintDungeonModificatorReference>[] modificatorsInclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference>[] modificatorsInclude

Tooltip: Restrict this army to specific island modificators.

Blueprint of type BlueprintDungeonModificator. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromModificatorsInclude(Func<BlueprintDungeonModificatorReference, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsInclude that match the provided predicate.

Declaration
public TBuilder RemoveFromModificatorsInclude(Func<BlueprintDungeonModificatorReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromPseudoCRUnits(BlueprintDungeonArmy.CrUnits[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.PseudoCRUnits

Declaration
public TBuilder RemoveFromPseudoCRUnits(params BlueprintDungeonArmy.CrUnits[] pseudoCRUnits)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits[] pseudoCRUnits
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromPseudoCRUnits(Func<BlueprintDungeonArmy.CrUnits, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.PseudoCRUnits that match the provided predicate.

Declaration
public TBuilder RemoveFromPseudoCRUnits(Func<BlueprintDungeonArmy.CrUnits, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSettingsExclude(Blueprint<BlueprintDungeonSettingReference>[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsExclude

Declaration
public TBuilder RemoveFromSettingsExclude(params Blueprint<BlueprintDungeonSettingReference>[] settingsExclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference>[] settingsExclude

Tooltip: Restrict this army to specific island settings.

Blueprint of type BlueprintDungeonSetting. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSettingsExclude(Func<BlueprintDungeonSettingReference, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsExclude that match the provided predicate.

Declaration
public TBuilder RemoveFromSettingsExclude(Func<BlueprintDungeonSettingReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSettingsInclude(Blueprint<BlueprintDungeonSettingReference>[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsInclude

Declaration
public TBuilder RemoveFromSettingsInclude(params Blueprint<BlueprintDungeonSettingReference>[] settingsInclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference>[] settingsInclude

Tooltip: Restrict this army to specific island settings.

Blueprint of type BlueprintDungeonSetting. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSettingsInclude(Func<BlueprintDungeonSettingReference, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsInclude that match the provided predicate.

Declaration
public TBuilder RemoveFromSettingsInclude(Func<BlueprintDungeonSettingReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromThemes(Blueprint<BlueprintDungeonThemeReference>[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Themes

Declaration
public TBuilder RemoveFromThemes(params Blueprint<BlueprintDungeonThemeReference>[] themes)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonThemeReference>[] themes

Blueprint of type BlueprintDungeonTheme. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromThemes(Func<BlueprintDungeonThemeReference, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Themes that match the provided predicate.

Declaration
public TBuilder RemoveFromThemes(Func<BlueprintDungeonThemeReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonThemeReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromTiers(Blueprint<BlueprintDungeonTierReference>[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Tiers

Declaration
public TBuilder RemoveFromTiers(params Blueprint<BlueprintDungeonTierReference>[] tiers)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonTierReference>[] tiers

Tooltip: This army should appear only in these tiers.

Blueprint of type BlueprintDungeonTier. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromTiers(Func<BlueprintDungeonTierReference, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Tiers that match the provided predicate.

Declaration
public TBuilder RemoveFromTiers(Func<BlueprintDungeonTierReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonTierReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromUnits(BlueprintDungeonArmy.CrUnits[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.Units

Declaration
public TBuilder RemoveFromUnits(params BlueprintDungeonArmy.CrUnits[] units)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits[] units
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromUnits(Func<BlueprintDungeonArmy.CrUnits, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.Units that match the provided predicate.

Declaration
public TBuilder RemoveFromUnits(Func<BlueprintDungeonArmy.CrUnits, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromUnitsCount(IntegerWeighted[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.UnitsCount

Declaration
public TBuilder RemoveFromUnitsCount(params IntegerWeighted[] unitsCount)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.IntegerWeighted[] unitsCount
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromUnitsCount(Func<IntegerWeighted, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.UnitsCount that match the provided predicate.

Declaration
public TBuilder RemoveFromUnitsCount(Func<IntegerWeighted, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.IntegerWeighted, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetCrUnitsFromPseudoCR(Dictionary<Int32, BlueprintDungeonArmy.CrUnits>)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_CrUnitsFromPseudoCR

Declaration
public TBuilder SetCrUnitsFromPseudoCR(Dictionary<int, BlueprintDungeonArmy.CrUnits> crUnitsFromPseudoCR)
Parameters
Type Name Description
System.Collections.Generic.Dictionary<System.Int32, Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits> crUnitsFromPseudoCR
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetExcludeTags(UnitTag[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeTags

Declaration
public TBuilder SetExcludeTags(params UnitTag[] excludeTags)
Parameters
Type Name Description
Kingmaker.Enums.UnitTag[] excludeTags
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetExcludeUnits(Blueprint<BlueprintUnitReference>[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ExcludeUnits

Declaration
public TBuilder SetExcludeUnits(params Blueprint<BlueprintUnitReference>[] excludeUnits)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[] excludeUnits

Blueprint of type BlueprintUnit. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIncludeTags(UnitTag[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeTags

Declaration
public TBuilder SetIncludeTags(params UnitTag[] includeTags)
Parameters
Type Name Description
Kingmaker.Enums.UnitTag[] includeTags
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIncludeUnits(Blueprint<BlueprintUnitReference>[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_IncludeUnits

Declaration
public TBuilder SetIncludeUnits(params Blueprint<BlueprintUnitReference>[] includeUnits)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[] includeUnits

Blueprint of type BlueprintUnit. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLimitMaxRooms(Boolean)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.LimitMaxRooms

Declaration
public TBuilder SetLimitMaxRooms(bool limitMaxRooms = true)
Parameters
Type Name Description
System.Boolean limitMaxRooms
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLimitMaxStage(Boolean)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.LimitMaxStage

Declaration
public TBuilder SetLimitMaxStage(bool limitMaxStage = true)
Parameters
Type Name Description
System.Boolean limitMaxStage
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLimitMinStage(Boolean)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.LimitMinStage

Declaration
public TBuilder SetLimitMinStage(bool limitMinStage = true)
Parameters
Type Name Description
System.Boolean limitMinStage
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMaxDifficulty(DungeonDifficulty)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_MaxDifficulty

Declaration
public TBuilder SetMaxDifficulty(DungeonDifficulty maxDifficulty)
Parameters
Type Name Description
Kingmaker.Dungeon.Enums.DungeonDifficulty maxDifficulty
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMaxRooms(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.MaxRooms

Declaration
public TBuilder SetMaxRooms(int maxRooms)
Parameters
Type Name Description
System.Int32 maxRooms

Tooltip: Limit the rooms count where the army may simultaneously be used.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMaxStage(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.MaxStage

Declaration
public TBuilder SetMaxStage(int maxStage)
Parameters
Type Name Description
System.Int32 maxStage

Tooltip: This army should appear not after this stage.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMinDifficulty(DungeonDifficulty)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_MinDifficulty

Declaration
public TBuilder SetMinDifficulty(DungeonDifficulty minDifficulty)
Parameters
Type Name Description
Kingmaker.Dungeon.Enums.DungeonDifficulty minDifficulty
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMinStage(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.MinStage

Declaration
public TBuilder SetMinStage(int minStage)
Parameters
Type Name Description
System.Int32 minStage

Tooltip: This army should appear not before this stage.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetModificatorsExclude(Blueprint<BlueprintDungeonModificatorReference>[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsExclude

Declaration
public TBuilder SetModificatorsExclude(params Blueprint<BlueprintDungeonModificatorReference>[] modificatorsExclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference>[] modificatorsExclude

Tooltip: Restrict this army to specific island modificators.

Blueprint of type BlueprintDungeonModificator. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetModificatorsInclude(Blueprint<BlueprintDungeonModificatorReference>[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ModificatorsInclude

Declaration
public TBuilder SetModificatorsInclude(params Blueprint<BlueprintDungeonModificatorReference>[] modificatorsInclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonModificatorReference>[] modificatorsInclude

Tooltip: Restrict this army to specific island modificators.

Blueprint of type BlueprintDungeonModificator. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetOverrideUnitsCount(Boolean)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.OverrideUnitsCount

Declaration
public TBuilder SetOverrideUnitsCount(bool overrideUnitsCount = true)
Parameters
Type Name Description
System.Boolean overrideUnitsCount
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetProbabilityWeight(Single)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_ProbabilityWeight

Declaration
public TBuilder SetProbabilityWeight(float probabilityWeight)
Parameters
Type Name Description
System.Single probabilityWeight

Tooltip: The weightened probability to use this army.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetPseudoCRMultiplier(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.PseudoCRMultiplier

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

SetPseudoCRUnits(BlueprintDungeonArmy.CrUnits[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.PseudoCRUnits

Declaration
public TBuilder SetPseudoCRUnits(params BlueprintDungeonArmy.CrUnits[] pseudoCRUnits)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits[] pseudoCRUnits
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSettingsExclude(Blueprint<BlueprintDungeonSettingReference>[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsExclude

Declaration
public TBuilder SetSettingsExclude(params Blueprint<BlueprintDungeonSettingReference>[] settingsExclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference>[] settingsExclude

Tooltip: Restrict this army to specific island settings.

Blueprint of type BlueprintDungeonSetting. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSettingsInclude(Blueprint<BlueprintDungeonSettingReference>[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_SettingsInclude

Declaration
public TBuilder SetSettingsInclude(params Blueprint<BlueprintDungeonSettingReference>[] settingsInclude)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonSettingReference>[] settingsInclude

Tooltip: Restrict this army to specific island settings.

Blueprint of type BlueprintDungeonSetting. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetThemes(Blueprint<BlueprintDungeonThemeReference>[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Themes

Declaration
public TBuilder SetThemes(params Blueprint<BlueprintDungeonThemeReference>[] themes)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonThemeReference>[] themes

Blueprint of type BlueprintDungeonTheme. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTiers(Blueprint<BlueprintDungeonTierReference>[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.m_Tiers

Declaration
public TBuilder SetTiers(params Blueprint<BlueprintDungeonTierReference>[] tiers)
Parameters
Type Name Description
Blueprint<Kingmaker.Dungeon.Blueprints.BlueprintDungeonTierReference>[] tiers

Tooltip: This army should appear only in these tiers.

Blueprint of type BlueprintDungeonTier. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetUnits(BlueprintDungeonArmy.CrUnits[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.Units

Declaration
public TBuilder SetUnits(params BlueprintDungeonArmy.CrUnits[] units)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.CrUnits[] units
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetUnitsCount(IntegerWeighted[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonArmy.UnitsCount

Declaration
public TBuilder SetUnitsCount(params IntegerWeighted[] unitsCount)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.IntegerWeighted[] unitsCount
Returns
Type Description
TBuilder
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX