removeEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
(Small overhaul, added an example with _thisEventHandler)
Line 7: Line 7:
|gr2= Event Handlers
|gr2= Event Handlers


| Removes an event handler added by [[addEventHandler]] by its index.
|descr= Removes a given Event Handler that was added with [[addEventHandler]].


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


|p1= objectName: [[Object]]
|p1= '''object''': [[Object]]


|p2= [type, index]: [[Array]]
|p2= '''type''': [[String]] - See [[:Category:Event Handlers|Event Handlers]] for the full list of available options.


|p3= type: [[String]] - see [[:Category:Event Handlers|Event Handlers]]
|p3= '''index''': [[Number]] - The value originally returned by [[addEventHandler]].


|p4= index: [[Number]] - value returned by [[addEventHandler]]
|r1= [[Nothing]]
 
|x1= <code>[[player]] [[removeEventHandler]] ["Killed", 0];</code>


| [[Nothing]]
|x2= Since Arma 3 v.1.63.137807 the Event Handler index is available as <tt>_thisEventHandler</tt> during Event Handler code execution and can be used to easily remove the Event Handler:
 
<code>[[player]] [[addEventHandler]] ["FiredNear", {
|x1= <code>[[player]] removeEventHandler ["killed", 0];</code>
[[systemChat]] "This Event Handler is now removing itself!";
[[player]] [[removeEventHandler]] ["FiredNear", _thisEventHandler];
}];</code>


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


Revision as of 23:20, 18 January 2021

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