setHitIndex: Difference between revisions
Jump to navigation
Jump to search
(added instigator) |
(Additional description for instigator parameter) |
||
Line 24: | Line 24: | ||
|p4= {{GVI|arma3|1.68}} 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 | ||
|p5= {{GVI|arma3|2.07}} instigator: [[Object]] - (Optional, default [[objNull]]) The unit | |p5= {{GVI|arma3|2.07}} 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. <br> | ||
* It can be used to show "killed by player" in debriefing statistics and killed messages in the chat (if difficulty death messages are enabled). <br> | |||
* It will alter the instigator's [[rating]] as if the instigator directly killed the unit. <br> | |||
* It will be listed as {{ic|_killer}} parameter in the [[Arma_3:_Event_Handlers#Killed|Killed]] event handler. | |||
|r1= [[Nothing]] | |r1= [[Nothing]] |
Revision as of 15:53, 7 September 2021
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
- 1.68 useEffects: Boolean - (Optional, default true) False to skip destruction effects
- 2.07 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.
- 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