removeEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed example)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(41 intermediate revisions by 13 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]]


{{Command|= Comments
|game1= ofp
____________________________________________________________________________________________
|version1= 1.85


| ofpr |= Game name
|game2= ofpe
|version2= 1.00


|1.85|= Game version
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Removes event handler added by [[addEventHandler]].  
|game4= arma2
|version4= 1.00


Format of handler is [type, index].  
|game5= arma2oa
|version5= 1.50


Index is returned by [[addEventHandler]].  
|game6= tkoh
|version6= 1.00


When any handler is removed, all handler indices higher than the deleted one should be decremented. |= Description
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50


| object '''removeEventHandler''' handler |= Syntax
|gr1= Event Handlers


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


|p2= handler: [[Array]] |= Parameter 2
|s1= target [[removeEventHandler]] [type, index]


| [[Nothing]] |= Return value
|p1= target: [[Object]] or {{GVI|arma3|2.10}} [[Group]]
____________________________________________________________________________________________
 
|x1= <code>[[player]] removeEventHandler ["killed", 0]</code> |= Example 1
____________________________________________________________________________________________


| |= See also
|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]]
 
|r1= [[Nothing]]
 
|x1= <sqf>player removeEventHandler ["Killed", 0];</sqf>


<h3 style="display:none">Notes</h3>
|x2= The [[Magic Variables]] <var>_thisEvent</var> and <var>_thisEventHandler</var> can be used to easily remove an Event Handler:
<dl class="command_description">
<sqf>
<!-- Note Section BEGIN -->
player addEventHandler ["FiredNear", {
systemChat "This Event Handler is now removing itself!";
player removeEventHandler [_thisEvent, _thisEventHandler];
}];
</sqf>


<!-- Note Section END -->
|seealso= [[addEventHandler]] [[removeAllEventHandlers]] [[removeMPEventHandler]] [[removeMissionEventHandler]] [[:Category:Event Handlers|Event Handlers]]
</dl>
}}

Latest revision as of 11: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"