View source for Arma 3: Event Handlers

__NOEDITSECTION__
{{SideTOC|0.85}}

An event handler (abbreviated to EH) allows you to automatically monitor and then execute custom code upon particular events being triggered.<br>
See also [[Event Scripts]] 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]]
* [[removeEventHandler]]
* [[removeAllEventHandlers]]

=== Standard ===
{{Cfg ref|start}}
{{Cfg ref|abc}}
==== AnimChanged ====
{{EffArg|cmd|arg|global}}<br>
Triggered every time a new animation is started. This EH is only triggered for the 1st animation state in a sequence.
It can be assigned to a remote unit but will only fire on the PC where the actual [[addEventHandler]] command was executed.
<syntaxhighlight lang="cpp">this addEventHandler ["AnimChanged", {
	params ["_unit", "_anim"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* anim: [[String]] - Name of the anim that is started


==== AnimDone ====
{{EffArg|cmd|arg|global}}<br>
Triggered every time an animation is finished. Triggered for all animation states in a sequence.
It can be assigned to a remote unit but will only fire on the PC where the actual [[addEventHandler]] command was executed.
<syntaxhighlight lang="cpp">this addEventHandler ["AnimDone", {
	params ["_unit", "_anim"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* anim: [[String]] - Name of the anim that has been finished


==== AnimStateChanged ====
{{EffArg|cmd|arg|global}}<br>
Triggered every time an animation state changes. Triggered for all animation states in a sequence.
It can be assigned to a remote unit but will only fire on the PC where the actual [[addEventHandler]] command was executed.
<syntaxhighlight lang="cpp">this addEventHandler ["AnimStateChanged", {
	params ["_unit", "_anim"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* anim: [[String]] - Name of the anim that has been started


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.32}}</div>
==== ContainerClosed ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggers when player finished accessing cargo container.
This event handler is similar to [[#InventoryClosed|InventoryClosed]] EH, but needs to be assigned to the container rather than the player.
Note: will trigger only for the unit opening container.

<syntaxhighlight lang="cpp">this addEventHandler ["ContainerClosed", {
	params ["_container", "_unit"];
}];</syntaxhighlight>

* container: [[Object]] - Cargo container.
* player: [[Object]] - Unit who accessed the container.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.32}}</div>
==== ContainerOpened ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggers when cargo container is accessed by player.
This event handler is similar to [[#InventoryOpened|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.

<syntaxhighlight lang="cpp">this addEventHandler ["ContainerOpened", {
	params ["_container", "_unit"];
}];</syntaxhighlight>

* container: [[Object]] - Cargo container.
* player: [[Object]] - Unit who accessed the container.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.00}}</div>
==== ControlsShifted ====
</div>
{{EffArg|cmd|arg|global}}{{EffArg|cmd|eff|local}}<br>
Triggers when control of a vehicle is shifted (pilot->co-pilot, co-pilot->pilot), usually when user performs an [[action]] such as [[action/Arma_3_Actions_List#TakeVehicleControl | TakeVehicleControl]], [[action/Arma_3_Actions_List#SuspendVehicleControl | SuspendVehicleControl]], [[action/Arma_3_Actions_List#UnlockVehicleControl | UnlockVehicleControl]], [[action/Arma_3_Actions_List#LockVehicleControl | LockVehicleControl]], or when [[enableCopilot]] command is used. This event handler will always fire on the PC where [[action]] is triggered as well as where the vehicle is [[local]] 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]] 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 [[Arma_3:_Event_Handlers/addMissionEventHandler#ControlsShifted | ControlsShifted]] event handler.

<syntaxhighlight lang="cpp">this addEventHandler ["ControlsShifted", {
	params ["_vehicle", "_activeCoPilot", "_oldController"];
}];</syntaxhighlight>

* vehicle: [[Object]] - Vehicle which controls were shifted.
* activeCoPilot: [[Object]] - Co-pilot unit which controls vehicle after this event. [[objNull]] if co-pilot is not controlling the vehicle.
* oldController: [[Object]] - Unit who controlled vehicle before this event.


==== Dammaged ====
{{EffArg|cmd|arg|global}}<br>
Triggered when the unit is damaged. In ArmA works with all vehicles not only men like in OFP.
It can be assigned to a remote vehicle but will only fire on the PC where the actual [[addEventHandler]] command was executed.

'''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.

<syntaxhighlight lang="cpp">this addEventHandler ["Dammaged", {
	params ["_unit", "_selection", "_damage", "_hitIndex", "_hitPoint", "_shooter", "_projectile"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* hitSelection: [[String]] - Name of the selection where the unit was damaged
* damage: [[Number]] - Resulting level of damage
* {{GVI|arma3|1.67}} hitPartIndex: [[Number]] - hit index of the hit selection
* {{GVI|arma3|1.67}} hitPoint: [[String]] - hit point Cfg name
* {{GVI|arma3|1.69}} shooter: [[Object]] - shooter reference (to get instigator use [[getShotParents]] on projectile)
* {{GVI|arma3|1.69}} projectile: [[Object]] - the projectile that caused damage


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.67}}</div>
==== Deleted ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggered just before the assigned entity is deleted.
<syntaxhighlight lang="cpp">this addEventHandler ["Deleted", {
	params ["_entity"];
}];</syntaxhighlight>

* entity: [[Object]] - Object the event handler is assigned to


==== Engine ====
{{EffArg|cmd|arg|global}}<br>
Triggered when the engine of the unit is turned on/off.
<syntaxhighlight lang="cpp">this addEventHandler ["Engine", {
	params ["_vehicle", "_engineState"];
}];</syntaxhighlight>

* vehicle: [[Object]] - Vehicle the event handler is assigned to
* engineState: [[Boolean]] - True when the engine is turned on, false when turned off


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.00}}</div>
==== EpeContact ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggered when object collision (PhysX) is in progress.
It can be assigned to a remote vehicle but will only fire on the PC where the actual [[addEventHandler]] command was executed.
<syntaxhighlight lang="cpp">this addEventHandler ["EpeContact", {
	params ["_object1", "_object2", "_selection1", "_selection2", "_force"];
}];</syntaxhighlight>

* object1: [[Object]] - Object with attached handler.
* object2: [[Object]] - Object which is colliding with object1.
* select1: [[String]] - Selection of object1 which is colliding - not in use at this moment, empty string is always returned.
* select2: [[String]] - Selection of object2 which is colliding - not in use at this moment, empty string is always returned.
* force: [[Number]] - Force of collision.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.00}}</div>
==== EpeContactEnd ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggered when object collision (PhysX) ends. It can be assigned to a remote vehicle but will only fire on the PC where the actual [[addEventHandler]] command was executed.
<syntaxhighlight lang="cpp">this addEventHandler ["EpeContactEnd", {
	params ["_object1", "_object2", "_selection1", "_selection2", "_force"];
}];</syntaxhighlight>

* object1: [[Object]] - Object with attached handler.
* object2: [[Object]] - Object which is colliding with object1.
* select1: [[String]] - Selection of object1 which is colliding - not in use at this moment, empty string is always returned.
* select2: [[String]] - Selection of object2 which is colliding - not in use at this moment, empty string is always returned.
* force: [[Number]] - Force of collision.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.00}}</div>
==== EpeContactStart ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggered when object collision (PhysX) starts. It can be assigned to a remote vehicle but will only fire on the PC where the actual [[addEventHandler]] command was executed.
<syntaxhighlight lang="cpp">this addEventHandler ["EpeContactStart", {
	params ["_object1", "_object2", "_selection1", "_selection2", "_force"];
}];</syntaxhighlight>

* object1: [[Object]] - Object with attached handler.
* object2: [[Object]] - Object which is colliding with object1.
* select1: [[String]] - Selection of object1 which is colliding - not in use at this moment, empty string is always returned.
* select2: [[String]] - Selection of object2 which is colliding - not in use at this moment, empty string is always returned.
* force: [[Number]] - Force of collision.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|0.76}}</div>
==== Explosion ====
</div>
{{EffArg|cmd|arg|global}}<br>
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.
<syntaxhighlight lang="cpp">this addEventHandler ["Explosion", {
	params ["_vehicle", "_damage"];
}];</syntaxhighlight>

* vehicle: [[Object]] - Object the event handler is assigned to
* damage: [[Number]] - Damage inflicted to the object


==== Fired ====
{{Important|When added to remote unit or vehicle, event handler will fire only if said entity is within range to the camera. Range is determined by fired ammo's highest visibleFire and audibleFire config value. In case of units muzzle attachment coefficients are applied too.}}
{{EffArg|cmd|arg|global}}<br>
Triggered when the unit fires a weapon.<br>
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]] if gunner is not present or the ''gunner'' is not the one who fires.
To check if "Manual Fire" is on, use [[isManualFire]]. The actual shot instigator could be retrieved with [[getShotParents]] command.<br>

<syntaxhighlight lang="cpp">this addEventHandler ["Fired", {
	params ["_unit", "_weapon", "_muzzle", "_mode", "_ammo", "_magazine", "_projectile", "_gunner"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* weapon: [[String]] - Fired weapon
* muzzle: [[String]] - Muzzle that was used
* mode: [[String]] - Current mode of the fired weapon
* ammo: [[String]] - Ammo used
* magazine: [[String]] - magazine name which was used
* projectile: [[Object]] - Object of the projectile that was shot out
* {{GVI|arma3|1.65}} gunner: [[Object]] - gunner whose weapons are firing.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.65}}</div>
==== FiredMan ====
</div>
{{EffArg|cmd|arg|global}}<br>
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]]ed unit use "Fired" EH instead.
<syntaxhighlight lang="cpp">this addEventHandler ["FiredMan", {
	params ["_unit", "_weapon", "_muzzle", "_mode", "_ammo", "_magazine", "_projectile", "_vehicle"];
}];</syntaxhighlight>

* unit: [[Object]] - Unit the event handler is assigned to (the instigator)
* weapon: [[String]] - Fired weapon
* muzzle: [[String]] - Muzzle that was used
* mode: [[String]] - Current mode of the fired weapon
* ammo: [[String]] - Ammo used
* magazine: [[String]] - magazine name which was used
* projectile: [[Object]] - Object of the projectile that was shot out
* vehicle: [[Object]] - Vehicle, if weapon is vehicle weapon, otherwise [[objNull]]


==== FiredNear ====
{{EffArg|cmd|arg|global}}<br>
Triggered when a weapon is fired somewhere ''near'' the unit or vehicle. It is also triggered if the unit itself is firing.
(Exception(s): the Throw weapon wont broadcast the FiredNear event).
When "Manual Fire" is used, the ''gunner'' is [[objNull]] if gunner is not present or the ''gunner'' is not the one who fires.
To check if "Manual Fire" is on, use [[isManualFire]]. The actual shot instigator could be retrieved with [[getShotParents]] command.
{{GVI|Arma 3|1.30}} Works with thrown weapons.
<syntaxhighlight lang="cpp">this addEventHandler ["FiredNear", {
	params ["_unit", "_firer", "_distance", "_weapon", "_muzzle", "_mode", "_ammo", "_gunner"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* firer: [[Object]] - Object which fires a weapon near the unit
* distance: [[Number]] - Distance in meters between the ''unit'' and ''firer'' (max. distance ~69m)
* weapon: [[String]] - Fired weapon
* muzzle: [[String]] - Muzzle that was used
* mode: [[String]] - Current mode of the fired weapon
* ammo: [[String]] - Ammo used
* {{GVI|arma3|1.65}} gunner: [[Object]] - gunner, whose weapons are fired


==== Fuel ====
{{EffArg|cmd|arg|global}}<br>
Triggered when the vehicle's fuel status changes between non-empty and empty or between empty and non-empty.
<syntaxhighlight lang="cpp">this addEventHandler ["Fuel", {
	params ["_vehicle", "_hasFuel"];
}];</syntaxhighlight>

* vehicle: [[Object]] - vehicle the event handler is assigned to
* hasFuel: [[Boolean]] - false when has no fuel, true when has some fuel


==== Gear ====
{{EffArg|cmd|arg|global}}<br>
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.
<syntaxhighlight lang="cpp">
this addEventHandler ["Gear", {
	params ["_vehicle", "_gearState"];
}];
</syntaxhighlight>

* vehicle: [[Object]] - Vehicle the event handler is assigned to
* gearState: [[Boolean]] - True when the gear is lowered, false when retracted


==== GetIn ====
{{EffArg|cmd|arg|global}}<br>
Triggers when a unit enters a vehicle. It can be assigned to a remote vehicle but will only fire on the PC where the actual [[addEventHandler]] command was executed. This EH is triggered by moveInXXXX commands and "GetInXXXX" [[action]]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.
<syntaxhighlight lang="cpp">this addEventHandler ["GetIn", {
	params ["_vehicle", "_role", "_unit", "_turret"];
}];</syntaxhighlight>

* vehicle: [[Object]] - Vehicle the event handler is assigned to
* role: [[String]] - Can be either "driver", "gunner" or "cargo"
* unit: [[Object]] - Unit that entered the vehicle
* {{GVI|arma3|1.36}} turret: [[Array]] - turret path


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.57}}</div>
==== GetInMan ====
</div>
{{EffArg|cmd|arg|global}}<br>
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]]. This EH is triggered by moveInXXXX commands and "GetInXXXX" [[action]]s.
<syntaxhighlight lang="cpp">this addEventHandler ["GetInMan", {
	params ["_unit", "_role", "_vehicle", "_turret"];
}];</syntaxhighlight>

* unit: [[Object]] - Unit the event handler is assigned to
* role: [[String]] - Can be either "driver", "gunner" or "cargo"
* vehicle: [[Object]] - Vehicle the unit entered
* turret: [[Array]] - turret path


==== GetOut ====
{{EffArg|cmd|arg|global}}<br>
Triggers when a unit gets out from a vehicle.
It can be assigned to a remote vehicle but will only fire on the PC where the actual [[addEventHandler]] command was executed.
This EH is triggered by [[moveOut]], "GetOut" & "Eject" [[action]]s, if an [[alive]] [[crew]] member disconnects or is deleted, but not upon a seat change within the same vehicle.
<syntaxhighlight lang="cpp">this addEventHandler ["GetOut", {
	params ["_vehicle", "_role", "_unit", "_turret"];
}];</syntaxhighlight>

* vehicle: [[Object]] - Vehicle the event handler is assigned to
* role: [[String]] - Can be either "driver", "gunner" or "cargo"
* unit: [[Object]] - Unit that left the vehicle
* {{GVI|arma3|1.36}} turret: [[Array]] - turret path


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.57}}</div>
==== GetOutMan ====
</div>
{{EffArg|cmd|arg|global}}<br>
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]]. This EH is triggered by [[moveOut]] and "GetOut" & "Eject" [[action]]s.
<syntaxhighlight lang="cpp">this addEventHandler ["GetOutMan", {
	params ["_unit", "_role", "_vehicle", "_turret"];
}];</syntaxhighlight>

* unit: [[Object]] - unit the event handler is assigned to
* role: [[String]] - Can be either "driver", "gunner" or "cargo"
* vehicle: [[Object]] - Vehicle that the unit left
* turret: [[Array]] - turret path


==== HandleDamage ====
{{EffArg|cmd|arg|global}}<br>
Triggers when the unit is damaged and fires for each damaged selection separately 
Note: Currently, in Arma 3 v1.70 it triggers for every selection of a vehicle, no matter if the section was damaged or not). Works with all vehicles.
This EH can accept a remote unit as argument however it will only fire when the unit is [[local]] 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]] will fire.

If code provided returns a numeric value, this value will overwrite the default damage of given selection after processing.
Return value of 0 will make the unit invulnerable if damage is not scripted in other ways (i.e using [[setDamage]] and/or [[setHit]] for additional damage handling).
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.

'''Notes:'''
* Multiple "HandleDamage" event handlers 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]]) onto the unit, as well as the current health of the unit/its selections, with [[setVariable]] and query it on each "HandleDamage" event with [[getVariable]] 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]] 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.

Additional [https://forums.bistudio.com/forums/topic/205515-handledamage-event-handler-explained/ Celery's explanation (Updated by ShadowRanger for Arma 3)].

<syntaxhighlight lang="cpp">this addEventHandler ["HandleDamage", {
	params ["_unit", "_selection", "_damage", "_source", "_projectile", "_hitIndex", "_instigator", "_hitPoint"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to.
* selection: [[String]] - Name of the selection where the unit was damaged. 
** "" for over-all structural damage
** "?" for unknown selections
* damage: [[Number]] - Resulting level of damage for the selection.
* source: [[Object]] - The source unit that caused the damage.
* projectile: [[String]] - Classname of the projectile that caused inflicted the damage. ("" for unknown, such as falling damage.)
* {{GVI|arma3|1.49}} hitPartIndex: [[Number]] - Hit part index of the hit point, -1 otherwise.
* {{GVI|arma3|1.65}} instigator: [[Object]] - Person who pulled the trigger
* {{GVI|arma3|1.67}} hitPoint: [[String]] - hit point Cfg name


==== HandleHeal ====
{{EffArg|cmd|arg|global}}<br>
Triggered when unit starts to heal (player using heal action or AI heals after being ordered).
Triggers only on PC where EH is added and unit is [[local]].
If code returns false, engine side healing follows.
Return true if you handle healing in script, use [[AISFinishHeal]] to tell engine that script side healing is done.
See also [[lifeState]] and [[setUnconscious]] commands.<br><br>
'''NOTE''': This Event Handler is broken but somewhat usable.
When attached to a unit it will fire when medic action is started (not finished!) on the unit.
{{Inline code|_this [[select]] 0}} will be the unit itself, {{Inline code|_this [[select]] 1}} will be the healer.
The 3rd param will always be [[false]] and neither returning [[true]] nor using [[AISFinishHeal]] will have any effect on the engine default healing behaviour.
If unit walks away from the healer during healing action, the heal will not finish but there is no way to detect this within "HandleHeal" framework.<br><br>
This code will fix unit to 100% health after self-use of medpack:
 [[this]] [[addEventHandler]] ["HandleHeal", {
 	[[_this]] [[spawn]] {
 		[[params]] ["_injured","_healer"];
 		_damage = [[damage]] _injured;
 		[[if]] (_injured == _healer) [[then]] {
 			[[waitUntil]] {[[damage]] _injured != _damage};
 			[[if]] ([[damage]] _injured < _damage) [[then]] {
 				_injured [[setDamage]] 0;
 			};
 		};
 	};
 }];
<syntaxhighlight lang="cpp">this addEventHandler ["HandleHeal", {
	params ["_unit", "_healer", "_isMedic"];
}];</syntaxhighlight>

* unit: [[Object]]
* healer: [[Object]]
* isMedic: [[Boolean]] - true when healer is corpsman


==== HandleIdentity ====
{{EffArg|cmd|arg|global}}<br>
Triggered whenever an entity is created. Can be used in scripts if EH is added immediately after unit is created in [[Scheduler#Unscheduled_Environment|unscheduled environment]].
Doesn't trigger for editor placed units. Doesn't work in Multiplayer. If EH scope returns [[true]], the default engine identity application is overridden.
<code>bob = [[group]] [[player]] [[createUnit]] [<nowiki/>[[typeOf]] [[player]], [[position]] [[player]], [], 0, "none"];
bob [[addEventHandler]] ["HandleIdentity", {[[hint]] [[str]] [[_this]]}];</code>
* unit: [[Object]] - Object the event handler is assigned to


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.32}}</div>
==== HandleRating ====
</div>
{{EffArg|cmd|arg|local}}<br>
Triggered when engine adds rating to overall rating of the unit, usually after a kill or a friendly kill.
If EH code returns [[Number]], this will override default engine behaviour and the resulting value added will be the one returned by EH code.
<syntaxhighlight lang="cpp">this addEventHandler ["HandleRating", {
	params ["_unit", "_rating"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* rating: [[Number]] - rating to be added


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.31}}</div>
==== HandleScore ====
</div>
{{EffArg|cmd|arg|global}}{{ServerExec}}<br>
Triggered when engine adds score to overall score of the unit, usually after a kill.
If the EH code returns [[Nothing]] or [[true]], the default engine scoreboard update (score, vehicle kills, infantry kills, etc) is applied, if it returns [[false]], the engine update is cancelled. To add or modify score, use [[addScore]] and [[addScoreSide]] commands.
For remote units like players, the event does not persist after respawn, and must be re-added to the new unit. <br><br>
'''NOTE:''' MP only.
<syntaxhighlight lang="cpp">this addEventHandler ["HandleScore", {
	params ["_unit", "_object", "_score"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* object: [[Object]] - object for which score was awarded
* score: [[Number]] - score to be added


==== Hit ====
{{EffArg|cmd|arg|local}}<br>
Triggered when the unit is hit/damaged.

Is ''not'' always triggered when unit is killed by a hit.<br>
Most of the time only the [[ArmA:_Event_Handlers#Killed|killed]] event handler is triggered when a unit dies from a hit.<br>
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.<br>
Does not fire when a unit is set to allowDamage false.
<syntaxhighlight lang="cpp">this addEventHandler ["Hit", {
	params ["_unit", "_source", "_damage", "_instigator"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* source: [[Object]] - Object that caused the damage – contains ''unit'' in case of collisions
* damage: [[Number]] - Level of damage caused by the hit
* {{GVI|arma3|1.65}} instigator: [[Object]] - Person who pulled the trigger


==== HitPart ====
{{EffArg|cmd|arg|global}}<br>
Runs when the object it was added to gets injured/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]] 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.

'''Notes'''
* The hit values from the ammo array are derived from the projectile's [[CfgAmmo Config Reference|CfgAmmo]] class, and do not match the actual damage inflicted, which is usually lower due to armor and other factors.
* This EH returns array of sub-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 each sub-array is listed below.


<syntaxhighlight lang="cpp">this addEventHandler ["HitPart", {
	(_this select 0) params ["_target", "_shooter", "_projectile", "_position", "_velocity", "_selection", "_ammo", "_vector", "_radius", "_surfaceType", "_isDirect"];
}];</syntaxhighlight>

* target: [[Object]] - Object that got injured/damaged.
* shooter: [[Object]] - Unit or vehicle that inflicted the damage. If injured by a vehicle impact or a fall the target itself is returned, or, in case of explosions, the [[objNull|null object]].
In case of explosives that were planted by someone (e.g. satchel charges), that unit is returned.
* projectile: [[Object]] - Object that was fired.
* position: [[Position3D]] - Position the bullet impacted (ASL).
* velocity: [[Vector3D]] - 3D speed at which bullet impacted.
* selection: [[Array]] - Array of [[String]]s with named selection of the object that were hit.
* ammo: [[Array]] - Ammo info: [hit value, indirect hit value, indirect hit range, explosive damage, ammo class name] OR, if there is no shot object: [impulse value on object collided with,0,0,0]
* vector: [[Vector3D]] - 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.
* radius: [[Number]] - Radius (size) of component hit.
* surface: [[String]] - Surface type struck.
* direct: [[Boolean]] - [[true]] if object was directly hit, [[false]] if it was hit by indirect/splash damage.


==== Init ====
{{EffArg|cmd|arg|global}}<br>
Triggered whenever an entity is created. Cannot be used in scripts, only inside class Eventhandlers in config.
e.g:
<syntaxhighlight lang="cpp">init = "params ['_entity'];";</syntaxhighlight>
<syntaxhighlight lang="cpp">params ["_entity"];</syntaxhighlight>
* entity: [[Object]] - Object the event handler is assigned to


==== IncomingMissile ====
{{EffArg|cmd|arg|global}}<br>
Triggered when a guided missile locked on the target or unguided missile or rocket aimed by AI or Player at the target was fired.
<syntaxhighlight lang="cpp">this addEventHandler ["IncomingMissile", {
	params ["_target", "_ammo", "_vehicle", "_instigator"];
}];</syntaxhighlight>

* target: [[Object]] - Object the event handler is assigned to
* ammo: [[String]] - Ammo type that was fired on the target
* {{GVI|arma3|1.42}} vehicle: [[Object]] - Vehicle that fired the weapon. In case of soldier, unit is returned
* {{GVI|arma3|1.65}} instigator: [[Object]] - Person who pulled the trigger


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.22}}</div>
==== InventoryClosed ====
</div>
{{EffArg|cmd|arg|global}}<br>
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.

 {{codecomment|// Delete dropped items when inventory closed}}
 [[player]] [[addEventHandler]] ["InventoryClosed", {
 	[[deleteVehicle]] (_this [[select]] 1);
 }];
<syntaxhighlight lang="cpp">this addEventHandler ["InventoryClosed", {
	params ["_unit", "_container"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* targetContainer: [[Object]] - connected container or weaponholder


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.22}}</div>
==== InventoryOpened ====
</div>
{{EffArg|cmd|arg|global}}<br>
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]] to override the opening of the inventory in case you wish to handle it yourself:

 {{codecomment|// 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 [[setPos]] ([[player]] [[modelToWorld]] [0,1.5,0.5]);
 	[[player]] [[action]] ["Gear", _box];
 	[[true]]; {{codecomment|// <-- inventory override}}
 }];
To return all nearby containers use [[nearSupplies]] command.
<syntaxhighlight lang="cpp">this addEventHandler ["InventoryOpened", {
	params ["_unit", "_container"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* targetContainer: [[Object]] - connected container or weaponholder
* {{GVI|arma3|1.65}} secondaryContainer: [[Object]] - second connected container or weaponholder or [[objNull]]


==== Killed ====
{{EffArg|cmd|arg|local}}<br>
Triggered when the unit is killed.

Be careful when the killer has been a vehicle. For most cases the reference of the vehicle is the same as the [[effectiveCommander]], but not always.
<syntaxhighlight lang="cpp">this addEventHandler ["Killed", {
	params ["_unit", "_killer", "_instigator", "_useEffects"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* killer: [[Object]] - Object that killed the unit. Contains the unit itself in case of collisions
* {{GVI|arma3|1.65}} instigator: [[Object]] - Person who pulled the trigger
* {{GVI|arma3|1.67}} useEffects: [[Boolean]] - same as ''useEffects'' in [[setDamage]] alt syntax


==== LandedTouchDown ====
{{EffArg|cmd|arg|global}}<br>
Triggered when a plane (AI or player) touches the ground.
<syntaxhighlight lang="cpp">this addEventHandler ["LandedTouchDown", {
	params ["_plane", "_airportID"];
}];</syntaxhighlight>

* plane: [[Object]] - Object the event handler is assigned to
* airportID: [[Number]] - ID of the airport (-1 for anything else)


==== LandedStopped ====
{{EffArg|cmd|arg|global}}<br>
Triggered when an AI pilot would get out usually. Not executed for player.
<syntaxhighlight lang="cpp">this addEventHandler ["LandedStopped", {
	params ["_plane", "_airportID"];
}];</syntaxhighlight>

* plane: [[Object]] - Object the event handler is assigned to
* airportID: [[Number]] - ID of the airport (-1 for anything else)


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.70}}</div>
==== Landing ====
</div>
{{EffArg|cmd|arg|global}}<br>
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)
<syntaxhighlight lang="cpp">this addEventHandler ["Landing", {
	params ["_plane", "_airportID", "_isCarrier"];
}];</syntaxhighlight>

* plane: [[Object]] - Object the event handler is assigned to
* airportID: [[Number]] or [[Object]] - ID of the airport or aircraft carrier object
* isCarrier: [[Boolean]] - true if landing on aircraft carrier


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.70}}</div>
==== LandingCanceled ====
</div>
{{EffArg|cmd|arg|global}}<br>
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''': Doesn't trigger if player switches off auto-pilot. Canceled is spelled with one L
<syntaxhighlight lang="cpp">this addEventHandler ["LandingCanceled", {
	params ["_plane", "_airportID", "_isCarrier"];
}];</syntaxhighlight>

* plane: [[Object]] - Object the event handler is assigned to
* airportID: [[Number]] or [[Object]] - ID of the airport or aircraft carrier object (-1 no airport)
* isCarrier: [[Boolean]] - true if landing on aircraft carrier


==== Local ====
{{EffArg|cmd|arg|global}}<br>
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]] [[select]] 1 will be [[true]],
and on the computer from which ownership is transferred (old owner), in which case [[_this]] [[select]] 1 will be [[false]].
<syntaxhighlight lang="cpp">this addEventHandler ["Local", {
	params ["_entity", "_isLocal"];
}];</syntaxhighlight>

* entity: [[Object]] - The object that changed locality.
* local: [[Boolean]] - If the object is local on given computer.

<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.93}}</div>

==== PathCalculated ====
{{EffArg|cmd|arg|local}}<br>
Triggers when [[calculatePath]] command has calculated the path.
<syntaxhighlight lang="cpp">this addEventHandler ["PathCalculated", {
	params ["_agent", "_path"];
}];</syntaxhighlight>

* agent: [[Object]] - The agent instance which was used to calculate the path
* path: [[Array]] - The array of positions representing the path

==== PostReset ====
Triggers after PP effects have been reset by the engine


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|0.56}}</div>
==== Put ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggers when a unit puts an item in a container.
<syntaxhighlight lang="cpp">this addEventHandler ["Put", {
	params ["_unit", "_container", "_item"];
}];</syntaxhighlight>

* unit: [[Object]] - Unit to which the event handler is assigned
* container: [[Object]] - The container into which the item was placed (vehicle, box, etc.)
* item: [[String]] - The class name of the moved item

{{Informative|This EH also triggered when unit replaces magazine in weapon with another magazine from unit containers (uniform, vest, backpack) during reload.}}

<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.57}}</div>
==== Reloaded ====
</div>
{{EffArg|cmd|arg|local}}<br>
Triggers when a weapon is reloaded with a new magazine. For more information see: [[Arma_3:_Event_Handlers/Reloaded|Reloaded]]
<syntaxhighlight lang="cpp">this addEventHandler ["Reloaded", {
	params ["_unit", "_weapon", "_muzzle", "_newMagazine", "_oldMagazine"];
}];</syntaxhighlight>

* unit: [[Object]] - unit or vehicle to which EH is assigned
* weapon: [[String]] - weapon that got reloaded
* muzzle: [[String]] - weapon's muzzle that got reloaded
* newMagazine: [[Array]] - new magazine info
* oldMagazine: [[Array]] or [[Nothing]] - old magazine info


==== Respawn ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a unit respawns.
<syntaxhighlight lang="cpp">this addEventHandler ["Respawn", {
	params ["_unit", "_corpse"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* corpse: [[Object]] - Object the event handler was assigned to, aka the corpse/unit player was previously controlling


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.34}}</div>
==== RopeAttach ====
</div>
Triggered when a rope is attached to an object.<br>
In the case of sling loading, this event handler must be assigned to the helicopter and will trigger for each attached rope.
<syntaxhighlight lang="cpp">this addEventHandler ["RopeAttach", {
	params ["_object1", "_rope", "_object2"];
}];</syntaxhighlight>

*object 1: [[Object]] - Object to which the event handler is assigned.
*rope: [[Object]] - The rope being attached between object 1 and object 2.
*object 2: [[Object]] - The object that is being attached to object 1 via rope.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.34}}</div>
==== RopeBreak ====
</div>
Triggered when a rope is detached from an object.<br>
In the case of sling loading, this event handler must be assigned to the helicopter and will trigger for each detached rope.
<syntaxhighlight lang="cpp">this addEventHandler ["RopeBreak", {
	params ["_object1", "_rope", "_object2"];
}];</syntaxhighlight>

