Class BaseDungeonTierConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseDungeonTierConfigurator<T, TBuilder>
DungeonTierConfigurator
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.Dungeon
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseDungeonTierConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintDungeonTier where TBuilder : BaseDungeonTierConfigurator<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

BaseDungeonTierConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

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

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

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

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

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

ModifyMapBackgroundLink(Action<SpriteLink>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.m_MapBackgroundLink by invoking the provided action.

Declaration
public TBuilder ModifyMapBackgroundLink(Action<SpriteLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.ResourceLinks.SpriteLink> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyMapForegroundLink(Action<SpriteLink>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.m_MapForegroundLink by invoking the provided action.

Declaration
public TBuilder ModifyMapForegroundLink(Action<SpriteLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.ResourceLinks.SpriteLink> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyMapFrameLink(Action<SpriteLink>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.m_MapFrameLink by invoking the provided action.

Declaration
public TBuilder ModifyMapFrameLink(Action<SpriteLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.ResourceLinks.SpriteLink> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyName(Action<LocalizedString>)

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

ModifyOnFinish(Action<ActionList>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.OnFinish by invoking the provided action.

Declaration
public TBuilder ModifyOnFinish(Action<ActionList> action)
Parameters
Type Name Description
System.Action<Kingmaker.ElementsSystem.ActionList> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyOnReach(Action<ActionList>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.OnReach by invoking the provided action.

Declaration
public TBuilder ModifyOnReach(Action<ActionList> action)
Parameters
Type Name Description
System.Action<Kingmaker.ElementsSystem.ActionList> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyOnStart(Action<ActionList>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.OnStart by invoking the provided action.

Declaration
public TBuilder ModifyOnStart(Action<ActionList> action)
Parameters
Type Name Description
System.Action<Kingmaker.ElementsSystem.ActionList> 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

SetCorruptionGrowth(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.CorruptionGrowth

Declaration
public TBuilder SetCorruptionGrowth(int corruptionGrowth)
Parameters
Type Name Description
System.Int32 corruptionGrowth
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetGoldMultiplier(Double)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.GoldMultiplier

Declaration
public TBuilder SetGoldMultiplier(double goldMultiplier)
Parameters
Type Name Description
System.Double goldMultiplier
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMapBackgroundLink(AssetLink<SpriteLink>)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.m_MapBackgroundLink

Declaration
public TBuilder SetMapBackgroundLink(AssetLink<SpriteLink> mapBackgroundLink)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink> mapBackgroundLink

You can pass in the animation using a SpriteLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMapForegroundLink(AssetLink<SpriteLink>)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.m_MapForegroundLink

Declaration
public TBuilder SetMapForegroundLink(AssetLink<SpriteLink> mapForegroundLink)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink> mapForegroundLink

You can pass in the animation using a SpriteLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMapFrameLink(AssetLink<SpriteLink>)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.m_MapFrameLink

Declaration
public TBuilder SetMapFrameLink(AssetLink<SpriteLink> mapFrameLink)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink> mapFrameLink

You can pass in the animation using a SpriteLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetModificatorsCount(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.ModificatorsCount

Declaration
public TBuilder SetModificatorsCount(int modificatorsCount)
Parameters
Type Name Description
System.Int32 modificatorsCount
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetName(LocalString)

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

SetOnFinish(ActionsBuilder)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.OnFinish

Declaration
public TBuilder SetOnFinish(ActionsBuilder onFinish)
Parameters
Type Name Description
ActionsBuilder onFinish

Tooltip: Actions to run when the tier is reached for the first time by the character.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetOnReach(ActionsBuilder)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.OnReach

Declaration
public TBuilder SetOnReach(ActionsBuilder onReach)
Parameters
Type Name Description
ActionsBuilder onReach

Tooltip: Actions to run when the tier is reached for the first time in the playthrough.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetOnStart(ActionsBuilder)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.OnStart

Declaration
public TBuilder SetOnStart(ActionsBuilder onStart)
Parameters
Type Name Description
ActionsBuilder onStart

Tooltip: Actions to run when the tier is reached for the first time by the character. Won&apos;t run if the OnReach runs.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetStageFirst(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.StageFirst

Declaration
public TBuilder SetStageFirst(int stageFirst)
Parameters
Type Name Description
System.Int32 stageFirst
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetStageLast(Int32)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonTier.StageLast

Declaration
public TBuilder SetStageLast(int stageLast)
Parameters
Type Name Description
System.Int32 stageLast
Returns
Type Description
TBuilder