BIS fnc removeScriptedEventHandler: Difference between revisions

Latest revision as of 13:30, 13 July 2022

Hover & click on the images for description

Description:: Removes scripted event handler with given name and id. Additionally "ScriptedEventHandlerRemoved" scripted EH is called.
ⓘ
For a list of available scripted event handlers, see Arma 3: Scripted Event Handlers.
Execution:: call
Groups:: Event Handlers

Syntax:: [namespace, name, id] call BIS_fnc_removeScriptedEventHandler
Parameters:: namespace: Namespace, Object, Group, Location, Boolean, Control or Display - namespace in which handler is saved
: name: String - handler name
: id: Number - EH id
Return Value:: Boolean - true if removed, false if didn't exist

Example 1:: [missionNamespace, "event", 2] call BIS_fnc_removeScriptedEventHandler;

See also:: BIS_fnc_callScriptedEventHandler BIS_fnc_addScriptedEventHandler BIS_fnc_removeAllScriptedEventHandlers

: 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

@@ Line 6: / Line 6: @@
 |gr1= Event Handlers
-|descr= Removes scripted event handler with given name and id. Additionally "ScriptedEventHandlerRemoved" scripted EH is called. For the list of available scripted event handlers see [[Arma 3: Scripted Event Handlers]]
+|descr= Removes scripted event handler with given name and id.
+Additionally "ScriptedEventHandlerRemoved" scripted EH is called.
+{{Feature|informative|For a list of available scripted event handlers, see [[Arma 3: Scripted Event Handlers]].}}
-|s1=[namespace, name, id] call [[BIS_fnc_removeScriptedEventHandler]]
+|s1= [namespace, name, id] call [[BIS_fnc_removeScriptedEventHandler]]
 |p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved
 |p2= name: [[String]] - handler name
 |p3= id: [[Number]] - EH id
-|r1=[[Boolean]] - [[true]] if removed, [[false]] if didn't exist
+|r1= [[Boolean]] - [[true]] if removed, [[false]] if didn't exist
+|x1= <sqf>[missionNamespace, "event", 2] call BIS_fnc_removeScriptedEventHandler;</sqf>
-|x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", 2] [[call]] [[BIS_fnc_removeScriptedEventHandler]];</code>
+|seealso= [[BIS_fnc_callScriptedEventHandler]] [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]]
-|seealso= [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]]
 }}