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, instigator] | |s1= vehicle [[setHitIndex]] [hitPartIndex, damage, useEffects, killer, instigator, breakRotor] | ||
|p1= vehicle : [[Object]] - vehicle to be damaged | |p1= vehicle : [[Object]] - vehicle to be damaged | ||
Line 35: | Line 35: | ||
* 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. | ||
|p6since= arma3 2.12 | |p6since= arma3 2.12 | ||
|p7= breakRotor: [[Boolean]] if the hitpoint is rotor on a helicopter, [[true]] will break the rotor as well as play corresponding sound if 'useEffects' is also [[true]]. | |||
|p7since= arma3 2.16 | |||
|r1= [[Nothing]] | |r1= [[Nothing]] |
Revision as of 14:04, 28 January 2024
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, breakRotor]
- 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.
- since 2.16
- breakRotor: Boolean if the hitpoint is rotor on a helicopter, true will break the rotor as well as play corresponding sound if 'useEffects' is also true.
- Return Value:
- Nothing
Examples
- Example 1:
- Example 2:
Additional Information
- See also:
- getAllHitPointsDamage getHitIndex getHitPointDamage setHitPointDamage setHit getHit setDamage damage forceHitPointsDamageSync
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