BIS fnc removeStackedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(\[[^ ]+\] (call|spawn) ('''|\[\[)BI(N|S)_fnc_[a-zA-Z0-9_]+('''|\]\]));? \| *p1 *=" to " |s1=$1 |p1=")
m (Text replacement - " |s1=[" to " |s1= [")
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Event Handlers
|gr1= Event Handlers


| Removes a stacked event handler with specified custom id.
|descr= Removes a stacked event handler with specified custom id.


|s1=[id, event] call [[BIS_fnc_removeStackedEventHandler]]
|s1= [id, event] call [[BIS_fnc_removeStackedEventHandler]]


|p1= key: [[String]] - custom id, a unique identifier, also returned by [[BIS_fnc_addStackedEventHandler]]
|p1= key: [[String]] - custom id, a unique identifier, also returned by [[BIS_fnc_addStackedEventHandler]]
Line 15: Line 14:
|p2= event: [[String]] - event handler name, see [[BIS_fnc_addStackedEventHandler]] fr supported event handlers
|p2= event: [[String]] - event handler name, see [[BIS_fnc_addStackedEventHandler]] fr supported event handlers


|r1=[[Boolean]] - [[true]] on success, [[false]] on failure
|r1= [[Boolean]] - [[true]] on success, [[false]] on failure


|x1= <code>["someId", "onEachFrame"] [[call]] [[BIS_fnc_removeStackedEventHandler]];</code>
|x1= <sqf>["someId", "onEachFrame"] call BIS_fnc_removeStackedEventHandler;</sqf>


|seealso= [[BIS_fnc_addStackedEventHandler]]
|seealso= [[BIS_fnc_addStackedEventHandler]]
}}
}}
[[Category:{{Name|arma3}}: Functions|{{uc:removeStackedEventHandler}}]]

Latest revision as of 23:11, 12 July 2022

Hover & click on the images for description

Description

Description:
Removes a stacked event handler with specified custom id.
Execution:
call
Groups:
Event Handlers

Syntax

Syntax:
[id, event] call BIS_fnc_removeStackedEventHandler
Parameters:
key: String - custom id, a unique identifier, also returned by BIS_fnc_addStackedEventHandler
event: String - event handler name, see BIS_fnc_addStackedEventHandler fr supported event handlers
Return Value:
Boolean - true on success, false on failure

Examples

Example 1:
["someId", "onEachFrame"] call BIS_fnc_removeStackedEventHandler;

Additional Information

See also:
BIS_fnc_addStackedEventHandler

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