setHitPointDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \|([ps][0-9]+) *= " to " |$1= ")
m (Some wiki formatting)
Line 13: Line 13:
|gr1= Object Manipulation
|gr1= Object Manipulation


|descr= Set the current level of damage for a specific Hit Point (specified by its config class).
|descr= 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]].
* 0: no damage
{{Feature|informative|See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency.}}
* 1: full damage
See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency


|s1= vehicle [[setHitPointDamage]] [hitPointName, damage, useEffects]
|s1= vehicle [[setHitPointDamage]] [hitPointName, damage, useEffects]
Line 22: Line 20:
|p1= vehicle : [[Object]] - vehicle to be damaged
|p1= vehicle : [[Object]] - vehicle to be damaged


|p2= [hitPointName, damage]: [[Array]]
|p2= hitPointName: [[String]] - name of the Hit Point class


|p3= hitPointName: [[String]] - name of the Hit Point class
|p3= damage: [[Number]] - level of damage, in range 0..1


|p4= damage: [[Number]] - level of damage
|p4= useEffects: [[Boolean]] - (Optional, default [[true]]) [[false]] to skip destruction effects
 
|p4since= arma3 1.68
|p5= useEffects (Optional, default [[true]]): [[Boolean]] - [[false]] to skip destruction effects
|p5since= arma3 1.68


|r1= [[Nothing]]
|r1= [[Nothing]]
Line 48: Line 44:
<dd class="notedate">Posted on August 30, 2012 - 13:54</dd>
<dd class="notedate">Posted on August 30, 2012 - 13:54</dd>
<dt class="note">[[User:Master85|Master85]]</dt>
<dt class="note">[[User:Master85|Master85]]</dt>
<dd class="note">This command is using the Hit Points (defined in the HitPoints class in the config) while [[setHit]] is using [[Named_Selection|Named Selections]] (defined in the model itself).
<dd class="note">This command is using the Hit Points (defined in the HitPoints class in the config) while [[setHit]] is using [[Named Selection]]s (defined in the model itself).</dd>
<dt><dt>
 
<dd class="notedate">Posted on November 10, 2016</dd>
<dt class="note">[[User:Kju|Kju]]</dt>
<dd class="note">This command has no affect when [[allowDamage]] is false.
<dt><dt>
<dt><dt>
<dd class="notedate">Posted on November 14, 2016 - 03:06</dd>
<dd class="notedate">Posted on November 14, 2016 - 03:06</dd>
<dt class="note">[[User:Demellion|Demellion]]</dt>
<dt class="note">[[User:Demellion|Demellion]]</dt>
<dd class="note">Mention that '''setHitPointDamage''' only can be executed localy, while the [[getHitPointDamage]] is global.
<dd class="note">Mention that '''setHitPointDamage''' only can be executed localy, while the [[getHitPointDamage]] is global.</dd>


</dl>
</dl>

Revision as of 00:49, 19 August 2021

Hover & click on the images for description

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.
See also BIS_fnc_setHitPointDamage for setting hit with dependency.
Groups:
Object Manipulation

Syntax

Syntax:
vehicle setHitPointDamage [hitPointName, damage, useEffects]
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 Arma 3 logo black.png1.68
useEffects: Boolean - (Optional, default true) false to skip destruction effects
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
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 14, 2016 - 03:06
Demellion
Mention that setHitPointDamage only can be executed localy, while the getHitPointDamage is global.