Class BaseFeatureBaseConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Classes.BlueprintFeatureBase.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseFactConfigurator<T, TBuilder>
BaseUnitFactConfigurator<T, TBuilder>
BaseFeatureBaseConfigurator<T, TBuilder>
BaseFeatureConfigurator<T, TBuilder>
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.Classes
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseFeatureBaseConfigurator<T, TBuilder> : BaseUnitFactConfigurator<T, TBuilder> where T : BlueprintFeatureBase where TBuilder : BaseFeatureBaseConfigurator<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

BaseFeatureBaseConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddFeatureTagsComponent(FeatureTag, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.Designers.Mechanics.Facts.FeatureTagsComponent

Declaration
public TBuilder AddFeatureTagsComponent(FeatureTag featureTags, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
Kingmaker.Blueprints.Classes.Selection.FeatureTag featureTags
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

  • AccomplishedSneakAttacker9f0187869dc23744292c0e5bb364464e
  • IndomitableMount68e814f1f3ce55942a52c1dd536eaa5b
  • WeaponSpecializationGreater7cf5edc65e785a24f9cf93af987d66b3
| Improve this Doc View Source

AddHideFeatureInInspect()

Adds Kingmaker.Designers.Mechanics.Facts.HideFeatureInInspect

Declaration
public TBuilder AddHideFeatureInInspect()
Returns
Type Description
TBuilder
Remarks

  • AbadarFeature6122dacf418611540a3c91e67197ee4e
  • FightDefensivelyFeatureca22afeb94442b64fb8536e7a9f7dc11
  • WitchBetterHexProgression38d01811fcb32444a8fe372c029fa0c6
| Improve this Doc View Source

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

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

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

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

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

SetHideInCharacterSheetAndLevelUp(Boolean)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintFeatureBase.HideInCharacterSheetAndLevelUp

Declaration
public TBuilder SetHideInCharacterSheetAndLevelUp(bool hideInCharacterSheetAndLevelUp = true)
Parameters
Type Name Description
System.Boolean hideInCharacterSheetAndLevelUp

Tooltip: It will not be showed on page Total in LevelUp/Charscreen and Character Sheet &gt; Abilities

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetHideInUI(Boolean)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintFeatureBase.HideInUI

Declaration
public TBuilder SetHideInUI(bool hideInUI = true)
Parameters
Type Name Description
System.Boolean hideInUI

Tooltip: It will not be showed in any UI screens

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetHideNotAvailibleInUI(Boolean)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintFeatureBase.HideNotAvailibleInUI

Declaration
public TBuilder SetHideNotAvailibleInUI(bool hideNotAvailibleInUI = true)
Parameters
Type Name Description
System.Boolean hideNotAvailibleInUI

Tooltip: For BlueprintFeature: NotAvailible will not be showed in LevelUp/Charscreen selecors. For BlueprintFeatureSelection: all NotAvailible child features will not be showed.

Returns
Type Description
TBuilder