setHitPointDamage
Jump to navigation
Jump to search
Description
- Description:
- Set the current level of damage for a specific Hit Point (specified by its config class). This command has no effect when allowDamage is set to false.
- Groups:
- Object Manipulation
Syntax
- Syntax:
- vehicle setHitPointDamage [hitPointName, damage, useEffects, killer, instigator]
- Parameters:
- vehicle : Object - vehicle to be damaged
- hitPointName: String - name of the Hit Point class
- damage: Number - level of damage, in range 0..1
- since 1.68
- useEffects: Boolean - (Optional, default true) false to skip destruction effects
- since 2.08
- SEServer 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
- SEServer 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:
- getHitPointDamage getAllHitPointsDamage setHit getHit setDamage damage getHitIndex setHitIndex BIS_fnc_setHitPointDamage Common TKOH Hit Points
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
- Posted on Aug 30, 2012 - 13:54 (UTC)
- This command is using the Hit Points (defined in the HitPoints class in the config) while setHit is using Named Selections (defined in the model itself).