BIS fnc removeScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Some wiki formatting)
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Event Handlers


|gr1 = Event Handlers |GROUP1=
|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]].}}


| 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: Event Handlers/ScriptedEventHandlers]] |DESCRIPTION=
|s1= [namespace, name, id] call [[BIS_fnc_removeScriptedEventHandler]]


| [namespace, name, id] call [[BIS_fnc_removeScriptedEventHandler]] |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|Parameter1=
|p2= name: [[String]] - handler name
|p2= name: [[String]] - handler name|Parameter2=


|p3= id: [[Number]] - EH id |PARAMETER3=
|p3= id: [[Number]] - EH id


| [[Boolean]] - [[true]] if removed, [[false]] if didn't exist|RETURNVALUE=
|r1= [[Boolean]] - [[true]] if removed, [[false]] if didn't exist


|x1= <code><nowiki>[</nowiki>[[missionNamespace]], "event", 2] [[call]] [[BIS_fnc_removeScriptedEventHandler]]; </code> |EXAMPLE1=
|x1= <sqf>[missionNamespace, "event", 2] call BIS_fnc_removeScriptedEventHandler;</sqf>
| [[BIS_fnc_callScriptedEventHandler]], [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_removeAllScriptedEventHandlers]] |SEEALSO=


|seealso= [[BIS_fnc_callScriptedEventHandler]] [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_removeAllScriptedEventHandlers]]
}}
}}
<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:Functions|{{uc:removeScriptedEventHandler}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeScriptedEventHandler}}]]

Latest revision as of 13:30, 13 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

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

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

Examples

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

Additional Information

See also:
BIS_fnc_callScriptedEventHandler BIS_fnc_addScriptedEventHandler BIS_fnc_removeAllScriptedEventHandlers

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=BIS_fnc_removeScriptedEventHandler&oldid=327930"