setHit: Difference between revisions

From Bohemia Interactive Community
mNo edit summary
mNo edit summary
Line 34: Line 34:
|p5= {{GVI|arma3|1.68}} useEffects: [[Boolean]] - (Optional, default [[true]]) [[false]] to skip destruction effects
|p5= {{GVI|arma3|1.68}} useEffects: [[Boolean]] - (Optional, default [[true]]) [[false]] to skip destruction effects


|p6= {{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>
|p6= {{GVI|arma3|2.08}} 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 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 instigator's [[rating]] as if the instigator directly killed the unit. <br>
* It will alter the instigator's [[rating]] as if the instigator directly killed the unit. <br>

Revision as of 16:24, 7 September 2021

Hover & click on the images for description

Description

Description:
Set damage on a part of an object.
Some part names are in Czech; see translation table.
Groups:
Object Manipulation

Syntax

Syntax:
object setHit [part, damage, useEffects, instigator]
Parameters:
[part, damage, useEffects]: Array
object: Object - local object
part: String - Name of the part (selection name)
damage: Number - Damage value ranging 0..1, 0 being fully functional, 1 being destroyed
Arma 3 logo black.png 1.68 useEffects: Boolean - (Optional, default true) false to skip destruction effects
Arma 3 logo black.png 2.08 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 kill messages in the chat (if 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 setHit ["motor", 1];
Example 2:
vehicle player setHit ["mala vrtule", 0.95];
Example 3:
if (local _heli) then { _heli setHit ["velka vrtule", 0]; } else { hint ("Vehicle " + str _heli + " must be local to this machine to do that!"); };

Additional Information

See also:
getHitgetHitPointDamagesetHitPointDamagedamagesetDamagesetFuelsetAmmogetHitIndexsetHitIndex

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
Deadfast
Damaging specific parts of the vehicle will not update its overall damage value (as of v1.03): player setHit ["hands", 0.9]; hint str (damage player); // will return 0
denisko.redisko
Direct use of the names of sections of the model is likely a bad practice, and will not work on some addons. So instead: _MH60S setHit ["elektronika", _hit]; should be used: _MH60S setHit [getText (configFile >> "cfgVehicles" >> "MH60S" >> "HitPoints" >> "HitAvionics" >> "name"), _hit];
Posted on September 11, 2018 - 19:37 (UTC)
HazJ
You can use getHit if you are using 1.64 EOL version.