setHitPointDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 26: Line 26:
|p4= {{GVI|arma3|1.68}} useEffects: [[Boolean]] -  (Optional, default [[true]]) [[false]] to skip destruction effects
|p4= {{GVI|arma3|1.68}} useEffects: [[Boolean]] -  (Optional, default [[true]]) [[false]] to skip destruction effects


|p5= {{GVI|arma3|2.07}} instigator: [[Object]] - (Optional, default [[objNull]]) The unit/object that caused the damage
|p5= {{GVI|arma3|2.07}} instigator: [[Object]] - (Optional, default [[objNull]]) The object that caused the damage. If the damage leads to the death of the unit, the instigator will be used as the object that caused the kill. <br>
* It can be used to show "killed by player" in debriefing statistics and killed messages in the chat (if difficulty death messages are enabled). <br>
* It will alter the instigator's [[rating]] as if the instigator directly killed the unit. <br>
* It will be listed as {{ic|_killer}} parameter in the [[Arma_3:_Event_Handlers#Killed|Killed]] event handler.


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

Revision as of 15:54, 7 September 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, instigator]
Parameters:
vehicle : Object - vehicle to be damaged
hitPointName: String - name of the Hit Point class
damage: Number - level of damage, in range 0..1
Arma 3 logo black.png1.68 useEffects: Boolean - (Optional, default true) false to skip destruction effects
Arma 3 logo black.png2.07 instigator: Object - (Optional, default objNull) The object that caused the damage. If the damage leads to the death of the unit, the instigator will be used as the object that caused the kill.
  • It can be used to show "killed by player" in debriefing statistics and killed messages in the chat (if difficulty death messages are enabled).
  • It will alter the instigator's rating as if the instigator directly killed the unit.
  • It will be listed as _killer parameter in the Killed event handler.
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.