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 (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| TKOH |Game name=
| TKOH


|1.00|Game version=
|1.00


|arg= local |Multiplayer Arguments=
|arg= local


|eff= global |Multiplayer Effects=
|eff= global


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


| 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).
* 0: no damage
* 0: no damage
* 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


| vehicle '''setHitPointDamage''' [hitPointName, damage, useEffects]|SYNTAX=
| vehicle '''setHitPointDamage''' [hitPointName, damage, useEffects]


|p1= vehicle : [[Object]] - vehicle to be damaged |PARAMETER1=
|p1= vehicle : [[Object]] - vehicle to be damaged
|p2= [hitPointName, damage]: [[Array]] |PARAMETER2=
|p2= [hitPointName, damage]: [[Array]]
|p3= hitPointName: [[String]] - name of the Hit Point class |PARAMETER3=
|p3= hitPointName: [[String]] - name of the Hit Point class
|p4= damage: [[Number]] - level of damage |PARAMETER4=
|p4= damage: [[Number]] - level of damage
|p5 = useEffects (Optional): [[Boolean]] - [[false]] to skip destruction effects. Default: [[true]] (Since Arma 3 v1.67)|PARAMETER5=
|p5 = useEffects (Optional): [[Boolean]] - [[false]] to skip destruction effects. Default: [[true]] (Since Arma 3 v1.67)




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


|x1= <code>[[vehicle]] [[player]] [[setHitPointDamage]] ["hitEngine2", 1.0];</code> |Example1=
|x1= <code>[[vehicle]] [[player]] [[setHitPointDamage]] ["hitEngine2", 1.0];</code>


|x2= <code>[[player]] [[setHitPointDamage]] ["hitHead", 0.5];
|x2= <code>[[player]] [[setHitPointDamage]] ["hitHead", 0.5];
[[player]] [[setHitPointDamage]] ["hitBody", 0.5];
[[player]] [[setHitPointDamage]] ["hitBody", 0.5];
[[player]] [[setHitPointDamage]] ["hitHands", 0.5];
[[player]] [[setHitPointDamage]] ["hitHands", 0.5];
[[player]] [[setHitPointDamage]] ["hitLegs", 0.5];</code> |EXAMPLE2=
[[player]] [[setHitPointDamage]] ["hitLegs", 0.5];</code>


| [[getHitPointDamage]], [[getAllHitPointsDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]], [[getHitIndex]], [[setHitIndex]], [[BIS_fnc_setHitPointDamage]], [[getHitPointDamage#Notes|Common TKOH Hit Points]] |SEEALSO=
| [[getHitPointDamage]], [[getAllHitPointsDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]], [[getHitIndex]], [[setHitIndex]], [[BIS_fnc_setHitPointDamage]], [[getHitPointDamage#Notes|Common TKOH Hit Points]]


}}
}}

Revision as of 11:08, 18 January 2021

tkoh logo small.png1.00
LALocalGEGlobal
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).
  • 0: no damage
  • 1: full damage
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, 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.
Retrieved from "https://community.bistudio.com/wiki?title=setHitPointDamage&oldid=210627"