BIS fnc removeScriptedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "| arma3 |1.00 " to "|game1= arma3 |version1= 1.00 ")
m (Text replacement - " |r1=[[" to " |r1= [[")
Line 15: Line 15:
|p3= id: [[Number]] - EH id
|p3= id: [[Number]] - EH id


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


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

Revision as of 23:25, 7 August 2021

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: 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_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