BIS fnc setHitPointDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.68|Game version=
|1.68


|gr1 = Object Manipulation |GROUP1=
|gr1 = Object Manipulation


| Sets damage to HitPoint with dependency or not. |DESCRIPTION=
| Sets damage to HitPoint with dependency or not.


| [object, hitPoint, damage, useDependency] call [[BIS_fnc_setHitPointDamage]] |SYNTAX=
| [object, hitPoint, damage, useDependency] call [[BIS_fnc_setHitPointDamage]]


|p1= object: [[Object]] - Entity to which damage applies |PARAMETER1=
|p1= object: [[Object]] - Entity to which damage applies


|p2= hitPoint: [[String]] - HitPoint to which damage applies |PARAMETER2=
|p2= hitPoint: [[String]] - HitPoint to which damage applies


|p3= damage:  [[Number]] - Amount of damage to apply |PARAMETER3=
|p3= damage:  [[Number]] - Amount of damage to apply


|p4= useDependency (Optional, default [[true]]): [[Boolean]]
|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 |PARAMETER4=
* [[false]] - apply damage to given HitPoint only


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


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


| [[setHitPointDamage]] |SEEALSO=
| [[setHitPointDamage]]
}}
}}



Revision as of 00:48, 18 January 2021

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 (Optional, default true): Boolean
  • 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

Bottom Section