Hardrock/Sandbox – User
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{|style="width:75%; text-align:left" | {|style="width:75%; text-align:left; vertical-align: top" | ||
|colspan=" | |colspan="3" style="font-size:1.7em; font-weight:bold; color:darkblue"|addEventHandler | ||
|style="background:#FFFFEE; border:1px solid grey; width:80px; text-align:center"|version: 1.00 | |style="background:#FFFFEE; border:1px solid grey; width:80px; text-align:center"|version: 1.00 | ||
|- | |- | ||
| Line 10: | Line 10: | ||
|colspan="2"|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. | |colspan="2"|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. | ||
|- | |- | ||
!Syntax: | !style="vertical-align:top"|Syntax: | ||
|<code>unit addEventHandler [type, code]</code> | |colspan="2"|<code>unit addEventHandler [type, code]</code> | ||
|- | |||
!style="vertical-align:top"|Parameters: | |||
|style="width:80px"|unit: Object | |||
|- | |||
| | |||
|type: String | |||
|event handler type | |||
|- | |||
| | |||
|code: String | |||
|code that should be executed once the event occurs | |||
|- | |||
!style="vertical-align:top"|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. | |||
|} | |} | ||
[[Category:Sandbox]] | [[Category:Sandbox]] | ||
Revision as of 20:18, 26 July 2006
| addEventHandler | version: 1.00 | ||
| 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. | ||
|---|---|---|---|
| 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. | |