BIS fnc removeStackedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - " |s1=[" to " |s1= [")
 
(36 intermediate revisions by 8 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 a stacked event handler with specified custom id.
____________________________________________________________________________________________


| <pre>/*
|s1= [id, event] call [[BIS_fnc_removeStackedEventHandler]]
Description:
This function removes an item that is stacked in some event
Parameter(s):
_this select 0: STRING - The unique ID of the item inside the stack
_this select 1: STRING - The onXxx event handler
Returns:
BOOLEAN - TRUE if successfully removed, FALSE if not
*/
//Parameters
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_removeStackedEventHandler]]; --> |= Syntax
|p1= key: [[String]] - custom id, a unique identifier, also returned by [[BIS_fnc_addStackedEventHandler]]


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


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


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


|seealso= [[BIS_fnc_addStackedEventHandler]]
}}
}}
<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:removeStackedEventHandler}}]]
[[Category:Functions|{{uc:removeStackedEventHandler}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeStackedEventHandler}}]]

Latest revision as of 23:11, 12 July 2022

Arma 3 logo black.png1.00
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_removeStackedEventHandler&oldid=327366"