Class BaseLocatorsConsiderationConfigurator<T, TBuilder>

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

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseConsiderationConfigurator<T, TBuilder>
BaseLocatorsConsiderationConfigurator<T, TBuilder>
LocatorsConsiderationConfigurator
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 BaseLocatorsConsiderationConfigurator<T, TBuilder> : BaseConsiderationConfigurator<T, TBuilder> where T : LocatorsConsideration where TBuilder : BaseLocatorsConsiderationConfigurator<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

BaseLocatorsConsiderationConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToLocators(EntityReference[])

Adds to the contents of Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.Locators

Declaration
public TBuilder AddToLocators(params EntityReference[] locators)
Parameters
Type Name Description
Kingmaker.Blueprints.EntityReference[] locators
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearLocators()

Removes all elements from Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.Locators

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

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

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

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

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

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

ModifyLocators(Action<EntityReference>)

Modifies Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.Locators by invoking the provided action on each element.

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

RemoveFromLocators(EntityReference[])

Removes elements from Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.Locators

Declaration
public TBuilder RemoveFromLocators(params EntityReference[] locators)
Parameters
Type Name Description
Kingmaker.Blueprints.EntityReference[] locators
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromLocators(Func<EntityReference, Boolean>)

Removes elements from Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.Locators that match the provided predicate.

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

SetCheckCasterDistance(Boolean)

Sets the value of Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.CheckCasterDistance

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

SetCheckPartyDistance(Boolean)

Sets the value of Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.CheckPartyDistance

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

SetLocators(EntityReference[])

Sets the value of Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.Locators

Declaration
public TBuilder SetLocators(params EntityReference[] locators)
Parameters
Type Name Description
Kingmaker.Blueprints.EntityReference[] locators
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMaxPartyDistanceToLocator(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.MaxPartyDistanceToLocator

Declaration
public TBuilder SetMaxPartyDistanceToLocator(float maxPartyDistanceToLocator)
Parameters
Type Name Description
System.Single maxPartyDistanceToLocator

InfoBox: Selects target point from locators which is distant from at least one party member less than MaxPartyDistanceToLocator meters (0 or less means no limit)

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMinCasterDistanceToLocator(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.MinCasterDistanceToLocator

Declaration
public TBuilder SetMinCasterDistanceToLocator(float minCasterDistanceToLocator)
Parameters
Type Name Description
System.Single minCasterDistanceToLocator

InfoBox: Selects target point from locators which is distant from caster by at least MinCasterDistanceToLocator meters (0 means no limit)

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMinPartyDistanceToLocator(Single)

Sets the value of Kingmaker.AI.Blueprints.Considerations.LocatorsConsideration.MinPartyDistanceToLocator

Declaration
public TBuilder SetMinPartyDistanceToLocator(float minPartyDistanceToLocator)
Parameters
Type Name Description
System.Single minPartyDistanceToLocator

InfoBox: Selects target point from locators which is distant from all party members by at least MinPartyDistanceToLocator meters (0 or less means no limit)

Returns
Type Description
TBuilder