Class BaseArmyHealthConsiderationConfigurator<T, TBuilder>

public abstract class BaseArmyHealthConsiderationConfigurator<T, TBuilder> : BaseConsiderationConfigurator<T, TBuilder> where T : ArmyHealthConsideration where TBuilder : BaseArmyHealthConsiderationConfigurator<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

BaseArmyHealthConsiderationConfigurator(Blueprint<BlueprintReference<T>>)

Declaration

protected BaseArmyHealthConsiderationConfigurator(Blueprint<BlueprintReference<T>> blueprint)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>>	blueprint

Methods

| Improve this Doc View Source

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

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

Declaration

public TBuilder CopyFrom(Blueprint<BlueprintReference<ArmyHealthConsideration>> blueprint, Predicate<BlueprintComponent> componentMatcher)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Armies.TacticalCombat.Brain.Considerations.ArmyHealthConsideration>>	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<ArmyHealthConsideration>>, Type[])

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

Declaration

public TBuilder CopyFrom(Blueprint<BlueprintReference<ArmyHealthConsideration>> blueprint, params Type[] componentTypes)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Armies.TacticalCombat.Brain.Considerations.ArmyHealthConsideration>>	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

SetDeadBorder(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Brain.Considerations.ArmyHealthConsideration.DeadBorder

Declaration

public TBuilder SetDeadBorder(float deadBorder)

Parameters

Type	Name	Description
System.Single	deadBorder	InfoBox: If unit current HP is below this percent of max HP -> return DeadScore

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetDeadScore(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Brain.Considerations.ArmyHealthConsideration.DeadScore

Declaration

public TBuilder SetDeadScore(float deadScore)

Parameters

Type	Name	Description
System.Single	deadScore

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetFullBorder(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Brain.Considerations.ArmyHealthConsideration.FullBorder

Declaration

public TBuilder SetFullBorder(float fullBorder)

Parameters

Type	Name	Description
System.Single	fullBorder	InfoBox: If unit current HP is above this percent of max HP -> return FullScore

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetFullScore(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Brain.Considerations.ArmyHealthConsideration.FullScore

Declaration

public TBuilder SetFullScore(float fullScore)

Parameters

Type	Name	Description
System.Single	fullScore	InfoBox: According to current HP percentage returns score between FullScore and DeadScore Current HP here is sum of all alive squad units HP

Returns

Type	Description
TBuilder