setHitIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \|([ps][0-9]+) *= " to " |$1= ")
(added instigator)
Line 12: Line 12:
|descr= Sets the current level of damage for a specific Hit Point. All hit points can be obtained with [[getAllHitPointsDamage]] command.
|descr= Sets the current level of damage for a specific Hit Point. All hit points can be obtained with [[getAllHitPointsDamage]] command.


|s1= vehicle [[setHitIndex]] [hitPartIndex, damage, useEffects]
|s1= vehicle [[setHitIndex]] [hitPartIndex, damage, useEffects, instigator]


|p1= vehicle : [[Object]] - Vehicle to be damaged
|p1= vehicle : [[Object]] - Vehicle to be damaged
Line 22: Line 22:
* 1: full damage
* 1: full damage


|p4= useEffects: [[Boolean]] - (Optional, default [[true]]) [[false|False]] to skip destruction effects.
|p4= {{GVI|arma3|1.68}} useEffects: [[Boolean]] - (Optional, default [[true]]) [[false|False]] to skip destruction effects
|p4since= arma3 1.68
 
|p5= {{GVI|arma3|2.07}} instigator: [[Object]] - (Optional, default [[objNull]]) The unit/object that caused the damage


|r1= [[Nothing]]
|r1= [[Nothing]]

Revision as of 16:36, 7 September 2021

Hover & click on the images for description

Description

Description:
Sets the current level of damage for a specific Hit Point. All hit points can be obtained with getAllHitPointsDamage command.
Groups:
Object Manipulation

Syntax

Syntax:
vehicle setHitIndex [hitPartIndex, damage, useEffects, instigator]
Parameters:
vehicle : Object - Vehicle to be damaged
hitPartIndex: Number - Hit part index of the Hit Point
damage: Number - Level of damage
  • 0: no damage
  • 1: full damage
Arma 3 logo black.png1.68 useEffects: Boolean - (Optional, default true) False to skip destruction effects
Arma 3 logo black.png2.07 instigator: Object - (Optional, default objNull) The unit/object that caused the damage
Return Value:
Nothing

Examples

Example 1:
vehicle player setHitIndex [1, 1];
Example 2:
player setHitIndex [7, 0.5];

Additional Information

See also:
getAllHitPointsDamagegetHitIndexgetHitPointDamagesetHitPointDamagesetHitgetHitsetDamagedamage

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