setHitPointDamage: Difference between revisions

Revision as of 08:50, 25 September 2020

Hover & click on the images for description

Description:

Set the current level of damage for a specific Hit Point (specified by its config class).

See also BIS_fnc_setHitPointDamage for setting hit with dependency

Groups:

Object Manipulation

Syntax:: vehicle setHitPointDamage [hitPointName, damage, useEffects]
Parameters:: vehicle : Object - vehicle to be damaged
: [hitPointName, damage]: Array
: hitPointName: String - name of the Hit Point class
: damage: Number - level of damage
: useEffects (Optional): Boolean - false to skip destruction effects. Default: true (Since Arma 3 v1.67)
Return Value:: Nothing

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 BIS_fnc_setHitPointDamage Common TKOH Hit Points

: 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 10, 2016
Kju: This command has no affect when allowDamage is false.; Posted on November 14, 2016 - 03:06
Demellion: Mention that setHitPointDamage only can be executed localy, while the getHitPointDamage is global.

@@ Line 23: / Line 23: @@
 |p1= vehicle : [[Object]] - vehicle to be damaged |PARAMETER1=
 |p2= [hitPointName, damage]: [[Array]] |PARAMETER2=
-|p3= hitPointName: [[String]] - name of the Hit Point class |PARAMETER5=
+|p3= hitPointName: [[String]] - name of the Hit Point class |PARAMETER3=
 |p4= damage: [[Number]] - level of damage |PARAMETER4=
-|p5 = useEffects (Optional): [[Boolean]] - [[false]] to skip destruction effects. Default: [[true]] (Since Arma 3 v1.67)|=
+|p5 = useEffects (Optional): [[Boolean]] - [[false]] to skip destruction effects. Default: [[true]] (Since Arma 3 v1.67)|PARAMETER5=
@@ Line 36: / Line 36: @@
 [[player]] [[setHitPointDamage]] ["hitBody", 0.5];
 [[player]] [[setHitPointDamage]] ["hitHands", 0.5];
-[[player]] [[setHitPointDamage]] ["hitLegs", 0.5];</code> |=
+[[player]] [[setHitPointDamage]] ["hitLegs", 0.5];</code> |EXAMPLE2=
 | [[getHitPointDamage]], [[getAllHitPointsDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]], [[getHitIndex]], [[setHitIndex]], [[BIS_fnc_setHitPointDamage]], [[getHitPointDamage#Notes|Common TKOH Hit Points]] |SEEALSO=