addEventHandler

From Bohemia Interactive Community
Revision as of 21:26, 31 July 2006 by Hardrock (talk | contribs)
Jump to navigation Jump to search
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. 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.
Groups:
Uncategorised

Syntax

Syntax:
unit addEventHandler [type, code]
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:
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.

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:
removeEventHandler

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