*object 1: [[Object]] - Object to which the event handler is assigned.
*rope: [[Object]] - The rope being detached between object 1 and object 2.
*object 2: [[Object]] - The object that is being detached from object 1 via rope.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.49}}</div>
==== SeatSwitched ====
</div>
{{EffArg|cmd|arg|global}}<br>
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]].
The new position can be obtained with [[assignedVehicleRole]] <unit>.
This EH must be assigned to a vehicle.
<syntaxhighlight lang="cpp">this addEventHandler ["SeatSwitched", {
	params ["_vehicle", "_unit1", "_unit2"];
}];</syntaxhighlight>

*vehicle: [[Object]] - Vehicle to which the event handler is assigned.
*unit1: [[Object]] - Unit switching seat.
*unit2: [[Object]] - Unit switching seat.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.57}}</div>
==== SeatSwitchedMan ====
</div>
{{EffArg|cmd|arg|global}}<br>
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]].
The new position can be obtained with [[assignedVehicleRole]] <unit>. 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.
<syntaxhighlight lang="cpp">this addEventHandler ["SeatSwitchedMan", {
	params ["_unit1", "_unit2", "_vehicle"];
}];</syntaxhighlight>

*unit1: [[Object]] - Unit switching seat.
*unit2: [[Object]] - Unit with which unit1 is switching seat.
*vehicle: [[Object]] - Vehicle where switching seats is taking place.


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|0.56}}</div>
==== SoundPlayed ====
</div>
{{EffArg|cmd|arg|local}}<br>
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
* 2 : Breath Injured
* 3 : Breath Scuba
* 4 : Injured
* 5 : Pulsation
* 6 : Hit Scream
* 7 : Burning
* 8 : Drowning
* 9 : Drown
* 10 : Gasping
* 11 : Stabilizing
* 12 : Healing
* 13 : Healing With Medikit
* 14 : Recovered
<syntaxhighlight lang="cpp">this addEventHandler ["SoundPlayed", {
	params ["_unit", "_soundID"];
}];</syntaxhighlight>

