Class BaseItemArmorConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseFactConfigurator<T, TBuilder>
BaseItemConfigurator<T, TBuilder>
BaseItemEquipmentConfigurator<T, TBuilder>
BaseItemArmorConfigurator<T, TBuilder>
ItemArmorConfigurator
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.Armors
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseItemArmorConfigurator<T, TBuilder> : BaseItemEquipmentConfigurator<T, TBuilder> where T : BlueprintItemArmor where TBuilder : BaseItemArmorConfigurator<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

BaseItemArmorConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToEnchantments(Blueprint<BlueprintEquipmentEnchantmentReference>[])

Adds to the contents of Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Enchantments

Declaration
public TBuilder AddToEnchantments(params Blueprint<BlueprintEquipmentEnchantmentReference>[] enchantments)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintEquipmentEnchantmentReference>[] enchantments

Blueprint of type BlueprintEquipmentEnchantment. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearEnchantments()

Removes all elements from Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Enchantments

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

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

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

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

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

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

ModifyEnchantments(Action<BlueprintEquipmentEnchantmentReference>)

Modifies Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Enchantments by invoking the provided action on each element.

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

ModifyType(Action<BlueprintArmorTypeReference>)

Modifies Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Type by invoking the provided action.

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

ModifyVisualParameters(Action<ArmorVisualParameters>)

Modifies Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_VisualParameters by invoking the provided action.

Declaration
public TBuilder ModifyVisualParameters(Action<ArmorVisualParameters> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.Items.Armors.ArmorVisualParameters> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

OnConfigureCompleted()

Declaration
protected override void OnConfigureCompleted()
Overrides
BlueprintCore.Blueprints.Configurators.Items.Equipment.BaseItemEquipmentConfigurator<T, TBuilder>.OnConfigureCompleted()
| Improve this Doc View Source

RemoveFromEnchantments(Blueprint<BlueprintEquipmentEnchantmentReference>[])

Removes elements from Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Enchantments

Declaration
public TBuilder RemoveFromEnchantments(params Blueprint<BlueprintEquipmentEnchantmentReference>[] enchantments)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintEquipmentEnchantmentReference>[] enchantments

Blueprint of type BlueprintEquipmentEnchantment. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromEnchantments(Func<BlueprintEquipmentEnchantmentReference, Boolean>)

Removes elements from Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Enchantments that match the provided predicate.

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

SetEnchantments(Blueprint<BlueprintEquipmentEnchantmentReference>[])

Sets the value of Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Enchantments

Declaration
public TBuilder SetEnchantments(params Blueprint<BlueprintEquipmentEnchantmentReference>[] enchantments)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintEquipmentEnchantmentReference>[] enchantments

Blueprint of type BlueprintEquipmentEnchantment. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetOverrideDestructible(Boolean)

Sets the value of Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_OverrideDestructible

Declaration
public TBuilder SetOverrideDestructible(bool overrideDestructible = true)
Parameters
Type Name Description
System.Boolean overrideDestructible

InfoBox: If true, ignores destructible property value from armor type and uses it from blueprint item.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetOverrideShardItem(Boolean)

Sets the value of Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_OverrideShardItem

Declaration
public TBuilder SetOverrideShardItem(bool overrideShardItem = true)
Parameters
Type Name Description
System.Boolean overrideShardItem

InfoBox: If true, ignores shard item from armor type and uses shard from this blueprint.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSize(Size)

Sets the value of Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Size

Declaration
public TBuilder SetSize(Size size)
Parameters
Type Name Description
Kingmaker.Enums.Size size
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetType(Blueprint<BlueprintArmorTypeReference>)

Sets the value of Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_Type

Declaration
public TBuilder SetType(Blueprint<BlueprintArmorTypeReference> type)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintArmorTypeReference> type

Blueprint of type BlueprintArmorType. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetVisualParameters(ArmorVisualParameters)

Sets the value of Kingmaker.Blueprints.Items.Armors.BlueprintItemArmor.m_VisualParameters

Declaration
public TBuilder SetVisualParameters(ArmorVisualParameters visualParameters)
Parameters
Type Name Description
Kingmaker.Blueprints.Items.Armors.ArmorVisualParameters visualParameters
Returns
Type Description
TBuilder