Class BaseArmyPresetConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Armies.Blueprints.BlueprintArmyPreset.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseArmyPresetConfigurator<T, TBuilder>
ArmyPresetConfigurator
Inherited Members
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>.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>)
Namespace: BlueprintCore.Blueprints.Configurators.Armies
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseArmyPresetConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintArmyPreset where TBuilder : BaseArmyPresetConfigurator<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

BaseArmyPresetConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToSquads(BlueprintArmyPreset.UnitAndCount[])

Adds to the contents of Kingmaker.Armies.Blueprints.BlueprintArmyPreset.Squads

Declaration
public TBuilder AddToSquads(params BlueprintArmyPreset.UnitAndCount[] squads)
Parameters
Type Name Description
Kingmaker.Armies.Blueprints.BlueprintArmyPreset.UnitAndCount[] squads
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearSquads()

Removes all elements from Kingmaker.Armies.Blueprints.BlueprintArmyPreset.Squads

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

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

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

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

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

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

ModifyLeader(Action<BlueprintArmyLeaderReference>)

Modifies Kingmaker.Armies.Blueprints.BlueprintArmyPreset.m_Leader by invoking the provided action.

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

ModifySquads(Action<BlueprintArmyPreset.UnitAndCount>)

Modifies Kingmaker.Armies.Blueprints.BlueprintArmyPreset.Squads by invoking the provided action on each element.

Declaration
public TBuilder ModifySquads(Action<BlueprintArmyPreset.UnitAndCount> action)
Parameters
Type Name Description
System.Action<Kingmaker.Armies.Blueprints.BlueprintArmyPreset.UnitAndCount> 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

RemoveFromSquads(BlueprintArmyPreset.UnitAndCount[])

Removes elements from Kingmaker.Armies.Blueprints.BlueprintArmyPreset.Squads

Declaration
public TBuilder RemoveFromSquads(params BlueprintArmyPreset.UnitAndCount[] squads)
Parameters
Type Name Description
Kingmaker.Armies.Blueprints.BlueprintArmyPreset.UnitAndCount[] squads
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSquads(Func<BlueprintArmyPreset.UnitAndCount, Boolean>)

Removes elements from Kingmaker.Armies.Blueprints.BlueprintArmyPreset.Squads that match the provided predicate.

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

SetArmyType(ArmyType)

Sets the value of Kingmaker.Armies.Blueprints.BlueprintArmyPreset.m_ArmyType

Declaration
public TBuilder SetArmyType(ArmyType armyType)
Parameters
Type Name Description
Kingmaker.Armies.Blueprints.ArmyType armyType

InfoBox: Determines which pawn army will have. Note: moving armies will have Travelling type automatically

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLeader(Blueprint<BlueprintArmyLeaderReference>)

Sets the value of Kingmaker.Armies.Blueprints.BlueprintArmyPreset.m_Leader

Declaration
public TBuilder SetLeader(Blueprint<BlueprintArmyLeaderReference> leader)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintArmyLeaderReference> leader

Blueprint of type BlueprintArmyLeader. 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

SetMorale(Int32)

Sets the value of Kingmaker.Armies.Blueprints.BlueprintArmyPreset.Morale

Declaration
public TBuilder SetMorale(int morale)
Parameters
Type Name Description
System.Int32 morale

InfoBox: See morale limits in MoraleRoot

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSquads(BlueprintArmyPreset.UnitAndCount[])

Sets the value of Kingmaker.Armies.Blueprints.BlueprintArmyPreset.Squads

Declaration
public TBuilder SetSquads(params BlueprintArmyPreset.UnitAndCount[] squads)
Parameters
Type Name Description
Kingmaker.Armies.Blueprints.BlueprintArmyPreset.UnitAndCount[] squads
Returns
Type Description
TBuilder