* unit: [[Object]] - Unit to which the event handler is assigned
* soundID: [[Number]] - sound origin


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|0.56}}</div>
==== Take ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggers when a unit takes an item from a container.
<syntaxhighlight lang="cpp">this addEventHandler ["Take", {
	params ["_unit", "_container", "_item"];
}];</syntaxhighlight>

* unit: [[Object]] - Unit to which the event handler is assigned
* container: [[Object]] - The container from which the item was taken (vehicle, box, etc.)
* item: [[String]] - The class name of the taken item

{{Informative|This EH also triggered when unit replaces magazine in weapon with another magazine from unit containers (uniform, vest, backpack) during reload.}}

<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.32}}</div>
==== TaskSetAsCurrent ====
</div>
Triggers when player's current task changes
<syntaxhighlight lang="cpp">this addEventHandler ["TaskSetAsCurrent", {
	params ["_unit", "_task"];
}];</syntaxhighlight>

* unit: [[Object]] - The player to whom the event handler is assigned
* task: [[Task]] - The new current task


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.66}}</div>
==== TurnIn ====
</div>
Triggers when member of crew in a vehicle uses Turn In [[action]]
<syntaxhighlight lang="cpp">this addEventHandler ["TurnIn", {
	params ["_vehicle", "_unit", "_turret"];
}];</syntaxhighlight>

