BIS fnc removeStackedEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - " |s1=[" to " |s1= [")
 
(32 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Event Handlers
____________________________________________________________________________________________


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


| param call [[BIS_fnc_removeStackedEventHandler]]; |= Syntax
|s1= [id, event] call [[BIS_fnc_removeStackedEventHandler]]


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


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


| [[Array]] |= Return value
|r1= [[Boolean]] - [[true]] on success, [[false]] on failure
____________________________________________________________________________________________
 
|x1= <code>["someId", "onEachFrame"] [[call]] [[BIS_fnc_removeStackedEventHandler]];</code> |=
____________________________________________________________________________________________


| [[BIS fnc addStackedEventHandler]] |= See also
|x1= <sqf>["someId", "onEachFrame"] call BIS_fnc_removeStackedEventHandler;</sqf>


|seealso= [[BIS_fnc_addStackedEventHandler]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on November 1, 2013
<dt class="note">[[User:neokika|neokika]]<dd class="note">
More info at: http://forums.bistudio.com/showthread.php?167822-Stacked-event-handlers-OnEachFrame-OnPlayerConnected-etc
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Arma 3:_Functions|log]]
[[Category:Function Group: Debug|log]]

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