getHitIndex: Difference between revisions

Latest revision as of 14:57, 10 May 2023

Hover & click on the images for description

Description

Description:

Return current level of damage for a specific Hit Point (specified by its hit part index). All hit points can be obtained with getAllHitPointsDamage command.

0: no damage
1: full damage

Groups:

Object Manipulation

Syntax

Syntax:: vehicle getHitIndex hitPartIndex
Parameters:: vehicle : Object - vehicle to be queried
: hitPartIndex: Number - hit part index of the Hit Point
Return Value:: Number - before 1.94, Nothing was returned when an invalid selection was provided (now returns 0)

Examples

Example 1:: vehicle player getHitIndex 3;

Additional Information

See also:: getAllHitPointsDamage setHitIndex setHitPointDamage getHitPointDamage setHit getHit setDamage damage

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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands]]
+{{RV|type=command
-{{Command|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.50
-| arma3|= Game name
+|arg= global
-|1.50|= Game version
-|arg= global|Multiplayer Arguments=
-____________________________________________________________________________________________
-| Return current level of damage for a specific Hit Point (specified by its hit part index). All hit points can be obtained with [[getAllHitPointsDamage]] command.
+|gr1= Object Manipulation
+|descr= Return current level of damage for a specific Hit Point (specified by its hit part index). All hit points can be obtained with [[getAllHitPointsDamage]] command.
 * 0: no damage
-* 1: full damage |DESCRIPTION=
+* 1: full damage
-____________________________________________________________________________________________
-| vehicle '''getHitIndex''' hitPartIndex|SYNTAX=
-|p1= vehicle : [[Object]] - vehicle to be queried |PARAMETER1=
+|s1= vehicle [[getHitIndex]] hitPartIndex
-|p2= hitPartIndex: [[Number]] - hit part index of the Hit Point|PARAMETER2=
-| [[Number]] (or, prior to Arma 3 v1.93.145625, [[Nothing]] when invalid input is given) |RETURNVALUE=
+|p1= vehicle : [[Object]] - vehicle to be queried
-____________________________________________________________________________________________
+|p2= hitPartIndex: [[Number]] - hit part index of the Hit Point
-|x1= <code>[[vehicle]] [[player]] [[getHitIndex]] 3;</code> |=
+|r1= [[Number]] - before {{GVI|arma3|1.94|size= 0.75}}, [[Nothing]] was returned when an invalid ''selection'' was provided (now returns {{hl|0}})
-| [[getAllHitPointsDamage]], [[setHitIndex]], [[setHitPointDamage]], [[getHitPointDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]] |SEEALSO=
+|x1= <sqf>vehicle player getHitIndex 3;</sqf>
+|seealso= [[getAllHitPointsDamage]] [[setHitIndex]] [[setHitPointDamage]] [[getHitPointDamage]] [[setHit]] [[getHit]] [[setDamage]] [[damage]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]