setHitIndex: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) No edit summary |
Killzone Kid (talk | contribs) No edit summary |
||
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, killer] | |s1= vehicle [[setHitIndex]] [hitPartIndex, damage, useEffects, killer, 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= | |p4= useEffects: [[Boolean]] - (Optional, default [[true]]) [[false|False]] to skip destruction effects | ||
|p4since= arma3 1.68 | |||
|p5= | |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> | ||
* It will be listed as | * It will be listed as <sqf inline>_killer</sqf> parameter in the [[Arma_3:_Event_Handlers#Killed|Killed]] event handler. | ||
|p5since= arma3 2.08 | |||
|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 | |||
* it will be listed as <sqf inline>_instigator</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler. | |||
|p6since= arma3 2.12 | |||
|r1= [[Nothing]] | |r1= [[Nothing]] |
Revision as of 22:07, 23 July 2022
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 1.68
- useEffects: Boolean - (Optional, default true) False to skip destruction effects
- since 2.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.
- since 2.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:
- Example 2:
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