BIS fnc setHitPointDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3>" to "")
m (Some wiki formatting)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma3
|game1= arma3
|version1= 1.68


|1.68
|gr1= Object Manipulation


|gr1 = Object Manipulation
|descr= Sets damage to HitPoint with dependency or not.


| Sets damage to HitPoint with dependency or not.
|s1= [object, hitPoint, damage, useDependency] call [[BIS_fnc_setHitPointDamage]]


| [object, hitPoint, damage, useDependency] call [[BIS_fnc_setHitPointDamage]]
|p1= object: [[Object]] - entity to which damage applies


|p1= object: [[Object]] - Entity to which damage applies
|p2= hitPoint: [[String]] - hitPoint to which damage applies


|p2= hitPoint: [[String]] - HitPoint to which damage applies
|p3= damage: [[Number]] - amount of damage to apply


|p3= damage: [[Number]] - Amount of damage to apply
|p4= useDependency: [[Boolean]] - (Optional, default [[true]])  
 
|p4= useDependency (Optional, default [[true]]): [[Boolean]]
* [[true]] - distribute damage to dependent HitPoints as well
* [[true]] - distribute damage to dependent HitPoints as well
* [[false]] - apply damage to given HitPoint only
* [[false]] - apply damage to given HitPoint only


| [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[<nowiki/>[[player]], "HitFace", 0.9] [[call]] [[BIS_fnc_setHitPointDamage]];</code>
|x1= <sqf>[player, "HitFace", 0.9] call BIS_fnc_setHitPointDamage;</sqf>


| [[setHitPointDamage]]
|seealso= [[setHitPointDamage]]
}}
}}
[[Category:Functions|{{uc:setHitPointDamage}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setHitPointDamage}}]]

Latest revision as of 01:59, 1 August 2022

Hover & click on the images for description

Description

Description:
Sets damage to HitPoint with dependency or not.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[object, hitPoint, damage, useDependency] call BIS_fnc_setHitPointDamage
Parameters:
object: Object - entity to which damage applies
hitPoint: String - hitPoint to which damage applies
damage: Number - amount of damage to apply
useDependency: Boolean - (Optional, default true)
  • true - distribute damage to dependent HitPoints as well
  • false - apply damage to given HitPoint only
Return Value:
Nothing

Examples

Example 1:
[player, "HitFace", 0.9] call BIS_fnc_setHitPointDamage;

Additional Information

See also:
setHitPointDamage

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