addEventHandler: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) No edit summary |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 29: | Line 29: | ||
|descr= Adds an Event Handler to the given object. | |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 | * Use [[removeEventHandler]] to remove an Event Handler | ||
Read [[:Category:Event Handlers|Event Handlers]] for more information and a list of all available Event Handlers. | Read [[:Category:Event Handlers|Event Handlers]] for more information and a list of all available Event Handlers. | ||
|mp= Some event handlers are persistent (i.e | |mp= Some event handlers are persistent (i.e they stay attached to the unit, even after it dies and respawns). | ||
|s1= target [[addEventHandler]] [type, code] | |s1= target [[addEventHandler]] [type, code] | ||
|p1= target: [[Object]] or {{GVI|arma3|2.10}} [[Group]] | |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 | |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: | |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 < | * Event Handler parameters are accessible via <sqf inline>_this</sqf> | ||
* The Event Handler type is available as < | * The Event Handler type is available as <sqf inline>_thisEvent</sqf> | ||
* The Event Handler index is available as < | * The Event Handler index is available as <sqf inline>_thisEventHandler</sqf> | ||
|r1= [[Number]] - | |r1= [[Number]] - the index of the added Event Handler. Indices start at 0 for each unit and increment with each added Event Handler. | ||
|x1= < | |x1= <sqf> | ||
this addEventHandler ["Killed", { | |||
params ["_unit", "_killer"]; | params ["_unit", "_killer"]; | ||
systemChat format ["%1 has been killed by %2.", _unit, _killer]; | systemChat format ["%1 has been killed by %2.", _unit, _killer]; | ||
}];</sqf> | }]; | ||
</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]] | |seealso= [[removeEventHandler]] [[removeAllEventHandlers]] [[:Category:Event Handlers|Event Handlers]] [[addMPEventHandler]] [[addMissionEventHandler]] [[BIS_fnc_addScriptedEventHandler]] [[getEventHandlerInfo]] |
Revision as of 21:08, 21 August 2022
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
- 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:
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
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.85
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Event Handlers
- Scripting Commands: Local Effect