setHitPointDamage: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| TKOH |Game name= | | TKOH |Game name= | ||
Line 11: | Line 10: | ||
|gr1= Object Manipulation |GROUP1= | |gr1= Object Manipulation |GROUP1= | ||
| Set the current level of damage for a specific Hit Point (specified by its config class). | | Set the current level of damage for a specific Hit Point (specified by its config class). | ||
Line 17: | Line 15: | ||
* 1: full damage | * 1: full damage | ||
See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency|DESCRIPTION= | See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency|DESCRIPTION= | ||
| vehicle '''setHitPointDamage''' [hitPointName, damage, useEffects]|SYNTAX= | | vehicle '''setHitPointDamage''' [hitPointName, damage, useEffects]|SYNTAX= | ||
Line 29: | Line 26: | ||
| [[Nothing]] |RETURNVALUE= | | [[Nothing]] |RETURNVALUE= | ||
|x1= <code>[[vehicle]] [[player]] [[setHitPointDamage]] ["hitEngine2", 1.0];</code> |Example1= | |x1= <code>[[vehicle]] [[player]] [[setHitPointDamage]] ["hitEngine2", 1.0];</code> |Example1= |
Revision as of 03:00, 17 January 2021
Description
- Description:
- Set the current level of damage for a specific Hit Point (specified by its config class).
- 0: no damage
- 1: full damage
- Groups:
- Object Manipulation
Syntax
- Syntax:
- vehicle setHitPointDamage [hitPointName, damage, useEffects]
- Parameters:
- vehicle : Object - vehicle to be damaged
- [hitPointName, damage]: Array
- hitPointName: String - name of the Hit Point class
- damage: Number - level of damage
- useEffects (Optional): Boolean - false to skip destruction effects. Default: true (Since Arma 3 v1.67)
- Return Value:
- Nothing
Examples
- Example 1:
vehicle player setHitPointDamage ["hitEngine2", 1.0];
- Example 2:
player setHitPointDamage ["hitHead", 0.5]; player setHitPointDamage ["hitBody", 0.5]; player setHitPointDamage ["hitHands", 0.5]; player setHitPointDamage ["hitLegs", 0.5];
Additional Information
- See also:
- getHitPointDamagegetAllHitPointsDamagesetHitgetHitsetDamagedamagegetHitIndexsetHitIndexBIS_fnc_setHitPointDamageCommon 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
Notes
- Posted on August 30, 2012 - 13:54
- Master85
- 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).
- Posted on November 10, 2016
- Kju
- This command has no affect when allowDamage is false.
- Posted on November 14, 2016 - 03:06
- Demellion
- Mention that setHitPointDamage only can be executed localy, while the getHitPointDamage is global.
Bottom Section
Categories:
- Scripting Commands
- Introduced with Take On Helicopters version 1.00
- Take On Helicopters: New Scripting Commands
- Take On Helicopters: Scripting Commands
- Command Group: Object Manipulation
- Scripting Commands: Global Effect
- Take On Helicopters: New Scripting Commands List
- Arma 3: New Scripting Commands
- Arma 3: Scripting Commands