Class BaseCustomAiConsiderationsRootConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.AI
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseCustomAiConsiderationsRootConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : CustomAiConsiderationsRoot where TBuilder : BaseCustomAiConsiderationsRootConfigurator<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 SourceBaseCustomAiConsiderationsRootConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseCustomAiConsiderationsRootConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddToActorConsiderations(Blueprint<ConsiderationCustom.Reference>[])
Adds to the contents of Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_ActorConsiderations
Declaration
public TBuilder AddToActorConsiderations(params Blueprint<ConsiderationCustom.Reference>[] actorConsiderations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference>[] | actorConsiderations | Blueprint of type ConsiderationCustom. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
AddToTargetConsiderations(Blueprint<ConsiderationCustom.Reference>[])
Adds to the contents of Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_TargetConsiderations
Declaration
public TBuilder AddToTargetConsiderations(params Blueprint<ConsiderationCustom.Reference>[] targetConsiderations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference>[] | targetConsiderations | Blueprint of type ConsiderationCustom. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
ClearActorConsiderations()
Removes all elements from Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_ActorConsiderations
Declaration
public TBuilder ClearActorConsiderations()
Returns
| Type | Description |
|---|---|
| TBuilder |
ClearTargetConsiderations()
Removes all elements from Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_TargetConsiderations
Declaration
public TBuilder ClearTargetConsiderations()
Returns
| Type | Description |
|---|---|
| TBuilder |
CopyFrom(Blueprint<BlueprintReference<CustomAiConsiderationsRoot>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<CustomAiConsiderationsRoot>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot>> | blueprint | |
| System.Predicate<Kingmaker.Blueprints.BlueprintComponent> | componentMatcher | Any components in |
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();
CopyFrom(Blueprint<BlueprintReference<CustomAiConsiderationsRoot>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<CustomAiConsiderationsRoot>> blueprint, params Type[] componentTypes)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot>> | blueprint | |
| System.Type[] | componentTypes | Any components in |
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();
ModifyActorConsiderations(Action<ConsiderationCustom.Reference>)
Modifies Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_ActorConsiderations by invoking the provided action on each element.
Declaration
public TBuilder ModifyActorConsiderations(Action<ConsiderationCustom.Reference> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyTargetConsiderations(Action<ConsiderationCustom.Reference>)
Modifies Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_TargetConsiderations by invoking the provided action on each element.
Declaration
public TBuilder ModifyTargetConsiderations(Action<ConsiderationCustom.Reference> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromActorConsiderations(Blueprint<ConsiderationCustom.Reference>[])
Removes elements from Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_ActorConsiderations
Declaration
public TBuilder RemoveFromActorConsiderations(params Blueprint<ConsiderationCustom.Reference>[] actorConsiderations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference>[] | actorConsiderations | Blueprint of type ConsiderationCustom. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromActorConsiderations(Func<ConsiderationCustom.Reference, Boolean>)
Removes elements from Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_ActorConsiderations that match the provided predicate.
Declaration
public TBuilder RemoveFromActorConsiderations(Func<ConsiderationCustom.Reference, bool> predicate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference, System.Boolean> | predicate |
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromTargetConsiderations(Blueprint<ConsiderationCustom.Reference>[])
Removes elements from Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_TargetConsiderations
Declaration
public TBuilder RemoveFromTargetConsiderations(params Blueprint<ConsiderationCustom.Reference>[] targetConsiderations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference>[] | targetConsiderations | Blueprint of type ConsiderationCustom. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromTargetConsiderations(Func<ConsiderationCustom.Reference, Boolean>)
Removes elements from Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_TargetConsiderations that match the provided predicate.
Declaration
public TBuilder RemoveFromTargetConsiderations(Func<ConsiderationCustom.Reference, bool> predicate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference, System.Boolean> | predicate |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetActorConsiderations(Blueprint<ConsiderationCustom.Reference>[])
Sets the value of Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_ActorConsiderations
Declaration
public TBuilder SetActorConsiderations(params Blueprint<ConsiderationCustom.Reference>[] actorConsiderations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference>[] | actorConsiderations | Blueprint of type ConsiderationCustom. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
SetTargetConsiderations(Blueprint<ConsiderationCustom.Reference>[])
Sets the value of Kingmaker.AI.Blueprints.CustomAiConsiderationsRoot.m_TargetConsiderations
Declaration
public TBuilder SetTargetConsiderations(params Blueprint<ConsiderationCustom.Reference>[] targetConsiderations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.AI.Blueprints.Considerations.ConsiderationCustom.Reference>[] | targetConsiderations | Blueprint of type ConsiderationCustom. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |