removeEventHandler

From Bohemia Interactive Community
Revision as of 22:20, 18 January 2021 by Ansin11 (talk | contribs) (Small overhaul, added an example with _thisEventHandler)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Removes a given Event Handler that was added with addEventHandler.
Groups:
Event Handlers

Syntax

Syntax:
object removeEventHandler [type, index]
Parameters:
object: Object
type: String - See Event Handlers for the full list of available options.
index: Number - The value originally returned by addEventHandler.
Return Value:
Nothing

Examples

Example 1:
player removeEventHandler ["Killed", 0];
Example 2:
Since Arma 3 v.1.63.137807 the Event Handler index is available as _thisEventHandler during Event Handler code execution and can be used to easily remove the Event Handler: player addEventHandler ["FiredNear", { systemChat "This Event Handler is now removing itself!"; player removeEventHandler ["FiredNear", _thisEventHandler]; }];

Additional Information

See also:
addEventHandler Event Handlers removeAllEventHandlers removeMPEventHandler removeMissionEventHandler

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