* vehicle: [[Object]] - The vehicle the event handler is assigned to
* unit: [[Object]] - The unit performing the Turn In action
* turret: [[Array]] - Turret path


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.66}}</div>
==== TurnOut ====
</div>
Triggers when member of crew in a vehicle uses Turn Out [[action]]
<syntaxhighlight lang="cpp">this addEventHandler ["TurnOut", {
	params ["_vehicle", "_unit", "_turret"];
}];</syntaxhighlight>

* vehicle: [[Object]] - The vehicle the event handler is assigned to
* unit: [[Object]] - The unit performing the Turn Out action
* turret: [[Array]] - Turret path


==== WeaponAssembled ====
{{EffArg|cmd|arg|global}}<br>
Triggers when weapon gets assembled. EH should be attached to the unit and not the weapon.
<syntaxhighlight lang="cpp">this addEventHandler ["WeaponAssembled", {
	params ["_unit", "_staticWeapon"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* weapon: [[Object]] - Object of the assembled weapon


==== WeaponDisassembled ====
{{EffArg|cmd|arg|global}}<br>
Triggers when weapon gets disassembled. EH should be attached to the unit and not the weapon.<br><br>
'''NOTE:''' As of Arma 3 v1.32, this event does not fire if the weapon is not local. See http://feedback.arma3.com/view.php?id=21308
<syntaxhighlight lang="cpp">this addEventHandler ["WeaponDisassembled", {
	params ["_unit", "_backpack1", "_backpack2"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* primaryBag: [[Object]] - First backpack object which was weapon disassembled into
* secondarybag: [[Object]] - Second backpack object which was weapon disassembled into


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.43}}</div>
==== WeaponDeployed ====
</div>
{{EffArg|cmd|arg|global}}<br>
Triggers when the deployed state of a weapon or bipod changes. Note: A weapon cannot be rested and deployed at the same time.
<syntaxhighlight lang="cpp">this addEventHandler ["WeaponDeployed", {
	params ["_unit", "_isDeployed"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* isDeployed: [[Boolean]] - true if deployed


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.43}}</div>
==== WeaponRested ====
</div>
{{EffArg|cmd|arg|local}}<br>
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.
<syntaxhighlight lang="cpp">this addEventHandler ["WeaponRested", {
	params ["_unit", "_isRested"];
}];</syntaxhighlight>

* unit: [[Object]] - Object the event handler is assigned to
* isRested: [[Boolean]] - true if rested

==== SelectedActionPerformed ====
RTM helicopter user action event
<syntaxhighlight lang="cpp">
this addEventHandler ["SelectedActionPerformed", {
	params ["_caller", "_target", "_enumNumber", "_actionId"];
}];
</syntaxhighlight>

{{Important|Limited or non-existent functionality}} 

==== SelectedActionChanged ====
RTM helicopter user action event
<syntaxhighlight lang="cpp">
this addEventHandler ["SelectedActionChanged", {
	params ["_caller", "_target", "_enumNumber", "_actionId"];
}];
</syntaxhighlight>

{{Important|Limited or non-existent functionality}} 

==== SelectedRotorLibActionPerformed ====
RTM helicopter user action event
<syntaxhighlight lang="cpp">
this addEventHandler ["SelectedRotorLibActionPerformed", {
	params ["_caller", "_target", "_enumNumber", "_actionId"];
}];
</syntaxhighlight>

{{Important|Works only for key press combination <tt>RightCtrl</tt> + <tt>W</tt>, 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:<br>
0: HelicopterAutoTrimOn<br>
1: HelicopterAutoTrimOff<br>
2: HelicopterTrimOn<br>
3: HelicopterTrimOff<br>
4: WheelsBrakeOn<br>
5: WheelsBrakeOff
}} 

==== SelectedRotorLibActionChanged ====
RTM helicopter user action event
<syntaxhighlight lang="cpp">
this addEventHandler ["SelectedRotorLibActionChanged", {
	params ["_caller", "_target", "_enumNumber", "_actionId"];
}];
</syntaxhighlight>

{{Important|Limited or non-existent functionality}} 

{{Cfg ref|end}}


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|1.16}}</div>
=== Curator ===
</div>
{{EffArg|cmd|arg|local}}{{EffArg|cmd|eff|local}}<br>
[[Curator]] Event Handlers are also added with [[addEventHandler]] command.
They will be executed only where curator is local (on the computer of who is in control of it).
All curator event handlers are local and have a global effect.
{{Important|
These events must be added to the curator object/module, '''not''' the player}}

{{Cfg ref|start}}
{{Cfg ref|abc}}
==== CuratorFeedbackMessage ====
{{EffArg|cmd|arg|local}}<br>
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]]
* 101 - trying to place an object when placing is disabled using [[setCuratorCoef]] "place"
* 102 - trying to place an object which is too expensive (cost set in ''curatorObjectRegistered'' multiplied by [[setCuratorCoef]] "place" is larger than [[curatorPoints]])
* 103 - trying to place an object outside of [[curatorEditingArea]]
* 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]] multiplied by [[setCuratorCoef]] "place" is larger than [[curatorPoints]])
* 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]] "edit"
* 302 - trying to move or rotate an entity when it's too expensive (entity cost multiplied by [[setCuratorCoef]] "edit" is larger than [[curatorPoints]])
* 303 - trying to move an entity outside of [[curatorEditingArea]]
* 304 - trying to move or rotate an entity which is outside of [[curatorEditingArea]]
* 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]] "delete"
* 402 - trying to delete an entity which is too expensive (cost multiplied by [[setCuratorCoef]] "delete" is larger than [[curatorPoints]])
* 404 - trying to delete an entity which is outside of [[curatorEditingArea]]
* 405 - trying to delete an entity which has [[curatorEditableObjects|non-editable]] 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]] "destroy"
* 502 - trying to destroy an object which is too expensive (cost multiplied by [[setCuratorCoef]] "destroy" is larger than [[curatorPoints]])
* 504 - trying to destroy an object which is outside of [[curatorEditingArea]]
* 505 - trying to destroy an object which has [[curatorEditableObjects|non-editable]] 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)
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorFeedbackMessage", {
	params ["_curator", "_errorID"];
}];</syntaxhighlight>

