addEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (removed nonworking example without any info in notes section)
Line 45: Line 45:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
String example: <code>_str = "This is a string"; _eventCode = _str + " exec "script.sqs"; _vehicle addEventHandler ['getIn', _eventCode]; </code>
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>

Revision as of 16:09, 15 January 2008

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 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. Every event will create an array named _this, which contains specific information about the particular event. (e.g. the "killed" EH will return an array with 2 elements: the killed unit, and the killer.)
Multiplayer:
Event handlers are persistent (i.e. they stay attached to a unit, even after it dies and respawns).
Groups:
Uncategorised

Syntax

Syntax:
Number = object addEventHandler ["type", {code}]
Parameters:
object: Object
type: String - Event Handler type
code: String - code that should be executed once the event occurs
Return Value:
_index Number - The index of the currently added event handler is returned. Indices start at 0 for each unit and increment with each added event handler. (optional)

Examples

Example 1:
_EHkilledIdx = player addEventHandler ["killed", {_this exec "playerKilled.sqs"}]
Example 2:
this addEventHandler ["killed", {hint format["%1 killed by %2",_this select 0, _this select 1]}]

Additional Information

See also:

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

Notes

Bottom Section