setHitIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
Line 14: Line 14:
|s1= vehicle [[setHitIndex]] [hitPartIndex, damage, useEffects, killer, instigator]
|s1= vehicle [[setHitIndex]] [hitPartIndex, damage, useEffects, killer, instigator]


|p1= vehicle : [[Object]] - Vehicle to be damaged
|p1= vehicle : [[Object]] - vehicle to be damaged


|p2= hitPartIndex: [[Number]] - Hit part index of the Hit Point
|p2= hitPartIndex: [[Number]] - hit part index of the Hit Point


|p3= damage: [[Number]] - Level of damage
|p3= damage: [[Number]] - level of damage
* 0: no damage
* 0: no damage
* 1: full damage
* 1: full damage


|p4= useEffects: [[Boolean]] - (Optional, default [[true]]) [[false|False]] to skip destruction effects
|p4= useEffects: [[Boolean]] - (Optional, default [[true]]) [[false]] to skip destruction effects
|p4since= arma3 1.68
|p4since= arma3 1.68


|p5= killer: [[Object]] - (Optional, default [[objNull]]) The entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill. <br>
|p5= killer: [[Object]] - (Optional, default [[objNull]]) the entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill. <br>
* It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled). <br>
* It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled). <br>
* It will alter the killer's [[rating]] as if the killer directly killed the unit. <br>
* It will alter the killer's [[rating]] as if the killer directly killed the unit. <br>
Line 31: Line 31:
|p5since= arma3 2.08
|p5since= arma3 2.08


|p6= instigator: [[Object]] - (Optional, default [[objNull]]) The person that instigated the damage.
|p6= instigator: [[Object]] - (Optional, default [[objNull]]) the person that instigated the damage.
* if a tank is a killer, the tank gunner that pulled the trigger is instigator
* if a tank is a killer, the tank gunner that pulled the trigger is instigator
* it will be listed as <sqf inline>_instigator</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler.
* it will be listed as <sqf inline>_instigator</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler.

Revision as of 02:46, 22 May 2023

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, killer, 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
since Arma 3 logo black.png1.68
useEffects: Boolean - (Optional, default true) false to skip destruction effects
since Arma 3 logo black.png2.08
killer: Object - (Optional, default objNull) the entity that caused the damage. If the damage leads to the death of the unit, the killer 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 killer's rating as if the killer directly killed the unit.
  • It will be listed as _killer parameter in the Killed event handler.
since Arma 3 logo black.png2.12
instigator: Object - (Optional, default objNull) the person that instigated the damage.
  • if a tank is a killer, the tank gunner that pulled the trigger is instigator
  • it will be listed as _instigator 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