getAllHitPointsDamage: Difference between revisions

Revision as of 11:04, 8 April 2024

1.50

GAGlobal

Hover & click on the images for description

Description

Description:: Get provided object's hit points damage.
Groups:: Object Manipulation

Syntax

Syntax:

getAllHitPointsDamage entity

Parameters:

entity: Object - object to be queried

Return Value:

Array - [] if entity is null or has no shape, otherwise [hitpointNames, selectionNames, damageValues]:

hitpointNames: Array of Strings
selectionNames: Array of Strings
damageValues: Array of Numbers - in range 0..1 where 0 = no damage, 1 = full damage

All values in all arrays are ordered accordingly to hit part index for convenience and for use in setHitIndex and getHitIndex.

Examples

Example 1:: hint str getAllHitPointsDamage player; /* [ ["hitface","hitneck","hithead","hitpelvis","hitabdomen","hitdiaphragm","hitchest","hitbody","hitarms","hithands","hitlegs","incapacitated"], ["face_hub","neck","head","pelvis","spine1","spine2","spine3","body","arms","hands","legs","body"], [0,0,0,0,0,0,0,0,0,0,0,0] ] */
Example 2:: hint str getAllHitPointsDamage vehicle player; /* [ ["hithull","hitengine","hitengine2","hitavionics","hitfuel","hitfuel2","hitglass1","hitlaileron","hitraileron","hitlcrudder","hitrrudder","hitlcelevator","hitrelevator","#gear_f_lights"], ["hithull","hitengine","hitengine2","hitavionics","hitfuel","hitfuel2","hitglass1","hitlaileron","hitraileron","hitlcrudder","hitrrudder","hitlcelevator","hitrelevator"," "], [0,0,0,0,0,0,0,0,0,0,0,0,0,0] ] */

Additional Information

See also:: setHitPointDamage getHitPointDamage setHitIndex getHitIndex 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 7: / Line 7: @@
 |gr1= Object Manipulation
-|descr= Returns 3 arrays for easy cross reference: 1st - array of hit point names, 2nd - array of hit selection names, 3rd - array of damage values. All values in all arrays are ordered accordingly to hit part index for convenience and for use in [[setHitIndex]] and [[getHitIndex]]. Levels of damage are:
+|descr= Get provided object's hit points damage.
-* 0: no damage
-* 1: full damage
 |s1= [[getAllHitPointsDamage]] entity
@@ Line 15: / Line 13: @@
 |p1= entity: [[Object]] - object to be queried
-|r1= [[Array]] - [] if entity is null or has no shape, otherwise [hitpointsNamesArray, selectionsNamesArray, damageValuesArray]
+|r1= [[Array]] - [] if entity is null or has no shape, otherwise [hitpointNames, selectionNames, damageValues]:
+* hitpointNames: [[Array]] of [[String]]s
+* selectionNames: [[Array]] of [[String]]s
+* damageValues: [[Array]] of [[Number]]s - in range 0..1 where 0 = no damage, 1 = full damage
+All values in all arrays are ordered accordingly to hit part index for convenience and for use in [[setHitIndex]] and [[getHitIndex]].
-|x1= <sqf>getAllHitPointsDamage player;
+|x1= <sqf>hint str getAllHitPointsDamage player;
-//[
+/*
-//["hitface","hitneck","hithead","hitpelvis","hitabdomen","hitdiaphragm","hitchest","hitbody","hitarms","hithands","hitlegs","incapacitated"],
+[
-//["face_hub","neck","head","pelvis","spine1","spine2","spine3","body","arms","hands","legs","body"],
+	["hitface","hitneck","hithead","hitpelvis","hitabdomen","hitdiaphragm","hitchest","hitbody","hitarms","hithands","hitlegs","incapacitated"],
-//[0,0,0,0,0,0,0,0,0,0,0,0]
+	["face_hub","neck","head","pelvis","spine1","spine2","spine3","body","arms","hands","legs","body"],
-//]</sqf>
+	[0,0,0,0,0,0,0,0,0,0,0,0]
+]
+*/
+</sqf>
-|x2= <sqf>getAllHitPointsDamage (vehicle player);
+|x2= <sqf>hint str getAllHitPointsDamage vehicle player;
-//[
+/*
-  //["hithull","hitengine","hitengine2","hitavionics","hitfuel","hitfuel2","hitglass1","hitlaileron","hitraileron","hitlcrudder","hitrrudder","hitlcelevator","hitrelevator","#gear_f_lights"],
+[
-  //["hithull","hitengine","hitengine2","hitavionics","hitfuel","hitfuel2","hitglass1","hitlaileron","hitraileron","hitlcrudder","hitrrudder","hitlcelevator","hitrelevator"," "],
+	["hithull","hitengine","hitengine2","hitavionics","hitfuel","hitfuel2","hitglass1","hitlaileron","hitraileron","hitlcrudder","hitrrudder","hitlcelevator","hitrelevator","#gear_f_lights"],
-  //[0,0,0,0,0,0,0,0,0,0,0,0,0,0]
+	["hithull","hitengine","hitengine2","hitavionics","hitfuel","hitfuel2","hitglass1","hitlaileron","hitraileron","hitlcrudder","hitrrudder","hitlcelevator","hitrelevator"," "],
-//]</sqf>
+	[0,0,0,0,0,0,0,0,0,0,0,0,0,0]
+]
+*/
+</sqf>
 |seealso= [[setHitPointDamage]] [[getHitPointDamage]] [[setHitIndex]] [[getHitIndex]] [[setHit]] [[getHit]] [[setDamage]] [[damage]]
 }}