* curator: [[Object]]
* errorID: [[Number]]


==== CuratorGroupDoubleClicked ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a group is double-clicked on in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorGroupDoubleClicked", {
	params ["_curator", "_group"];
}];</syntaxhighlight>

* curator: [[Object]]
* group: [[Group]]


==== CuratorGroupPlaced ====
{{EffArg|cmd|arg|local}}<br>
Triggered when new group is placed in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorGroupPlaced", {
	params ["_curator", "_group"];
}];</syntaxhighlight>

* curator: [[Object]]
* group: [[Group]]


==== CuratorGroupSelectionChanged ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a group is selected in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorGroupSelectionChanged", {
	params ["_curator", "_group"];
}];</syntaxhighlight>

* curator: [[Object]]
* group: [[Group]]


==== CuratorMarkerDeleted ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a marker is deleted in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorMarkerDeleted", {
	params ["_curator", "_marker"];
}];</syntaxhighlight>

* curator: [[Object]]
* marker: [[String]]


==== CuratorMarkerDoubleClicked ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a marker is double-clicked on in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorMarkerDoubleClicked", {
	params ["_curator", "_marker"];
}];</syntaxhighlight>

* curator: [[Object]]
* marker: [[String]]


==== CuratorMarkerEdited ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a marker is moved in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorMarkerEdited", {
	params ["_curator", "_marker"];
}];</syntaxhighlight>

