addEventHandler: Difference between revisions

Revision as of 19:33, 31 July 2006

-wrong parameter ("addEventHandler") defined!-[[:Category:Introduced with addEventHandler version ofpr|OFPR]]

GAGlobal LELocal

Hover & click on the images for description

Description

Description:: 1.85
Groups:: Uncategorised

Syntax

Syntax:: 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.
Parameters:: unit: Object
: type: String - The event handler type. Check Event handlers for the available types.
: code: String - The scripting code which should be executed on activation of the event handler.
Return Value:: unit addEventHandler [type, code]

Examples

Example 1:: EHkilled = player addEventHandler ["killed", {_this exec "playerKilled.sqs"}] This example adds an event handler of type "killed" to the player. Once the player dies, the script "playerKilled.sqs" will be executed.

Additional Information

See also:: 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.

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

[[Category:Introduced with addEventHandler version ofpr]][[ Category: addEventHandler: New Scripting Commands | ADDEVENTHANDLER]][[ Category: addEventHandler: Scripting Commands | ADDEVENTHANDLER]]

@@ Line 4: / Line 4: @@
-<h2 style="color:#000066">'''''object'' addEventHandler ''handler'''''</h2>
+{{Command|=
+____________________________________________________________________________________________
+| addEventHandler |=
-'''Operand types:'''
+| ofpr |=
-'''object:''' [[Object]]
+|1.85|=
-'''handler:''' [[Array]]
+|arg= global |=
-'''Type of returned value:'''
+|eff= local |=
+____________________________________________________________________________________________
-[[Number]]
+| 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. |=
+____________________________________________________________________________________________
-'''Compatibility:'''
+| unit '''addEventHandler''' [type, code] |=
-Added in version '''1.85'''
+|p1= unit: [[Object]] |=
-'''Description:'''
+|p2= type: [[String]] - The event handler type. Check [[Event handlers]] for the available types. |=
-Format of handler is '''''[type ([[String]]),command ([[Code]])]'''''.
+|p3= code: [[String]] - The scripting code which should be executed on activation of the event handler. |=
-Check scripting topic [[Event handlers]] for more information.
+| [[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. |=
+____________________________________________________________________________________________
-Index of currently added handler is returned.
+|x1= <code><nowiki>EHkilled = player addEventHandler ["killed", {_this exec "playerKilled.sqs"}]</nowiki></code>
+This example adds an event handler of type "killed" to the player. Once the player dies, the script "playerKilled.sqs" will be executed. |=
+____________________________________________________________________________________________
-'''Example:'''
+| [[removeEventHandler]] |=
-player '''addEventHandler''' ["killed",{_this [[exec]] "playerKilled.sqs"}]
+}}
+<dl class="command_description">
+<!-- Note Section BEGIN -->
+<!-- Note Section END -->
+</dl>