BIS fnc removeScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Some wiki formatting)
 
(35 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 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]].}}


| <pre>/*
|s1= [namespace, name, id] call [[BIS_fnc_removeScriptedEventHandler]]


Description:
|p1= namespace: [[Namespace]], [[Object]], [[Group]], [[Location]], [[Boolean]], [[Control]] or [[Display]] - namespace in which handler is saved
Remove scripted event handler


Parameter(s):
|p2= name: [[String]] - handler name
0: NAMESPACE, OBJECT, GROUP or LOCATION - namespace in which handler is saved
1: STRING - handler name
2: NUMBER - handler ID


Returns:
|p3= id: [[Number]] - EH id
BOOL
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_removeScriptedEventHandler]]; --> |= Syntax
|r1= [[Boolean]] - [[true]] if removed, [[false]] if didn't exist


|p1= |= Parameter 1
|x1= <sqf>[missionNamespace, "event", 2] call BIS_fnc_removeScriptedEventHandler;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|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:Function Group: Misc|{{uc:removeScriptedEventHandler}}]]
[[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"