* curator: [[Object]]
* marker: [[String]]


==== CuratorMarkerPlaced ====
{{EffArg|cmd|arg|local}}<br>
Triggered when new marker is placed in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorMarkerPlaced", {
	params ["_curator", "_marker"];
}];</syntaxhighlight>

* curator: [[Object]]
* marker: [[String]]


==== CuratorMarkerSelectionChanged ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a marker is selected in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorMarkerSelectionChanged", {
	params ["_curator", "_marker"];
}];</syntaxhighlight>

* curator: [[Object]]
* marker: [[String]]


==== CuratorObjectDeleted ====
{{EffArg|cmd|arg|local}}<br>
Triggered when an object is deleted in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorObjectDeleted", {
	params ["_curator", "_entity"];
}];</syntaxhighlight>

* curator: [[Object]]
* entity: [[Object]]


==== CuratorObjectDoubleClicked ====
{{EffArg|cmd|arg|local}}<br>
Triggered when an object is double-clicked on in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorObjectDoubleClicked", {
	params ["_curator", "_entity"];
}];</syntaxhighlight>

* curator: [[Object]]
* entity: [[Object]]


==== CuratorObjectEdited ====
{{EffArg|cmd|arg|local}}<br>
Triggered when an object is moved or rotated in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorObjectEdited", {
	params ["_curator", "_entity"];
}];</syntaxhighlight>

