Ability template fields¶
Set directly on an +AbilityEdits entry, alongside Ability. These change the ability template itself rather than one of its costs, effects or conditions.
| Config field | Type | Requires | Game field | Description |
|---|---|---|---|---|
Hostility |
EAbilityHostility |
SetHostility=true |
Hostility |
Whether the ability is offensive, defensive or neutral. Drives AI targeting and the reticle colour. One of eHostility_Offensive, eHostility_Defensive, eHostility_Neutral. |
ConcealmentRule |
EConcealmentRule |
SetConcealmentRule=true |
ConcealmentRule |
What happens to the shooter's concealment when the ability is used. |
CrossClassEligible |
bool |
SetCrossClassEligible=true |
bCrossClassEligible |
Sets bCrossClassEligible (bool). |
IsPassive |
bool |
SetIsPassive=true |
bIsPassive |
Sets bIsPassive (bool). |
UniqueSource |
bool |
SetUniqueSource=true |
bUniqueSource |
Sets bUniqueSource (bool). |
AllowedByDefault |
bool |
SetAllowedByDefault=true |
bAllowedByDefault |
Sets bAllowedByDefault (bool). |
TriggerChance |
float |
SetTriggerChance=true |
TriggerChance |
Sets TriggerChance (float). |
SuperConcealmentLoss |
int |
SetSuperConcealmentLoss=true |
SuperConcealmentLoss |
Sets SuperConcealmentLoss (int). |
ChosenActivationIncreasePerUse |
int |
SetChosenActivationIncreasePerUse=true |
ChosenActivationIncreasePerUse |
Sets ChosenActivationIncreasePerUse (int). |
LostSpawnIncreasePerUse |
int |
SetLostSpawnIncreasePerUse=true |
LostSpawnIncreasePerUse |
Sets LostSpawnIncreasePerUse (int). |
AbilityPointCost |
int |
SetAbilityPointCost=true |
AbilityPointCost |
Sets AbilityPointCost (int). |
DefaultSourceItemSlot |
EInventorySlot |
SetDefaultSourceItemSlot=true |
DefaultSourceItemSlot |
Sets DefaultSourceItemSlot (EInventorySlot). |
UseThrownGrenadeEffects |
bool |
SetUseThrownGrenadeEffects=true |
bUseThrownGrenadeEffects |
Sets bUseThrownGrenadeEffects (bool). |
UseLaunchedGrenadeEffects |
bool |
SetUseLaunchedGrenadeEffects=true |
bUseLaunchedGrenadeEffects |
Sets bUseLaunchedGrenadeEffects (bool). |
AllowFreeFireWeaponUpgrade |
bool |
SetAllowFreeFireWeaponUpgrade=true |
bAllowFreeFireWeaponUpgrade |
Sets bAllowFreeFireWeaponUpgrade (bool). |
AllowAmmoEffects |
bool |
SetAllowAmmoEffects=true |
bAllowAmmoEffects |
Sets bAllowAmmoEffects (bool). |
AllowBonusWeaponEffects |
bool |
SetAllowBonusWeaponEffects=true |
bAllowBonusWeaponEffects |
Sets bAllowBonusWeaponEffects (bool). |
SilentAbility |
bool |
SetSilentAbility=true |
bSilentAbility |
Sets bSilentAbility (bool). |
CannotTeleport |
bool |
SetCannotTeleport=true |
bCannotTeleport |
Sets bCannotTeleport (bool). |
PreventsTargetTeleport |
bool |
SetPreventsTargetTeleport=true |
bPreventsTargetTeleport |
Sets bPreventsTargetTeleport (bool). |
FinalizeAbilityName |
name |
SetFinalizeAbilityName=true |
FinalizeAbilityName |
Sets FinalizeAbilityName (name). |
CancelAbilityName |
name |
SetCancelAbilityName=true |
CancelAbilityName |
Sets CancelAbilityName (name). |
TwoTurnAttackAbility |
name |
SetTwoTurnAttackAbility=true |
TwoTurnAttackAbility |
Sets TwoTurnAttackAbility (name). |
IconImage |
string |
SetIconImage=true |
IconImage |
Sets IconImage (string). |
AbilityIconColor |
string |
SetAbilityIconColor=true |
AbilityIconColor |
Sets AbilityIconColor (string). |
AbilityIconBehaviorHUD |
EAbilityIconBehavior |
SetAbilityIconBehaviorHUD=true |
eAbilityIconBehaviorHUD |
Sets eAbilityIconBehaviorHUD (EAbilityIconBehavior). |
ShotHUDPriority |
int |
SetShotHUDPriority=true |
ShotHUDPriority |
Sets ShotHUDPriority (int). |
DisplayInUITooltip |
bool |
SetDisplayInUITooltip=true |
bDisplayInUITooltip |
Sets bDisplayInUITooltip (bool). |
DisplayInUITacticalText |
bool |
SetDisplayInUITacticalText=true |
bDisplayInUITacticalText |
Sets bDisplayInUITacticalText (bool). |
DontDisplayInAbilitySummary |
bool |
SetDontDisplayInAbilitySummary=true |
bDontDisplayInAbilitySummary |
Sets bDontDisplayInAbilitySummary (bool). |
DisplayTargetHitChance |
bool |
SetDisplayTargetHitChance=true |
DisplayTargetHitChance |
Sets DisplayTargetHitChance (bool). |
HideOnClassUnlock |
bool |
SetHideOnClassUnlock=true |
bHideOnClassUnlock |
Sets bHideOnClassUnlock (bool). |
AbilitySourceName |
name |
SetAbilitySourceName=true |
AbilitySourceName |
Sets AbilitySourceName (name). |
LimitTargetIcons |
bool |
SetLimitTargetIcons=true |
bLimitTargetIcons |
Sets bLimitTargetIcons (bool). |
BypassAbilityConfirm |
bool |
SetBypassAbilityConfirm=true |
bBypassAbilityConfirm |
Sets bBypassAbilityConfirm (bool). |
UseAmmoAsChargesForHUD |
bool |
SetUseAmmoAsChargesForHUD=true |
bUseAmmoAsChargesForHUD |
Sets bUseAmmoAsChargesForHUD (bool). |
AmmoAsChargesDivisor |
int |
SetAmmoAsChargesDivisor=true |
iAmmoAsChargesDivisor |
Sets iAmmoAsChargesDivisor (int). |
FriendlyFireWarning |
bool |
SetFriendlyFireWarning=true |
bFriendlyFireWarning |
Sets bFriendlyFireWarning (bool). |
FriendlyFireWarningRobotsOnly |
bool |
SetFriendlyFireWarningRobotsOnly=true |
bFriendlyFireWarningRobotsOnly |
Sets bFriendlyFireWarningRobotsOnly (bool). |
CommanderAbility |
bool |
SetCommanderAbility=true |
bCommanderAbility |
Sets bCommanderAbility (bool). |
FriendlyName |
string |
SetFriendlyName=true |
LocFriendlyName |
Name shown in the UI. Short text only: the ini cannot carry quotes, commas or parentheses. For prose use a [MyAbility X2AbilityTemplate] section in XComGame.int. |
LongDescription |
string |
SetLongDescription=true |
LocLongDescription |
Description shown in the ability tooltip and on the promotion screen. Same limits as FriendlyName. |
HelpText |
string |
SetHelpText=true |
LocHelpText |
Short help line shown in the tactical HUD tooltip. Same limits as FriendlyName. |
FlyOverText |
string |
SetFlyOverText=true |
LocFlyOverText |
Text of the flyover shown when the ability activates. Same limits as FriendlyName. |
TargetingMethod |
string |
SetTargetingMethod=true |
TargetingMethod |
Qualified class path of the targeting method, e.g. XComGame.X2TargetingMethod_OverTheShoulder. The class default is X2TargetingMethod_TopDown. |
CinescriptCameraType |
string |
SetCinescriptCameraType=true |
CinescriptCameraType |
Cinescript camera played when the ability is visualized, e.g. StandardGunFiring (see DefaultCameras.ini). |
AbilityConfirmSound |
string |
SetAbilityConfirmSound=true |
AbilityConfirmSound |
Sound played when the ability is confirmed in the HUD, e.g. TacticalUI_SwordConfirm. |
ActivationSpeech |
name |
SetActivationSpeech=true |
ActivationSpeech |
Speech line played when the ability activates. |
CustomFireAnim |
name |
SetCustomFireAnim=true |
CustomFireAnim |
Animation played instead of the weapon's normal fire animation. |
SkipFireAction |
bool |
SetSkipFireAction=true |
bSkipFireAction |
Do not exit cover, fire and re-enter cover when the ability activates. |
ShowActivation |
bool |
SetShowActivation=true |
bShowActivation |
Show the ability name over the activating unit when it is used. |
SkipMoveStop |
bool |
SetSkipMoveStop=true |
bSkipMoveStop |
Move-then-act abilities only: do not play the stop-moving animation before acting. |
FrameEvenWhenUnitIsHidden |
bool |
SetFrameEvenWhenUnitIsHidden=true |
bFrameEvenWhenUnitIsHidden |
Frame the camera on the source unit when the ability is used even if the unit is hidden in the fog. |
AdditionalAbilities |
array<name> |
AdditionalAbilitiesMode (ENameArrayEditMode) |
AdditionalAbilities |
Sets AdditionalAbilities (array<name>). |
PrerequisiteAbilities |
array<name> |
PrerequisiteAbilitiesMode (ENameArrayEditMode) |
PrerequisiteAbilities |
Sets PrerequisiteAbilities (array<name>). |
OverrideAbilities |
array<name> |
OverrideAbilitiesMode (ENameArrayEditMode) |
OverrideAbilities |
Sets OverrideAbilities (array<name>). |
AssociatedPassives |
array<name> |
AssociatedPassivesMode (ENameArrayEditMode) |
AssociatedPassives |
Sets AssociatedPassives (array<name>). |
PostActivationEvents |
array<name> |
PostActivationEventsMode (ENameArrayEditMode) |
PostActivationEvents |
Sets PostActivationEvents (array<name>). |
HideIfAvailable |
array<name> |
HideIfAvailableMode (ENameArrayEditMode) |
HideIfAvailable |
Sets HideIfAvailable (array<name>). |
Not editable from config
Requirements— typeStrategyRequirementbRecordValidTiles— not covered (deliberate core-set choice)bTickPerActionEffects— not covered (deliberate core-set choice)bCheckCollision— not covered (deliberate core-set choice)bAffectNeighboringTiles— not covered (deliberate core-set choice)bFragileDamageOnly— not covered (deliberate core-set choice)AbilityRevealEvent— not covered (deliberate core-set choice)ChosenReinforcementGroupName— not covered (deliberate core-set choice)ChosenTraitType— not covered (deliberate core-set choice)ChosenExcludeTraits— not covered (deliberate core-set choice)ChosenTraitForceLevelGate— not covered (deliberate core-set choice)LocPromotionPopupText— localized — use .int localization filesLocMissMessage— localized — use .int localization filesLocHitMessage— localized — use .int localization filesLocFriendlyNameWhenConcealed— localized — use .int localization filesLocLongDescriptionWhenConcealed— localized — use .int localization filesLocDefaultSoldierClass— localized — use .int localization filesLocDefaultPrimaryWeapon— localized — use .int localization filesLocDefaultSecondaryWeapon— localized — use .int localization filesHideErrors— not covered (deliberate core-set choice)bNoConfirmationWithHotKey— not covered (deliberate core-set choice)DefaultKeyBinding— not covered (deliberate core-set choice)UIStatMarkups— array ofUIAbilityStatMarkupCustomFireKillAnim— not covered (deliberate core-set choice)CustomMovingFireAnim— not covered (deliberate core-set choice)CustomMovingFireKillAnim— not covered (deliberate core-set choice)CustomMovingTurnLeftFireAnim— not covered (deliberate core-set choice)CustomMovingTurnLeftFireKillAnim— not covered (deliberate core-set choice)CustomMovingTurnRightFireAnim— not covered (deliberate core-set choice)CustomMovingTurnRightFireKillAnim— not covered (deliberate core-set choice)CustomSelfFireAnim— not covered (deliberate core-set choice)AssociatedPlayTiming— typeSequencePlayTimingbShowPostActivation— not covered (deliberate core-set choice)bSkipExitCoverWhenFiring— not covered (deliberate core-set choice)bSkipPerkActivationActions— not covered (deliberate core-set choice)bSkipPerkActivationActionsSync— not covered (deliberate core-set choice)bOverrideMeleeDeath— not covered (deliberate core-set choice)bOverrideVisualResult— not covered (deliberate core-set choice)OverrideVisualResult— not covered (deliberate core-set choice)bHideWeaponDuringFire— not covered (deliberate core-set choice)bHideAmmoWeaponDuringFire— not covered (deliberate core-set choice)bIsASuppressionEffect— not covered (deliberate core-set choice)bOverrideAim— not covered (deliberate core-set choice)bUseSourceLocationZToAim— not covered (deliberate core-set choice)bOverrideWeapon— not covered (deliberate core-set choice)bStationaryWeapon— not covered (deliberate core-set choice)ActionFireClass— class referencebForceProjectileTouchEvents— not covered (deliberate core-set choice)SourceHitSpeech— not covered (deliberate core-set choice)TargetHitSpeech— not covered (deliberate core-set choice)SourceMissSpeech— not covered (deliberate core-set choice)TargetMissSpeech— not covered (deliberate core-set choice)TargetKilledByAlienSpeech— not covered (deliberate core-set choice)TargetKilledByXComSpeech— not covered (deliberate core-set choice)MultiTargetsKilledByAlienSpeech— not covered (deliberate core-set choice)MultiTargetsKilledByXComSpeech— not covered (deliberate core-set choice)TargetWingedSpeech— not covered (deliberate core-set choice)TargetArmorHitSpeech— not covered (deliberate core-set choice)TargetMissedSpeech— not covered (deliberate core-set choice)AbilityPassiveAOEStyle— typeX2AbilityPassiveAOEStylebAllowUnderhandAnim— not covered (deliberate core-set choice)SecondaryTargetingMethod— class referenceSkipRenderOfAOETargetingTiles— not covered (deliberate core-set choice)SkipRenderOfTargetingTemplate— not covered (deliberate core-set choice)MeleePuckMeshPath— not covered (deliberate core-set choice)CameraPriority— not covered (deliberate core-set choice)bUsesFiringCamera— not covered (deliberate core-set choice)FrameAbilityCameraType— not covered (deliberate core-set choice)BuildNewGameStateFn— delegate — code-onlyBuildInterruptGameStateFn— delegate — code-onlyBuildVisualizationFn— delegate — code-onlyBuildAppliedVisualizationSyncFn— delegate — code-onlyBuildAffectedVisualizationSyncFn— delegate — code-onlySoldierAbilityPurchasedFn— delegate — code-onlyOnVisualizationTrackInsertedFn— delegate — code-onlyModifyNewContextFn— delegate — code-onlyDamagePreviewFn— delegate — code-onlyGetBonusWeaponAmmoFn— delegate — code-onlyMergeVisualizationFn— delegate — code-onlyAlternateFriendlyNameFn— delegate — code-onlyShouldRevealChosenTraitFn— delegate — code-onlyOverrideAbilityAvailabilityFn— delegate — code-onlyMP_PerkOverride— not covered (deliberate core-set choice)