BIS fnc removeAllScriptedEventHandlers: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " |r1=[[" to " |r1= [[") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
|gr1= Event Handlers | |gr1= Event Handlers | ||
|descr= Removes all scripted event handler with given name. | |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]].}} | |||
|s1=[namespace, name] call [[BIS_fnc_removeAllScriptedEventHandlers]] | |s1= [namespace, name] call [[BIS_fnc_removeAllScriptedEventHandlers]] | ||
|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 | ||
|r1= [[Boolean]] - [[false]] if never existed, [[true]] otherwise | |r1= [[Boolean]] - [[false]] if never existed, [[true]] otherwise | ||
|x1= < | |x1= <sqf>[missionNamespace, "event"] call BIS_fnc_removeAllScriptedEventHandlers;</sqf> | ||
|seealso= [[BIS_fnc_callScriptedEventHandler]] | |||
|seealso= [[BIS_fnc_callScriptedEventHandler]] [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_removeScriptedEventHandler]] | |||
}} | }} | ||
Latest revision as of 13:09, 13 July 2022
Description
- Description:
- Removes all scripted event handler with given name. Additionally "ScriptedEventHandlerRemoved" scripted EH is called for every removed event handler.
- 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:
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