* curator: [[Object]]
* entity: [[Object]]


==== CuratorObjectPlaced ====
{{EffArg|cmd|arg|local}}<br>
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.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorObjectPlaced", {
	params ["_curator", "_entity"];
}];</syntaxhighlight>

* curator: [[Object]]
* entity: [[Object]]


==== CuratorObjectRegistered ====
{{EffArg|cmd|arg|local}}<br>
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.<br>
''Full article - [[Curator#Manual_Assigning|Curator]]''

<syntaxhighlight lang="cpp">this addEventHandler ["CuratorObjectRegistered", {
	params ["_curator", "_input"];
}];</syntaxhighlight>

* curator: [[Object]]
* input: [[Array]] of [[String]]s - all CfgVehicles classes


==== CuratorObjectSelectionChanged ====
{{EffArg|cmd|arg|local}}<br>
Triggered when an object is selected in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorObjectSelectionChanged", {
	params ["_curator", "_entity"];
}];</syntaxhighlight>

* curator: [[Object]]
* entity: [[Object]]


==== CuratorPinged ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a player pings his curator(s) by pressing ''Zeus'' key. To add player to specific curator, use [[addCuratorEditableObjects]] command.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorPinged", {
	params ["_curator", "_unit"];
}];</syntaxhighlight>

* curator: [[Object]]
* player: [[Object]]


==== CuratorWaypointDeleted ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a waypoint is deleted in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorWaypointDeleted", {
	params ["_curator", "_waypoint"];
}];</syntaxhighlight>

* curator: [[Object]]
* waypoint: [[Array]]


==== CuratorWaypointDoubleClicked ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a waypoint is double-clicked on in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorWaypointDoubleClicked", {
	params ["_curator", "_waypoint"];
}];</syntaxhighlight>

* curator: [[Object]]
* waypoint: [[Array]]


==== CuratorWaypointEdited ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a waypoint is moved in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorWaypointEdited", {
	params ["_curator", "_waypoint"];
}];</syntaxhighlight>

* curator: [[Object]]
* waypoint: [[Array]]


==== CuratorWaypointPlaced ====
{{EffArg|cmd|arg|local}}<br>
Triggered when new waypoint is placed in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorWaypointPlaced", {
	params ["_curator", "_group", "_waypointID"];
}];</syntaxhighlight>

* curator: [[Object]]
* Group: [[Group]]
* Waypoint Index: [[Number]]


==== CuratorWaypointSelectionChanged ====
{{EffArg|cmd|arg|local}}<br>
Triggered when a waypoint is selected in curator interface.
<syntaxhighlight lang="cpp">this addEventHandler ["CuratorWaypointSelectionChanged", {
	params ["_curator", "_waypoint"];
}];</syntaxhighlight>

* curator: [[Object]]
* waypoint: [[Array]]


{{Cfg ref|end}}


=== Multiplayer Event Handlers ===
Global object event handler, executed on every connected machine.<br>
Commands:
* [[addMPEventHandler]]
* [[removeMPEventHandler]]
* [[removeAllMPEventHandlers]]

