addEventHandler: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| 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 | | 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. |= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 18: | Line 18: | ||
|p1= unit: [[Object]] |= | |p1= unit: [[Object]] |= | ||
|p2= type: [[String]] - | |p2= type: [[String]] - event handler type |= | ||
|p3= code: [[String]] - | |p3= code: [[String]] - code that should be executed once the event occurs |= | ||
| [[Integer]] - The index of the currently added event handler is returned. Indices start at 0 for | | [[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. |= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= < | |x1= <pre>EHkilled = player addEventHandler ["killed", {_this exec "playerKilled.sqs"}]</pre> |= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 38: | Line 37: | ||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
Revision as of 11:31, 1 August 2006
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.
- 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.
Examples
- Example 1:
EHkilled = player addEventHandler ["killed", {_this exec "playerKilled.sqs"}]
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