BIS fnc removeStackedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= * " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Event Handlers |GROUP1=
|gr1 = Event Handlers


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


| [id, event] call [[BIS_fnc_removeStackedEventHandler]]; |SYNTAX=
| [id, event] call [[BIS_fnc_removeStackedEventHandler]];


|p1= key: [[String]] - custom id, a unique identifier, also returned by [[BIS_fnc_addStackedEventHandler]] |PARAMETER1=
|p1= key: [[String]] - custom id, a unique identifier, also returned by [[BIS_fnc_addStackedEventHandler]]


|p2= event: [[String]] - event handler name, see [[BIS_fnc_addStackedEventHandler]] fr supported event handlers |PARAMETER2=
|p2= event: [[String]] - event handler name, see [[BIS_fnc_addStackedEventHandler]] fr supported event handlers


| [[Boolean]] - [[true]] on success, [[false]] on failure |RETURNVALUE=
| [[Boolean]] - [[true]] on success, [[false]] on failure
   
   
|x1= <code>["someId", "onEachFrame"] [[call]] [[BIS_fnc_removeStackedEventHandler]];</code>
|x1= <code>["someId", "onEachFrame"] [[call]] [[BIS_fnc_removeStackedEventHandler]];</code>


| [[BIS_fnc_addStackedEventHandler]] |SEEALSO=
| [[BIS_fnc_addStackedEventHandler]]


}}
}}

Revision as of 23:39, 17 January 2021

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

Notes

Bottom Section