{{Cfg ref|start}}
{{Cfg ref|abc}}
==== MPHit ====
{{EffArg|cmd|arg|global}}{{EffArg|cmd|eff|global}}<br>
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 [[ArmA_3:_Event_Handlers#Killed|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]] [[false]].
However it will fire with "HandleDamage" EH added alongside stopping unit from taking damage ({{Inline code|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!
* unit: [[Object]] - Object the event handler is assigned to <br>
* causedBy: [[Object]] - Object that caused the damage. Contains the unit itself in case of collisions. <br>
* damage: [[Number]] - Level of damage caused by the hit
* {{GVI|arma3|1.65}} instigator: [[Object]] - Person who pulled the trigger


==== MPKilled ====
{{EffArg|cmd|arg|global}}{{EffArg|cmd|eff|global}}<br>
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 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.

* unit: [[Object]] - Object the event handler is assigned to
* killer: [[Object]] - Object that killed the unit<br>Contains the unit itself in case of collisions
* {{GVI|arma3|1.65}} instigator: [[Object]] - Person who pulled the trigger
* {{GVI|arma3|1.67}} useEffects: [[Boolean]] - same as ''useEffects'' in [[setDamage]] alt syntax


==== MPRespawn ====
{{EffArg|cmd|arg|global}}{{EffArg|cmd|eff|local}}<br>
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]].
The only difference between '''Respawn''' and '''MPRespawn''' is that '''MPRespawn''' can be assigned from anywhere while '''Respawn''' requires the unit to be local.<br><br>
MPRespawn EH expects the EH code to return array in format of [[Position]], which will be used to place respawned unit at desired coordinates.<br>
For example: {{Inline code|[[player]] [[addMPEventHandler]] ["MPRespawn", {[1234,1234,0]}];}} will place player at [1234,1234,0] immediately on respawn.
* unit: [[Object]] - Object the event handler is assigned to
* corpse: [[Object]] - Object the event handler was assigned to, aka the corpse/unit player was previously controlling.


{{Cfg ref|end}}


== Mission Event Handlers ==
Mission event handlers are specific EHs that are anchored to the running mission and automatically removed when mission is over.
The following mission EHs are available in Arma 3:
* [[Arma_3:_Event_Handlers/addMissionEventHandler#Draw3D|Draw3D]] - Drawing HUD event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#Ended|Ended]] - Mission end event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#MPEnded|MPEnded]] - MP mission ended, i.e. the server status changes from "Playing"
* [[Arma_3:_Event_Handlers/addMissionEventHandler#Loaded|Loaded]] - Game loading from save event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#Map|Map]] - Map open/close event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#HandleDisconnect|HandleDisconnect]] - Player disconnect in MP event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#EntityRespawned|EntityRespawned]] - Some entity respawn event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#EntityKilled|EntityKilled]] - Some entity death event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#EachFrame|EachFrame]] - Per frame event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#MapSingleClick|MapSingleClick]] - Map click event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#HCGroupSelectionChanged|HCGroupSelectionChanged]] - High Command group select event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#CommandModeChanged|CommandModeChanged]] - High Command mode change event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#ControlsShifted|ControlsShifted]] - Vehicle controls shifted event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#GroupIconClick|GroupIconClick]] - High Command icon click event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#GroupIconOverEnter|GroupIconOverEnter]] - High Command icon enter event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#GroupIconOverLeave|GroupIconOverLeave]] - High Command icon leave event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerConnected|PlayerConnected]] - Client joining MP mission event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerDisconnected|PlayerDisconnected]] - Client leaving MP mission event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#TeamSwitch|TeamSwitch]] - Player teamswitch event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#PreloadStarted|PreloadStarted]] - Mission preload start event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#PreloadFinished|PreloadFinished]] - Mission preload finish event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerViewChanged|PlayerViewChanged]] - Player view change event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#BuildingChanged|BuildingChanged]] - Building model change event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#HandleAccTime|HandleAccTime]] - Time acceleration change event
* [[Arma_3:_Event_Handlers/addMissionEventHandler#ExtensionCallback|ExtensionCallback]] - [[callExtension | Extension callback]] event
For detailed description see [[Arma_3:_Event_Handlers/addMissionEventHandler|Mission Event Handlers]] page.


== Player's UI Event Handlers ==
In Game UI Event Handlers trigger when user scrolls or activates in game action menu.<br>
The following mission EHs are available in Arma 3:
* [[Arma_3: Event Handlers/inGameUISetEventHandler#PrevAction|PrevAction]] - Action menu scroll up event
* [[Arma_3: Event Handlers/inGameUISetEventHandler#Action|Action]] - Action menu action event
* [[Arma_3: Event Handlers/inGameUISetEventHandler#NextAction|NextAction]] - Action menu scroll down event

{{note|Only one event of each kind can exist, adding another will overwrite the existing one.}}

Commands:
* [[inGameUISetEventHandler]]
''Full article - [[Arma 3: Event Handlers/inGameUISetEventHandler]]''


== UI Event Handlers (Displays and Controls) ==
Commands:
* [[ctrlAddEventHandler]]
* [[ctrlRemoveEventHandler]]
* [[ctrlRemoveAllEventHandlers]]
* [[displayAddEventHandler]]
* [[displayRemoveEventHandler]]
* [[displayRemoveAllEventHandlers]]
''Full article - [[User Interface Event Handlers]]''


== Music Event Handlers ==
Music event handler, always executed on the computer where it was added.<br>
Commands:
* [[setMusicEventHandler]]
* [[addMusicEventHandler]]
* [[removeMusicEventHandler]]
* [[removeAllMusicEventHandlers]]

{{Cfg ref|start}}
{{Cfg ref|abc}}
<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|0.50}}</div>
==== MusicStart ====
</div>
Triggers when [[Description.ext#cfgMusic|CfgMusic]] sound starts playing, after being executed with [[playMusic]] command.

This event handler needs to be added with [[addMusicEventHandler]] command and removed with [[removeMusicEventHandler]].
* className: [[String]] - [[Description.ext#Music|CfgMusic]] class name of currently playing sound.
* handlerID: [[Number]] - EH id returned by [[addMusicEventHandler]].


<div><div style="float: left; margin-right: 0.5em;">{{GVI|arma3|0.50}}</div>
==== MusicStop ====
</div>
Triggers when [[Description.ext#cfgMusic|CfgMusic]] sound finished playing, after being executed with [[playMusic]] command.
Note that EH will not be triggered if you force stop the music with [[playMusic]] "".

This event handler needs to be added with [[addMusicEventHandler]] command and removed with [[removeMusicEventHandler]].
* className: [[String]] - [[Description.ext#Music|CfgMusic]] class name of currently played sound.
* handlerID: [[Number]] - EH id returned by [[addMusicEventHandler]].


{{Cfg ref|end}}


== Eden Editor ==
Commands:
* [[add3DENEventHandler]]
* [[remove3DENEventHandler]]
* [[removeAll3DENEventHandlers]]
''Full article - [[Arma 3: Event Handlers: Eden Editor]] and its sub-category [[Arma 3: Event Handlers: Eden Editor#Object Event Handlers|Object Event Handlers]]'' - see also [[Eden Editor]]


== Public Variable Broadcast Event ==
Commands:
* [[addPublicVariableEventHandler]]

Triggers when [[missionNamespace]] variable EH is associated with is sent over network via [[publicVariable]], [[publicVariableServer]] or [[publicVariableClient]] commands.
{{Informative | Unlike with other types of EHs, there is no way of removing added public variable event handler}}

== Weapon Config Muzzle Events ==
There are 3 event handlers that could be set on weapon in config, "Fired" - when muzzle fired, "Reload" - before muzzle is reloaded, "Reloaded" - after muzzle is reloaded.
<syntaxhighlight lang=cpp>
class CfgWeapons
{

	class RifleCore;
	class Rifle: RifleCore
	{
		class EventHandlers
		{
			fired		= "systemchat format['fired EH output: %1 [time: %2]',_this, time]";
			reload		= "systemchat format['reload EH output: %1 [time: %2]',_this, time]";
			reloaded	= "systemchat format['reloaded EH output: %1 [time: %2]',_this, time]";
		};
	};
};
</syntaxhighlight>  

== BI Scripted Events ==
Commands:
* [[BIS_fnc_addScriptedEventHandler]]
* [[BIS_fnc_removeScriptedEventHandler]]
* [[BIS_fnc_removeAllScriptedEventHandlers]]
* [[BIS_fnc_callScriptedEventHandler]]
''Full article - [[Arma 3: Event Handlers/ScriptedEventHandlers]]


[[Category: Event Handlers]]
[[Category:Scripting Topics]]