Hardrock/Sandbox – User

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 69: Line 69:
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.


<h2 class="sectionheader">Usage:</h2><dl><dt>Syntax:</dt><dd>unit '''addEventHandler''' [type, code]</dd><div class="param"><dt>Parameters:</dt><dd>unit: [[Object]]
<h2 class="sectionheader">Usage:</h2><dl><dt>Syntax:</dt><dd>unit '''addEventHandler''' [type, code]</dd><dt class="param">Parameters:</dt><dd>unit: [[Object]]


type: [[String]] - Event handler type
type: [[String]] - Event handler type
Line 75: Line 75:
code: [[String]] - Code that should be executed once the event occurs</dd><dt>Return Value:</dt><dd>[[Integer]]
code: [[String]] - Code that should be executed once the event occurs</dd><dt>Return Value:</dt><dd>[[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.</dd></div><dt>Multiplayer Behaviour:</dt><dd>Unknown.</dd></dl><h2 class="sectionheader">Examples:</h2>
The index of the currently added event handler is returned. Indices start at 0 for each unit and increment with each added event handler.</dd><dt>Multiplayer Behaviour:</dt><dd>Unknown.</dd></dl><h2 class="sectionheader">Examples:</h2>
<dl><dt>Example 1:</dt><dd><code>Code 1</code></dd><dt>Example 2:</dt><dd><code>Code 2</code></dd></dl><h2 class="sectionheader">Additional Information:</h2><dl><dt>See also:</dt><dd>'''[[removeEventHandler]]'''</dd><dt>Attention:</dt><dd>Not filled.</dd><dt>Bugs:</dt><dd>
<dl><dt>Example 1:</dt><dd><code>Code 1</code></dd><dt>Example 2:</dt><dd><code>Code 2</code></dd></dl><h2 class="sectionheader">Additional Information:</h2><dl><dt>See also:</dt><dd>'''[[removeEventHandler]]'''</dd><dt>Attention:</dt><dd>Not filled.</dd><dt>Bugs:</dt><dd>
* First
* First

Revision as of 01:38, 27 July 2006

Option 1:
Dependencies
Game: Operation Flashpoint
Game Version: 1.00
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.
Usage
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.
Multiplayer: Behaviour not known.
Examples
Example 1: Code 1
Example 2: Code 2
Additional Information
See also: removeEventHandler
Attention: This and that happens then and then.
Bugs:
  • First bug
  • Second bug


Option 2:

Dependencies:

Game:
Operation Flashpoint
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.

Usage:

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.
Multiplayer Behaviour:
Unknown.

Examples:

Example 1:
Code 1
Example 2:
Code 2

Additional Information:

See also:
removeEventHandler
Attention:
Not filled.
Bugs:
  • First
  • Second
  • Third