setDamage

?

1.00

Hover & click on the images for description

Description

Description:


Event Handler	Triggered
`Hit`
`HandleDamage`
`Killed`
`MPKilled`

Sets the damage (or lack thereof) of an object/unit. The alternative syntax allows to skip destruction effects for vehicles and buildings.

Since Arma 3 v2.12 it is possible to influence trees, poles and walls fall direction by supplying the killer entity param - the fall direction will then be away from killer's position. In multiplayer, the killer argument is ignored if the command is not executed on the server unless it targets trees, walls or poles - see Syntax 2 and Example 3.

Alias:

setDammage

Groups:

Object Manipulation

Syntax

Syntax:: object setDamage damage
Parameters:: object: Object
: damage: Number - range 0..1, 0 = pristine/healthy condition, 1 = entirely destroyed/killed
Return Value:: Nothing

1.68

Alternative Syntax

Syntax:

object setDamage [damage, useEffects, killer, instigator]

Parameters:

object: Object

damage: Number - range 0..1, 0 = pristine/healthy condition, 1 = entirely destroyed/killed

useEffects: Boolean (Optional, default true) - false to skip destruction effects

since 2.12

SEServer 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
MP restricted similar to setShotParents, will be ignored unless executed on the server or headless client in MP

since 2.12

SEServer 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
MP restricted similar to setShotParents, will be ignored unless executed on the server or headless client in MP
- the above MP restriction does not apply to trees, poles and walls

Return Value:

Nothing

Examples

Example 1:: _soldier1 setDamage 1;
Example 2:: _house1 setDamage [1, false];
Example 3:: // executed on a client _remoteVehicle setDamage [1, true, player]; // killer is not considered if the command is not called on the server - the vehicle still gets destroyed _tree setDamage [1, true, player]; // the tree is destroyed and falls away from the player

Additional Information

See also:: setVehicleArmor damage setHit getHit getHitIndex setHitIndex getHitPointDamage 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

Fragorl - c: Posted on Apr 17, 2006 - 07:36 (UTC)
: 1.00

In Operation Flashpoint, setting a unit's damage to a negative value will set it is health to full, but impair their aim.

KamikazXeX - c: Posted on May 29, 2015 - 11:23 (UTC)
: Using this possible overrides individual hit damages such as setHitPointDamage ["HitHead", _value]; if you're having issues try setting hitdamage after setdamage.

Sarogahtyp - c: Posted on Jun 24, 2021 - 10:31 (UTC)
: You are able to repair buildings with this command if you just store the original object and use setDamage on this and not on the wreck which is shown after the building was destroyed. This works in debug console when pointing a house:
[] spawn { private _house = cursorObject; _house setDamage 1; sleep 5; _house setDamage 0; };