addEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (removed nonworking example without any info in notes section)
m (Undo revision 363475 by R3vo (talk))
Tag: Undo
 
(98 intermediate revisions by 20 users not shown)
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 [[:Category:Event Handlers|Event handlers]] in this reference. 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


Every event will create an array named '''_this''', which contains specific information about the particular event. (e.g. the "killed" EH will return an array with 2 elements: the killed unit, and the killer.)
|game6= tkoh
|=
|version6= 1.00
____________________________________________________________________________________________


| [[Number]] <nowiki>=</nowiki> object '''addEventHandler''' ["type", {code}] |=
|game7= arma3
|version7= 0.50


|p1= object: [[Object]] |=
|arg= global


|p2= type: [[String]] - [[:Category:Event Handlers|Event Handler]] type |=
|eff= local


|p3= code: [[String]] - code that should be executed once the event occurs |=
|gr1= Event Handlers


| _index [[Number]] - 
|descr= Adds an Event Handler to the given object.
The index of the currently added event handler is returned. Indices start at 0 for each unit and increment with each added event handler. (optional)|=
* 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.
|x1= <code>_EHkilledIdx <nowiki>=</nowiki> [[player]] '''addEventHandler''' ["killed", {_this [[exec]] "playerKilled.sqs"}]</code> |=
|x2= <code>this addEventHandler ["killed", {hint format["%1 killed by %2",_this select 0, _this select 1]}]</code> |=
____________________________________________________________________________________________


|mp= Event handlers are persistent (i.e. they stay attached to a unit, even after it dies and respawns). |=
|mp= Some event handlers are persistent (i.e they stay attached to the unit, even after it dies and respawns).
|
* [[removeEventHandler]]
* [[Operation_Flashpoint:_EventHandlers_List|OFP EventHandlers list]]
* [[Armed Assault:_EventHandlers_List|ArmA EventHandlers list]]
|=


|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]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Killzone_Kid
<!-- Note Section BEGIN -->
|timestamp= 20150607210600
<!-- Note Section END -->
|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:
</dl>
<sqf>if (whatever) exitWith {true}; false;</sqf>
 
Forget about it, will not work. Instead use:
<h3 style="display:none">Bottom Section</h3>
<sqf>if (whatever) then {true} else {false};</sqf>
[[Category:Scripting Commands|ADDEVENTHANDLER]]
100% satisfaction guaranteed!
[[Category:Scripting Commands OFP 1.96|ADDEVENTHANDLER]]
}}
[[Category:Scripting Commands ArmA|ADDEVENTHANDLER]]
[[Category:Command_Group:_Activators|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:58, 31 March 2024

Logo A0.png1.85ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
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 Arma 3 logo black.png2.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:
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!
Retrieved from "https://community.bistudio.com/wiki?title=addEventHandler&oldid=363476"