Class BaseDungeonBoonConfigurator<T, TBuilder>

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

BaseDungeonBoonConfigurator(Blueprint<BlueprintReference<T>>)

Declaration

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

Parameters

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

Methods

| Improve this Doc View Source

AddBoonLogicFeature(Blueprint<BlueprintFeatureReference>, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>)

Adds Kingmaker.Dungeon.Blueprints.Boons.BoonLogicFeature

Declaration

public TBuilder AddBoonLogicFeature(Blueprint<BlueprintFeatureReference> feature = null, bool? mainCharacterOnly = null, int? start = null, int? step = null)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintFeatureReference>	feature	Blueprint of type BlueprintFeature. 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.
System.Nullable<System.Boolean>	mainCharacterOnly
System.Nullable<System.Int32>	start
System.Nullable<System.Int32>	step

Returns

Type	Description
TBuilder

Remarks

DungeonBoon_Aoe5424ec0ee1ef4c06be0b2a847ca77c16
DungeonBoon_Gnome3c86efed41f7426292148ae079d881a6
DungeonBoon_Shieldbuffe0a3d1009fd549fe97c57683b0e6cfe8

| Improve this Doc View Source

AddBoonLogicPartyBuff(Blueprint<BlueprintBuffReference>, Nullable<Boolean>, Nullable<Boolean>, Nullable<DungeonBoonLogic.ProgressionType>, Nullable<Int32>, Nullable<Int32>)

Adds Kingmaker.Dungeon.Blueprints.Boons.BoonLogicPartyBuff

Declaration

public TBuilder AddBoonLogicPartyBuff(Blueprint<BlueprintBuffReference> buff = null, bool? mainCharacterOnly = null, bool? onlyRandomCharacterClass = null, DungeonBoonLogic.ProgressionType? progression = null, int? start = null, int? step = null)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintBuffReference>	buff	Blueprint of type BlueprintBuff. 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.
System.Nullable<System.Boolean>	mainCharacterOnly
System.Nullable<System.Boolean>	onlyRandomCharacterClass
System.Nullable<Kingmaker.Dungeon.Blueprints.DungeonBoonLogic.ProgressionType>	progression
System.Nullable<System.Int32>	start
System.Nullable<System.Int32>	step

Returns

Type	Description
TBuilder

Remarks

DungeonBoon_Acid30d5a9af67c844eaba0a9eccd0e10c39
DungeonBoon_HPRegainc80f02b4bb9a47eb951cbb7fe18b8668
DungeonBoon_UnarmedStrikes5c7a5a0220e84b3fa5d78d427d10bf6b

| Improve this Doc View Source

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

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

Declaration

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

Parameters

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

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

Declaration

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

Parameters

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

ModifyDescription(Action<LocalizedString>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonBoon.m_Description by invoking the provided action.

Declaration

public TBuilder ModifyDescription(Action<LocalizedString> action)

Parameters

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

Returns

Type	Description
TBuilder

| Improve this Doc View Source

ModifyIcon(Action<Sprite>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonBoon.Icon by invoking the provided action.

Declaration

public TBuilder ModifyIcon(Action<Sprite> action)

Parameters

Type	Name	Description
System.Action<UnityEngine.Sprite>	action

Returns

Type	Description
TBuilder

| Improve this Doc View Source

ModifyName(Action<LocalizedString>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonBoon.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

OnConfigureCompleted()

Declaration

protected override void OnConfigureCompleted()

Overrides

BlueprintCore.Blueprints.CustomConfigurators.RootConfigurator<T, TBuilder>.OnConfigureCompleted()

| Improve this Doc View Source

SetDescription(LocalString)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonBoon.m_Description

Declaration

public TBuilder SetDescription(LocalString description)

Parameters

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

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetIcon(Asset<Sprite>)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonBoon.Icon

Declaration

public TBuilder SetIcon(Asset<Sprite> icon)

Parameters

Type	Name	Description
Asset<UnityEngine.Sprite>	icon	You can pass in the animation using a Sprite or it's AssetId.

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetMinStage(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonBoon.MinStage

Declaration

public TBuilder SetMinStage(int minStage)

Parameters

Type	Name	Description
System.Int32	minStage

Returns

Type	Description
TBuilder

| Improve this Doc View Source

SetName(LocalString)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonBoon.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