removeEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#))?\]\] " to "")
(Add 2.10 group possibility)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofpr
|game1= ofp
|version1= 1.85


|1.85
|game2= ofpe
|version2= 1.00


|gr2= Event Handlers
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50
 
|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]].


|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


|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>


|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:
|x1= <sqf>player removeEventHandler ["Killed", 0];</sqf>
<code>[[player]] [[addEventHandler]] ["FiredNear", {
 
[[systemChat]] "This Event Handler is now removing itself!";
|x2= The [[Magic Variables]] <var>_thisEvent</var> and <var>_thisEventHandler</var> can be used to easily remove an Event Handler:
[[player]] [[removeEventHandler]] ["FiredNear", _thisEventHandler];
<sqf>player addEventHandler ["FiredNear", {
}];</code>
systemChat "This Event Handler is now removing itself!";
player removeEventHandler [_thisEvent, _thisEventHandler];
}];</sqf>


|seealso= [[addEventHandler]] [[:Category:Event Handlers|Event Handlers]] [[removeAllEventHandlers]] [[removeMPEventHandler]] [[removeMissionEventHandler]]
|seealso= [[addEventHandler]] [[removeAllEventHandlers]] [[removeMPEventHandler]] [[removeMissionEventHandler]] [[:Category:Event Handlers|Event Handlers]]
}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 11:52, 24 May 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:
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=322046"