Compute Apply Damage Modifiers

This trigger is the best place to add some static damage modifier. This script in particular runs when the owner of the script applies damage to another Actor. See Compute Take Damage Modifiers for modifying damage an actor receives. This trigger is primarily for modifying the modifiers object where you can add or remove reductions.

Key

computeApplyDamageModifiers

Arguments

args.actor - The Actor taking damage

args.attacker - The Actor doing damage

args.opposedTest - The Opposed Test that was used to calculate damage

args.damageType - Whether to ignore AP, TB, or both. This argument is obsolete and has already been derived into applyAP and applyTB

args.weaponProperties - What properties (qualities and flaws) the weapon has. This can be modified to add properties to the calculation. (e.g. args.weaponProperties.qualities.damaging or args.weaponProperties.flaws.unbalanced)

args.applyAP - Whether to apply armour to reduce the incoming damage

args.applyTB - Whether to apply Toughness bonus to reduce the incoming damage

args.totalWoundLoss - This will eventually be the actual amount of wounds deducted from the Actor. At this point in the process, it is the raw damage value from the test.

args.AP - The data of the location taking damage. See Armour Calculation to see the object structure.

args.modifiers - Modifiers for armour, toughness, and damage.

args.modifiers.tb - TB used for damage reduction args.modifiers.ap - AP data used for damage reduction args.modifiers.ap.value - Total AP at the location, args.modifiers.ap.ignored - Amount of AP ignored based on computed context, args.modifiers.ap.metal - How much AP being used is metal, this field is purely descriptive, not prescriptive. Changes to this field should also be reflected in ap.value args.modifiers.ap.nonmetal - How much AP being used is non-metal, this field is purely descriptive, not prescriptive. Changes to this field should also be reflected in ap.value args.modifiers.ap.magical - How much AP being used is magical, this field is purely descriptive, not prescriptive. Changes to this field should also be reflected in ap.value args.modifiers.ap.shield - How much AP being used is from a shield, args.modifiers.ap.details - Array of descriptions for AP modifications made in this script; args.modifiers.minimumOne - Whether minimumOne was triggered (used for the tooltip) args.modifiers.other - Array of modifiers used for any miscellaneous damage modifications. {label : string, value : number, details : string}

args.extraMessages - Array of strings that can be added to for displaying in chat.

args.ward - Ward value of the Actor (If ward is some number, a roll is made and if that roll is greater or eual to the ward value, the damage is ignored)

args.wardRoll - The Ward roll is determined at the beginning of damage application, but only checked if needed.

args.abort - Set this to a string value to abort the process (with the string being the message shown in chat)

Examples

Increase Damage

Usage: Increase all damage by some static amount.

args.modifiers.other.push({label : this.effect.name, details : "Damage Increase", value : 3})

Ignore Metal AP

Usage: Ignore AP from metal armour

if (args.applyAP && args.modifiers.ap.metal) 
{
    args.modifiers.ap.ignored += args.modifiers.ap.metal
    args.modifiers.ap.details.push("<strong>" + this.effect.name + "</strong>: Ignore Metal (" + args.modifiers.ap.metal + ")");
    args.modifiers.ap.metal = 0
}

Ignore AP and add the amount to damage

Usage: Ignore metal AP then add the value of that AP back to damage.

if (args.applyAP && args.modifiers.ap.metal) 
{
    args.modifiers.ap.ignored += args.modifiers.ap.metal
    args.modifiers.other.push({value : args.modifiers.ap.metal, label : this.effect.name, details : "Add Metal AP to Damage" })
    args.modifiers.ap.details.push("<strong>" + this.effect.name + "</strong>: Ignore Metal (" + args.modifiers.ap.metal + ")");
    args.modifiers.ap.metal = 0
}