setHitPointDamage

Hover & click on the images for description

Description

Description:

Event Handler	Triggered
`Hit`
`HandleDamage`
`Killed`
`MPKilled`

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.

ⓘ

See also BIS_fnc_setHitPointDamage for setting hit with dependency.

Groups:

Object Manipulation

Syntax

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

since 1.68

useEffects: Boolean - (Optional, default true) false to skip destruction effects

since 2.08

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 2.12

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 2.18

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.

Return Value:

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];

Additional Information

See also:: getHitPointDamage getAllHitPointsDamage setHit getHit setDamage damage getHitIndex setHitIndex forceHitPointsDamageSync BIS_fnc_setHitPointDamage Common TKOH Hit Points

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Master85 - c: Posted on Aug 30, 2012 - 13:54 (UTC)
: This command is using the Hit Points (defined in the HitPoints class in the config) while setHit is using Named Selections (defined in the model itself).