Class BaseFormationsRootConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Root.FormationsRoot.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.Root
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseFormationsRootConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : FormationsRoot where TBuilder : BaseFormationsRootConfigurator<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 SourceBaseFormationsRootConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseFormationsRootConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddToPredefinedFormations(Blueprint<BlueprintPartyFormationReference>[])
Adds to the contents of Kingmaker.Blueprints.Root.FormationsRoot.m_PredefinedFormations
Declaration
public TBuilder AddToPredefinedFormations(params Blueprint<BlueprintPartyFormationReference>[] predefinedFormations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintPartyFormationReference>[] | predefinedFormations | Blueprint of type BlueprintPartyFormation. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
ClearPredefinedFormations()
Removes all elements from Kingmaker.Blueprints.Root.FormationsRoot.m_PredefinedFormations
Declaration
public TBuilder ClearPredefinedFormations()
Returns
| Type | Description |
|---|---|
| TBuilder |
CopyFrom(Blueprint<BlueprintReference<FormationsRoot>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<FormationsRoot>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.Root.FormationsRoot>> | 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<FormationsRoot>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<FormationsRoot>> blueprint, params Type[] componentTypes)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.Root.FormationsRoot>> | 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();
ModifyAutoFormation(Action<FormationsRoot.AutoFormationSettings>)
Modifies Kingmaker.Blueprints.Root.FormationsRoot.AutoFormation by invoking the provided action.
Declaration
public TBuilder ModifyAutoFormation(Action<FormationsRoot.AutoFormationSettings> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Blueprints.Root.FormationsRoot.AutoFormationSettings> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyFollowersFormation(Action<BlueprintFollowersFormationReference>)
Modifies Kingmaker.Blueprints.Root.FormationsRoot.m_FollowersFormation by invoking the provided action.
Declaration
public TBuilder ModifyFollowersFormation(Action<BlueprintFollowersFormationReference> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Blueprints.BlueprintFollowersFormationReference> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyPredefinedFormations(Action<BlueprintPartyFormationReference>)
Modifies Kingmaker.Blueprints.Root.FormationsRoot.m_PredefinedFormations by invoking the provided action on each element.
Declaration
public TBuilder ModifyPredefinedFormations(Action<BlueprintPartyFormationReference> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Blueprints.BlueprintPartyFormationReference> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromPredefinedFormations(Blueprint<BlueprintPartyFormationReference>[])
Removes elements from Kingmaker.Blueprints.Root.FormationsRoot.m_PredefinedFormations
Declaration
public TBuilder RemoveFromPredefinedFormations(params Blueprint<BlueprintPartyFormationReference>[] predefinedFormations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintPartyFormationReference>[] | predefinedFormations | Blueprint of type BlueprintPartyFormation. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromPredefinedFormations(Func<BlueprintPartyFormationReference, Boolean>)
Removes elements from Kingmaker.Blueprints.Root.FormationsRoot.m_PredefinedFormations that match the provided predicate.
Declaration
public TBuilder RemoveFromPredefinedFormations(Func<BlueprintPartyFormationReference, bool> predicate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Kingmaker.Blueprints.BlueprintPartyFormationReference, System.Boolean> | predicate |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetAutoFormation(FormationsRoot.AutoFormationSettings)
Sets the value of Kingmaker.Blueprints.Root.FormationsRoot.AutoFormation
Declaration
public TBuilder SetAutoFormation(FormationsRoot.AutoFormationSettings autoFormation)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.Blueprints.Root.FormationsRoot.AutoFormationSettings | autoFormation |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetFollowersFormation(Blueprint<BlueprintFollowersFormationReference>)
Sets the value of Kingmaker.Blueprints.Root.FormationsRoot.m_FollowersFormation
Declaration
public TBuilder SetFollowersFormation(Blueprint<BlueprintFollowersFormationReference> followersFormation)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintFollowersFormationReference> | followersFormation | Blueprint of type FollowersFormation. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
SetFormationsScale(Single)
Sets the value of Kingmaker.Blueprints.Root.FormationsRoot.FormationsScale
Declaration
public TBuilder SetFormationsScale(float formationsScale)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | formationsScale |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetMinSpaceFactor(Single)
Sets the value of Kingmaker.Blueprints.Root.FormationsRoot.MinSpaceFactor
Declaration
public TBuilder SetMinSpaceFactor(float minSpaceFactor)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | minSpaceFactor |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetPredefinedFormations(Blueprint<BlueprintPartyFormationReference>[])
Sets the value of Kingmaker.Blueprints.Root.FormationsRoot.m_PredefinedFormations
Declaration
public TBuilder SetPredefinedFormations(params Blueprint<BlueprintPartyFormationReference>[] predefinedFormations)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintPartyFormationReference>[] | predefinedFormations | Blueprint of type BlueprintPartyFormation. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |