Class BaseEquipmentEnchantmentConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Items.Ecnchantments.BlueprintEquipmentEnchantment.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseFactConfigurator<T, TBuilder>
BaseItemEnchantmentConfigurator<T, TBuilder>
BaseEquipmentEnchantmentConfigurator<T, TBuilder>
BaseArmorEnchantmentConfigurator<T, TBuilder>
EquipmentEnchantmentConfigurator
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.Items.Ecnchantments
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseEquipmentEnchantmentConfigurator<T, TBuilder> : BaseItemEnchantmentConfigurator<T, TBuilder> where T : BlueprintEquipmentEnchantment where TBuilder : BaseEquipmentEnchantmentConfigurator<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

BaseEquipmentEnchantmentConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddAllSavesBonusEquipment(Nullable<ModifierDescriptor>, Nullable<Int32>)

Adds Kingmaker.Designers.Mechanics.EquipmentEnchants.AllSavesBonusEquipment

Declaration
public TBuilder AddAllSavesBonusEquipment(ModifierDescriptor? descriptor = null, int? value = null)
Parameters
Type Name Description
System.Nullable<Kingmaker.Enums.ModifierDescriptor> descriptor
System.Nullable<System.Int32> value
Returns
Type Description
TBuilder
Remarks

ComponentName: Item Enchantments/Bonus to all saves

  • BlackKnightCloakEnchantment1ad2e26850bfef7409199c2fa23e1fa3
  • Resistance586748e27c9e3b414a97330ea74858994
  • WhiteKnightCloakEnchantment6a37e931c20406e488be6250b5d79a44
| Improve this Doc View Source

AddEquipmentWeaponTypeDamageStatReplacement(Nullable<Boolean>, Nullable<WeaponCategory>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<StatType>)

Adds Kingmaker.Designers.Mechanics.EquipmentEnchants.EquipmentWeaponTypeDamageStatReplacement

Declaration
public TBuilder AddEquipmentWeaponTypeDamageStatReplacement(bool? allNaturalAndUnarmed = null, WeaponCategory? category = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, bool? requiresFinesse = null, StatType? stat = null)
Parameters
Type Name Description
System.Nullable<System.Boolean> allNaturalAndUnarmed
System.Nullable<Kingmaker.Enums.WeaponCategory> category
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> merge

If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components.
ComponentMerge mergeBehavior

Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail.
System.Nullable<System.Boolean> requiresFinesse
System.Nullable<Kingmaker.EntitySystem.Stats.StatType> stat
Returns
Type Description
TBuilder
Remarks

ComponentName: Weapon Damage Stat Replacement Increase

  • UnarmedAgileEnchantment90316f5801dbe4748a66816a7c00380c
| Improve this Doc View Source

AddEquipmentWeaponTypeEnhancement(Nullable<Boolean>, Nullable<WeaponCategory>, Nullable<Int32>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.Designers.Mechanics.EquipmentEnchants.EquipmentWeaponTypeEnhancement

Declaration
public TBuilder AddEquipmentWeaponTypeEnhancement(bool? allNaturalAndUnarmed = null, WeaponCategory? category = null, int? enhancement = null, bool? isStackable = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
System.Nullable<System.Boolean> allNaturalAndUnarmed
System.Nullable<Kingmaker.Enums.WeaponCategory> category
System.Nullable<System.Int32> enhancement
System.Nullable<System.Boolean> isStackable
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> merge

If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components.
ComponentMerge mergeBehavior

Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail.
Returns
Type Description
TBuilder
Remarks

ComponentName: Weapon Damage Stat Replacement Increase

  • ClawEnhancement254f152bc1abbffa42a030ff300f03d5a
  • MagicFangGreaterBuff463dc4ce7bd5f4451b244e148be45106c
  • UnarmedEnhancement6c21b5879e8a7497408980ca0427c7f52
| Improve this Doc View Source

AddWeaponGroupAttackBonusEquipment(Nullable<Int32>, Nullable<ModifierDescriptor>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<WeaponFighterGroup>)

Adds Kingmaker.Designers.Mechanics.EquipmentEnchants.WeaponGroupAttackBonusEquipment

Declaration
public TBuilder AddWeaponGroupAttackBonusEquipment(int? attackBonus = null, ModifierDescriptor? descriptor = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, WeaponFighterGroup? weaponGroup = null)
Parameters
Type Name Description
System.Nullable<System.Int32> attackBonus
System.Nullable<Kingmaker.Enums.ModifierDescriptor> descriptor
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> merge

If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components.
ComponentMerge mergeBehavior

Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail.
System.Nullable<Kingmaker.Blueprints.Items.Weapons.WeaponFighterGroup> weaponGroup
Returns
Type Description
TBuilder
Remarks

ComponentName: Weapon group attack bonus

  • GamekeepersArmorEnchantLongbowe3017d807ffd5c3449dba82735b0ef56
| Improve this Doc View Source

AddWeaponGroupDamageBonusEquipment(Nullable<Int32>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<WeaponFighterGroup>)

Adds Kingmaker.Designers.Mechanics.EquipmentEnchants.WeaponGroupDamageBonusEquipment

Declaration
public TBuilder AddWeaponGroupDamageBonusEquipment(int? attackBonus = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, WeaponFighterGroup? weaponGroup = null)
Parameters
Type Name Description
System.Nullable<System.Int32> attackBonus
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> merge

If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components.
ComponentMerge mergeBehavior

Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail.
System.Nullable<Kingmaker.Blueprints.Items.Weapons.WeaponFighterGroup> weaponGroup
Returns
Type Description
TBuilder
Remarks

ComponentName: Weapon group attack bonus

  • GamekeepersArmorEnchantLongbowe3017d807ffd5c3449dba82735b0ef56
| Improve this Doc View Source

AddWeaponRangeTypeAttackBonusEquipment(Nullable<Int32>, Nullable<ModifierDescriptor>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<WeaponRangeType>)

Adds Kingmaker.Designers.Mechanics.EquipmentEnchants.WeaponRangeTypeAttackBonusEquipment

Declaration
public TBuilder AddWeaponRangeTypeAttackBonusEquipment(int? attackBonus = null, ModifierDescriptor? descriptor = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, WeaponRangeType? rangeType = null)
Parameters
Type Name Description
System.Nullable<System.Int32> attackBonus
System.Nullable<Kingmaker.Enums.ModifierDescriptor> descriptor
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> merge

If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components.
ComponentMerge mergeBehavior

Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail.
System.Nullable<Kingmaker.Enums.WeaponRangeType> rangeType
Returns
Type Description
TBuilder
Remarks

  • DeadlyRaysEnchantmentdcfc21064c91497aa58801d5b3f45733
  • LethalConductorEnchantment77b4aea38f4bb874396d6c6c2cc9c4cf
  • RingOfFirmTouchEnchantment78e1932653b0d5e4db01cbe87a55eb91
| Improve this Doc View Source

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

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

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

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

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