Class BaseDungeonCampaignConfigurator<T, TBuilder>

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

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseDungeonCampaignConfigurator<T, TBuilder>
DungeonCampaignConfigurator
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 BaseDungeonCampaignConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintDungeonCampaign where TBuilder : BaseDungeonCampaignConfigurator<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

BaseDungeonCampaignConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToExpeditions(BlueprintDungeonCampaign.HardcodedExpedition[])

Adds to the contents of Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.Expeditions

Declaration
public TBuilder AddToExpeditions(params BlueprintDungeonCampaign.HardcodedExpedition[] expeditions)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.HardcodedExpedition[] expeditions
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearExpeditions()

Removes all elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.Expeditions

Declaration
public TBuilder ClearExpeditions()
Returns
Type Description
TBuilder
| Improve this Doc View Source

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

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

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

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

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

ModifyExpeditions(Action<BlueprintDungeonCampaign.HardcodedExpedition>)

Modifies Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.Expeditions by invoking the provided action on each element.

Declaration
public TBuilder ModifyExpeditions(Action<BlueprintDungeonCampaign.HardcodedExpedition> action)
Parameters
Type Name Description
System.Action<Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.HardcodedExpedition> 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

RemoveFromExpeditions(BlueprintDungeonCampaign.HardcodedExpedition[])

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.Expeditions

Declaration
public TBuilder RemoveFromExpeditions(params BlueprintDungeonCampaign.HardcodedExpedition[] expeditions)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.HardcodedExpedition[] expeditions
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromExpeditions(Func<BlueprintDungeonCampaign.HardcodedExpedition, Boolean>)

Removes elements from Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.Expeditions that match the provided predicate.

Declaration
public TBuilder RemoveFromExpeditions(Func<BlueprintDungeonCampaign.HardcodedExpedition, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.HardcodedExpedition, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetExpeditions(BlueprintDungeonCampaign.HardcodedExpedition[])

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.Expeditions

Declaration
public TBuilder SetExpeditions(params BlueprintDungeonCampaign.HardcodedExpedition[] expeditions)
Parameters
Type Name Description
Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.HardcodedExpedition[] expeditions
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIsShowMap(Boolean)

Sets the value of Kingmaker.Dungeon.Blueprints.BlueprintDungeonCampaign.m_IsShowMap

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