removeEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Updated Example with _thisEvent)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(One intermediate revision by the same user not shown)
Line 26: Line 26:
|descr= Removes a given Event Handler that was added with [[addEventHandler]].
|descr= Removes a given Event Handler that was added with [[addEventHandler]].


|s1= object [[removeEventHandler]] [type, index]
|s1= target [[removeEventHandler]] [type, index]


|p1= object: [[Object]]
|p1= target: [[Object]] or {{GVI|arma3|2.10}} [[Group]]


|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
Line 39: Line 39:


|x2= The [[Magic Variables]] <var>_thisEvent</var> and <var>_thisEventHandler</var> can be used to easily remove an Event Handler:
|x2= The [[Magic Variables]] <var>_thisEvent</var> and <var>_thisEventHandler</var> can be used to easily remove an Event Handler:
<sqf>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 [_thisEvent, _thisEventHandler];
}];</sqf>
}];
</sqf>


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

Latest revision as of 12:34, 3 September 2024

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:
target removeEventHandler [type, index]
Parameters:
target: Object or Arma 3 logo black.png2.10 Group
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=369196"