getHitIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory *\| *arma3 *\| *(New )?Scripting Commands\}\}" to "")
(Fix return value)
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
|1.50
|version1= 1.50
 
|arg= global
|arg= global


|gr1= Object Manipulation
|gr1= Object Manipulation


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


|s1= vehicle '''getHitIndex''' hitPartIndex
|s1= vehicle [[getHitIndex]] hitPartIndex


|p1= vehicle : [[Object]] - vehicle to be queried
|p1= vehicle : [[Object]] - vehicle to be queried
|p2= hitPartIndex: [[Number]] - hit part index of the Hit Point
|p2= hitPartIndex: [[Number]] - hit part index of the Hit Point


|r1=[[Number]] (or, prior to Arma 3 v1.94, [[Nothing]] when invalid input is given)
|r1= [[Number]] - before {{GVI|arma3|1.94|size= 0.75}}, [[Nothing]] was returned when an invalid ''selection'' was provided (now returns {{hl|0}})


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


|seealso= [[getAllHitPointsDamage]], [[setHitIndex]], [[setHitPointDamage]], [[getHitPointDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]]
|seealso= [[getAllHitPointsDamage]] [[setHitIndex]] [[setHitPointDamage]] [[getHitPointDamage]] [[setHit]] [[getHit]] [[setDamage]] [[damage]]
}}
}}

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 Arma 3 logo black.png1.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