addEventHandler: Difference between revisions

Latest revision as of 15:58, 31 March 2024

1.85

1.00

Hover & click on the images for description

Description

Description:

Adds an Event Handler to the given object.

As many Event Handlers of any type can be added - existing Event Handlers do not get overwritten
Use removeEventHandler to remove an Event Handler

Read Event Handlers for more information and a list of all available Event Handlers.

Multiplayer:

Some event handlers are persistent (i.e they stay attached to the unit, even after it dies and respawns).

Groups:

Event Handlers

Syntax

Syntax:

target addEventHandler [type, code]

Parameters:

target: Object or

2.10 Group

type: String - see Event Handlers for the full list of available options

code: Code or String - code that should be executed when the Event Handler fires; executed in missionNamespace by default. Several Magic Variables are available:

Event Handler parameters are accessible via _this
The Event Handler type is available as _thisEvent
The Event Handler index is available as _thisEventHandler

Return Value:

Number - the index of the added Event Handler. Indices start at 0 for each unit and increment with each added Event Handler.

Examples

Example 1:: this addEventHandler ["Killed", { params ["_unit", "_killer"]; systemChat format ["%1 has been killed by %2.", _unit, _killer]; }];
Example 2:: _index = player addEventHandler ["Killed", { _this exec "playerKilled.sqs" }]

Additional Information

See also:: removeEventHandler removeAllEventHandlers Event Handlers addMPEventHandler addMissionEventHandler BIS_fnc_addScriptedEventHandler getEventHandlerInfo

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Killzone_Kid - c: Posted on Jun 07, 2015 - 21:06 (UTC)
: When using overridable EH, such as "InventoryOpened" and similar, where returning true allows to override default action, exitWith cannot be used to return value. So:
if (whatever) exitWith {true}; false;
Forget about it, will not work. Instead use:
if (whatever) then {true} else {false};
100% satisfaction guaranteed!

@@ Line 1: / Line 1: @@
-{{Command|=
+{{RV|type=command
-____________________________________________________________________________________________
-| ofpr |=
+|game1= ofp
+|version1= 1.85
-|1.85|=
+|game2= ofpe
+|version2= 1.00
-|arg= global |=
+|game3= arma1
+|version3= 1.00
-|eff= local |=
+|game4= arma2
-____________________________________________________________________________________________
+|version4= 1.00
-| Adds an event handler to a given unit. For more information about event handlers and their types check the scripting topic [[Event handlers]]. You may add as many event handlers of any type as you like to every unit, if you add an event handler of type "killed" and there already exists one, the old one doesn't get overwritten. Use [[removeEventHandler]] to delete event handlers. |=
+|game5= arma2oa
-____________________________________________________________________________________________
+|version5= 1.50
-| unit '''addEventHandler''' [type, code] |=
+|game6= tkoh
+|version6= 1.00
-|p1= unit: [[Object]] |=
+|game7= arma3
+|version7= 0.50
-|p2= type: [[String]] - The event handler type. Check [[Event handlers]] for the available types. |=
+|arg= global
-|p3= code: [[String]] - The scripting code which should be executed on activation of the event handler. |=
+|eff= local
-| [[Integer]] - The index of the currently added event handler is returned. Indices start at 0 for every unit and increment with each added event handler. |=
+|gr1= Event Handlers
-____________________________________________________________________________________________
-|x1= <code><nowiki>EHkilled = player addEventHandler ["killed", {_this exec "playerKilled.sqs"}]</nowiki></code>
+|descr= Adds an Event Handler to the given object.
+* As many Event Handlers of any type can be added - existing Event Handlers do not get overwritten
+* Use [[removeEventHandler]] to remove an Event Handler
+Read [[:Category:Event Handlers|Event Handlers]] for more information and a list of all available Event Handlers.
-This example adds an event handler of type "killed" to the player. Once the player dies, the script "playerKilled.sqs" will be executed. |=
+|mp= Some event handlers are persistent (i.e they stay attached to the unit, even after it dies and respawns).
-____________________________________________________________________________________________
-| [[removeEventHandler]] |=
+|s1= target [[addEventHandler]] [type, code]
+|p1= target: [[Object]] or {{GVI|arma3|2.10|size= 0.75}} [[Group]]
+|p2= type: [[String]] - see [[:Category:Event Handlers|Event Handlers]] for the full list of available options
+|p3= code: [[Code]] or [[String]] - code that should be executed when the Event Handler fires; executed in [[missionNamespace]] by default. Several [[Magic Variables]] are available:
+* Event Handler parameters are accessible via <sqf inline>_this</sqf>
+* The Event Handler type is available as <sqf inline>_thisEvent</sqf>
+* The Event Handler index is available as <sqf inline>_thisEventHandler</sqf>
+|r1= [[Number]] - the index of the added Event Handler. Indices start at 0 for each unit and increment with each added Event Handler.
+|x1= <sqf>
+this addEventHandler ["Killed", {
+	params ["_unit", "_killer"];
+	systemChat format ["%1 has been killed by %2.", _unit, _killer];
+}];
+</sqf>
+|x2= <sqs>_index = player addEventHandler ["Killed", { _this exec "playerKilled.sqs" }]</sqs>
+|seealso= [[removeEventHandler]] [[removeAllEventHandlers]] [[:Category:Event Handlers|Event Handlers]] [[addMPEventHandler]] [[addMissionEventHandler]] [[BIS_fnc_addScriptedEventHandler]] [[getEventHandlerInfo]]
 }}
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+{{Note
-</dl>
+|user= Killzone_Kid
+|timestamp= 20150607210600
-[[Category:Scripting Commands|ADDEVENTHANDLER]]
+|text= When using overridable EH, such as "InventoryOpened" and similar, where returning [[true]] allows to override default action, [[exitWith]] cannot be used to return value. So:
-[[Category:Scripting Commands OFP 1.96|ADDEVENTHANDLER]]
+<sqf>if (whatever) exitWith {true}; false;</sqf>
-[[Category:Scripting Commands ArmA|ADDEVENTHANDLER]]
+Forget about it, will not work. Instead use:
+<sqf>if (whatever) then {true} else {false};</sqf>
+% satisfaction guaranteed!
+}}