setHitPointDamage: Difference between revisions

Revision as of 17:57, 20 January 2022

1.00

0.50

LALocal GEGlobal

Hover & click on the images for description

Description

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.
ⓘ
See also BIS_fnc_setHitPointDamage for setting hit with dependency.
Groups:: Object Manipulation

Syntax

Syntax:

vehicle setHitPointDamage [hitPointName, damage, useEffects, instigator]

Parameters:

vehicle : Object - vehicle to be damaged

hitPointName: String - name of the Hit Point class

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

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

2.08 instigator: Object - (Optional, default objNull) The object that caused the damage. If the damage leads to the death of the unit, the instigator 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 instigator's rating as if the instigator directly killed the unit.
It will be listed as _killer parameter in the Killed event handler.

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


: Posted on August 30, 2012 - 13:54
Master85: 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).

: Posted on November 14, 2016 - 03:06
Demellion: Mention that setHitPointDamage only can be executed localy, while the getHitPointDamage is global.

@@ Line 40: / Line 40: @@
 [[player]] [[setHitPointDamage]] ["hitLegs", 0.5];</code>
-|seealso= [[getHitPointDamage]] [[getAllHitPointsDamage]] [[setHit]], [[getHit]], [[setDamage]], [[damage]], [[getHitIndex]], [[setHitIndex]], [[BIS_fnc_setHitPointDamage]], [[getHitPointDamage#Notes|Common TKOH Hit Points]]
+|seealso= [[getHitPointDamage]] [[getAllHitPointsDamage]] [[setHit]] [[getHit]], [[setDamage]], [[damage]], [[getHitIndex]], [[setHitIndex]], [[BIS_fnc_setHitPointDamage]], [[getHitPointDamage#Notes|Common TKOH Hit Points]]
 }}