Class BaseGlobalMagicSpellConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseGlobalMagicSpellConfigurator<T, TBuilder>
GlobalMagicSpellConfigurator
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.Crusade
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseGlobalMagicSpellConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintGlobalMagicSpell where TBuilder : BaseGlobalMagicSpellConfigurator<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

BaseGlobalMagicSpellConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

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

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

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

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

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

ModifyExecutor(Action<BlueprintGlobalMagicSpell.ExecutorGlobalMagicSpell>)

Modifies Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_Executor by invoking the provided action.

Declaration
public TBuilder ModifyExecutor(Action<BlueprintGlobalMagicSpell.ExecutorGlobalMagicSpell> action)
Parameters
Type Name Description
System.Action<Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.ExecutorGlobalMagicSpell> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyHoursCooldown(Action<GlobalMagicValue>)

Modifies Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_HoursCooldown by invoking the provided action.

Declaration
public TBuilder ModifyHoursCooldown(Action<GlobalMagicValue> action)
Parameters
Type Name Description
System.Action<Kingmaker.Crusade.GlobalMagic.GlobalMagicValue> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyIcon(Action<Sprite>)

Modifies Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_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

ModifySpellActions(Action<ActionList>)

Modifies Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_SpellActions by invoking the provided action.

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

ModifySpellName(Action<LocalizedString>)

Modifies Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_SpellName by invoking the provided action.

Declaration
public TBuilder ModifySpellName(Action<LocalizedString> action)
Parameters
Type Name Description
System.Action<Kingmaker.Localization.LocalizedString> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyVFX(Action<PrefabLink>)

Modifies Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_VFX by invoking the provided action.

Declaration
public TBuilder ModifyVFX(Action<PrefabLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.ResourceLinks.PrefabLink> 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.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.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

SetExecutor(BlueprintGlobalMagicSpell.ExecutorGlobalMagicSpell)

Sets the value of Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_Executor

Declaration
public TBuilder SetExecutor(BlueprintGlobalMagicSpell.ExecutorGlobalMagicSpell executor)
Parameters
Type Name Description
Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.ExecutorGlobalMagicSpell executor
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetHoursCooldown(GlobalMagicValue)

Sets the value of Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_HoursCooldown

Declaration
public TBuilder SetHoursCooldown(GlobalMagicValue hoursCooldown)
Parameters
Type Name Description
Kingmaker.Crusade.GlobalMagic.GlobalMagicValue hoursCooldown
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIcon(Asset<Sprite>)

Sets the value of Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_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

SetSetCooldownManually(Boolean)

Sets the value of Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_SetCooldownManually

Declaration
public TBuilder SetSetCooldownManually(bool setCooldownManually = true)
Parameters
Type Name Description
System.Boolean setCooldownManually

InfoBox: Turn on if you set cooldown for this spell manually. And default cooldown set logic shouldn&apos;t be run

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSpellActions(ActionsBuilder)

Sets the value of Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_SpellActions

Declaration
public TBuilder SetSpellActions(ActionsBuilder spellActions)
Parameters
Type Name Description
ActionsBuilder spellActions
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSpellName(LocalString)

Sets the value of Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_SpellName

Declaration
public TBuilder SetSpellName(LocalString spellName)
Parameters
Type Name Description
LocalString spellName

You can pass in the string using a LocalizedString or the Key to a LocalizedString.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetVFX(AssetLink<PrefabLink>)

Sets the value of Kingmaker.Crusade.GlobalMagic.BlueprintGlobalMagicSpell.m_VFX

Declaration
public TBuilder SetVFX(AssetLink<PrefabLink> vFX)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.PrefabLink> vFX

You can pass in the animation using a PrefabLink or it's AssetId.
Returns
Type Description
TBuilder