setHitIndex

From Bohemia Interactive Community
Revision as of 11:17, 12 May 2022 by Lou Montana (talk | contribs) (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "<code>$1$2$3</code>")
Jump to navigation Jump to search
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.08 instigator: Object - (Optional, default objNull) The object that caused the damage. If the damage leads to the death of the unit, the instigator will be used as the object that caused the kill.
  • It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled).
  • It will alter the instigator's rating as if the instigator directly killed the unit.
  • It will be listed as _killer parameter in the Killed event handler.
Return Value:
Nothing

Examples

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

Additional Information

See also:
getAllHitPointsDamage getHitIndex getHitPointDamage setHitPointDamage 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