---
name: "Arma 3: Event Handlers"
type: topic
aliases: ["ArmA 3: Event Handlers"]
source: https://community.bistudio.com/wiki/Arma_3:_Event_Handlers
revid: 378964
updated: 2026-09-07T08:29:27Z
---
# Arma 3: Event Handlers
An Event Handler (abbreviated to EH) allows you to automatically monitor and then execute custom code upon particular events being triggered.
See also [Event Scripts](../topics/Event_Scripts.md) for special event triggered scripts.
### Basic Event Handlers
The object-based Event Handler is always executed on the computer where it was added.
Commands:
- [addEventHandler](../commands/addEventHandler.md)
- [removeEventHandler](../commands/removeEventHandler.md)
- [removeAllEventHandlers](../commands/removeAllEventHandlers.md)
#### AmmoExplodedNear (Arma 3 v2.22)
Triggers when ammo explodes in some damage range of the object. This EH triggers where the ammo is 'real', similar to HitPart.
```sqf
this addEventHandler ["AmmoExplodedNear", {
params ["_object", "_shot", "_position", "_velocity", "_ammo", "_explosive", "_indirectHit", "_invArmor", "_damage"];
}];
```
- object: [Object](../topics/Object.md) - object the event handler is assigned to
- shot: [Object](../topics/Object.md) - shot that has exploded
- position: [Array](../topics/Array.md) - world position of the shot
- velocity: [Array](../topics/Array.md) - world velocity of the shot
- ammmo: [String](../topics/String.md) - config ammo class name
- explosive: [Number](../topics/Number.md) - config value for 'explosive'
- indirectHit: [Number](../topics/Number.md) - config value for 'indirectHit'
- invArmor: [Number](../topics/Number.md) - calculated inverse armor from config value
- damage: [Number](../topics/Number.md) - a rough estimate of the potential damage to the center of the object based on config values and the distance
#### AnimChanged
Global Argument
Triggered every time a new animation is started. This EH is only triggered for the 1st animation state in a sequence.
```sqf
this addEventHandler ["AnimChanged", {
params ["_unit", "_anim"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- anim: [String](../topics/String.md) - name of the anim that is started
#### AnimDone
Global Argument
Triggered every time an animation is finished. Triggered for all animation states in a sequence.
```sqf
this addEventHandler ["AnimDone", {
params ["_unit", "_anim"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- anim: [String](../topics/String.md) - name of the anim that has been finished
#### AnimStateChanged
Global Argument
Triggered every time an animation state changes. Triggered for all animation states in a sequence.
```sqf
this addEventHandler ["AnimStateChanged", {
params ["_unit", "_anim"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- anim: [String](../topics/String.md) - name of the anim that has been started
#### Assembled (Arma 3 v2.18)
Local Argument
Triggers when weapon that is moved out of the world is assembled again. EH should be attached to the entity.
```sqf
this addEventHandler ["Assembled", {
params ["_entity", "_unit", "_primaryBag", "_secondaryBag"];
}];
```
- entity: [Object](../topics/Object.md) - weapon this event is assigned to
- unit: [Object](../topics/Object.md) - person who assembled the weapon
- primaryBag: [Object](../topics/Object.md) - first backpack object which was entity disassembled into (just before it is deleted)
- secondaryBag: [Object](../topics/Object.md) - second backpack object which was entity disassembled into (just before it is deleted)
#### Attached (Arma 3 v2.18)
Triggered after an object has been attached to another object (see [attachTo](../commands/attachTo.md)).
```sqf
this addEventHandler ["Attached", {
params ["_attachedObj", "_parentObj", "_isReattach", "_offset", "_memoryPointIndex", "_followBoneRotation"];
}];
```
- attachedObj: [Object](../topics/Object.md)
- parentObj: [Object](../topics/Object.md)
- isReattach: [Boolean](../topics/Boolean.md) - [true](../commands/true.md) if `attachedObj` was already attached to `parentObj`, e.g. if only the offset was changed
- offset: [Array](../topics/Array.md) format [PositionRelative](../topics/Position.md)
- memoryPointIndex: [Number](../topics/Number.md)
- followBoneRotation: [Boolean](../topics/Boolean.md)
#### CargoLoaded (Arma 3 v2.06)
Global Argument
Triggered when a vehicle is loaded into another vehicle ([ViV](../commands/setVehicleCargo.md)).
It can be added to either the transport vehicle, or the cargo vehicle, and will fire for both cases.
```sqf
this addEventHandler ["CargoLoaded", {
params ["_parentVehicle", "_cargoVehicle"];
}];
```
- parentVehicle: [Object](../topics/Object.md) - the transport (parent) vehicle
- cargoVehicle: [Object](../topics/Object.md) - the cargo (child) vehicle
#### CargoUnloaded (Arma 3 v2.06)
Global Argument
Triggered when a vehicle is unloaded from another vehicle ([ViV](../commands/setVehicleCargo.md)).
It can be added to either the transport vehicle, or the cargo vehicle, and will fire for both cases.
```sqf
this addEventHandler ["CargoUnloaded", {
params ["_parentVehicle", "_cargoVehicle"];
}];
```
- parentVehicle: [Object](../topics/Object.md) - the transport (parent) vehicle
- cargoVehicle: [Object](../topics/Object.md) - the cargo (child) vehicle
#### ContainerClosed (Arma 3 v1.32)
Global Argument
Triggers when player finished accessing cargo container.
This event handler is similar to [InventoryClosed](../topics/Event_Handlers.md#inventoryclosed) EH, but needs to be assigned to the container rather than the player.
**Note:** will trigger only for the unit opening container.
```sqf
this addEventHandler ["ContainerClosed", {
params ["_container", "_unit"];
}];
```
- container: [Object](../topics/Object.md) - cargo container.
- unit: [Object](../topics/Object.md) - unit who accessed the container
#### ContainerOpened (Arma 3 v1.32)
Global Argument
Triggers when cargo container is accessed by player.
This event handler is similar to [InventoryOpened](../topics/Event_Handlers.md#inventoryopened) EH, but needs to be assigned to the container rather than the player and cannot be overridden.
**Note:** will trigger only for the unit opening container.
```sqf
this addEventHandler ["ContainerOpened", {
params ["_container", "_unit"];
}];
```
- container: [Object](../topics/Object.md) - cargo container
- unit: [Object](../topics/Object.md) - unit who accessed the container
#### ControlsShifted (Arma 3 v1.00)
Global ArgumentLocal Effect
Triggers when control of a vehicle is shifted (pilot->co-pilot, co-pilot->pilot), usually when user performs an [action](../commands/action.md) such as [TakeVehicleControl](../topics/Actions.md#takevehiclecontrol), [SuspendVehicleControl](../topics/Actions.md#suspendvehiclecontrol), [UnlockVehicleControl](../topics/Actions.md#unlockvehiclecontrol), [LockVehicleControl](../topics/Actions.md#lockvehiclecontrol), or when [enableCopilot](../commands/enableCopilot.md) command is used. This event handler will always fire on the PC where [action](../commands/action.md) is triggered as well as where the vehicle is [local](../topics/Multiplayer_Scripting.md#locality) at the time. When control of the vehicle is shifted, the locality of the vehicle changes to the locality of the new controller. For example, if helicopter is [local](../topics/Multiplayer_Scripting.md#locality) to the server and co-pilot takes controls, the helicopter changes locality to co-pilot PC.
This means that if "ControlsShifted" EH was added on both server and client, "Take Controls" action will trigger EH on both, client and server PC, but subsequent co-pilot "Release Controls" action will trigger only on co-pilot's PC, because vehicle will be local to co-pilot at this point. There is also a slightly better mission version of [ControlsShifted](../topics/Mission_Event_Handlers.md#controlsshifted) event handler.
```sqf
this addEventHandler ["ControlsShifted", {
params ["_vehicle", "_activeCoPilot", "_oldController"];
}];
```
- vehicle: [Object](../topics/Object.md) - vehicle which controls were shifted
- activeCoPilot: [Object](../topics/Object.md) - co-pilot unit which controls vehicle after this event. [objNull](../commands/objNull.md) if co-pilot is not controlling the vehicle
- oldController: [Object](../topics/Object.md) - unit who controlled vehicle before this event
#### Dammaged
Global Argument
Triggered when the unit is damaged. In ArmA works with all vehicles not only men like in OFP.
**Notes:**
- The typo is "intentional": it is Da**mm**aged with two "m".
- If simultaneous damage occured (e.g. via grenade) EH might be triggered several times.
- The Dammaged EH will not necessarily fire if only minor damage occurred (e.g. firing a bullet at a tank), even though the damage increased.
```sqf
this addEventHandler ["Dammaged", {
params ["_unit", "_hitSelection", "_damage", "_hitPartIndex", "_hitPoint", "_shooter", "_projectile"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- hitSelection: [String](../topics/String.md) - name of the selection where the unit was damaged
- damage: [Number](../topics/Number.md) - resulting level of damage
- Arma 3 v1.68 hitPartIndex: [Number](../topics/Number.md) - hit index of the hit selection
- Arma 3 v1.68 hitPoint: [String](../topics/String.md) - hit point Cfg name
- Arma 3 v1.70 shooter: [Object](../topics/Object.md) - shooter reference (to get instigator use [getShotParents](../commands/getShotParents.md) on projectile)
- Arma 3 v1.70 projectile: [Object](../topics/Object.md) - the projectile that caused damage
#### Deleted (Entity) (Arma 3 v1.68)
Global Argument
Triggered just before the assigned entity is deleted.
```sqf
this addEventHandler ["Deleted", {
params ["_entity"];
}];
```
- entity: [Object](../topics/Object.md) - object the event handler is assigned to
#### Detached (Arma 3 v2.18)
Triggered after an object has been detached from its parent object (see [detach](../commands/detach.md)). Does not fire if the parent object was deleted.
```sqf
this addEventHandler ["Detached", {
params ["_attachedObj", "_parentObj"];
}];
```
- attachedObj: [Object](../topics/Object.md)
- parentObj: [Object](../topics/Object.md)
#### Disassembled (Arma 3 v2.00)
Local Argument
Triggers when entity such as weapon/backpack gets disassembled. EH should be attached to the entity.
```sqf
this addEventHandler ["Disassembled", {
params ["_entity", "_primaryBag", "_secondaryBag", "_unit"];
}];
```
- entity: [Object](../topics/Object.md) - weapon this event is assigned to (just before is is moved out of the world)
- primaryBag: [Object](../topics/Object.md) - first backpack object which was entity disassembled into
- secondaryBag: [Object](../topics/Object.md) - second backpack object which was entity disassembled into
- Arma 3 v2.18 unit: [Object](../topics/Object.md) - person who disassembled the weapon
#### Engine
Global Argument
Triggered when the engine of the unit is turned on/off.
> [!NOTE]
> Although the event is global, on clients (non-server) and applied to remote vehicles, it will fire only if the vehicle is closer than about 6 km from the camera.
> Should the vehicle be far away, it will fire as soon as the camera and vehicle are close enough together, alongside the [isEngineOn](../commands/isEngineOn.md) flag change.
```sqf
this addEventHandler ["Engine", {
params ["_vehicle", "_engineState"];
}];
```
- vehicle: [Object](../topics/Object.md) - vehicle the event handler is assigned to
- engineState: [Boolean](../topics/Boolean.md) - true when the engine is turned on, false when turned off
#### EpeContact (Arma 3 v1.00)
Global Argument
Triggered when object collision (PhysX) is in progress.
```sqf
this addEventHandler ["EpeContact", {
params ["_object1", "_object2", "_selection1", "_selection2", "_force", "_reactVect", "_worldPos"];
}];
```
- object1: [Object](../topics/Object.md) - object with attached handler
- object2: [Object](../topics/Object.md) - object which is colliding with object1
- selection1: [String](../topics/String.md) - selection of object1 which is colliding - not in use at this moment, empty string is always returned
- selection2: [String](../topics/String.md) - selection of object2 which is colliding - not in use at this moment, empty string is always returned
- force: [Number](../topics/Number.md) - force of collision
- Arma 3 v2.12 reactVect: [Array](../topics/Array.md) - impact reaction force vector
- Arma 3 v2.12 worldPos: [PositionWorld](../topics/Position.md) - point of impact in world coordinates
#### EpeContactEnd (Arma 3 v1.00)
Global Argument
Triggered when object collision (PhysX) ends.
```sqf
this addEventHandler ["EpeContactEnd", {
params ["_object1", "_object2", "_selection1", "_selection2", "_force"];
}];
```
- object1: [Object](../topics/Object.md) - object with attached handler
- object2: [Object](../topics/Object.md) - object which is colliding with object1
- selection1: [String](../topics/String.md) - selection of object1 which is colliding - not in use at this moment, empty string is always returned
- selection2: [String](../topics/String.md) - selection of object2 which is colliding - not in use at this moment, empty string is always returned
- force: [Number](../topics/Number.md) - force of collision
#### EpeContactStart (Arma 3 v1.00)
Global Argument
Triggered when object collision (PhysX) starts.
```sqf
this addEventHandler ["EpeContactStart", {
params ["_object1", "_object2", "_selection1", "_selection2", "_force", "_reactForce", "_worldPos"];
}];
```
- object1: [Object](../topics/Object.md) - object with attached handler
- object2: [Object](../topics/Object.md) - object which is colliding with object1
- select1: [String](../topics/String.md) - selection of object1 which is colliding - not in use at this moment, empty string is always returned
- select2: [String](../topics/String.md) - selection of object2 which is colliding - not in use at this moment, empty string is always returned
- force: [Number](../topics/Number.md) - force of collision
- Arma 3 v2.12 reactForce: [Array](../topics/Array.md) - impact reaction force vector
- Arma 3 v2.12 worldPos: [PositionWorld](../topics/Position.md) - point of impact in world coordinates
#### Explosion (Arma 3 v0.76)
Global Argument
Triggered when a vehicle or unit is damaged by a nearby explosion.
It can be assigned to a remote unit or vehicle but will only fire on the PC where EH is added and explosion is local, i.e. it really needs to be added on every PC and JIP and will fire only where the explosion is originated.
```sqf
this addEventHandler ["Explosion", {
params ["_vehicle", "_damage", "_explosionSource"];
}];
```
- vehicle: [Object](../topics/Object.md) - object the event handler is assigned to
- damage: [Number](../topics/Number.md) - damage inflicted to the object
- Arma 3 v2.10 explosionSource: [Object](../topics/Object.md) - the exploding object (NOT the shooter) - may be [objNull](../commands/objNull.md) in some cases
> [!NOTE]
> This event will fire even for tiniest of explosion damage (which appears as 0 damage argument), while [#HitPart (Entity)](../topics/Event_Handlers.md#hitpart-entity) could ignore such damage and not fire.
> Example of such event would be a tank firing AP round and hitting ground a meter away from the vehicle, it does not produce an explosion yet its indirectHit could still cause tiny amount of damage to weak hit points (car wheels, headlights, etc.).
> In such case you might not get any [#HitPart (Entity)](../topics/Event_Handlers.md#hitpart-entity) event fires, get some [#HandleDamage](../topics/Event_Handlers.md#handledamage) events if target is local, and get this Explosion event.
#### Fired
Global Argument
Triggered when the unit fires a weapon.
This EH will not trigger if a unit fires out of a vehicle. For those cases an EH has to be attached to that particular vehicle.
When "Manual Fire" is used, the *gunner* is [objNull](../commands/objNull.md) if gunner is not present or the *gunner* is not the one who fires.
To check if "Manual Fire" is on, use [isManualFire](../commands/isManualFire.md). The actual shot instigator could be retrieved with [getShotParents](../commands/getShotParents.md) command.
> [!WARNING]
> **Special multiplayer behaviour:** When added to a remote unit or vehicle, this EH will only fire if said entity is within range of the camera.
> That range is determined by the fired ammo's highest visibleFire and audibleFire config value.
> In case of units, muzzle attachment coefficients are applied too.
```sqf
this addEventHandler ["Fired", {
params ["_unit", "_weapon", "_muzzle", "_mode", "_ammo", "_magazine", "_projectile", "_gunner"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- weapon: [String](../topics/String.md) - fired weapon
- muzzle: [String](../topics/String.md) - muzzle that was used
- mode: [String](../topics/String.md) - current mode of the fired weapon
- ammo: [String](../topics/String.md) - ammo used
- magazine: [String](../topics/String.md) - magazine name which was used
- projectile: [Object](../topics/Object.md) - object of the projectile that was shot out
- Arma 3 v1.66 gunner: [Object](../topics/Object.md) - gunner whose weapons are firing.
#### FiredMan (Arma 3 v1.66)
Global Argument
Triggered when the unit fires a weapon. This EH must be attached to a soldier and unlike with "Fired" EH, it will fire regardless of whether the soldier is on foot or firing vehicle weapon.
For [remoteControl](../commands/remoteControl.md)ed unit use "Fired" EH instead.
> [!WARNING]
> **Special multiplayer behaviour:** When added to a remote unit or vehicle, this EH will only fire if said entity is within range of the camera.
> That range is determined by the fired ammo's highest visibleFire and audibleFire config value.
> In case of units, muzzle attachment coefficients are applied too.
```sqf
this addEventHandler ["FiredMan", {
params ["_unit", "_weapon", "_muzzle", "_mode", "_ammo", "_magazine", "_projectile", "_vehicle"];
}];
```
- unit: [Object](../topics/Object.md) - unit the event handler is assigned to (the instigator)
- weapon: [String](../topics/String.md) - fired weapon
- muzzle: [String](../topics/String.md) - muzzle that was used
- mode: [String](../topics/String.md) - current mode of the fired weapon
- ammo: [String](../topics/String.md) - ammo used
- magazine: [String](../topics/String.md) - magazine name which was used
- projectile: [Object](../topics/Object.md) - object of the projectile that was shot out
- vehicle: [Object](../topics/Object.md) - vehicle, if weapon is vehicle weapon, otherwise [objNull](../commands/objNull.md)
#### FiredNear
Global Argument
Triggered when a weapon is fired somewhere *near* the unit or vehicle. It is also triggered if the unit itself is firing.
When "Manual Fire" is used, the *gunner* is [objNull](../commands/objNull.md) if gunner is not present or the *gunner* is not the one who fires.
To check if "Manual Fire" is on, use [isManualFire](../commands/isManualFire.md). The actual shot instigator can be retrieved with [getShotParents](../commands/getShotParents.md) command.
Arma 3 v1.30 Works with thrown weapons (using the "Throw" weapon) like grenades.
```sqf
this addEventHandler ["FiredNear", {
params ["_unit", "_firer", "_distance", "_weapon", "_muzzle", "_mode", "_ammo", "_gunner"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- firer: [Object](../topics/Object.md) - object which fires a weapon near the unit
- distance: [Number](../topics/Number.md) - distance in meters between the *unit* and *firer* (max. distance ~69m)
- weapon: [String](../topics/String.md) - fired weapon
- muzzle: [String](../topics/String.md) - muzzle that was used
- mode: [String](../topics/String.md) - current mode of the fired weapon
- ammo: [String](../topics/String.md) - ammo used
- Arma 3 v1.66 gunner: [Object](../topics/Object.md) - gunner, whose weapons are fired
#### Fuel
Global Argument
Triggered when the vehicle's fuel status changes between non-empty and empty or between empty and non-empty.
```sqf
this addEventHandler ["Fuel", {
params ["_vehicle", "_hasFuel"];
}];
```
- vehicle: [Object](../topics/Object.md) - vehicle the event handler is assigned to
- hasFuel: [Boolean](../topics/Boolean.md) - false when has no fuel, true when has some fuel
#### Gear
Global Argument
Triggered when the unit lowers/retracts the landing gear, whether it is a helicopter or a plane.
Also triggered for helicopters in landing mode, regardless if they have retractable gear or not.
> [!NOTE]
> Not to be confused with *[InventoryOpened](../topics/Event_Handlers.md#inventoryopened)* and *[InventoryClosed](../topics/Event_Handlers.md#inventoryclosed)* events, *Gear* fires when the landing gear state on an aircraft has changed.
```sqf
this addEventHandler ["Gear", {
params ["_vehicle", "_gearState"];
}];
```
- vehicle: [Object](../topics/Object.md) - vehicle the event handler is assigned to
- gearState: [Boolean](../topics/Boolean.md) - true when the gear is lowered, false when retracted
#### GestureChanged (Arma 3 v2.06)
Global Argument
Triggered every time a new gesture is played.
```sqf
this addEventHandler ["GestureChanged", {
params ["_unit", "_gesture"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- gesture: [String](../topics/String.md) - name of the gesture that has started playing
#### GestureDone (Arma 3 v2.06)
Global Argument
Triggered every time a gesture is finished.
```sqf
this addEventHandler ["GestureDone", {
params ["_unit", "_gesture"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- gesture: [String](../topics/String.md) - name of the gesture that has been finished
#### GetIn
Global Argument
Triggers when a unit enters the vehicle to which this EH has been added. This EH is triggered by moveInXXXX commands and "GetInXXXX" [action](../commands/action.md)s, but not upon a seat change within the same vehicle.
In vehicles with multi-turret setup, entering any turret will show "gunner" for position.
```sqf
this addEventHandler ["GetIn", {
params ["_vehicle", "_role", "_unit", "_turret"];
}];
```
- vehicle: [Object](../topics/Object.md) - vehicle the event handler is assigned to
- role: [String](../topics/String.md) - can be either "driver", "gunner", "commander" or "cargo"
- unit: [Object](../topics/Object.md) - unit that entered the vehicle
- Arma 3 v1.36 turret: [Array](../topics/Array.md) - turret path
#### GetInMan (Arma 3 v1.58)
Global Argument
Triggers when a unit enters a vehicle. Similar to "GetIn" but must be assigned to a unit and not vehicle.
Persistent on respawn if assigned where unit was [local](../topics/Multiplayer_Scripting.md#locality). This EH is triggered by moveInXXXX commands and "GetInXXXX" [action](../commands/action.md)s.
```sqf
this addEventHandler ["GetInMan", {
params ["_unit", "_role", "_vehicle", "_turret"];
}];
```
- unit: [Object](../topics/Object.md) - unit the event handler is assigned to
- role: [String](../topics/String.md) - can be either "driver", "gunner", "commander" or "cargo"
- vehicle: [Object](../topics/Object.md) - vehicle the unit entered
- turret: [Array](../topics/Array.md) - turret path
#### GetOut
Global Argument
Triggers when a unit gets out from the vehicle to which this EH has been added.
This EH is triggered by [moveOut](../commands/moveOut.md), "GetOut" & "Eject" [action](../commands/action.md)s, if an [alive](../commands/alive.md) [crew](../commands/crew.md) member disconnects or is deleted, but not upon a seat change within the same vehicle.
```sqf
this addEventHandler ["GetOut", {
params ["_vehicle", "_role", "_unit", "_turret", "_isEject"];
}];
```
- vehicle: [Object](../topics/Object.md) - vehicle the event handler is assigned to
- role: [String](../topics/String.md) - can be either "driver", "gunner", "commander" or "cargo"
- unit: [Object](../topics/Object.md) - unit that left the vehicle
- Arma 3 v1.36 turret: [Array](../topics/Array.md) - turret path
- Arma 3 v2.14 isEject: [Boolean](../topics/Boolean.md) - [true](../commands/true.md) if unit used 'Eject' action
#### GetOutMan (Arma 3 v1.58)
Global Argument
Triggers when a unit exits a vehicle. Similar to "GetOut" but must be assigned to a unit and not vehicle.
Persistent on respawn if assigned where unit was [local](../topics/Multiplayer_Scripting.md#locality). This EH is triggered by [moveOut](../commands/moveOut.md) and "GetOut" & "Eject" [action](../commands/action.md)s.
```sqf
this addEventHandler ["GetOutMan", {
params ["_unit", "_role", "_vehicle", "_turret", "_isEject"];
}];
```
- unit: [Object](../topics/Object.md) - unit the event handler is assigned to
- role: [String](../topics/String.md) - can be either "driver", "gunner", "commander" or "cargo"
- vehicle: [Object](../topics/Object.md) - vehicle that the unit left
- turret: [Array](../topics/Array.md) - turret path
- Arma 3 v2.14 isEject: [Boolean](../topics/Boolean.md) - [true](../commands/true.md) if unit used 'Eject' action
#### HandleDamage
Global Argument
Triggers when the unit is damaged and fires for each damaged selection separately
Works with all vehicles.
This EH can accept a remote unit as argument however it will only fire when the unit is [local](../topics/Multiplayer_Scripting.md#locality) to the PC this event handler was added on.
For example, you can add this event handler to one particular vehicle on every PC.
When this vehicle gets hit, only EH on PC where the vehicle is currently [local](../topics/Multiplayer_Scripting.md#locality) will fire.
If the provided code returns a numeric value, this value will overwrite the default damage of given selection after processing.
If no value is returned, the default damage processing will be done - this allows for safe stacking of this event handler.
Only the return value of the last added "HandleDamage" EH is considered.
> [!IMPORTANT]
> A return value of 0 will make the unit **invulnerable** if damage is not scripted in other ways (i.e using [setDamage](../commands/setDamage.md) and/or [setHit](../commands/setHit.md) for additional damage handling).
> The return value is the hit zone's **absolute damage value**, **not** the damage to be *added* to it.
**Notes:**
- Multiple "HandleDamage" EHs can be added to the same unit. If multiple EHs return damage value for custom damage handling, only last returned value will be considered by the engine.
EHs that do not return value can be safely added after EHs that do return value.
- You can save the last event as timestamp ([diag_tickTime](../commands/diag_tickTime.md)) onto the unit, as well as the current health of the unit/its selections, with [setVariable](../commands/setVariable.md) and query it on each "HandleDamage" event with [getVariable](../commands/getVariable.md) to define a system how to handle the "HandleDamage" event.
- "HandleDamage" will continue to trigger even if the unit is already dead.
- "HandleDamage" is persistent. If you add it to the [player](../commands/player.md) object, it will continue to exist after player respawned.
- "HandleDamage" can trigger "twice" per damage event. Once for direct damage, once for indirect damage (explosive damage). This can happen even in the same frame, but is unlikely.
- Use [setMissionOptions](../commands/setMissionOptions.md) to filter out no damage calls or fake head hit.
Additional [Celery's explanation (Updated by ShadowRanger for Arma 3)](https://forums.bistudio.com/forums/topic/205515-handledamage-event-handler-explained/).
```sqf
this addEventHandler ["HandleDamage", {
params ["_unit", "_selection", "_damage", "_source", "_projectile", "_hitPartIndex", "_instigator", "_hitPoint", "_directHit", "_context"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- selection: [String](../topics/String.md) - name of the selection where the unit was damaged.
- "" for overall structural damage
- "?" for unknown selections
- damage: [Number](../topics/Number.md) - resulting level of damage for the selection
- source: [Object](../topics/Object.md) - the source unit that caused the damage
- projectile: [String](../topics/String.md) - classname of the projectile that caused inflicted the damage. ("" for unknown, such as fall damage)
- Arma 3 v1.50 hitPartIndex: [Number](../topics/Number.md) - hit part index of the hit point, -1 otherwise
- Arma 3 v1.66 instigator: [Object](../topics/Object.md) - person who pulled the trigger
- Arma 3 v1.68 hitPoint: [String](../topics/String.md) - hit point Cfg name
- Arma 3 v2.12 directHit: [Boolean](../topics/Boolean.md) - [true](../commands/true.md) for direct projectile damage, [false](../commands/false.md) for explosion splash damage and all other kinds of damage like fall damage, fire damage, collision damage, etc.
- Arma 3 v2.16 context: [Number](../topics/Number.md) - some additional context for the event:
0 : TotalDamage - total damage adjusted before iteration through hitpoints
1 : HitPoint - some hit point processed during iteration
2 : LastHitPoint - the last hitpoint from iteration is processed
3 : FakeHeadHit - head hit that is added/adjusted
4 : TotalDamageBeforeBleeding - total damage is adjusted before calculating bleeding
> [!NOTE]
> Between an unknown version (confirmed in Arma 3 v1.70) until v1.78 HandleDamage event triggered for every selection of a vehicle, no matter if the section was damaged or not.
#### HandleHeal
Global Argument
Triggered when unit starts healing process (player using heal action on self or other unit, scripted [action](../commands/action.md) or AI heals after being ordered or on its own).
This event handler must be added to the 'injured' (could be added to Init field in editor) and in multiplayer will trigger only on PC where 'healer' is [local](../topics/Multiplayer_Scripting.md#locality). If code returns anything but [true](../commands/true.md), engine side healing follows, otherwise healing is aborted.
> [!IMPORTANT]
> When AI unit is ordered (or acts at own accord) to heal at a medical vehicle and the event handler returns [true](../commands/true.md), the healing is canceled but AI will try again and again and again. The event handler in this case will fire every second until AI unit is healed by other means.
**NOTE**: This Event Handler was broken before Arma 3 v2.18.
```sqf
this addEventHandler ["HandleHeal", {
_this spawn {
params ["_injured", "_healer", "_isMedic", "_atVehicle", "_action"];
private _damage = damage _injured;
if (_injured == _healer) then
{
waitUntil { damage _injured != _damage };
if (damage _injured < _damage) then
{
_injured setDamage 0;
};
};
};
}];
```
```sqf
this addEventHandler ["HandleHeal", {
params ["_injured", "_healer", "_isMedic", "_atVehicle", "_action"];
}];
```
- injured: [Object](../topics/Object.md) - unit EH is attached to
- healer: [Object](../topics/Object.md) - unit that does the healing (could be the same unit as 'injured')
- isMedic: [Boolean](../topics/Boolean.md) - true when healer is 'Medic'
- Arma 3 v2.18 atVehicle: [Object](../topics/Object.md) - when healing at medical vehicle, this is the vehicle
- Arma 3 v2.18 action: [String](../topics/String.md) - the action that triggered the event handler, for example "SoldierHealSelf"
#### HandleIdentity
Global Argument
Triggered whenever an entity is created. Can be used in scripts if EH is added immediately after unit is created in [unscheduled environment](../topics/Scheduler.md#unscheduled-environment).
Doesn't trigger for editor placed units. Does not work in Multiplayer. If EH scope returns [true](../commands/true.md), the default engine identity application is overridden.
```sqf
bob = group player createUnit [typeOf player, position player, [], 0, "NONE"];
bob addEventHandler ["HandleIdentity", {
params ["_unit"];
hint str _unit;
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
#### HandleRating (Arma 3 v1.32)
Local Argument
Triggered when engine adds rating to overall rating of the unit, usually after a kill or a friendly kill.
If EH code returns [Number](../topics/Number.md), this will override default engine behaviour and the resulting value added will be the one returned by EH code.
```sqf
this addEventHandler ["HandleRating", {
params ["_unit", "_rating"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- rating: [Number](../topics/Number.md) - rating to be added
#### HandleScore (Arma 3 v1.32)
Global ArgumentServer Execution
Triggered when engine adds score to overall score of the unit, usually after a kill.
If the EH code returns [Nothing](../topics/Nothing.md) or [true](../commands/true.md), the default engine scoreboard update (score, vehicle kills, infantry kills, etc) is applied, if it returns [false](../commands/false.md), the engine update is cancelled. To add or modify score, use [addScore](../commands/addScore.md) and [addScoreSide](../commands/addScoreSide.md) commands.
For remote units like players, the event does not persist after respawn, and must be re-added to the new unit.
**Note:** MP only.
```sqf
this addEventHandler ["HandleScore", {
params ["_unit", "_object", "_score"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- object: [Object](../topics/Object.md) - object for which score was awarded
- score: [Number](../topics/Number.md) - score to be added
#### Hit
Local Argument
Triggered when the unit is hit/damaged.
Is *not* always triggered when unit is killed by a hit.
Most of the time only the [killed](../topics/Event_Handlers.md#killed) event handler is triggered when a unit dies from a hit.
The hit EH will not necessarily fire if only minor damage occurred (e.g. firing a bullet at a tank), even though the damage increased.
Does not fire when a unit is set to allowDamage false.
```sqf
this addEventHandler ["Hit", {
params ["_unit", "_source", "_damage", "_instigator"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- source: [Object](../topics/Object.md) - object that caused the damage – contains *unit* in case of collisions
- damage: [Number](../topics/Number.md) - level of damage caused by the hit
- Arma 3 v1.66 instigator: [Object](../topics/Object.md) - person who pulled the trigger
#### HitPart (Entity)
Global Argument
Triggered when the object it was added to gets damaged.
It returns the position and component that was hit on the object within a nested array, this is because the model may have more than one selection name for the hit component (i.e. a single piece of geometry can be simultaneously part of multiple, overlapping named selections).
While you can add "HitPart" handler to a remote unit, the respective [addEventHandler](../commands/addEventHandler.md) command must be executed on the shooter's PC and will only fire on shooter's PC as well.
The event will not fire if the shooter is not local, even if the target itself is local.
Additionally, if the unit gets damaged by any means other than ammunition or explosions, such as fall damage and burning, "HitPart" will not fire.
Because of this, this event handler is most suitable for when the shooter needs feedback on his shooting, such as target practicing or hitmarker creation.
This EH returns an array of arrays. Each sub-array contains data for the part that was hit as usually multiple parts are hit at the same time (see HitPart Sample). The structure of the sub-arrays is listed below.
```sqf
this addEventHandler ["HitPart", {
{
_x params [
"_target", "_shooter", "_projectile", "_position", "_velocity",
"_selection", "_ammo", "_vector", "_radius", "_surfaceType",
"_isDirect", "_instigator"
];
} forEach _this;
}];
```
- target: [Object](../topics/Object.md) - object that was damaged
- shooter: [Object](../topics/Object.md) - Unit or vehicle that inflicted the damage. If injured by a vehicle collision, the target itself is returned, or [objNull](../commands/objNull.md) in case of explosions. In case of explosives that were planted by someone (e.g. satchel charges), that unit is returned.
- projectile: [Object](../topics/Object.md) - object that was fired
- position: [Array](../topics/Array.md) format [PositionASL](../topics/Position.md#positionasl) - position the bullet impacted
- velocity: [Vector3D](../topics/Vector3D.md) - 3D speed at which the bullet impacted
- selection: [Array](../topics/Array.md) - array of [String](../topics/String.md)s with named selection of the object that were hit, in the FireGeometry LOD
- ammo:
- [Array](../topics/Array.md) in format [hitValue, indirectHitValue, indirectHitRange, explosiveDamage, ammoClassName] - If the damage was directly or indirectly inflicted by a projectile. Hit and damage values are derived from the projectile's CfgAmmo class, and do not match the actual damage inflicted, which is usually lower due to armor and other factors.
- [Array](../topics/Array.md) in format [impulseValue, 0, 0, 0] - if the damage was inflicted by a vehicle collision
- vector: [Vector3D](../topics/Vector3D.md) - Vector that is orthogonal (perpendicular) to the surface struck. For example, if a wall was hit, the vector would be pointing out of the wall at a 90 degree angle.
- radius: [Number](../topics/Number.md) - radius (size) of component hit
- surfaceType: [String](../topics/String.md) - surface type struck
- isDirect: [Boolean](../topics/Boolean.md) - [true](../commands/true.md) if object was directly hit, [false](../commands/false.md) if it was hit by indirect / splash damage
- Arma 3 v2.18 instigator: [Object](../topics/Object.md) - shot instigator
> [!NOTE]
> See [#HitPart (Projectile)](../topics/Event_Handlers.md#hitpart-projectile) for a similar event handler that is attached to the projectile instead of the entity.
> [!NOTE]
> This event does not fire when miniscule explosive damage is dealt to the target entity, but the [Explosion](../topics/Event_Handlers.md#explosion) event will still fire.
#### IncomingMissile
Global Argument
Triggered when a unit fires a missile or rocket at the target. For projectiles fired by players this EH only triggers for guided missiles that have locked onto the target.
```sqf
this addEventHandler ["IncomingMissile", {
params ["_target", "_ammo", "_vehicle", "_instigator", "_missile"];
}];
```
- target: [Object](../topics/Object.md) - object the event handler is assigned to
- ammo: [String](../topics/String.md) - ammo type that was fired on the target
- Arma 3 v1.42 vehicle: [Object](../topics/Object.md) - vehicle that fired the weapon. In case of soldier, unit is returned
- Arma 3 v1.66 instigator: [Object](../topics/Object.md) - person who pulled the trigger
- Arma 3 v2.10 missile: [Object](../topics/Object.md) - the incoming missile
#### Init (Entity)
Global Argument
Triggered whenever an entity is created. Cannot be used in scripts, only inside class Eventhandlers in config.
> [!IMPORTANT]
> It is recommended to use the [#PostInit](../topics/Event_Handlers.md#postinit) event handler instead of this one when setting entity textures ([setObjectTexture](../commands/setObjectTexture.md), [BIS_fnc_initVehicle](../functions/BIS_fnc_initVehicle.md) etc) to avoid networking issues.
e.g:
```cpp
init = "params ['_entity'];";
```
```sqf
params ["_entity"];
```
- entity: [Object](../topics/Object.md) - object the event handler is assigned to
#### InventoryClosed (Arma 3 v1.22)
Global Argument
Triggered when the unit closes inventory. Said unit can be non-local when adding the EH, but **must** be local for the EH to trigger.
```sqf
this addEventHandler ["InventoryClosed", {
params ["_unit", "_container"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- container: [Object](../topics/Object.md) - connected container or weaponholder
```sqf
// Delete dropped items when inventory closed
player addEventHandler ["InventoryClosed", {
params ["_unit", "_container"];
if (_container isKindOf "WeaponHolder") then
{
deleteVehicle _container;
};
}];
```
#### InventoryOpened (Arma 3 v1.22)
Global Argument
Triggered when unit opens inventory. Said unit can be non-local when adding the EH, but **must** be local for the EH to trigger. End EH main scope with [true](../commands/true.md) to override the opening of the inventory in case you wish to handle it yourself:
```sqf
// Create and open an ammo box when "Inventory" button is pressed
player addEventHandler ["InventoryOpened", {
player removeAllEventHandlers "InventoryOpened";
_box = "Box_NATO_Ammo_F" createVehicle [0,0,0];
_box setPosASL (player modelToWorldVisualWorld [0,1.5,0.5]);
player action ["Gear", _box];
true; // <-- inventory override
}];
```
To return all nearby containers use [nearSupplies](../commands/nearSupplies.md) command.
```sqf
this addEventHandler ["InventoryOpened", {
params ["_unit", "_primaryContainer", "_secondaryContainer"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- primaryContainer: [Object](../topics/Object.md) - connected container or weaponholder
- Arma 3 v1.66 secondaryContainer: [Object](../topics/Object.md) - second connected container or weaponholder or [objNull](../commands/objNull.md)
#### Killed
Local Argument
Triggered when the unit is killed.
```sqf
this addEventHandler ["Killed", {
params ["_unit", "_killer", "_instigator", "_useEffects", "_shot", "_real"];
}];
```
- unit: [Object](../topics/Object.md) - the object the event handler is assigned to
- killer: [Object](../topics/Object.md) - the object that killed the unit. Contains the unit itself in case of collisions.
- Arma 3 v1.66 instigator: [Object](../topics/Object.md) - the person who pulled the trigger
- Arma 3 v1.68 useEffects: [Boolean](../topics/Boolean.md) - same as *useEffects* in [setDamage](../commands/setDamage.md) alt syntax
- Arma 3 v2.22 shot: [Object](../topics/Object.md) - shot that caused damage
- Arma 3 v2.22 real: [Boolean](../topics/Boolean.md) - [true](../commands/true.md) when the shot was 'real' where the event handler triggered
#### LandedStopped
Global Argument
Triggered when an AI pilot would get out usually. Not executed for player.
```sqf
this addEventHandler ["LandedStopped", {
params ["_plane", "_airportID", "_airportObject"];
}];
```
- plane: [Object](../topics/Object.md) - object the event handler is assigned to
- airportID: [Number](../topics/Number.md) - ID of the airport (-1 for anything else)
- Arma 3 v2.12 airportObject: [Object](../topics/Object.md) - airport object in the event of a Dynamic Airport, otherwise [objNull](../commands/objNull.md)
#### LandedTouchDown
Global Argument
Triggered when a plane (AI or player) touches the ground.
```sqf
this addEventHandler ["LandedTouchDown", {
params ["_plane", "_airportID", "_airportObject"];
}];
```
- plane: [Object](../topics/Object.md) - object the event handler is assigned to
- airportID: [Number](../topics/Number.md) - ID of the airport (-1 for anything else)
- Arma 3 v2.12 airportObject: [Object](../topics/Object.md) - airport object in the event of a Dynamic Airport, otherwise [objNull](../commands/objNull.md)
#### Landing (Arma 3 v1.70)
Global Argument
Triggered when an AI pilot (or auto-pilot) is preparing for landing. The exact moment of triggering coincides with lowering of the gear ("Gear" EH)
```sqf
this addEventHandler ["Landing", {
params ["_plane", "_airportID", "_isCarrier"];
}];
```
- plane: [Object](../topics/Object.md) - object the event handler is assigned to
- airportID: [Number](../topics/Number.md) or [Object](../topics/Object.md) - ID of the airport or aircraft carrier object
- isCarrier: [Boolean](../topics/Boolean.md) - true if landing on aircraft carrier
#### LandingCanceled (Arma 3 v1.70)
Global Argument
Triggered when AI pilot landing is cancelled (for example new order received to land elsewhere).
The exact moment of triggering coincides with retracting of the gear ("Gear" EH).
**Note**: Does not trigger if player switches off auto-pilot. Canceled is spelled with one `L`
```sqf
this addEventHandler ["LandingCanceled", {
params ["_plane", "_airportID", "_isCarrier"];
}];
```
- plane: [Object](../topics/Object.md) - object the event handler is assigned to
- airportID: [Number](../topics/Number.md) or [Object](../topics/Object.md) - ID of the airport or aircraft carrier object (-1 no airport)
- isCarrier: [Boolean](../topics/Boolean.md) - [true](../commands/true.md) if landing on aircraft carrier
#### LaserTargetChanged (Arma 3 v2.22)
Triggered when the laser target changes.
```sqf
this addEventHandler ["LaserTargetChanged", {
params ["_unit", "_laserTarget", "_designatedTarget", "_turretPath"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- laserTarget: [Object](../topics/Object.md) - the laser target entity that got created at impact point
- designatedTarget: [Object](../topics/Object.md) - the object that is targeted by the laser
- turretPath: Turret Path - the path to the turret that activated the laser. It is empty when the event is triggered by a unit
#### LeaningChanged (Arma 3 v2.18)
Global Argument
Triggered when a soldier leaning factor is changed between -1 (extreme left), 0 (not leaning) and 1 (extreme right)
```sqf
this addEventHandler ["LeaningChanged", {
params ["_unit", "_newLeaning", "_oldLeaning"];
}];
```
- unit: [Object](../topics/Object.md) - soldier
- newLeaning: [Number](../topics/Number.md) from -1 to 1
- oldLeaning: [Number](../topics/Number.md) from -1 to 1
#### Local (Entity)
Global Argument
Triggers when locality of object in MP is changed. The event handler only triggers on the computers that are directly involved in change of locality.
So if EH is added to every computer on network, it will only trigger on 2 computers, on the computer that receives ownership of the object (new owner), in which case [_this](../topics/Magic_Variables.md#this) [select](../commands/select.md) 1 will be [true](../commands/true.md),
and on the computer from which ownership is transferred (old owner), in which case [_this](../topics/Magic_Variables.md#this) [select](../commands/select.md) 1 will be [false](../commands/false.md).
```sqf
this addEventHandler ["Local", {
params ["_entity", "_isLocal"];
}];
```
- entity: [Object](../topics/Object.md) - the object that changed locality
- isLocal: [Boolean](../topics/Boolean.md) - if the object is local on given computer
#### MagazineReloading (Arma 3 v2.18)
Local Argument
Triggers when reloading starts.
```sqf
this addEventHandler ["MagazineReloading", {
params ["_unit", "_weapon", "_muzzle", "_magazine", "_magazineClass", "_ammoCount", "_magazineID", "_magazineCreator"];
}];
```
- unit: [Object](../topics/Object.md) - unit or vehicle to which EH is assigned
- weapon: [String](../topics/String.md) - weapon that got unloaded
- muzzle: [String](../topics/String.md) - weapon's muzzle that got unloaded
- magazine: [Array](../topics/Array.md) - magazine info in format [magazineClass, ammoCount, magazineID, magazineCreator], where:
- magazineClass: [String](../topics/String.md) - class name of the magazine
- ammoCount: [Number](../topics/Number.md) - amount of ammo in magazine
- magazineID: [Number](../topics/Number.md) - global magazine id
- magazineCreator: [Number](../topics/Number.md) - owner of the magazine creator
#### MagazineUnloaded (Arma 3 v2.18)
Local Argument
Triggers when a magazine is removed from a weapon manually or via script.
```sqf
this addEventHandler ["MagazineUnloaded", {
params ["_unit", "_weapon", "_muzzle", "_magazine", "_magazineClass", "_ammoCount", "_magazineID", "_magazineCreator"];
}];
```
- unit: [Object](../topics/Object.md) - unit or vehicle to which EH is assigned
- weapon: [String](../topics/String.md) - weapon that got unloaded
- muzzle: [String](../topics/String.md) - weapon's muzzle that got unloaded
- magazine: [Array](../topics/Array.md) - magazine info in format [magazineClass, ammoCount, magazineID, magazineCreator], where:
- magazineClass: [String](../topics/String.md) - class name of the magazine
- ammoCount: [Number](../topics/Number.md) - amount of ammo in magazine
- magazineID: [Number](../topics/Number.md) - global magazine id
- magazineCreator: [Number](../topics/Number.md) - owner of the magazine creator
#### OpticsModeChanged (Arma 3 v2.10)
Local Argument
Triggers everytime a local unit changes optic mode. This could be either through the [setOpticsMode](../commands/setOpticsMode.md) command or by the player switching to the next optic mode using e.g NUM / or Ctrl+RMB.
```sqf
this addEventHandler ["OpticsModeChanged", {
params ["_unit", "_opticsClass", "_newMode", "_oldMode", "_isADS"];
}];
```
- unit: [Object](../topics/Object.md) - the unit
- opticsClass: [String](../topics/String.md)
- newMode: [String](../topics/String.md)
- oldMode: [String](../topics/String.md)
- isADS: [Boolean](../topics/Boolean.md) - if the new view is GUNNER
#### OpticsSwitch (Arma 3 v2.10)
Local Argument
Triggers at the start of the camera transition from GUNNER to INTERNAL/EXTERNAL and vice-versa.
So anytime the right mouse button is pressed and there is a GUNNER view available or are currently in it, this triggers.
Works in vehicles and FFV as well. See also [cameraView](../commands/cameraView.md).
```sqf
this addEventHandler ["OpticsSwitch", {
params ["_unit", "_isADS"];
}];
```
- unit: [Object](../topics/Object.md) - the unit
- isADS: [Boolean](../topics/Boolean.md) - if the new view is GUNNER
#### PathCalculated (Arma 3 v1.94)
Local Argument
Triggers when a path has been calculated for the unit. Works for both agents and normal AI units.
Note that paths to far destinations are typically calculated in segments.
When the unit completes a segment, a new path is calculated and this is continued until the unit reaches its destination.
```sqf
this addEventHandler ["PathCalculated", {
params ["_unit", "_path"];
}];
```
- unit: [Object](../topics/Object.md) - the unit/agent for which the path was calculated
- path: [Array](../topics/Array.md) - the array of positions representing the path (PositionASL)
#### PeriscopeElevationChanged (Arma 3 v2.00)
Fires every frame during periscope elevation animation.
```sqf
this addEventHandler ["PeriscopeElevationChanged", {
params ["_vehicle", "_turret", "_elevation", "_direction", "_userIsBlocked"];
}];
```
- vehicle: [Object](../topics/Object.md) - the vehicle this EH is assigned to
- turret: [Array](../topics/Array.md) - the turret which periscope is changing elevation
- elevation: [Number](../topics/Number.md) - current periscope elevation (changes with each simulation). See also [periscopeElevation](../commands/periscopeElevation.md), [elevatePeriscope](../commands/elevatePeriscope.md)
- direction: [Number](../topics/Number.md) - 1: moves up, 0: stopped, -1: moves down; when `direction` returns 0, this also means the event handler fired for the last time for this elevation.
- userIsBlocked: [Boolean](../topics/Boolean.md) - whether or not the user ability to override is blocked. See also [periscopeElevation](../commands/periscopeElevation.md), [elevatePeriscope](../commands/elevatePeriscope.md)
#### PostInit (Arma 3 v2.06)
Global Argument
Triggered whenever an entity is created and initialized. Cannot be used in scripts, only inside class Eventhandlers in config.
> [!IMPORTANT]
> It is recommended to use this event handler instead of the [#Init](../topics/Event_Handlers.md#init) one when setting entity textures ([setObjectTexture](../commands/setObjectTexture.md), [BIS_fnc_initVehicle](../functions/BIS_fnc_initVehicle.md) etc) to avoid networking issues.
e.g:
```cpp
postInit = "params ['_entity'];";
```
```cpp
postinit = "params ['_entity']; if (local _entity) then { [_entity, '', [], false] call BIS_fnc_initVehicle };";
```
```sqf
params ["_entity"];
```
- entity: [Object](../topics/Object.md) - object the event handler is assigned to
#### PostReset
**Obsolete** - triggers after PP effects have been reset by the engine.
#### Put (Arma 3 v0.56)
Global Argument
Triggers when a unit puts an item in a container.
Arma 3 v2.14 This event handler can be added to a container.
```sqf
this addEventHandler ["Put", {
params ["_unit", "_container", "_item"];
}];
```
- unit: [Object](../topics/Object.md) - unit who put the item in the container
- container: [Object](../topics/Object.md) - the container into which the item was placed (vehicle, box, etc.)
- item: [String](../topics/String.md) - the class name of the moved item
> [!NOTE]
> This EH could also trigger when unit replaces magazine in weapon with another magazine from unit containers (uniform, vest, backpack) during reload.
#### PylonChanged (Arma 3 v2.20)
Local Argument
Triggers when an aircraft's pylon changes magazine type:
```sqf
vehicle player addEventHandler ["PylonChanged", {
params ["_vehicle", "_pylonIndex", "_oldMagazine", "_newMagazine"];
}];
```
- vehicle: [Object](../topics/Object.md)
- pylonIndex: [Number](../topics/Number.md)
- oldMagazine: [String](../topics/String.md)
- newMagazine: [String](../topics/String.md)
> [!IMPORTANT]
> This event generally triggers **twice** for a swap, first unload then load, e.g:
>
> ```sqf
> // [myVehicle, 1, "oldMagClass", ""]
> // [myVehicle, 1, "", "newMagClass"]
> ```
#### Reloaded (Arma 3 v1.58)
Local Argument
Triggers once a weapon is reloaded with a new magazine. For more information, see Reloaded.
```sqf
this addEventHandler ["Reloaded", {
params ["_unit", "_weapon", "_muzzle", "_newMagazine", "_oldMagazine"];
}];
```
- unit: [Object](../topics/Object.md) - unit or vehicle to which EH is assigned
- weapon: [String](../topics/String.md) - weapon that got reloaded
- muzzle: [String](../topics/String.md) - weapon's muzzle that got reloaded
- newMagazine: [Array](../topics/Array.md) - new magazine info
- oldMagazine: [Array](../topics/Array.md) or [Nothing](../topics/Nothing.md) - old magazine info
#### Respawn
Local Argument
Triggered when a unit respawns.
```sqf
this addEventHandler ["Respawn", {
params ["_unit", "_corpse"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- corpse: [Object](../topics/Object.md) - object the event handler was assigned to, aka the corpse/unit player was previously controlling
#### RopeAttach (Arma 3 v1.34)
Triggered when a rope is attached to an object.
In the case of sling loading, this event handler must be assigned to the helicopter and will trigger for each attached rope.
```sqf
this addEventHandler ["RopeAttach", {
params ["_object1", "_rope", "_object2"];
}];
```
- object1: [Object](../topics/Object.md) - object to which the event handler is assigned.
- rope: [Object](../topics/Object.md) - the rope being attached between object 1 and object 2.
- object2: [Object](../topics/Object.md) - the object that is being attached to object 1 via rope.
#### RopeBreak (Arma 3 v1.34)
Triggered when a rope is detached from an object.
In the case of sling loading, this event handler must be assigned to the helicopter and will trigger for each detached rope.
```sqf
this addEventHandler ["RopeBreak", {
params ["_object1", "_rope", "_object2"];
}];
```
- object1: [Object](../topics/Object.md) - object to which the event handler is assigned.
- rope: [Object](../topics/Object.md) - the rope that connected object 1 and object 2.
- object2: [Object](../topics/Object.md) - the object that was connected to object 1 with a rope.
#### SeatSwitched (Arma 3 v1.50)
Global Argument
Triggered when unit changes seat within vehicle. EH returns both units switching seats.
If switching seats with an empty seat, one of the returned units will be [objNull](../commands/objNull.md).
The new position can be obtained with [assignedVehicleRole](../commands/assignedVehicleRole.md).
This EH must be assigned to a vehicle.
```sqf
this addEventHandler ["SeatSwitched", {
params ["_vehicle", "_unit1", "_unit2"];
}];
```
- vehicle: [Object](../topics/Object.md) - vehicle to which the event handler is assigned.
- unit1: [Object](../topics/Object.md) - unit switching seat.
- unit2: [Object](../topics/Object.md) - unit switching seat.
#### SeatSwitchedMan (Arma 3 v1.58)
Global Argument
Triggered when unit changes seat within vehicle. EH returns both units switching seats.
If switching seats with an empty seat, one of the returned units will be [objNull](../commands/objNull.md).
The new position can be obtained with [assignedVehicleRole](../commands/assignedVehicleRole.md) . This EH must be assigned to a unit and not a vehicle.
This EH is persistent and will be transferred to the new unit after respawn, but only if it was assigned where unit was local.
```sqf
this addEventHandler ["SeatSwitchedMan", {
params ["_unit1", "_unit2", "_vehicle"];
}];
```
- unit1: [Object](../topics/Object.md) - unit switching seat.
- unit2: [Object](../topics/Object.md) - unit with which unit1 is switching seat.
- vehicle: [Object](../topics/Object.md) - vehicle where switching seats is taking place.
#### SelectedActionChanged
RTM helicopter user action event
```sqf
this addEventHandler ["SelectedActionChanged", {
params ["_caller", "_target", "_enumNumber", "_actionId"];
}];
```
> [!IMPORTANT]
> Limited or non-existent functionality.
#### SelectedActionPerformed
RTM helicopter user action event
```sqf
this addEventHandler ["SelectedActionPerformed", {
params ["_caller", "_target", "_enumNumber", "_actionId"];
}];
```
> [!IMPORTANT]
> Limited or non-existent functionality.
#### SelectedRotorLibActionChanged
RTM helicopter user action event
```sqf
this addEventHandler ["SelectedRotorLibActionChanged", {
params ["_caller", "_target", "_enumNumber", "_actionId"];
}];
```
> [!IMPORTANT]
> Limited or non-existent functionality.
#### SelectedRotorLibActionPerformed
RTM helicopter user action event
```sqf
this addEventHandler ["SelectedRotorLibActionPerformed", {
params ["_caller", "_target", "_enumNumber", "_actionId"];
}];
```
> [!IMPORTANT]
> Works only for key press combination RCtrl+W, which is the binding for helicopter wheels brakes.
> It fires with or without Advanced Flight Model enabled. The enum number returned is 4 and 5, probably because the enum is structured like this:
> - 0: HelicopterAutoTrimOn
> - 1: HelicopterAutoTrimOff
> - 2: HelicopterTrimOn
> - 3: HelicopterTrimOff
> - 4: WheelsBrakeOn
> - 5: WheelsBrakeOff
#### SlotItemChanged (Arma 3 v2.14)
Global Argument
Triggered when any of the following slots get assigned or unassigned: *Items* - Map, GPS, Radio, Watch, Compass, Helmet, Goggles, NVG; *Weapon* - Binoculars; *Containers* - Uniform, Vest, Backpack.
```sqf
this addEventHandler ["SlotItemChanged", {
params ["_unit", "_name", "_slot", "_assigned", "_weapon"];
}];
```
- unit: [Object](../topics/Object.md) - unit EH assigned to.
- name: [String](../topics/String.md) - name of the item/weapon/container (see [getSlotItemName](../commands/getSlotItemName.md)).
- slot: [Number](../topics/Number.md) - slot id (see [getSlotItemName](../commands/getSlotItemName.md)).
- assigned: [Boolean](../topics/Boolean.md) - [true](../commands/true.md) assign action, [false](../commands/false.md) unassign action.
- Arma 3 v2.18 weapon: [String](../topics/String.md) - name of weapon in event that slot changed is a weapon attachment slot
#### SoundPlayed (Arma 3 v0.56)
Local Argument
Triggered when player is making noises when injured or fatigued for example. The number param passed to the EH code points to the sound origin:
1. Breath
1. Breath Injured
1. Breath Scuba
1. Injured
1. Pulsation
1. Hit Scream
1. Burning
1. Drowning
1. Drown
1. Gasping
1. Stabilizing
1. Healing
1. Healing With Medikit
1. Recovered
1. Breath Held
```sqf
this addEventHandler ["SoundPlayed", {
params ["_unit", "_soundID"];
}];
```
- unit: [Object](../topics/Object.md) - unit to which the event handler is assigned
- soundID: [Number](../topics/Number.md) - sound origin
> [!NOTE]
> Since Arma 3 v2.12 returning a [Number](../topics/Number.md) from last added EH in range from 0 to 5 will alter the volume of played sound from mute to max volume.
#### Suppressed (Arma 3 v2.02)
Local Argument
Triggers when enemy projectile is passing by closer than defined suppression radius ammo value in config.
Can be made to trigger for the same side if the side is set as enemy to itself (with [setFriend](../commands/setFriend.md)). For more information see Arma 3: Suppression.
```sqf
this addEventHandler ["Suppressed", {
params ["_unit", "_distance", "_shooter", "_instigator", "_ammoObject", "_ammoClassName", "_ammoConfig"];
}];
```
- unit: [Object](../topics/Object.md) - unit to which the event is assigned
- distance: [Number](../topics/Number.md) - distance of the projectile pass-by
- shooter: [Object](../topics/Object.md) - who (or what) fired - vehicle or drone
- instigator: [Object](../topics/Object.md) - who pressed the trigger. Instigator is different from the shooter when player is operator of UAV for example
- ammoObject: [Object](../topics/Object.md) - the ammunition itself
- ammoClassName: [String](../topics/String.md) - the ammunition's classname
- ammoConfig: [Config](../topics/Config.md) - the ammunition's CfgAmmo config path
#### Take (Arma 3 v0.56)
Global Argument
Triggers when a unit takes an item from a container.
Arma 3 v2.14 This event handler can be added to a container.
```sqf
this addEventHandler ["Take", {
params ["_unit", "_container", "_item"];
}];
```
- unit: [Object](../topics/Object.md) - unit who took the item from the container
- container: [Object](../topics/Object.md) - the container from which the item was taken (vehicle, box, etc.)
- item: [String](../topics/String.md) - the class name of the taken item
> [!NOTE]
> This EH could also trigger when unit replaces magazine in weapon with another magazine from unit containers (uniform, vest, backpack) during reload.
#### TaskSetAsCurrent (Arma 3 v1.32)
Triggers when player's current task changes
```sqf
this addEventHandler ["TaskSetAsCurrent", {
params ["_unit", "_task"];
}];
```
- unit: [Object](../topics/Object.md) - the player to whom the event handler is assigned
- task: [Task](../topics/Task.md) - the new current task
#### TurnIn (Arma 3 v1.66)
Triggers when member of crew in a vehicle uses Turn In [action](../commands/action.md)
```sqf
this addEventHandler ["TurnIn", {
params ["_vehicle", "_unit", "_turret"];
}];
```
- vehicle: [Object](../topics/Object.md) - the vehicle the event handler is assigned to
- unit: [Object](../topics/Object.md) - the unit performing the Turn In action
- turret: [Array](../topics/Array.md) - turret path
#### TurnOut (Arma 3 v1.66)
Triggers when member of crew in a vehicle uses Turn Out [action](../commands/action.md)
```sqf
this addEventHandler ["TurnOut", {
params ["_vehicle", "_unit", "_turret"];
}];
```
- vehicle: [Object](../topics/Object.md) - the vehicle the event handler is assigned to
- unit: [Object](../topics/Object.md) - the unit performing the Turn Out action
- turret: [Array](../topics/Array.md) - turret path
#### VisionModeChanged (Arma 3 v2.08)
Triggers when the assigned vehicle/unit's vision mode has changed.
```sqf
player addEventHandler ["VisionModeChanged", {
params ["_person", "_visionMode", "_TIindex", "_visionModePrev", "_TIindexPrev", "_vehicle", "_turret"];
}];
```
- person: [Object](../topics/Object.md) - unit for whom the vision mode changes
- visionMode: [Number](../topics/Number.md) - [vision mode index](../commands/currentVisionMode.md)
- TIindex: [Number](../topics/Number.md) - [thermal vision mode index](../commands/setCamUseTI.md); will return -1 when *visionMode* is not 2
- visionModePrev: [Number](../topics/Number.md) - last vision mode
- TIindexPrev: [Number](../topics/Number.md) - last TI mode; will return -1 when *visionModePrev* is not 2
- vehicle: [Object](../topics/Object.md) - if unit is in a vehicle or controlling a UAV, this will be the vehicle
- turret: [Array](../topics/Array.md) - turret path to the turret occupied by the unit, or [] if not on turret
#### WeaponAssembled
Global Argument
Triggers when a weapon gets assembled. EH must be attached to the unit and not the weapon.
```sqf
this addEventHandler ["WeaponAssembled", {
params ["_unit", "_weapon", "_primaryBag", "_secondaryBag"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- weapon: [Object](../topics/Object.md) - object of the assembled weapon
- Arma 3 v2.18 primaryBag: [Object](../topics/Object.md) - primary bag (just before it is deleted)
- Arma 3 v2.18 secondaryBag: [Object](../topics/Object.md) - secondary bag (just before it is deleted)
#### WeaponChanged (Arma 3 v2.18)
Fires on weapon switch and firemode switch. Does not fire for player units inside vehicles (but does fire for vehicles with players in them).
The locality is unknown, but it is known that this EH behaves like [currentWeapon](../commands/currentWeapon.md), [currentWeaponMode](../commands/currentWeaponMode.md) and [currentMuzzle](../commands/currentMuzzle.md) in terms of locality.
Arma 3 v2.22 Fires for "Throw" muzzle changes too.
```sqf
this addEventHandler ["WeaponChanged", {
params ["_object", "_oldWeapon", "_newWeapon", "_oldMode", "_newMode", "_oldMuzzle", "_newMuzzle", "_turretIndex"];
}];
```
- object: [Object](../topics/Object.md) - the unit or vehicle the event handler is assigned to
- oldWeapon: [String](../topics/String.md) - the class name of the previous weapon
- newWeapon: [String](../topics/String.md) - the class name of the new weapon (same as [currentWeapon](../commands/currentWeapon.md))
- oldMode: [String](../topics/String.md) - the previous weapon mode
- newMode: [String](../topics/String.md) - the new weapon mode (same as [currentWeaponMode](../commands/currentWeaponMode.md))
- oldMuzzle: [String](../topics/String.md) - the previous weapon muzzle
- newMuzzle: [String](../topics/String.md) - the new weapon muzzle (same as [currentMuzzle](../commands/currentMuzzle.md))
- turretIndex: [Array](../topics/Array.md) format Turret Path - the turret path, or empty array if `object` is not a transport vehicle
#### WeaponDeployed (Arma 3 v1.44)
Global Argument
Triggers when the deployed state of a weapon or bipod changes.
**Note:** A weapon cannot be rested and deployed at the same time.
```sqf
this addEventHandler ["WeaponDeployed", {
params ["_unit", "_isDeployed"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- isDeployed: [Boolean](../topics/Boolean.md) - true if deployed
#### WeaponDisassembled
Global Argument
Triggers when a weapon gets disassembled. EH must be attached to the unit and not the weapon.
**Note:** As of Arma 3 v1.32, this event does not fire if the weapon is not local.
```sqf
this addEventHandler ["WeaponDisassembled", {
params ["_unit", "_primaryBag", "_secondaryBag", "_weapon"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- primaryBag: [Object](../topics/Object.md) - first backpack object which was weapon disassembled into
- secondaryBag: [Object](../topics/Object.md) - second backpack object which was weapon disassembled into
- Arma 3 v2.18 weapon: [Object](../topics/Object.md) - disassembled weapon (just before it is moved out of the world)
#### WeaponRested (Arma 3 v1.44)
Local Argument
Triggers when weapon rested state changes (weapon near a surface that can provide weapon support).
**Note:** A weapon cannot be rested and deployed at the same time.
```sqf
this addEventHandler ["WeaponRested", {
params ["_unit", "_isRested"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- isRested: [Boolean](../topics/Boolean.md) - true if rested
### Multiplayer Event Handlers
Global object event handler, executed on every connected machine.
Commands:
- [addMPEventHandler](../commands/addMPEventHandler.md)
- [removeMPEventHandler](../commands/removeMPEventHandler.md)
- [removeAllMPEventHandlers](../commands/removeAllMPEventHandlers.md)
> [!IMPORTANT]
> A Multiplayer Event Handler is **not** saved in a save file and therefore will not be restored on load - use it accordingly.
#### MPHit
Global ArgumentGlobal Effect
Triggered when the unit is hit/damaged. EH can be added on any machine and EH code will trigger globally on every connected client and server.
This EH is clever enough to be triggered globally only once even if added on all clients or a single client that is then disconnected, EH will still trigger globally only once.
Is *not* always triggered when unit is killed by a hit.
Most of the time only the [killed](../topics/Event_Handlers.md#killed) event handler is triggered when a unit dies from a hit.
The hit EH will not necessarily fire if only minor damage occurred (e.g. firing a bullet at a tank), even though the damage increased.
Can also trigger several times for an explosion (direct and indirect damage). Does not fire when a unit is set to [allowDamage](../commands/allowDamage.md) [false](../commands/false.md).
However it will fire with "HandleDamage" EH added alongside stopping unit from taking damage (`unit addEventHandler ["HandleDamage", { 0 }];`.
Will not trigger once the unit is dead.
**Note:** call a function from the MPHit EH code space rather than defining the full code in there directly.
The reason is the code space will be transferred over network on each event activation - so keep the data as small as possible!
```sqf
this addMPEventHandler ["MPHit", {
params ["_unit", "_causedBy", "_damage", "_instigator"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- causedBy: [Object](../topics/Object.md) - object that caused the damage. Contains the unit itself in case of collisions.
- damage: [Number](../topics/Number.md) - level of damage caused by the hit
- Arma 3 v1.66 instigator: [Object](../topics/Object.md) - person who pulled the trigger
#### MPKilled
Global ArgumentGlobal Effect
Triggered when the unit is killed. EH can be added on any machine and EH code will trigger globally **on every connected client and server**.
This EH has a safeguard measure so that even if it's added on all clients or a single client that is then disconnected, EH will still trigger globally only once per client.
```sqf
this addMPEventHandler ["MPKilled", {
params ["_unit", "_killer", "_instigator", "_useEffects"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- killer: [Object](../topics/Object.md) - object that killed the unit. Contains the unit itself in case of collisions
- Arma 3 v1.66 instigator: [Object](../topics/Object.md) - person who pulled the trigger
- Arma 3 v1.68 useEffects: [Boolean](../topics/Boolean.md) - same as *useEffects* in [setDamage](../commands/setDamage.md) alt syntax
#### MPRespawn
Global ArgumentLocal Effect
Triggered when a unit, it is assigned to, respawns. This EH does not work as one would expect MP EH should work like.
It is only triggered on one machine where the unit it was assigned to is [local](../topics/Multiplayer_Scripting.md#locality).
The only difference between **Respawn** and **MPRespawn** is that **MPRespawn** can be assigned from anywhere while **Respawn** requires the unit to be local.
MPRespawn EH expects the EH code to return an array in [Position](../topics/Position.md) format which will be used to place the respawned unit at the desired coordinates.
For example: `player addMPEventHandler ["MPRespawn", { [1234, 1234, 0] }];` will place player at [1234,1234,0] immediately on respawn.
```sqf
this addMPEventHandler ["MPRespawn", {
params ["_unit", "_corpse"];
}];
```
- unit: [Object](../topics/Object.md) - object the event handler is assigned to
- corpse: [Object](../topics/Object.md) - object the event handler was assigned to, aka the corpse/unit player was previously controlling.
### Mission Event Handlers
Mission Event Handlers are specific EHs that are anchored to the running mission and automatically removed when mission is over.
Commands:
- [addMissionEventHandler](../commands/addMissionEventHandler.md)
- [removeMissionEventHandler](../commands/removeMissionEventHandler.md)
> [!NOTE]
> See [Arma 3: Mission Event Handlers](../topics/Mission_Event_Handlers.md).
### Curator Event Handlers (Arma 3 v1.16)
Local ArgumentLocal Effect
[Arma 3: Curator](../topics/Curator.md) Event Handlers are also added with the [addEventHandler](../commands/addEventHandler.md) command. They are executed only where the curator is local - on the machine that is in control of it.
> [!IMPORTANT]
> These Event Handlers must be added to the curator object/module, **not** the player!
Commands:
- [addEventHandler](../commands/addEventHandler.md)
- [removeEventHandler](../commands/removeEventHandler.md)
- [removeAllEventHandlers](../commands/removeAllEventHandlers.md)
#### CuratorFeedbackMessage
Local Argument
Triggered when curator attempts invalid action in curator interface.
Each error has its own unique ID, recognized values are:
- 003 - when trying to teleport camera outside of [curatorCameraArea](../commands/curatorCameraArea.md)
- 101 - trying to place an object when placing is disabled using [setCuratorCoef](../commands/setCuratorCoef.md) "place"
- 102 - trying to place an object which is too expensive (cost set in *curatorObjectRegistered* multiplied by [setCuratorCoef](../commands/setCuratorCoef.md) "place" is larger than [curatorPoints](../commands/curatorPoints.md))
- 103 - trying to place an object outside of [curatorEditingArea](../commands/curatorEditingArea.md)
- 104 - items of a placed composition were skipped / could not be placed (since Arma 3 v2.06)
- 201 - trying to place a waypoint when waypoint placing is disabled
- 202 - trying to place a waypoint which is too expensive (cost set by [setCuratorWaypointCost](../commands/setCuratorWaypointCost.md) multiplied by [setCuratorCoef](../commands/setCuratorCoef.md) "place" is larger than [curatorPoints](../commands/curatorPoints.md))
- 206 - trying to place a waypoint when no AI unit is selected
- 301 - trying to move or rotate an entity when editing is disabled using [setCuratorCoef](../commands/setCuratorCoef.md) "edit"
- 302 - trying to move or rotate an entity when it is too expensive (entity cost multiplied by [setCuratorCoef](../commands/setCuratorCoef.md) "edit" is larger than [curatorPoints](../commands/curatorPoints.md))
- 303 - trying to move an entity outside of [curatorEditingArea](../commands/curatorEditingArea.md)
- 304 - trying to move or rotate an entity which is outside of [curatorEditingArea](../commands/curatorEditingArea.md)
- 307 - trying to move or rotate a player (players cannot be manipulated with)
- 401 - trying to delete an entity when deleting is disabled using [setCuratorCoef](../commands/setCuratorCoef.md) "delete"
- 402 - trying to delete an entity which is too expensive (cost multiplied by [setCuratorCoef](../commands/setCuratorCoef.md) "delete" is larger than [curatorPoints](../commands/curatorPoints.md))
- 404 - trying to delete an entity which is outside of [curatorEditingArea](../commands/curatorEditingArea.md)
- 405 - trying to delete an entity which has [non-editable](../commands/curatorEditableObjects.md) crew in it
- 407 - trying to delete a player (players cannot be manipulated with)
- 501 - trying to destroy an object when destroying is disabled using [setCuratorCoef](../commands/setCuratorCoef.md) "destroy"
- 502 - trying to destroy an object which is too expensive (cost multiplied by [setCuratorCoef](../commands/setCuratorCoef.md) "destroy" is larger than [curatorPoints](../commands/curatorPoints.md))
- 504 - trying to destroy an object which is outside of [curatorEditingArea](../commands/curatorEditingArea.md)
- 505 - trying to destroy an object which has [non-editable](../commands/curatorEditableObjects.md) crew in it
- 506 - trying to destroy an object when no object is selected
- 507 - trying to destroy a player (players cannot be manipulated with)
```sqf
this addEventHandler ["CuratorFeedbackMessage", {
params ["_curator", "_errorID"];
}];
```
- curator: [Object](../topics/Object.md)
- errorID: [Number](../topics/Number.md)
#### CuratorGroupDoubleClicked
Local Argument
Triggered when a group is double-clicked on in curator interface.
```sqf
this addEventHandler ["CuratorGroupDoubleClicked", {
params ["_curator", "_group"];
}];
```
- curator: [Object](../topics/Object.md)
- group: [Group](../topics/Group.md)
#### CuratorGroupPlaced
Local Argument
Triggered when new group is placed in curator interface.
```sqf
this addEventHandler ["CuratorGroupPlaced", {
params ["_curator", "_group"];
}];
```
- curator: [Object](../topics/Object.md)
- group: [Group](../topics/Group.md)
#### CuratorGroupSelectionChanged
Local Argument
Triggered when a group is selected in curator interface.
```sqf
this addEventHandler ["CuratorGroupSelectionChanged", {
params ["_curator", "_group"];
}];
```
- curator: [Object](../topics/Object.md)
- group: [Group](../topics/Group.md)
#### CuratorMarkerDeleted
Local Argument
Triggered when a marker is deleted in curator interface.
```sqf
this addEventHandler ["CuratorMarkerDeleted", {
params ["_curator", "_marker"];
}];
```
- curator: [Object](../topics/Object.md)
- marker: [String](../topics/String.md)
#### CuratorMarkerDoubleClicked
Local Argument
Triggered when a marker is double-clicked on in curator interface.
```sqf
this addEventHandler ["CuratorMarkerDoubleClicked", {
params ["_curator", "_marker"];
}];
```
- curator: [Object](../topics/Object.md)
- marker: [String](../topics/String.md)
#### CuratorMarkerEdited
Local Argument
Triggered when a marker is moved in curator interface.
```sqf
this addEventHandler ["CuratorMarkerEdited", {
params ["_curator", "_marker"];
}];
```
- curator: [Object](../topics/Object.md)
- marker: [String](../topics/String.md)
#### CuratorMarkerPlaced
Local Argument
Triggered when new marker is placed in curator interface.
```sqf
this addEventHandler ["CuratorMarkerPlaced", {
params ["_curator", "_marker"];
}];
```
- curator: [Object](../topics/Object.md)
- marker: [String](../topics/String.md)
#### CuratorMarkerSelectionChanged
Local Argument
Triggered when a marker is selected in curator interface.
```sqf
this addEventHandler ["CuratorMarkerSelectionChanged", {
params ["_curator", "_marker"];
}];
```
- curator: [Object](../topics/Object.md)
- marker: [String](../topics/String.md)
#### CuratorObjectDeleted
Local Argument
Triggered when an object is deleted in curator interface.
```sqf
this addEventHandler ["CuratorObjectDeleted", {
params ["_curator", "_entity"];
}];
```
- curator: [Object](../topics/Object.md)
- entity: [Object](../topics/Object.md)
#### CuratorObjectDoubleClicked
Local Argument
Triggered when an object is double-clicked on in curator interface.
```sqf
this addEventHandler ["CuratorObjectDoubleClicked", {
params ["_curator", "_entity"];
}];
```
- curator: [Object](../topics/Object.md)
- entity: [Object](../topics/Object.md)
#### CuratorObjectEdited
Local Argument
Triggered when an object is moved or rotated in curator interface.
```sqf
this addEventHandler ["CuratorObjectEdited", {
params ["_curator", "_entity"];
}];
```
- curator: [Object](../topics/Object.md)
- entity: [Object](../topics/Object.md)
#### CuratorObjectPlaced
Local Argument
Triggered when new object is placed in curator interface.
This event handler will trigger individually for each unit in a placed group - excluding the crew in vehicles.
```sqf
this addEventHandler ["CuratorObjectPlaced", {
params ["_curator", "_entity"];
}];
```
- curator: [Object](../topics/Object.md)
- entity: [Object](../topics/Object.md)
#### CuratorObjectRegistered
Local Argument
Triggered when player enters curator interface. Assign curator cost to every object in the game.
This is the primary method that a mission designer can use to limit the objects a curator can place.
> [!NOTE]
> See [Curator#Manual Assigning](../topics/Curator.md#manual-assigning).
```sqf
this addEventHandler ["CuratorObjectRegistered", {
params ["_curator", "_input"];
}];
```
- curator: [Object](../topics/Object.md)
- input: [Array](../topics/Array.md) of [String](../topics/String.md)s - all CfgVehicles classes
#### CuratorObjectSelectionChanged
Local Argument
Triggered when an object is selected in curator interface.
```sqf
this addEventHandler ["CuratorObjectSelectionChanged", {
params ["_curator", "_entity"];
}];
```
- curator: [Object](../topics/Object.md)
- entity: [Object](../topics/Object.md)
#### CuratorPinged
Local Argument
Triggered when a player pings his curator(s) by pressing the *Zeus* key.
```sqf
this addEventHandler ["CuratorPinged", {
params ["_curator", "_player"];
}];
```
- curator: [Object](../topics/Object.md)
- player: [Object](../topics/Object.md)
#### CuratorSelectionPresetLoaded (Arma 3 v2.14)
Local Argument
Triggered when a selection preset is loaded using the respective number key or through script.
```sqf
this addEventHandler ["CuratorSelectionPresetLoaded", {
params ["_curator", "_numkey"];
}];
```
- curator: [Object](../topics/Object.md)
- numkey: [Number](../topics/Number.md)
#### CuratorSelectionPresetSaved (Arma 3 v2.14)
Local Argument
Triggered when a selection preset is saved using the respective CTRL + number key or set through script.
```sqf
this addEventHandler ["CuratorSelectionPresetSaved", {
params ["_curator", "_numkey"];
}];
```
- curator: [Object](../topics/Object.md)
- numkey: [Number](../topics/Number.md)
#### CuratorWaypointDeleted
Local Argument
Triggered when a waypoint is deleted in curator interface.
```sqf
this addEventHandler ["CuratorWaypointDeleted", {
params ["_curator", "_waypoint"];
}];
```
- curator: [Object](../topics/Object.md)
- waypoint: [Array](../topics/Array.md)
#### CuratorWaypointDoubleClicked
Local Argument
Triggered when a waypoint is double-clicked on in curator interface.
```sqf
this addEventHandler ["CuratorWaypointDoubleClicked", {
params ["_curator", "_waypoint"];
}];
```
- curator: [Object](../topics/Object.md)
- waypoint: [Array](../topics/Array.md)
#### CuratorWaypointEdited
Local Argument
Triggered when a waypoint is moved in curator interface.
```sqf
this addEventHandler ["CuratorWaypointEdited", {
params ["_curator", "_group", "_waypointID"];
}];
```
- curator: [Object](../topics/Object.md)
- group: [Group](../topics/Group.md)
- waypointID: [Number](../topics/Number.md)
#### CuratorWaypointPlaced
Local Argument
Triggered when new waypoint is placed in curator interface.
```sqf
this addEventHandler ["CuratorWaypointPlaced", {
params ["_curator", "_group", "_waypointID"];
}];
```
- curator: [Object](../topics/Object.md)
- group: [Group](../topics/Group.md)
- waypointID: [Number](../topics/Number.md)
#### CuratorWaypointSelectionChanged
Local Argument
Triggered when a waypoint is selected in curator interface.
```sqf
this addEventHandler ["CuratorWaypointSelectionChanged", {
params ["_curator", "_waypoint"];
}];
```
- curator: [Object](../topics/Object.md)
- waypoint: [Array](../topics/Array.md)
### UserAction Event Handlers (Arma 3 v2.06)
UserAction Event Handlers are events that trigger on user action.
Commands:
- [addUserActionEventHandler](../commands/addUserActionEventHandler.md)
- [removeUserActionEventHandler](../commands/removeUserActionEventHandler.md)
> [!NOTE]
> See Arma 3: Modded Keybinding.
#### Activate
```sqf
addUserActionEventHandler ["KeyName", "Activate", {
params ["_activated"];
}];
```
- activated: [Boolean](../topics/Boolean.md) - always returns [true](../commands/true.md)
#### Deactivate
```sqf
addUserActionEventHandler ["KeyName", "Deactivate", {
params ["_activated"];
}];
```
- activated: [Boolean](../topics/Boolean.md) - always returns [false](../commands/false.md)
#### Analog
```sqf
addUserActionEventHandler ["KeyName", "Analog", {
params ["_value"];
}];
```
- value: [Number](../topics/Number.md) - input device's analog value
### Projectile Event Handlers (Arma 3 v2.10)
Commands:
- [addEventHandler](../commands/addEventHandler.md)
- [removeEventHandler](../commands/removeEventHandler.md)
- [removeAllEventHandlers](../commands/removeAllEventHandlers.md)
#### Deleted (Projectile)
```sqf
_projectile addEventHandler ["Deleted", {
params ["_projectile"];
}];
```
- projectile: [Object](../topics/Object.md)
#### Deflected
```sqf
_projectile addEventHandler ["Deflected", {
params ["_projectile", "_position", "_velocity", "_hitObject"];
}];
```
- projectile: [Object](../topics/Object.md)
- position: [Array](../topics/Array.md) format [PositionASL](../topics/Position.md#positionasl)
- velocity: [Array](../topics/Array.md) format [Vector3D](../topics/Vector3D.md)
- hitObject: [Object](../topics/Object.md) - the object that deflected the projectile
#### Explode
Local Argument
```sqf
_projectile addEventHandler ["Explode", {
params ["_projectile", "_position", "_velocity"];
}];
```
- projectile: [Object](../topics/Object.md)
- position: [Array](../topics/Array.md) format [PositionASL](../topics/Position.md#positionasl)
- velocity: [Array](../topics/Array.md) format [Vector3D](../topics/Vector3D.md)
#### HitExplosion
```sqf
_projectile addEventHandler ["HitExplosion", {
params ["_projectile", "_hitEntity", "_projectileOwner", "_hitSelections", "_instigator"];
}];
```
- projectile: [Object](../topics/Object.md)
- hitEntity: [Object](../topics/Object.md)
- projectileOwner: [Object](../topics/Object.md)
- hitSelections: [Array](../topics/Array.md) of [Array](../topics/Array.md)s - same list of FireGeometry components that [#HitPart (Entity)](../topics/Event_Handlers.md#hitpart-entity) gets but only contains:
- position: [Array](../topics/Array.md) format [PositionASL](../topics/Position.md#positionasl) - position of impact
- vector: [Array](../topics/Array.md) format [Vector3D](../topics/Vector3D.md) - vector that is orthogonal (perpendicular) to the surface struck. For example, if a wall was hit, vector would be pointing out of the wall at a 90 degree angle
- selection: [String](../topics/String.md) - named selection of the object that was hit, in the FireGeometry LOD.
- radius: [Number](../topics/Number.md) - radius (size) of component hit
- surface: [String](../topics/String.md) - surface type struck
- Arma 3 v2.18 instigator: [Object](../topics/Object.md) - shot instigator
#### HitPart (Projectile)
Triggered when the projectile hits any surface.
```sqf
_projectile addEventHandler ["HitPart", {
params ["_projectile", "_hitEntity", "_projectileOwner", "_pos", "_velocity", "_normal", "_components", "_radius" ,"_surfaceType", "_instigator"];
}];
```
- projectile: [Object](../topics/Object.md)
- hitEntity: [Object](../topics/Object.md)
- projectileOwner: [Object](../topics/Object.md)
- pos: [Array](../topics/Array.md) format [PositionASL](../topics/Position.md#positionasl)
- velocity: [Array](../topics/Array.md) format [Vector3D](../topics/Vector3D.md)
- normal: [Array](../topics/Array.md) format [Vector3D](../topics/Vector3D.md)
- components: [Array](../topics/Array.md) of [String](../topics/String.md)s - the selections that were hit, in the FireGeometry LOD.
- radius: [Number](../topics/Number.md) - radius (size) of the hitPoint
- surfaceType: [String](../topics/String.md)
- Arma 3 v2.18 instigator: [Object](../topics/Object.md) - shot instigator
> [!IMPORTANT]
> This event handler only triggers for direct hits and not splash damage, unlike [#HitPart (Entity)](../topics/Event_Handlers.md#hitpart-entity). For splash damage, use [#HitExplosion](../topics/Event_Handlers.md#hitexplosion).
#### Init (Projectile)
Triggered whenever a projectile is created. Cannot be used in scripts, only inside class Eventhandlers in config.
```cpp
init = "params ['_projectile'];";
```
```sqf
params ["_projectile"];
```
- projectile: [Object](../topics/Object.md) - object the event handler is assigned to
#### MineActivated (Arma 3 v2.14)
Local Argument
Local Effect
```sqf
_projectile addEventHandler ["MineActivated", {
params ["_projectile", "_isActive"];
}];
```
- projectile: [Object](../topics/Object.md)
- isActive: [Boolean](../topics/Boolean.md) - new active state of the mine
#### Penetrated
This event fires as many times as the projectile penetrates a surface.
```sqf
_projectile addEventHandler ["Penetrated", {
params ["_projectile", "_hitObject", "_surfaceType", "_entryPoint", "_exitPoint", "_exitVector"];
}];
```
- projectile: [Object](../topics/Object.md)
- hitObject: [Object](../topics/Object.md)
- surfaceType: [String](../topics/String.md) - see [surfaceType](../commands/surfaceType.md)
- entryPoint: [Array](../topics/Array.md) format [PositionASL](../topics/Position.md#positionasl) - the projectile's entry point
- exitPoint: [Array](../topics/Array.md) format [PositionASL](../topics/Position.md#positionasl) - the projectile's exit point
- exitVector: [Array](../topics/Array.md) format [Vector3D](../topics/Vector3D.md) - speed/angle exit vector (see [vectorMagnitude](../commands/vectorMagnitude.md) to obtain the speed, in metre per second)
#### SubmunitionCreated
This event fires as many times as submunitions are created.
```sqf
_projectile addEventHandler ["SubmunitionCreated", {
params ["_projectile", "_submunitionProjectile", "_position", "_velocity"];
}];
```
- projectile: [Object](../topics/Object.md)
- subMunitionProjectile: [Object](../topics/Object.md)
- position: [Array](../topics/Array.md) format [PositionASL](../topics/Position.md#positionasl)
- velocity: [Array](../topics/Array.md) format [Vector3D](../topics/Vector3D.md)
### Group Event Handlers (Arma 3 v2.10)
Commands:
- [addEventHandler](../commands/addEventHandler.md)
- [removeEventHandler](../commands/removeEventHandler.md)
- [removeAllEventHandlers](../commands/removeAllEventHandlers.md)
#### CombatModeChanged
Triggers when the group's **behaviour** changes (see [behaviour](../commands/behaviour.md), [setBehaviour](../commands/setBehaviour.md))
```sqf
_group addEventHandler ["CombatModeChanged", {
params ["_group", "_newMode"];
}];
```
- group: [Group](../topics/Group.md)
- newMode: [String](../topics/String.md) - see AI Behaviour (**not** Combat Modes!)
#### CommandChanged
```sqf
_group addEventHandler ["CommandChanged", {
params ["_group", "_newCommand"];
}];
```
- group: [Group](../topics/Group.md)
- newCommand: [String](../topics/String.md), can be one of:
| | |
|---|---|
| "NO CMD" | NoCommand |
| "WAIT" | Wait |
| "ATTACK" | Attack |
| "Suppress" | Suppress |
| "HIDE" | Hide |
| "MOVE" | Move |
| "HOOK CARGO" | HookCargo |
| "UNHOOK CARGO" | UnhookCargo |
| "VIV GETIN" | ViVGetIn |
| "VIV GETOUT" | ViVGetOut |
| "VIV UNLOAD" | ViVUnload |
| "HEAL" | Heal |
| "REPAIR" | Repair |
| "REFUEL" | Refuel |
| "REARM" | Rearm |
| "SUPPORT" | Support |
| "JOIN" | Join |
| "GET IN" | GetIn |
| "FIRE" | Fire |
| "GET OUT" | GetOut |
| "STOP" | Stop |
| "EXPECT" | Expect |
| "ACTION" | Action |
| "SCRIPTED" | Scripted |
| "DISMISS" | Dismiss |
| "HEAL SOLDIER" | HealSoldier |
| "PATCH SOLDIER" | PatchSoldier |
| "FIRST AID" | FirstAid |
| "HEAL SELF" | HealSoldierSelf |
| "ATTACK AND FIRE" | AttackAndFire |
| "CARRY SOLDIER" | CarrySoldier |
| "DROP CARRIED" | DropCarried |
| "TAKE BAG" | TakeBag |
| "ASSEMBLE" | Assemble |
| "DISASSEMBLE" | DisAssemble |
| "DROP BAG" | DropBag |
| "OPEN BAG" | OpenBag |
| "IRLASER ON" | IRLaserOn |
| "IRLASER OFF" | IRLaserOff |
| "GUN LIGHT ON" | GunLightOn |
| "GUN LIGHT OFF" | GunLightOff |
| "FIRE AT POSITION" | FireAtPosition |
| "REPAIR VEHICLE" | RepairVehicle |
| "OPEN PARA" | OpenParachute |
| "KEEP DEPTH LEADER" | KeepDepthLeader |
| "KEEP DEPTH UND SURF" | KeepDepthUnderSurface |
| "KEEP DEPTH ABV SURF" | KeepDepthAboveSurface |
| "KEEP DEPTH BOTTOM" | KeepDepthBottom |
| "PUT IN" | PutIn |
| "UNLOAD FROM" | UnloadFrom |
| "USE CONTAINER MAGAZINE" | UseContainerMagazine |
| "ACTIVATE MINE" | ActivateMine |
| "DISABLE MINE" | DisableMine |
#### Deleted (Group)
```sqf
_group addEventHandler ["Deleted", {
params ["_group"];
}];
```
- group: [Group](../topics/Group.md)
#### Empty
```sqf
_group addEventHandler ["Empty", {
params ["_group"];
}];
```
- group: [Group](../topics/Group.md)
#### EnableAttackChanged
```sqf
_group addEventHandler ["EnableAttackChanged", {
params ["_group", "_attackEnabled"];
}];
```
- group: [Group](../topics/Group.md)
- attackEnabled: [Boolean](../topics/Boolean.md)
#### EnemyDetected
```sqf
_group addEventHandler ["EnemyDetected", {
params ["_group", "_newTarget"];
}];
```
- group: [Group](../topics/Group.md)
- newTarget: [Object](../topics/Object.md)
#### Fleeing
```sqf
_group addEventHandler ["Fleeing", {
params ["_group", "_fleeingNow"];
}];
```
- group: [Group](../topics/Group.md)
- fleeingNow: [Boolean](../topics/Boolean.md)
#### FormationChanged
```sqf
_group addEventHandler ["FormationChanged", {
params ["_group", "_newFormation"];
}];
```
- group: [Group](../topics/Group.md)
- newFormation: [String](../topics/String.md) - see [setFormation](../commands/setFormation.md)
#### GroupIdChanged
```sqf
_group addEventHandler ["GroupIdChanged", {
params ["_group", "_newGroupId"];
}];
```
- group: [Group](../topics/Group.md)
- newGroupId: [String](../topics/String.md)
#### KnowsAboutChanged
```sqf
_group addEventHandler ["KnowsAboutChanged", {
params ["_group", "_targetUnit", "_newKnowsAbout", "_oldKnowsAbout"];
}];
```
- group: [Group](../topics/Group.md)
- targetUnit: [Object](../topics/Object.md)
- newKnowsAbout: [Number](../topics/Number.md)
- oldKnowsAbout: [Number](../topics/Number.md)
#### LeaderChanged
```sqf
_group addEventHandler ["LeaderChanged", {
params ["_group", "_newLeader"];
}];
```
- group: [Group](../topics/Group.md)
- newLeader: [Object](../topics/Object.md)
#### Local (Group)
```sqf
_group addEventHandler ["Local", {
params ["_group", "_isLocal"];
}];
```
- group: [Group](../topics/Group.md)
#### SpeedModeChanged
```sqf
_group addEventHandler ["SpeedModeChanged", {
params ["_group", "_newSpeedMode"];
}];
```
- group: [Group](../topics/Group.md)
- newSpeedMode: [String](../topics/String.md) - see [setSpeedMode](../commands/setSpeedMode.md)
#### UnitJoined
```sqf
_group addEventHandler ["UnitJoined", {
params ["_group", "_newUnit"];
}];
```
- group: [Group](../topics/Group.md)
- newUnit: [Object](../topics/Object.md)
#### UnitKilled (Arma 3 v2.18)
Local Argument
Triggered when a unit in the group is killed.
```sqf
_group addEventHandler ["UnitKilled", {
params ["_group", "_unit", "_killer", "_instigator", "_useEffects"];
}];
```
- group: [Group](../topics/Group.md) - the group the event handler is assigned to
- unit: [Object](../topics/Object.md) - the unit that was killed
- killer: [Object](../topics/Object.md) - the object that killed the unit. Contains the unit itself in case of collisions.
- instigator: [Object](../topics/Object.md) - the person who pulled the trigger
- useEffects: [Boolean](../topics/Boolean.md) - same as *useEffects* in [setDamage](../commands/setDamage.md) alt syntax
#### UnitLeft
```sqf
_group addEventHandler ["UnitLeft", {
params ["_group", "_oldUnit"];
}];
```
- group: [Group](../topics/Group.md)
- oldUnit: [Object](../topics/Object.md)
#### VehicleAdded
```sqf
_group addEventHandler ["VehicleAdded", {
params ["_group", "_newVehicle"];
}];
```
- group: [Group](../topics/Group.md)
- newVehicle: [Object](../topics/Object.md)
#### VehicleRemoved
```sqf
_group addEventHandler ["VehicleRemoved", {
params ["_group", "_oldVehicle"];
}];
```
- group: [Group](../topics/Group.md)
- oldVehicle: [Object](../topics/Object.md)
#### WaypointComplete
```sqf
_group addEventHandler ["WaypointComplete", {
params ["_group", "_waypointIndex"];
}];
```
- group: [Group](../topics/Group.md)
- waypointIndex: [Number](../topics/Number.md)
### Game UI Event Handlers
In Game UI Event Handlers trigger when user scrolls or activates in game action menu.
The following mission EHs are available in Arma 3:
- PrevAction - action menu scroll up event
- Action - action menu action event
- NextAction - action menu scroll down event
> [!IMPORTANT]
> Only one event of each kind can exist, adding another will overwrite the existing one.
Commands:
- [inGameUISetEventHandler](../commands/inGameUISetEventHandler.md)
> [!NOTE]
> See Arma 3: Event Handlers/inGameUISetEventHandler.
### Control/Display UI Event Handlers
Commands:
- [ctrlAddEventHandler](../commands/ctrlAddEventHandler.md)
- [ctrlRemoveEventHandler](../commands/ctrlRemoveEventHandler.md)
- [ctrlRemoveAllEventHandlers](../commands/ctrlRemoveAllEventHandlers.md)
- [displayAddEventHandler](../commands/displayAddEventHandler.md)
- [displayRemoveEventHandler](../commands/displayRemoveEventHandler.md)
- [displayRemoveAllEventHandlers](../commands/displayRemoveAllEventHandlers.md)
> [!NOTE]
> See [User Interface Event Handlers](../topics/User_Interface_Event_Handlers.md).
### Music Event Handlers
Music event handler, always executed on the computer where it was added.
> [!NOTE]
> Does not apply to [interface-less](../commands/hasInterface.md) machines (dedicated server, headless client).
Commands:
- [setMusicEventHandler](../commands/setMusicEventHandler.md)
- [addMusicEventHandler](../commands/addMusicEventHandler.md)
- [removeMusicEventHandler](../commands/removeMusicEventHandler.md)
- [removeAllMusicEventHandlers](../commands/removeAllMusicEventHandlers.md)
#### MusicStart (Arma 3 v0.50)
Triggers when [CfgMusic](../topics/Description.ext.md#cfgmusic) sound starts playing, after being executed with [playMusic](../commands/playMusic.md) command.
```sqf
addMusicEventHandler ["MusicStart", {
params ["_musicClassname", "_eventHandlerID", "_currentPosition", "_totalLength"];
}];
```
- musicClassName: [String](../topics/String.md) - [CfgMusic](../topics/Description.ext.md#music) class name of the music that started
- eventHandlerID: [Number](../topics/Number.md) - EH id returned by [addMusicEventHandler](../commands/addMusicEventHandler.md)
- Arma 3 v2.18 currentPosition: [Number](../topics/Number.md) - current playback position in 0...1 range (see also: [getMusicPlayedTime](../commands/getMusicPlayedTime.md))
- Arma 3 v2.18 totalLength: [Number](../topics/Number.md) - track total length in seconds
#### MusicStop (Arma 3 v0.50)
Triggers when [CfgMusic](../topics/Description.ext.md#cfgmusic) sound finished playing, after being executed with [playMusic](../commands/playMusic.md) command.
Arma 3 v2.14 `playMusic ""` triggers this event if a music is currently playing.
```sqf
addMusicEventHandler ["MusicStop", {
params ["_musicClassname", "_eventHandlerID", "_currentPosition", "_totalLength"];
}];
```
- musicClassName: [String](../topics/String.md) - [CfgMusic](../topics/Description.ext.md#music) class name of the music that stopped
- eventHandlerID: [Number](../topics/Number.md) - EH id returned by [addMusicEventHandler](../commands/addMusicEventHandler.md)
- Arma 3 v2.18 currentPosition: [Number](../topics/Number.md) - current playback position in 0...1 range (see also: [getMusicPlayedTime](../commands/getMusicPlayedTime.md))
- Arma 3 v2.18 totalLength: [Number](../topics/Number.md) - track total length in seconds
### Eden Editor
Commands:
- [add3DENEventHandler](../commands/add3DENEventHandler.md)
- [remove3DENEventHandler](../commands/remove3DENEventHandler.md)
- [removeAll3DENEventHandlers](../commands/removeAll3DENEventHandlers.md)
> [!NOTE]
> See also:
> - Arma 3: Event Handlers: Eden Editor
> - its sub-category Object Event Handlers
> - Eden Editor
### Public Variable Broadcast Event
Commands:
- [addPublicVariableEventHandler](../commands/addPublicVariableEventHandler.md)
Triggers when [missionNamespace](../commands/missionNamespace.md) variable EH is associated with is sent over network via [publicVariable](../commands/publicVariable.md), [publicVariableServer](../commands/publicVariableServer.md) or [publicVariableClient](../commands/publicVariableClient.md) commands.
> [!NOTE]
> Unlike with other types of EHs, there is no way of removing added public variable event handler
### Weapon Muzzle Config Events
There are six event handlers that can be set on weapon in config. Their parameters are the same as their entity EH equivalents.
- "Fired" - when muzzle fired - see [Fired](../topics/Event_Handlers.md#fired)
- "Reload" - before muzzle is reloaded - see [MagazineReloading](../topics/Event_Handlers.md#magazinereloading)
- "Reloaded" - after muzzle is reloaded - see [Reloaded](../topics/Event_Handlers.md#reloaded)
- "MagazineUnloaded" - when the magazine is removed - see [MagazineUnloaded](../topics/Event_Handlers.md#magazineunloaded)
- "WeaponChanged" - when the weapon is switched to or from - see [WeaponChanged](../topics/Event_Handlers.md#weaponchanged)
- "SlotItemChanged" - when one of the weapon's attachments is changed - see [SlotItemChanged](../topics/Event_Handlers.md#slotitemchanged)
```cpp
class CfgWeapons
{
class RifleCore;
class TAG_Rifle : RifleCore
{
class EventHandlers
{
fired = "systemChat format ['fired weapon EH output: %1 [time: %2]', _this, time]";
reload = "systemChat format ['reload weapon EH output: %1 [time: %2]', _this, time]";
reloaded = "systemChat format ['reloaded weapon EH output: %1 [time: %2]', _this, time]";
magazineunloaded = "systemChat format ['magazineunloaded weapon EH output: %1 [time: %2]', _this, time]";
slotitemchanged = "systemChat format ['slotitemchanged weapon EH output: %1 [time: %2]', _this, time]";
weaponchanged = "systemChat format ['weaponchanged weapon EH output: %1 [time: %2]', _this, time]";
};
};
};
```
### Ammo Config Events
There are three event handlers that can be set on ammo in config:
- "init" - when the ammo is created, by any mean (fired, created, etc). Params: [shot]
- "fired" - when the ammo is fired (legacy). Params: same as in entity EH "Fired".
- "ammoHit" - when the ammo hits anything (can trigger multiple times). Params: [shot, shooter, hitobj, pos, velocity, hitComponents, [hit, indirecthit, indirecthitrange, explosive, name], normal, explode, instigator (since Arma 3 v2.18)]
```cpp
class CfgAmmo
{
class BulletCore;
class TAG_Bullet : BulletCore
{
class EventHandlers
{
init = "systemChat format ['init ammo EH output: %1 [time: %2]', _this, time]";
fired = "systemChat format ['fired ammo EH output: %1 [time: %2]', _this, time]";
ammoHit = "systemChat format ['ammoHit EH output: %1 [time: %2]', _this, time]";
};
};
};
```
### BI Scripted Events
Commands:
- [BIS_fnc_addScriptedEventHandler](../functions/BIS_fnc_addScriptedEventHandler.md)
- [BIS_fnc_removeScriptedEventHandler](../functions/BIS_fnc_removeScriptedEventHandler.md)
- [BIS_fnc_removeAllScriptedEventHandlers](../functions/BIS_fnc_removeAllScriptedEventHandlers.md)
- [BIS_fnc_callScriptedEventHandler](../functions/BIS_fnc_callScriptedEventHandler.md)
> [!NOTE]
> See also [Arma 3: Scripted Event Handlers](../topics/Scripted_Event_Handlers.md).
Jump to [the top](../topics/Event_Handlers.md#top) of the page
Source: [BI Community Wiki — Arma 3: Event Handlers](https://community.bistudio.com/wiki/Arma_3:_Event_Handlers) (revision 378964).