removeEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Add 2.10 group possibility)
 
(43 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|REMOVEEVENTHANDLER]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.96|REMOVEEVENTHANDLER]]
[[Category:Scripting Commands ArmA|REMOVEEVENTHANDLER]]


|game1= ofp
|version1= 1.85


<h2 style="color:#000066">''object '''''removeEventHandler ''handler'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''object:''' [[Object]]
|game5= arma2oa
|version5= 1.50


'''handler:''' [[Array]]
|game6= tkoh
|version6= 1.00


'''Type of returned value:'''
|game7= arma3
|version7= 0.50


[[Nothing]]
|gr1= Event Handlers


'''Compatibility:'''
|descr= Removes a given Event Handler that was added with [[addEventHandler]].


Added in version '''1.85'''
|s1= target [[removeEventHandler]] [type, index]


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


Removes event handler added by [[addEventHandler]].
|p2= type: [[String]] - see [[:Category:Event Handlers|Event Handlers]] for the full list of available options


Format of handler is '''''[type, index]'''''.
|p3= index: [[Number]] - the value originally returned by [[addEventHandler]]


Index is returned by [[addEventHandler]].
|r1= [[Nothing]]


When any handler is removed, all handler indices higher than the deleted one should be decremented.
|x1= <sqf>player removeEventHandler ["Killed", 0];</sqf>


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


'''Example:'''
|seealso= [[addEventHandler]] [[removeAllEventHandlers]] [[removeMPEventHandler]] [[removeMissionEventHandler]] [[:Category:Event Handlers|Event Handlers]]
 
}}
[[player]] '''removeEventHandler''' ["killed", 0]

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"