Class BasePartyFormationConfigurator<T, TBuilder>

public abstract class BasePartyFormationConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintPartyFormation where TBuilder : BasePartyFormationConfigurator<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

BasePartyFormationConfigurator(Blueprint<BlueprintReference<T>>)

Declaration

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

Parameters

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

Methods

| Improve this Doc View Source

AddToPositions(Vector2[])

Adds to the contents of Kingmaker.Formations.BlueprintPartyFormation.Positions

Declaration

public TBuilder AddToPositions(params Vector2[] positions)

Parameters

Type	Name	Description
UnityEngine.Vector2[]	positions

Returns

Type	Description
TBuilder

| Improve this Doc View Source

ClearPositions()

Removes all elements from Kingmaker.Formations.BlueprintPartyFormation.Positions

Declaration

public TBuilder ClearPositions()

Returns

Type	Description
TBuilder

| Improve this Doc View Source

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

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

Declaration

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

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Formations.BlueprintPartyFormation>>	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<BlueprintPartyFormation>>, Type[])

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

Declaration

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

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Formations.BlueprintPartyFormation>>	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

ModifyName(Action<LocalizedString>)

Modifies Kingmaker.Formations.BlueprintPartyFormation.Name by invoking the provided action.

Declaration

public TBuilder ModifyName(Action<LocalizedString> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.Localization.LocalizedString>	action

Returns

Type	Description
TBuilder

| Improve this Doc View Source

ModifyPositions(Action<Vector2>)

Modifies Kingmaker.Formations.BlueprintPartyFormation.Positions by invoking the provided action on each element.

Declaration

public TBuilder ModifyPositions(Action<Vector2> action)

Parameters

Type	Name	Description
System.Action<UnityEngine.Vector2>	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

RemoveFromPositions(Func<Vector2, Boolean>)

Removes elements from Kingmaker.Formations.BlueprintPartyFormation.Positions that match the provided predicate.

Declaration

public TBuilder RemoveFromPositions(Func<Vector2, bool> predicate)

Parameters

Type	Name	Description
System.Func<UnityEngine.Vector2, System.Boolean>	predicate

Returns

Type	Description
TBuilder

| Improve this Doc View Source

RemoveFromPositions(Vector2[])

Removes elements from Kingmaker.Formations.BlueprintPartyFormation.Positions

Declaration

public TBuilder RemoveFromPositions(params Vector2[] positions)

Parameters

Type	Name	Description
UnityEngine.Vector2[]	positions

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetName(LocalString)

Sets the value of Kingmaker.Formations.BlueprintPartyFormation.Name

Declaration

public TBuilder SetName(LocalString name)

Parameters

Type	Name	Description
LocalString	name	You can pass in the string using a LocalizedString or the Key to a LocalizedString.

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetPositions(Vector2[])

Sets the value of Kingmaker.Formations.BlueprintPartyFormation.Positions

Declaration

public TBuilder SetPositions(params Vector2[] positions)

Parameters

Type	Name	Description
UnityEngine.Vector2[]	positions

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetType(PartyFormationType)

Sets the value of Kingmaker.Formations.BlueprintPartyFormation.Type

Declaration

public TBuilder SetType(PartyFormationType type)

Parameters

Type	Name	Description
Kingmaker.Formations.PartyFormationType	type

Returns

Type	Description
TBuilder