Class BaseRaceConfigurator<T, TBuilder>

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

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseFactConfigurator<T, TBuilder>
BaseUnitFactConfigurator<T, TBuilder>
BaseFeatureBaseConfigurator<T, TBuilder>
BaseFeatureConfigurator<T, TBuilder>
BaseRaceConfigurator<T, TBuilder>
RaceConfigurator
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 BaseRaceConfigurator<T, TBuilder> : BaseFeatureConfigurator<T, TBuilder> where T : BlueprintRace where TBuilder : BaseRaceConfigurator<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

BaseRaceConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToFeatures(Blueprint<BlueprintFeatureBaseReference>[])

Adds to the contents of Kingmaker.Blueprints.Classes.BlueprintRace.m_Features

Declaration
public TBuilder AddToFeatures(params Blueprint<BlueprintFeatureBaseReference>[] features)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintFeatureBaseReference>[] features

Blueprint of type BlueprintFeatureBase. 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

AddToPresets(Blueprint<BlueprintRaceVisualPresetReference>[])

Adds to the contents of Kingmaker.Blueprints.Classes.BlueprintRace.m_Presets

Declaration
public TBuilder AddToPresets(params Blueprint<BlueprintRaceVisualPresetReference>[] presets)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintRaceVisualPresetReference>[] presets

Blueprint of type BlueprintRaceVisualPreset. 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

AddToSpecialDollTypes(BlueprintRace.SpecialDollTypeEntry[])

Adds to the contents of Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypes

Declaration
public TBuilder AddToSpecialDollTypes(params BlueprintRace.SpecialDollTypeEntry[] specialDollTypes)
Parameters
Type Name Description
Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypeEntry[] specialDollTypes
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearFeatures()

Removes all elements from Kingmaker.Blueprints.Classes.BlueprintRace.m_Features

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

ClearPresets()

Removes all elements from Kingmaker.Blueprints.Classes.BlueprintRace.m_Presets

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

ClearSpecialDollTypes()

Removes all elements from Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypes

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

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

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

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

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

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

