Class BaseDungeonMapConfigurator<T, TBuilder>

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

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseDungeonMapConfigurator<T, TBuilder>
DungeonMapConfigurator
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 BaseDungeonMapConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintDungeonMap where TBuilder : BaseDungeonMapConfigurator<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

BaseDungeonMapConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

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

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

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

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

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

ModifyArrowsLink(Action<SpriteLink>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.m_ArrowsLink by invoking the provided action.

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

ModifyDescription(Action<LocalizedString>)

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

ModifyLayout(Action<DungeonMapLayout>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.Layout by invoking the provided action.

Declaration
public TBuilder ModifyLayout(Action<DungeonMapLayout> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.DungeonMapLayout> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyMapFinalIslandPawnPosition(Action<Vector2>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.MapFinalIslandPawnPosition by invoking the provided action.

Declaration
public TBuilder ModifyMapFinalIslandPawnPosition(Action<Vector2> action)
Parameters
Type Name Description
System.Action<UnityEngine.Vector2> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyMapStartIslandPawnPosition(Action<Vector2>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.MapStartIslandPawnPosition by invoking the provided action.

Declaration
public TBuilder ModifyMapStartIslandPawnPosition(Action<Vector2> action)
Parameters
Type Name Description
System.Action<UnityEngine.Vector2> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyName(Action<LocalizedString>)

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

SetArrowsLink(AssetLink<SpriteLink>)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.m_ArrowsLink

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

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

SetDescription(LocalString)

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

SetLayout(DungeonMapLayout)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.Layout

Declaration
public TBuilder SetLayout(DungeonMapLayout layout)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.DungeonMapLayout layout
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMapFinalIslandPawnPosition(Vector2)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.MapFinalIslandPawnPosition

Declaration
public TBuilder SetMapFinalIslandPawnPosition(Vector2 mapFinalIslandPawnPosition)
Parameters
Type Name Description
UnityEngine.Vector2 mapFinalIslandPawnPosition

Tooltip: Pawn end position. 0 is for the topmost position, 1 is for bottommost position.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMapStartIslandPawnPosition(Vector2)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.MapStartIslandPawnPosition

Declaration
public TBuilder SetMapStartIslandPawnPosition(Vector2 mapStartIslandPawnPosition)
Parameters
Type Name Description
UnityEngine.Vector2 mapStartIslandPawnPosition

Tooltip: Pawn start position. 0 is for the topmost position, 1 is for bottommost position.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetName(LocalString)

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

SetOverrideMapFinalIslandPawnPosition(Boolean)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.OverrideMapFinalIslandPawnPosition

Declaration
public TBuilder SetOverrideMapFinalIslandPawnPosition(bool overrideMapFinalIslandPawnPosition = true)
Parameters
Type Name Description
System.Boolean overrideMapFinalIslandPawnPosition
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetOverrideMapStartIslandPawnPosition(Boolean)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.OverrideMapStartIslandPawnPosition

Declaration
public TBuilder SetOverrideMapStartIslandPawnPosition(bool overrideMapStartIslandPawnPosition = true)
Parameters
Type Name Description
System.Boolean overrideMapStartIslandPawnPosition
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetShouldAddDecorations(Boolean)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonMap.ShouldAddDecorations

Declaration
public TBuilder SetShouldAddDecorations(bool shouldAddDecorations = true)
Parameters
Type Name Description
System.Boolean shouldAddDecorations
Returns
Type Description
TBuilder