Class BaseAbilityAreaEffectConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseAbilityAreaEffectConfigurator<T, TBuilder>
AbilityAreaEffectConfigurator
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.UnitLogic.Abilities
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseAbilityAreaEffectConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintAbilityAreaEffect where TBuilder : BaseAbilityAreaEffectConfigurator<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

BaseAbilityAreaEffectConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddAbilityAreaEffectBuff(Blueprint<BlueprintBuffReference>, Nullable<Boolean>, ConditionsBuilder)

Adds Kingmaker.UnitLogic.Abilities.Components.AreaEffects.AbilityAreaEffectBuff

Declaration
public TBuilder AddAbilityAreaEffectBuff(Blueprint<BlueprintBuffReference> buff = null, bool? checkConditionEveryRound = null, ConditionsBuilder condition = null)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintBuffReference> buff

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

System.Nullable<System.Boolean> checkConditionEveryRound
ConditionsBuilder condition
Returns
Type Description
TBuilder
Remarks

  • AcidFogAreaf4dc3f53090627945b83f16ebf3146a6
  • GolemClaySlipperyMudArea7d7821abf06fae744a4e37e48077a43a
  • ZoneOfPredeterminationArea1ff4dfed4f7eb504fa0447e93d1bcf64
| Improve this Doc View Source

