BIS fnc removeScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "^ {{Function\|Comments\=" to "{{Function|Comments=")
mNo edit summary
Line 15: Line 15:
|p2= name: [[String]] - handler name|Parameter2=
|p2= name: [[String]] - handler name|Parameter2=


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


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


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

Revision as of 08:58, 25 September 2020

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 the list of available scripted event handlers see Arma 3: Event Handlers/ScriptedEventHandlers
Execution:
call
Groups:
Uncategorised

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_callScriptedEventHandlerBIS_fnc_addScriptedEventHandlerBIS_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

Notes

Bottom Section