Hardrock/Sandbox – User

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 67: Line 67:
== Dependencies ==
== Dependencies ==


{| cellspacing="0" cellpadding="5" style="text-align:left"
<dt>Game:</dt>
! style="width:100px" | Game:
<dd>Operation Flashpoint</dd>
| Operation Flashpoint
|-
! Version:
| 1.00
|}


== Description ==  
<dt>Version:</dt>
<dd>1.00</dd>
 
== 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.
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 81: Line 79:
== Usage ==
== Usage ==


{| cellspacing="0" cellpadding="5" style="text-align:left"
<dt>Syntax:</dt>
! style="width:100px" | Syntax:
<dd>unit '''addEventHandler''' [type, code]</dd>
| unit '''addEventHandler''' [type, code]
 
|-
<dt>Parameters:</dt>
! Parameters:
<dd>unit: [[Object]]
|
 
|-
type: [[String]] - Event handler type
! Return Value:
 
|
code: [[String]] - Code that should be executed once the event occurs</dd>
|-
 
! Multiplayer:
<dt>Return Value:</dt>
| Behaviour unknown.
<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>
 
<dt>Multiplayer Behaviour:</dt>
<dd>Unknown.</dd>


== Examples ==
== Examples ==


{| cellspacing="0" cellpadding="5" style="text-align:left"
<dt>Example 1:</dt>
! style="width:100px" | Example 1:
<dd><code>Code 1</code></dd>
| <code>Code 1</code>
 
|-
<dt>Example 2:</dt>
! Example 2:
<dd><code>Code 2</code></dd>
| <code>Code 2</code>
|}


== Additional Information ==
== Additional Information ==


{| cellspacing="0" cellpadding="5" style="text-align:left"
<dt>See also:</dt>
! style="width:100px" | Attention:
<dd>'''[[removeEventHandler]]'''</dd>
|
 
|-
<dt>Attention:</dt>
! Bugs:
<dd></dd>
|
 
|}
<dt>Bugs:</dt>
<dd>
* First
* Second
* Third
</dd>


[[Category:Sandbox]]
[[Category:Sandbox]]

Revision as of 00:34, 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:
Bugs:
  • First
  • Second
  • Third