AddAbilityAreaEffectMovement(Nullable<Feet>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.UnitLogic.Abilities.Components.AreaEffects.AbilityAreaEffectMovement

Declaration
public TBuilder AddAbilityAreaEffectMovement(Feet? distancePerRound = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
System.Nullable<Kingmaker.Utility.Feet> distancePerRound
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

  • CloudkillArea6df1ac314d4e6e9418e34470b79f90d8
  • PlagueStormCackleFeverArea6cae3c64989f3684bb078efcfa9021a1
  • TsunamiArea800daf41c11463742ad24efd71ab1916
| Improve this Doc View Source

AddAbilityAreaEffectRunAction(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, ActionsBuilder, ActionsBuilder, ActionsBuilder, ActionsBuilder)

Adds Kingmaker.UnitLogic.Abilities.Components.AreaEffects.AbilityAreaEffectRunAction

Declaration
public TBuilder AddAbilityAreaEffectRunAction(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, ActionsBuilder round = null, ActionsBuilder unitEnter = null, ActionsBuilder unitExit = null, ActionsBuilder unitMove = null)
Parameters
Type Name Description
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.
ActionsBuilder round
ActionsBuilder unitEnter
ActionsBuilder unitExit
ActionsBuilder unitMove
Returns
Type Description
TBuilder
Remarks

  • AcidFogAreaf4dc3f53090627945b83f16ebf3146a6
  • HokugolColdAuraAreaEffecta0a68b62640fda14da15804dcd30fca9
  • ZeorisDaggerRing_BetrayalAreaccce3891532741ee91800c01b2304f53
| Improve this Doc View Source

AddAbilityAreaEffectSpecialBehaviour(Nullable<SpecialBehaviour>, Blueprint<BlueprintBuffReference>, Buff, Nullable<Int32>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.UnitLogic.Abilities.Components.AreaEffects.AbilityAreaEffectSpecialBehaviour

Declaration
public TBuilder AddAbilityAreaEffectSpecialBehaviour(SpecialBehaviour? behaviour = null, Blueprint<BlueprintBuffReference> buff = null, Buff buffFact = null, int? count = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
System.Nullable<Kingmaker.UnitLogic.Abilities.Components.AreaEffects.SpecialBehaviour> behaviour
Blueprint<Kingmaker.Blueprints.BlueprintBuffReference> buff

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

Kingmaker.UnitLogic.Buffs.Buff buffFact
System.Nullable<System.Int32> count
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

  • DoombringingAura9c1c22ea222df984388bc8b803033e10
  • TreantAura11e046f425592df4db61c31e1429db19
| Improve this Doc View Source

AddAbilityDifficultyLimitDC(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.UnitLogic.Abilities.Components.AbilityDifficultyLimitDC

Declaration
public TBuilder AddAbilityDifficultyLimitDC(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
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

  • StewardOfTheSkeinGazeBuff4f18044ca197eb945b7d1b557dd9b447
  • Weird870af83be6572594d84d276d7fc583e0
  • WildHunt_ScoutCrystalAbilityc470c62b38db74e4fb6b84b331beda30
| Improve this Doc View Source

AddAbillityAreaEffectRoundFX(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, AssetLink<PrefabLink>)

Adds Kingmaker.UnitLogic.Abilities.Components.AreaEffects.AbillityAreaEffectRoundFX

Declaration
public TBuilder AddAbillityAreaEffectRoundFX(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, AssetLink<PrefabLink> prefabLink = null)
Parameters
Type Name Description
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.
AssetLink<Kingmaker.ResourceLinks.PrefabLink> prefabLink

You can pass in the animation using a PrefabLink or it's AssetId.
Returns
Type Description
TBuilder
Remarks

  • RuneOfJandelayAreab2394fd9423c44a0a8bdb518b66e9266
| Improve this Doc View Source

AddAreaEffectPit(ContextValue, Nullable<Boolean>, List<Blueprint<BlueprintUnitFactReference>>, List<Blueprint<BlueprintUnitFactReference>>, ActionsBuilder, Nullable<Size>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, ActionsBuilder, ActionsBuilder, Blueprint<BlueprintBuffReference>, Blueprint<BlueprintAreaEffectPitVisualSettingsReference>)

Adds Kingmaker.UnitLogic.Abilities.Components.AreaEffects.AreaEffectPit

Declaration
public TBuilder AddAreaEffectPit(ContextValue climbDC = null, bool? disableClimb = null, List<Blueprint<BlueprintUnitFactReference>> effectsImmunityFacts = null, List<Blueprint<BlueprintUnitFactReference>> evadingImmunityFacts = null, ActionsBuilder everyRoundAction = null, Size? maxUnitSize = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, ActionsBuilder onEndedActionForUnitsInside = null, ActionsBuilder onFallAction = null, Blueprint<BlueprintBuffReference> unitOnEdgeBuff = null, Blueprint<BlueprintAreaEffectPitVisualSettingsReference> visualSettings = null)
Parameters
Type Name Description
Kingmaker.UnitLogic.Mechanics.ContextValue climbDC
System.Nullable<System.Boolean> disableClimb
System.Collections.Generic.List<Blueprint<Kingmaker.Blueprints.BlueprintUnitFactReference>> effectsImmunityFacts

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

System.Collections.Generic.List<Blueprint<Kingmaker.Blueprints.BlueprintUnitFactReference>> evadingImmunityFacts

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

ActionsBuilder everyRoundAction
System.Nullable<Kingmaker.Enums.Size> maxUnitSize
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.
ActionsBuilder onEndedActionForUnitsInside
ActionsBuilder onFallAction
Blueprint<Kingmaker.Blueprints.BlueprintBuffReference> unitOnEdgeBuff

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

Blueprint<Kingmaker.Blueprints.BlueprintAreaEffectPitVisualSettingsReference> visualSettings

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

  • AcidPitAreae122151e93e44e0488521aed9e51b617
  • HungryPitAread086b1aeb367a5b43808d34c321955d1
  • TricksterRecreationalPitAreabf68ec704dc186549a7c6fbf22d3d661
| Improve this Doc View Source

AddArmorWeightCoef(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Single>)

Adds Kingmaker.Blueprints.Classes.Spells.ArmorWeightCoef

Declaration
public TBuilder AddArmorWeightCoef(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, float? weightCoef = null)
Parameters
Type Name Description
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.Single> weightCoef
Returns
Type Description
TBuilder
Remarks

  • PurifierCelestialArmorFeature7dc8d7dede2704640956f7bc4102760a
| Improve this Doc View Source

AddContextCalculateAbilityParams(ContextValue, Blueprint<BlueprintUnitPropertyReference>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<Boolean>, ContextValue, Nullable<StatType>, Nullable<Boolean>, Nullable<Boolean>)

Adds Kingmaker.UnitLogic.Mechanics.Components.ContextCalculateAbilityParams

Declaration
public TBuilder AddContextCalculateAbilityParams(ContextValue casterLevel = null, Blueprint<BlueprintUnitPropertyReference> customProperty = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, bool? replaceCasterLevel = null, bool? replaceSpellLevel = null, ContextValue spellLevel = null, StatType? statType = null, bool? statTypeFromCustomProperty = null, bool? useKineticistMainStat = null)
Parameters
Type Name Description
Kingmaker.UnitLogic.Mechanics.ContextValue casterLevel
Blueprint<Kingmaker.Blueprints.BlueprintUnitPropertyReference> customProperty

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

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> replaceCasterLevel
System.Nullable<System.Boolean> replaceSpellLevel
Kingmaker.UnitLogic.Mechanics.ContextValue spellLevel
System.Nullable<Kingmaker.EntitySystem.Stats.StatType> statType
System.Nullable<System.Boolean> statTypeFromCustomProperty
System.Nullable<System.Boolean> useKineticistMainStat
Returns
Type Description
TBuilder
Remarks

  • 1_FirstStage_AcidBuff6afe27c9a2d64eb890673ff3649dacb3
  • DemonPlagueFeature096156df0b5aa4f458d35db066b27f35
  • Yozz_Feature_AdditionalAttacksbcf37abbb0b1485b83059600ed440881
| Improve this Doc View Source

AddContextCalculateAbilityParamsBasedOnClass(Blueprint<BlueprintCharacterClassReference>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<StatType>, Nullable<Boolean>)

Adds Kingmaker.UnitLogic.Mechanics.Components.ContextCalculateAbilityParamsBasedOnClass

Declaration
public TBuilder AddContextCalculateAbilityParamsBasedOnClass(Blueprint<BlueprintCharacterClassReference> characterClass = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, StatType? statType = null, bool? useKineticistMainStat = null)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintCharacterClassReference> characterClass

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

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.EntitySystem.Stats.StatType> statType
System.Nullable<System.Boolean> useKineticistMainStat
Returns
Type Description
TBuilder
Remarks

  • AirBlastAbility31f668b12011e344aa542aa07ab6c8d9
  • NereidBeguilingAuraBuffab6181f9447a4d945bdcbe6466c42189
  • XantirOnlySwarm_MidnightFaneInThePastFeature5131c4b93f314bd4589edf612b4eb600
| Improve this Doc View Source

AddContextCalculateSharedValue(Nullable<Double>, ContextDiceValue, Nullable<AbilitySharedValue>)

Adds Kingmaker.UnitLogic.Mechanics.Components.ContextCalculateSharedValue

Declaration
public TBuilder AddContextCalculateSharedValue(double? modifier = null, ContextDiceValue value = null, AbilitySharedValue? valueType = null)
Parameters
Type Name Description
System.Nullable<System.Double> modifier
Kingmaker.UnitLogic.Mechanics.ContextDiceValue value
System.Nullable<Kingmaker.UnitLogic.Abilities.AbilitySharedValue> valueType
Returns
Type Description
TBuilder
Remarks

  • AbyssalCreatureAcidTemplate6e6fda1c8a35069468e7398082cd30f5
  • InspireTranquilitySavingThrowBuffMythic60b646069fa949d8983b4d74fc55218b
  • WrackBloodBlastAbility0199d49f59833104198e2c0196235a45
| Improve this Doc View Source

AddContextRankConfig(ContextRankConfig)

Adds Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig

Declaration
public TBuilder AddContextRankConfig(ContextRankConfig component)
Parameters
Type Name Description
Kingmaker.UnitLogic.Mechanics.Components.ContextRankConfig component
Returns
Type Description
TBuilder
Remarks

Use ContextRankConfigs to create the ContextRankConfig component.

  • 5_DeadStage_AcidBuffb730dbbb5e8143abbba6a066bc82c19a
  • HellsDecreeAbilityMagicNecromancyBuffc695587d5307d234cb34f62750ff7616
  • ZonKuthonScarBufffbb677d91f924b99a3610ae79f6468fa
| Improve this Doc View Source

AddContextSetAbilityParams(Nullable<Boolean>, ContextValue, ContextValue, ContextValue, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, ContextValue)

Adds Kingmaker.UnitLogic.Mechanics.Components.ContextSetAbilityParams

Declaration
public TBuilder AddContextSetAbilityParams(bool? add10ToDC = null, ContextValue casterLevel = null, ContextValue concentration = null, ContextValue dC = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, ContextValue spellLevel = null)
Parameters
Type Name Description
System.Nullable<System.Boolean> add10ToDC
Kingmaker.UnitLogic.Mechanics.ContextValue casterLevel

InfoBox: If set to negative value, will be calculated by default mechanic. Positive or zero value will be set as is (plus bonuses)

Kingmaker.UnitLogic.Mechanics.ContextValue concentration

InfoBox: If set to negative value, will be calculated by default mechanic. Positive or zero value will be set as is (plus bonuses)

Kingmaker.UnitLogic.Mechanics.ContextValue dC

InfoBox: If set to negative value, will be calculated by default mechanic. Positive or zero value will be set as is (plus bonuses)

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.UnitLogic.Mechanics.ContextValue spellLevel

InfoBox: If set to negative value, will be calculated by default mechanic. Positive or zero value will be set as is

Returns
Type Description
TBuilder
Remarks

  • AbruptForceEnchantmentc31b3edcf2088a64e80133ebbd6374cb
  • HeartOfIcebergEnchantment719881e400d980f4da1bf7361c1903db
  • ZombieSlashingExplosionf6b63adab8b645c8beb9cab170dac9d3
| Improve this Doc View Source

AddCustomAreaOnGrid(List<Vector2Int>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>)

Adds Kingmaker.Armies.TacticalCombat.Components.CustomAreaOnGrid

Declaration
public TBuilder AddCustomAreaOnGrid(List<Vector2Int> affectedCells = null, bool? ignoreObstaclesAndUnits = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, bool? spawnFxInEveryCell = null)
Parameters
Type Name Description
System.Collections.Generic.List<UnityEngine.Vector2Int> affectedCells

InfoBox: In relative coordinates where left-bottom cell is (0, 0)

System.Nullable<System.Boolean> ignoreObstaclesAndUnits
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> spawnFxInEveryCell
Returns
Type Description
TBuilder
Remarks

  • ArmySummonGlabrezu7453306a53e94766aad9fa716acaaada
  • RangerExplosivesTrapAbility8f684342b757e0f47adfb5edaaabc488
  • RangerWeakeningTrapAreaf3c79a96342c37e4d9ec7cbe35dcbda0
| Improve this Doc View Source

AddSpellDescriptorComponent(SpellDescriptorWrapper, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.Blueprints.Classes.Spells.SpellDescriptorComponent

Declaration
public TBuilder AddSpellDescriptorComponent(SpellDescriptorWrapper descriptor, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
Kingmaker.Blueprints.Classes.Spells.SpellDescriptorWrapper 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.
Returns
Type Description
TBuilder
Remarks

  • Abrikandilu_Frozen_Buffb2df7031cdad480caddf962c894ca484
  • Halaseliax_FireBreathWeaponcef56b3867604e7394e61fcbeb51dae5
  • ZachariusFearAuraBuff4d9144b465bbefe4786cfe86c745ea4e
| Improve this Doc View Source

AddTacticalCombatCellsProviderLink(Blueprint<BlueprintAbilityReference>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.Armies.TacticalCombat.Components.TacticalCombatCellsProviderLink

Declaration
public TBuilder AddTacticalCombatCellsProviderLink(Blueprint<BlueprintAbilityReference> abilityWithCellsProvider = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintAbilityReference> abilityWithCellsProvider

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

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

  • ArmyReachingStrikeActivatableAbility6e8cad7fbb534154a0b3c83102e37323
| Improve this Doc View Source

AddTacticalCombatResurrection(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.Armies.TacticalCombat.Components.TacticalCombatResurrection

Declaration
public TBuilder AddTacticalCombatResurrection(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
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

  • ArmyChannelNegativeEnergyHealAbilityfe3524be49f748aa80f809778999bf59
  • ArmyVampiricTouchOnHitNinjaPirates540f87a0ae7d4caaa17596307b3586a6
  • RitualJudgementDayAbility814a31b50da1434aa9f8622b87157fda
| Improve this Doc View Source

AddToTags(AreaEffectTags[])

Adds to the contents of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.m_Tags

Declaration
public TBuilder AddToTags(params AreaEffectTags[] tags)
Parameters
Type Name Description
Kingmaker.UnitLogic.Abilities.Blueprints.AreaEffectTags[] tags

Tooltip: Тэги имеют информационный характер для условной группировки эффектов. DestroyableInCutscene - помечаются эффекты, которые необходимо удалять во время проигрывания катсцен и схожих событиях, так как они могут наносит урон игроку, вызывать визуальный шум и создавать прочие неудобства.

Returns
Type Description
TBuilder
| Improve this Doc View Source

AddUniqueAreaEffect(Blueprint<BlueprintUnitFactReference>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.UnitLogic.FactLogic.UniqueAreaEffect

Declaration
public TBuilder AddUniqueAreaEffect(Blueprint<BlueprintUnitFactReference> feature = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitFactReference> feature

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

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

  • CloudBlizzardBlastArea6ea87a0ff5df41c459d641326f9973d5
  • WallChargedWaterBlastArea724d174829a1c1949a4a7ba99cfb06a0
  • WallWaterBlastAreabb4ddd5e7d64a4a49ba71fe8275d1552
| Improve this Doc View Source

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

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

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

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

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

ModifyFx(Action<PrefabLink>)

Modifies Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.Fx by invoking the provided action.

Declaration
public TBuilder ModifyFx(Action<PrefabLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.ResourceLinks.PrefabLink> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifySize(Action<Feet>)

Modifies Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.Size by invoking the provided action.

Declaration
public TBuilder ModifySize(Action<Feet> action)
Parameters
Type Name Description
System.Action<Kingmaker.Utility.Feet> 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

RemoveFromTags(AreaEffectTags[])

Removes elements from Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.m_Tags

Declaration
public TBuilder RemoveFromTags(params AreaEffectTags[] tags)
Parameters
Type Name Description
Kingmaker.UnitLogic.Abilities.Blueprints.AreaEffectTags[] tags

Tooltip: Тэги имеют информационный характер для условной группировки эффектов. DestroyableInCutscene - помечаются эффекты, которые необходимо удалять во время проигрывания катсцен и схожих событиях, так как они могут наносит урон игроку, вызывать визуальный шум и создавать прочие неудобства.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAffectDead(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.AffectDead

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

SetAffectEnemies(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.AffectEnemies

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

SetAggroEnemies(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.AggroEnemies

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

SetAllowNonContextActions(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.m_AllowNonContextActions

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

SetCanBeUsedInTacticalCombat(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.CanBeUsedInTacticalCombat

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

SetFx(AssetLink<PrefabLink>)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.Fx

Declaration
public TBuilder SetFx(AssetLink<PrefabLink> fx)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.PrefabLink> fx

You can pass in the animation using a PrefabLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIgnoreSleepingUnits(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.IgnoreSleepingUnits

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

SetShape(AreaEffectShape)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.Shape

Declaration
public TBuilder SetShape(AreaEffectShape shape)
Parameters
Type Name Description
Kingmaker.UnitLogic.Abilities.Blueprints.AreaEffectShape shape
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSize(Feet)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.Size

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

SetSizeInCells(Int32)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.m_SizeInCells

Declaration
public TBuilder SetSizeInCells(int sizeInCells)
Parameters
Type Name Description
System.Int32 sizeInCells

InfoBox: For now, only Cylinder shapes and odd diameters can be used. 1 -&gt; 1 cell, 3 -&gt; 9 cells, ...

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSkipTickRoundAfterSpawnRealtime(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.m_SkipTickRoundAfterSpawnRealtime

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

SetSpellResistance(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.SpellResistance

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

SetTags(AreaEffectTags[])

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.m_Tags

Declaration
public TBuilder SetTags(params AreaEffectTags[] tags)
Parameters
Type Name Description
Kingmaker.UnitLogic.Abilities.Blueprints.AreaEffectTags[] tags

Tooltip: Тэги имеют информационный характер для условной группировки эффектов. DestroyableInCutscene - помечаются эффекты, которые необходимо удалять во время проигрывания катсцен и схожих событиях, так как они могут наносит урон игроку, вызывать визуальный шум и создавать прочие неудобства.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTargetType(BlueprintAbilityAreaEffect.TargetType)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.m_TargetType

Declaration
public TBuilder SetTargetType(BlueprintAbilityAreaEffect.TargetType targetType)
Parameters
Type Name Description
Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.TargetType targetType
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTickRoundAfterSpawn(Boolean)

Sets the value of Kingmaker.UnitLogic.Abilities.Blueprints.BlueprintAbilityAreaEffect.m_TickRoundAfterSpawn

Declaration
public TBuilder SetTickRoundAfterSpawn(bool tickRoundAfterSpawn = true)
Parameters
Type Name Description
System.Boolean tickRoundAfterSpawn
Returns
Type Description
TBuilder