ModifyFeatures(Action<BlueprintFeatureBaseReference>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.m_Features by invoking the provided action on each element.

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

ModifyFemaleOptions(Action<CustomizationOptions>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.FemaleOptions by invoking the provided action.

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

ModifyFemaleSpeedSettings(Action<UnitAnimationSettings>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.FemaleSpeedSettings by invoking the provided action.

Declaration
public TBuilder ModifyFemaleSpeedSettings(Action<UnitAnimationSettings> action)
Parameters
Type Name Description
System.Action<Kingmaker.View.Animation.UnitAnimationSettings> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyLinkHairAndSkinColorsCondition(Action<Condition>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.LinkHairAndSkinColorsCondition by invoking the provided action.

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

ModifyMaleOptions(Action<CustomizationOptions>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.MaleOptions by invoking the provided action.

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

ModifyMaleSpeedSettings(Action<UnitAnimationSettings>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.MaleSpeedSettings by invoking the provided action.

Declaration
public TBuilder ModifyMaleSpeedSettings(Action<UnitAnimationSettings> action)
Parameters
Type Name Description
System.Action<Kingmaker.View.Animation.UnitAnimationSettings> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyPresets(Action<BlueprintRaceVisualPresetReference>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.m_Presets by invoking the provided action on each element.

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

ModifySoundKey(Action<String>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.SoundKey by invoking the provided action.

Declaration
public TBuilder ModifySoundKey(Action<string> action)
Parameters
Type Name Description
System.Action<System.String> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifySpecialDollTypes(Action<BlueprintRace.SpecialDollTypeEntry>)

Modifies Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypes by invoking the provided action on each element.

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

OnConfigureCompleted()

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

RemoveFromFeatures(Blueprint<BlueprintFeatureBaseReference>[])

Removes elements from Kingmaker.Blueprints.Classes.BlueprintRace.m_Features

Declaration
public TBuilder RemoveFromFeatures(params Blueprint<BlueprintFeatureBaseReference>[] features)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintFeatureBaseReference>[] features

Blueprint of type BlueprintFeatureBase. 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

RemoveFromFeatures(Func<BlueprintFeatureBaseReference, Boolean>)

Removes elements from Kingmaker.Blueprints.Classes.BlueprintRace.m_Features that match the provided predicate.

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

RemoveFromPresets(Blueprint<BlueprintRaceVisualPresetReference>[])

Removes elements from Kingmaker.Blueprints.Classes.BlueprintRace.m_Presets

Declaration
public TBuilder RemoveFromPresets(params Blueprint<BlueprintRaceVisualPresetReference>[] presets)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintRaceVisualPresetReference>[] presets

Blueprint of type BlueprintRaceVisualPreset. 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

RemoveFromPresets(Func<BlueprintRaceVisualPresetReference, Boolean>)

Removes elements from Kingmaker.Blueprints.Classes.BlueprintRace.m_Presets that match the provided predicate.

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

RemoveFromSpecialDollTypes(BlueprintRace.SpecialDollTypeEntry[])

Removes elements from Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypes

Declaration
public TBuilder RemoveFromSpecialDollTypes(params BlueprintRace.SpecialDollTypeEntry[] specialDollTypes)
Parameters
Type Name Description
Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypeEntry[] specialDollTypes
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSpecialDollTypes(Func<BlueprintRace.SpecialDollTypeEntry, Boolean>)

Removes elements from Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypes that match the provided predicate.

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

SetFeatures(Blueprint<BlueprintFeatureBaseReference>[])

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.m_Features

Declaration
public TBuilder SetFeatures(params Blueprint<BlueprintFeatureBaseReference>[] features)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintFeatureBaseReference>[] features

Blueprint of type BlueprintFeatureBase. 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

SetFemaleOptions(CustomizationOptions)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.FemaleOptions

Declaration
public TBuilder SetFemaleOptions(CustomizationOptions femaleOptions)
Parameters
Type Name Description
Kingmaker.Blueprints.CharGen.CustomizationOptions femaleOptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetFemaleSpeedSettings(UnitAnimationSettings)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.FemaleSpeedSettings

Declaration
public TBuilder SetFemaleSpeedSettings(UnitAnimationSettings femaleSpeedSettings)
Parameters
Type Name Description
Kingmaker.View.Animation.UnitAnimationSettings femaleSpeedSettings
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLinkHairAndSkinColorsCondition(Condition)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.LinkHairAndSkinColorsCondition

Declaration
public TBuilder SetLinkHairAndSkinColorsCondition(Condition linkHairAndSkinColorsCondition)
Parameters
Type Name Description
Kingmaker.ElementsSystem.Condition linkHairAndSkinColorsCondition
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMaleOptions(CustomizationOptions)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.MaleOptions

Declaration
public TBuilder SetMaleOptions(CustomizationOptions maleOptions)
Parameters
Type Name Description
Kingmaker.Blueprints.CharGen.CustomizationOptions maleOptions
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMaleSpeedSettings(UnitAnimationSettings)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.MaleSpeedSettings

Declaration
public TBuilder SetMaleSpeedSettings(UnitAnimationSettings maleSpeedSettings)
Parameters
Type Name Description
Kingmaker.View.Animation.UnitAnimationSettings maleSpeedSettings
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetPresets(Blueprint<BlueprintRaceVisualPresetReference>[])

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.m_Presets

Declaration
public TBuilder SetPresets(params Blueprint<BlueprintRaceVisualPresetReference>[] presets)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintRaceVisualPresetReference>[] presets

Blueprint of type BlueprintRaceVisualPreset. 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

SetRaceId(Race)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.RaceId

Declaration
public TBuilder SetRaceId(Race raceId)
Parameters
Type Name Description
Kingmaker.Blueprints.Race raceId
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSelectableRaceStat(Boolean)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.SelectableRaceStat

Declaration
public TBuilder SetSelectableRaceStat(bool selectableRaceStat = true)
Parameters
Type Name Description
System.Boolean selectableRaceStat
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSize(Size)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.Size

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

SetSoundKey(String)

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.SoundKey

Declaration
public TBuilder SetSoundKey(string soundKey)
Parameters
Type Name Description
System.String soundKey
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSpecialDollTypes(BlueprintRace.SpecialDollTypeEntry[])

Sets the value of Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypes

Declaration
public TBuilder SetSpecialDollTypes(params BlueprintRace.SpecialDollTypeEntry[] specialDollTypes)
Parameters
Type Name Description
Kingmaker.Blueprints.Classes.BlueprintRace.SpecialDollTypeEntry[] specialDollTypes
Returns
Type Description
TBuilder