setHitPointDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 16: Line 16:
{{Feature|informative|See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency.}}
{{Feature|informative|See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency.}}


|s1= vehicle [[setHitPointDamage]] [hitPointName, damage, useEffects, killer]
|s1= vehicle [[setHitPointDamage]] [hitPointName, damage, useEffects, killer, instigator]


|p1= vehicle : [[Object]] - vehicle to be damaged
|p1= vehicle : [[Object]] - vehicle to be damaged
Line 24: Line 24:
|p3= damage: [[Number]] - level of damage, in range 0..1
|p3= damage: [[Number]] - level of damage, in range 0..1


|p4= {{GVI|arma3|1.68}} useEffects: [[Boolean]] -  (Optional, default [[true]]) [[false]] to skip destruction effects
|p4= useEffects: [[Boolean]] -  (Optional, default [[true]]) [[false]] to skip destruction effects
|p4since= arma3 1.68


|p5= {{GVI|arma3|2.08}} killer: [[Object]] - (Optional, default [[objNull]]) The entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill. <br>
|p5= killer: [[Object]] - (Optional, default [[objNull]]) The entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill. <br>
* It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled). <br>
* It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled). <br>
* It will alter the killer's [[rating]] as if the killer directly killed the unit. <br>
* It will alter the killer's [[rating]] as if the killer directly killed the unit. <br>
* It will be listed as {{ic|_killer}} parameter in the [[Arma_3:_Event_Handlers#Killed|Killed]] event handler.
* It will be listed as <sqf inline>_killer</sqf> parameter in the [[Arma_3:_Event_Handlers#Killed|Killed]] event handler.
|p5since= arma3 2.08
 
|p6= instigator: [[Object]] - (Optional, default [[objNull]]) The person that instigated the damage.
* if a tank is a killer, the tank gunner that pulled the trigger is instigator
* it will be listed as <sqf inline>_instigator</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler.
|p6since= arma3 2.12


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

Revision as of 22:05, 23 July 2022

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, killer, 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
since Arma 3 logo black.png1.68
useEffects: Boolean - (Optional, default true) false to skip destruction effects
since Arma 3 logo black.png2.08
killer: Object - (Optional, default objNull) The entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill.
  • It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled).
  • It will alter the killer's rating as if the killer directly killed the unit.
  • It will be listed as _killer parameter in the Killed event handler.
since Arma 3 logo black.png2.12
instigator: Object - (Optional, default objNull) The person that instigated the damage.
  • if a tank is a killer, the tank gunner that pulled the trigger is instigator
  • it will be listed as _instigator 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:
getHitPointDamage getAllHitPointsDamage setHit getHit setDamage damage getHitIndex setHitIndex BIS_fnc_setHitPointDamage Common 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 locally, while the getHitPointDamage is global.