getHitIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma3|Game name=
| arma3|Game name=
Line 7: Line 6:


|gr1= Object Manipulation |GROUP1=
|gr1= Object Manipulation |GROUP1=
____________________________________________________________________________________________


| 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.
| 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
* 0: no damage
* 1: full damage |DESCRIPTION=
* 1: full damage |DESCRIPTION=
____________________________________________________________________________________________


| vehicle '''getHitIndex''' hitPartIndex|SYNTAX=
| vehicle '''getHitIndex''' hitPartIndex|SYNTAX=
Line 20: Line 17:


| [[Number]] (or, prior to Arma 3 v1.93.145625, [[Nothing]] when invalid input is given) |RETURNVALUE=
| [[Number]] (or, prior to Arma 3 v1.93.145625, [[Nothing]] when invalid input is given) |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code>[[vehicle]] [[player]] [[getHitIndex]] 3;</code> |=
|x1= <code>[[vehicle]] [[player]] [[getHitIndex]] 3;</code> |=

Revision as of 01:14, 17 January 2021

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 (or, prior to Arma 3 v1.93.145625, Nothing when invalid input is given)

Examples

Example 1:
vehicle player getHitIndex 3;

Additional Information

See also:
getAllHitPointsDamagesetHitIndexsetHitPointDamagegetHitPointDamagesetHitgetHitsetDamagedamage

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

Notes

Bottom Section