setHitPointDamage

Description

Set the current level of damage for a specific Hit Point (specified by its config class). This command has no effect when allowDamage is set to false.

Note

See also BIS_fnc_setHitPointDamage for setting hit with dependency.

Syntax

vehicle setHitPointDamage [hitPointName, damage, useEffects, killer, instigator, breakRotor]

Parameters:

• vehicle: Object - vehicle to be damaged

• hitPointName: String - name of the Hit Point class

• damage: Number - level of damage, in range 0..1

• useEffects: Boolean - (Optional, default true) false to skip destruction effects (since arma3 1.68)

• killer: Object - (Optional, default objNull) the entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill.

  • It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled).
  • It will alter the killer's rating as if the killer directly killed the unit.
  • It will be listed as _killer parameter in the Killed event handler. (since arma3 2.08)

• instigator: Object - (Optional, default objNull) the person that instigated the damage.

  • if a tank is a killer, the tank gunner that pulled the trigger is instigator
  • it will be listed as _instigator parameter in the Killed event handler. (since arma3 2.12)

• breakRotor: Boolean - (Optional, default false) if the hitpoint is rotor on a helicopter, true will break the rotor as well as play corresponding sound if 'useEffects' is also true. (since arma3 2.18)

Returns: Nothing

Examples

Example 1

vehicle player setHitPointDamage ["hitEngine2", 1.0];

Example 2

player setHitPointDamage ["hitHead", 0.5];
player setHitPointDamage ["hitBody", 0.5];
player setHitPointDamage ["hitHands", 0.5];
player setHitPointDamage ["hitLegs", 0.5];

See also

getHitPointDamage · getAllHitPointsDamage · setHit · getHit · setDamage · damage · getHitIndex · setHitIndex · forceHitPointsDamageSync · BIS_fnc_setHitPointDamage