Class BaseUnitsAroundConsiderationConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseConsiderationConfigurator<T, TBuilder>
BaseUnitsAroundConsiderationConfigurator<T, TBuilder>
BaseBuffsAroundConsiderationConfigurator<T, TBuilder>
BaseHealthAroundConsiderationConfigurator<T, TBuilder>
UnitsAroundConsiderationConfigurator
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.AI
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseUnitsAroundConsiderationConfigurator<T, TBuilder> : BaseConsiderationConfigurator<T, TBuilder> where T : UnitsAroundConsideration where TBuilder : BaseUnitsAroundConsiderationConfigurator<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

BaseUnitsAroundConsiderationConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

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

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

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

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

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

SetBelowMinScore(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.BelowMinScore

Declaration
public TBuilder SetBelowMinScore(float belowMinScore)
Parameters
Type Name Description
System.Single belowMinScore
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetCheckRadiusFromCaster(Boolean)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.CheckRadiusFromCaster

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

SetCustomRadiusInMeters(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.CustomRadiusInMeters

Declaration
public TBuilder SetCustomRadiusInMeters(float customRadiusInMeters)
Parameters
Type Name Description
System.Single customRadiusInMeters
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetExtraTargetScore(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.ExtraTargetScore

Declaration
public TBuilder SetExtraTargetScore(float extraTargetScore)
Parameters
Type Name Description
System.Single extraTargetScore
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetFilter(TargetType)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.Filter

Declaration
public TBuilder SetFilter(TargetType filter)
Parameters
Type Name Description
Kingmaker.AI.Blueprints.TargetType filter
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetFilterDead(DeadTargetType)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.FilterDead

Declaration
public TBuilder SetFilterDead(DeadTargetType filterDead)
Parameters
Type Name Description
Kingmaker.AI.Blueprints.DeadTargetType filterDead
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIncludeUnconscious(Boolean)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.IncludeUnconscious

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

SetMaxCount(Int32)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.MaxCount

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

SetMaxScore(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.MaxScore

Declaration
public TBuilder SetMaxScore(float maxScore)
Parameters
Type Name Description
System.Single maxScore
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMinCount(Int32)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.MinCount

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

SetMinScore(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.MinScore

Declaration
public TBuilder SetMinScore(float minScore)
Parameters
Type Name Description
System.Single minScore
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSqrCustomRadius(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.m_SqrCustomRadius

Declaration
public TBuilder SetSqrCustomRadius(float sqrCustomRadius)
Parameters
Type Name Description
System.Single sqrCustomRadius
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetUseAbilityShape(Boolean)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.UseAbilityShape

Declaration
public TBuilder SetUseAbilityShape(bool useAbilityShape = true)
Parameters
Type Name Description
System.Boolean useAbilityShape

InfoBox: Check units in action&apos;s ability AoE from target. (In Tactical combat is considered as always true)

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetUseCustomRadius(Boolean)

Sets the value of Kingmaker.AI.Blueprints.Considerations.UnitsAroundConsideration.UseCustomRadius

Declaration
public TBuilder SetUseCustomRadius(bool useCustomRadius = true)
Parameters
Type Name Description
System.Boolean useCustomRadius

InfoBox: Check units in given radius (CustomRadiusInMeters) from target or caster (CheckRadiusFromCaster)

Returns
Type Description
TBuilder