removeEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<tt>([a-zA-Z0-9\. _"']+)<\/tt>" to "{{hl|$1}}")
m (Updated Example with _thisEvent)
Line 22: Line 22:
|version7= 0.50
|version7= 0.50


|gr2= Event Handlers
|gr1= Event Handlers


|descr= Removes a given Event Handler that was added with [[addEventHandler]].
|descr= Removes a given Event Handler that was added with [[addEventHandler]].
Line 30: Line 30:
|p1= object: [[Object]]
|p1= object: [[Object]]


|p2= type: [[String]] - See [[:Category:Event Handlers|Event Handlers]] for the full list of available options
|p2= type: [[String]] - see [[:Category:Event Handlers|Event Handlers]] for the full list of available options


|p3= index: [[Number]] - The value originally returned by [[addEventHandler]]
|p3= index: [[Number]] - the value originally returned by [[addEventHandler]]


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[player]] [[removeEventHandler]] ["Killed", 0];</code>
|x1= <sqf>player removeEventHandler ["Killed", 0];</sqf>


|x2= Since Arma 3 v1.64 the Event Handler index is available as {{hl|_thisEventHandler}} during Event Handler code execution and can be used to easily remove the Event Handler:
|x2= The [[Magic Variables]] <var>_thisEvent</var> and <var>_thisEventHandler</var> can be used to easily remove an Event Handler:
<code>[[player]] [[addEventHandler]] ["FiredNear",
<sqf>player addEventHandler ["FiredNear", {
{
systemChat "This Event Handler is now removing itself!";
[[systemChat]] "This Event Handler is now removing itself!";
player removeEventHandler [_thisEvent, _thisEventHandler];
[[player]] [[removeEventHandler]] ["FiredNear", _thisEventHandler];
}];</sqf>
}];</code>


|seealso= [[addEventHandler]] [[:Category:Event Handlers|Event Handlers]] [[removeAllEventHandlers]] [[removeMPEventHandler]] [[removeMissionEventHandler]]
|seealso= [[addEventHandler]] [[removeAllEventHandlers]] [[removeMPEventHandler]] [[removeMissionEventHandler]] [[:Category:Event Handlers|Event Handlers]]
}}
}}

Revision as of 13:40, 27 March 2022

Logo A0.png1.85ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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:
The Magic Variables _thisEvent and _thisEventHandler can be used to easily remove an Event Handler:
player addEventHandler ["FiredNear", { systemChat "This Event Handler is now removing itself!"; player removeEventHandler [_thisEvent, _thisEventHandler]; }];

Additional Information

See also:
addEventHandler removeAllEventHandlers removeMPEventHandler removeMissionEventHandler Event Handlers

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
Retrieved from "https://community.bistudio.com/wiki?title=removeEventHandler&oldid=308630"