Class BaseConsoleRootConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Root.ConsoleRoot.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseConsoleRootConfigurator<T, TBuilder>
ConsoleRootConfigurator
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.Root
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseConsoleRootConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : ConsoleRoot where TBuilder : BaseConsoleRootConfigurator<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

BaseConsoleRootConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

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

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

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

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

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

ModifyIcons(Action<GamePadIcons>)

Modifies Kingmaker.Blueprints.Root.ConsoleRoot.Icons by invoking the provided action.

Declaration
public TBuilder ModifyIcons(Action<GamePadIcons> action)
Parameters
Type Name Description
System.Action<Owlcat.Runtime.UI.ConsoleTools.GamepadInput.GamePadIcons> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyInGameMenuIcons(Action<ConsoleRoot.UIInGameMenuIcons>)

Modifies Kingmaker.Blueprints.Root.ConsoleRoot.InGameMenuIcons by invoking the provided action.

Declaration
public TBuilder ModifyInGameMenuIcons(Action<ConsoleRoot.UIInGameMenuIcons> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.Root.ConsoleRoot.UIInGameMenuIcons> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyTexts(Action<GamePadTexts.Reference>)

Modifies Kingmaker.Blueprints.Root.ConsoleRoot.Texts by invoking the provided action.

Declaration
public TBuilder ModifyTexts(Action<GamePadTexts.Reference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.Console.GamePadTexts.Reference> 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

SetIcons(GamePadIcons)

Sets the value of Kingmaker.Blueprints.Root.ConsoleRoot.Icons

Declaration
public TBuilder SetIcons(GamePadIcons icons)
Parameters
Type Name Description
Owlcat.Runtime.UI.ConsoleTools.GamepadInput.GamePadIcons icons
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetInGameMenuIcons(ConsoleRoot.UIInGameMenuIcons)

Sets the value of Kingmaker.Blueprints.Root.ConsoleRoot.InGameMenuIcons

Declaration
public TBuilder SetInGameMenuIcons(ConsoleRoot.UIInGameMenuIcons inGameMenuIcons)
Parameters
Type Name Description
Kingmaker.Blueprints.Root.ConsoleRoot.UIInGameMenuIcons inGameMenuIcons
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTexts(Blueprint<GamePadTexts.Reference>)

Sets the value of Kingmaker.Blueprints.Root.ConsoleRoot.Texts

Declaration
public TBuilder SetTexts(Blueprint<GamePadTexts.Reference> texts)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.Console.GamePadTexts.Reference> texts

Blueprint of type GamePadTexts. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder