Class BaseUnitAsksListConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Visual.Sound.BlueprintUnitAsksList.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseUnitAsksListConfigurator<T, TBuilder>
UnitAsksListConfigurator
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.Visual
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseUnitAsksListConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintUnitAsksList where TBuilder : BaseUnitAsksListConfigurator<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

BaseUnitAsksListConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddUnitAsksComponent(UnitAsksComponent.Bark, UnitAsksComponent.AnimationBark[], UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, String, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, String[], UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitAsksComponent.Bark, UnitEntityData)

Adds Kingmaker.Visual.Sound.UnitAsksComponent

Declaration
public TBuilder AddUnitAsksComponent(UnitAsksComponent.Bark aggro = null, UnitAsksComponent.AnimationBark[] animationBarks = null, UnitAsksComponent.Bark checkFail = null, UnitAsksComponent.Bark checkSuccess = null, UnitAsksComponent.Bark criticalHit = null, UnitAsksComponent.Bark currentlyActiveBark = null, UnitAsksComponent.Bark death = null, UnitAsksComponent.Bark discovery = null, UnitAsksComponent.Bark fatigue = null, UnitAsksComponent.Bark lowHealth = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, UnitAsksComponent.Bark order = null, UnitAsksComponent.Bark orderMove = null, UnitAsksComponent.Bark pain = null, string previewSound = null, UnitAsksComponent.Bark refuseCast = null, UnitAsksComponent.Bark refuseEquip = null, UnitAsksComponent.Bark refuseUnequip = null, UnitAsksComponent.Bark selected = null, string[] soundBanks = null, UnitAsksComponent.Bark stealth = null, UnitAsksComponent.Bark stormRain = null, UnitAsksComponent.Bark stormSnow = null, UnitAsksComponent.Bark unconscious = null, UnitEntityData unit = null)
Parameters
Type Name Description
Kingmaker.Visual.Sound.UnitAsksComponent.Bark aggro
Kingmaker.Visual.Sound.UnitAsksComponent.AnimationBark[] animationBarks
Kingmaker.Visual.Sound.UnitAsksComponent.Bark checkFail
Kingmaker.Visual.Sound.UnitAsksComponent.Bark checkSuccess
Kingmaker.Visual.Sound.UnitAsksComponent.Bark criticalHit
Kingmaker.Visual.Sound.UnitAsksComponent.Bark currentlyActiveBark
Kingmaker.Visual.Sound.UnitAsksComponent.Bark death
Kingmaker.Visual.Sound.UnitAsksComponent.Bark discovery
Kingmaker.Visual.Sound.UnitAsksComponent.Bark fatigue
Kingmaker.Visual.Sound.UnitAsksComponent.Bark lowHealth
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.
Kingmaker.Visual.Sound.UnitAsksComponent.Bark order
Kingmaker.Visual.Sound.UnitAsksComponent.Bark orderMove
Kingmaker.Visual.Sound.UnitAsksComponent.Bark pain
System.String previewSound
Kingmaker.Visual.Sound.UnitAsksComponent.Bark refuseCast
Kingmaker.Visual.Sound.UnitAsksComponent.Bark refuseEquip
Kingmaker.Visual.Sound.UnitAsksComponent.Bark refuseUnequip
Kingmaker.Visual.Sound.UnitAsksComponent.Bark selected
System.String[] soundBanks
Kingmaker.Visual.Sound.UnitAsksComponent.Bark stealth
Kingmaker.Visual.Sound.UnitAsksComponent.Bark stormRain
Kingmaker.Visual.Sound.UnitAsksComponent.Bark stormSnow
Kingmaker.Visual.Sound.UnitAsksComponent.Bark unconscious
Kingmaker.EntitySystem.Entities.UnitEntityData unit
Returns
Type Description
TBuilder
Remarks

  • Abrikandilu_Barks97c7b7df236d38d4083756c6e71e038b
  • Kalavakus_Barks291595dc771a12e46ba63b1f09aec713
  • Zombie_Barks5b77c4c031391294b920f5a1e119b959
| Improve this Doc View Source

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

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

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

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

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

ModifyDisplayName(Action<LocalizedString>)

Modifies Kingmaker.Visual.Sound.BlueprintUnitAsksList.DisplayName by invoking the provided action.

Declaration
public TBuilder ModifyDisplayName(Action<LocalizedString> action)
Parameters
Type Name Description
System.Action<Kingmaker.Localization.LocalizedString> 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

SetDisplayName(LocalString)

Sets the value of Kingmaker.Visual.Sound.BlueprintUnitAsksList.DisplayName

Declaration
public TBuilder SetDisplayName(LocalString displayName)
Parameters
Type Name Description
LocalString displayName

You can pass in the string using a LocalizedString or the Key to a LocalizedString.
Returns
Type Description
TBuilder