BIS fnc removeAllScriptedEventHandlers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(format)
m (Some wiki formatting)
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Event Handlers


|1.00|= Game version
|descr= Removes all scripted event handler with given name.
____________________________________________________________________________________________
Additionally "ScriptedEventHandlerRemoved" scripted EH is called for every removed event handler.
{{Feature|informative|For a list of available scripted event handlers, see [[Arma 3: Scripted Event Handlers]].}}


| Removes all scripted event handler with given name. "ScriptedEventHandlerRemoved" scripted EH is called for every removed EH|= Description
|s1= [namespace, name] call [[BIS_fnc_removeAllScriptedEventHandlers]]
____________________________________________________________________________________________


| [namespace, name] call [[BIS_fnc_removeAllScriptedEventHandlers]] |= Syntax
|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved


|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved|=
|p2= name: [[String]] - handler name
|p2= name: [[String]] - handler name|=


| [[Boolean]] - [[false]] if never existed, [[true]] otherwise|= Return value
|r1= [[Boolean]] - [[false]] if never existed, [[true]] otherwise
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event"] [[call]] [[BIS_fnc_removeAllScriptedEventHandlers]]; </code> |=
|x1= <sqf>[missionNamespace, "event"] call BIS_fnc_removeAllScriptedEventHandlers;</sqf>
____________________________________________________________________________________________
| [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeScriptedEventHandler]] |= See also


|seealso= [[BIS_fnc_callScriptedEventHandler]] [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:removeAllScriptedEventHandlers}}]]
[[Category:Functions|{{uc:removeAllScriptedEventHandlers}}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeAllScriptedEventHandlers}}]]

Latest revision as of 13:09, 13 July 2022

Hover & click on the images for description

Description

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

Syntax

Syntax:
[namespace, name] call BIS_fnc_removeAllScriptedEventHandlers
Parameters:
namespace: Namespace, Object, Group, Location, Boolean, Control or Display - namespace in which handler is saved
name: String - handler name
Return Value:
Boolean - false if never existed, true otherwise

Examples

Example 1:
[missionNamespace, "event"] call BIS_fnc_removeAllScriptedEventHandlers;

Additional Information

See also:
BIS_fnc_callScriptedEventHandler BIS_fnc_addScriptedEventHandler BIS_fnc_removeScriptedEventHandler

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