BIS fnc setHitPointDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(29 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.68


| arma3dev |= Game name
|gr1= Object Manipulation


|1.67|= Game version
|descr= Sets damage to HitPoint with dependency or not.
____________________________________________________________________________________________


| Sets damage to HitPoint with dependency or not (Optional)  |= Description
|s1= [object, hitPoint, damage, useDependency] call [[BIS_fnc_setHitPointDamage]]
____________________________________________________________________________________________


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


|p1= object: [[Object]] - Entity to which damage applies |= Parameter 1
|p2= hitPoint: [[String]] - hitPoint to which damage applies
|p2= hitPoint: [[String]] - HitPoint to which damage applies |= Parameter 1
|p3= damage:  [[Number]] - Amount of damage to apply |= Parameter 1
|p3= useDependency (Optional):  [[Boolean]]
* [[true]] (Default) - distribute damage to dependent HitPoints as well
* [[false]] - apply damage to given HitPoint only |= Parameter 1


| [[Nothing]]|= Return value
|p3= damage:  [[Number]] - amount of damage to apply
____________________________________________________________________________________________


|x1= <code>[player, "HitFace", 0.9] [[call]] [[BIS_fnc_setHitPointDamage]];</code> |=
|p4= useDependency: [[Boolean]] - (Optional, default [[true]])
____________________________________________________________________________________________
* [[true]] - distribute damage to dependent HitPoints as well
* [[false]] - apply damage to given HitPoint only


|[[setHitPointDamage]] |= See also
|r1= [[Nothing]]


|x1= <sqf>[player, "HitFace", 0.9] call BIS_fnc_setHitPointDamage;</sqf>
|seealso= [[setHitPointDamage]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Objects|{{uc:setHitPointDamage}}]]
[[Category:Functions|{{uc:setHitPointDamage}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setHitPointDamage}}]]

Latest revision as of 01:59, 1 August 2022

Arma 3 logo black.png1.68
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_setHitPointDamage&oldid=329658"