addEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(add example)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Adds an event handler to a given unit. For more information about event handlers and their types check the scripting topic [[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. |=
| Adds an event handler to a given unit. For more information about event handlers and their types check the scripting topic [[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.  
 
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.)
|=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 23: Line 26:


| [[Integer]] -   
| [[Integer]] -   
The index of the currently added event handler is returned. Indices start at 0 for each unit and increment with each added event handler. |=
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)|=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>EHkilled <nowiki>=</nowiki> [[player]] '''addEventHandler''' ["killed", {_this [[exec]] "playerKilled.sqs"}]</code> |=
|x1= <code>EHkilled <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> |=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 01:04, 26 December 2006

Hover & click on the images for description

Description

Description:
Adds an event handler to a given unit. For more information about event handlers and their types check the scripting topic 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. 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.)
Groups:
Uncategorised

Syntax

Syntax:
unit addEventHandler [type, code]
Parameters:
unit: Object
type: String - Event Handler type
code: String - code that should be executed once the event occurs
Return Value:
Integer - 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)

Examples

Example 1:
EHkilled = player addEventHandler ["killed", {_this exec "playerKilled.sqs"}]
Example 2:
this addEventHandler ["killed", {hint format["%1 killed by %2",_this select 0, _this select 1]}]

Additional Information

See also:

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

Notes

Bottom Section