removeMissionEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style='display:none'>Notes</h3>" to "")
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(36 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| arma3
|game1= arma3
|version1= 0.50


|0.50
|eff= local
 
|eff= local |MP Effects=


|gr1= Event Handlers
|gr1= Event Handlers


| Removes mission event handler added by [[addMissionEventHandler]].
|descr= Removes mission event handler added by [[addMissionEventHandler]].


| [[removeMissionEventHandler]] [type, index]
|s1= [[removeMissionEventHandler]] [type, index]


|p1= type: [[String]]
|p1= type: [[String]]


|p2= index: [[Number]] - Index is returned by addMissionEventHandler.
|p2= index: [[Number]] - index is returned by addMissionEventHandler.


| [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[private]] _eventHandlerId = [[addMissionEventHandler]] ["Ended", { [[diag_log]] "mission complete"; }];
|x1= <sqf>
{{cc|...}}
private _eventHandlerId = addMissionEventHandler ["Ended", { diag_log "mission complete"; }];
[[removeMissionEventHandler]] ["Ended", _eventHandlerId];</code>
// ...
removeMissionEventHandler ["Ended", _eventHandlerId];
</sqf>


|x2= <code>[[for]] "_i" [[from]] 0 [[to]] 4 [[do]] {
|x2= <sqf>
[[missionNamespace]] [[setVariable]] [<nowiki/>[[format]] ["handler%1",_i], [[addMissionEventHandler]] ["Loaded","hint ""_i"";"]];
for "_i" from 0 to 4 do {
missionNamespace setVariable [format ["handler%1",_i], addMissionEventHandler ["Loaded","hint ""_i"";"]];
};
};
[[removeMissionEventHandler]] ["Loaded", handler2]; {{cc|Remove the third index under type "Loaded"}}</code>
removeMissionEventHandler ["Loaded", handler2]; // Remove the third index under type "Loaded"
</sqf>


| [[addMissionEventHandler]], [[removeAllMissionEventHandlers]]
|x3= <sqf>addMissionEventHandler ["entityKilled",{hint "First kill!"; removeMissionEventHandler ["entityKilled", _thisEventHandler]; }];</sqf>


|seealso= [[addMissionEventHandler]] [[removeAllMissionEventHandlers]]
}}
}}


<dl class="command_description">


 
<dt><dt>
<dl class='command_description'>
<dd class="notedate">Posted on 2015-08-06 - 22:02 (UTC)</dd>
<!-- Note Section BEGIN -->
 
<dd class="notedate">Posted on August 6, 2015 - 22:02 (UTC)</dd>
<dt class="note">[[User:SilentSpike|SilentSpike]]</dt>
<dt class="note">[[User:SilentSpike|SilentSpike]]</dt>
<dd class="note">
<dd class="note">
Line 44: Line 46:
</dd>
</dd>


<!-- Note Section END -->
</dl>
</dl>
<h3 style='display:none'>Bottom Section</h3>

Latest revision as of 19:42, 3 September 2024

Hover & click on the images for description

Description

Description:
Removes mission event handler added by addMissionEventHandler.
Groups:
Event Handlers

Syntax

Syntax:
removeMissionEventHandler [type, index]
Parameters:
type: String
index: Number - index is returned by addMissionEventHandler.
Return Value:
Nothing

Examples

Example 1:
private _eventHandlerId = addMissionEventHandler ["Ended", { diag_log "mission complete"; }]; // ... removeMissionEventHandler ["Ended", _eventHandlerId];
Example 2:
for "_i" from 0 to 4 do { missionNamespace setVariable [format ["handler%1",_i], addMissionEventHandler ["Loaded","hint ""_i"";"]]; }; removeMissionEventHandler ["Loaded", handler2]; // Remove the third index under type "Loaded"
Example 3:
addMissionEventHandler ["entityKilled",{hint "First kill!"; removeMissionEventHandler ["entityKilled", _thisEventHandler]; }];

Additional Information

See also:
addMissionEventHandler removeAllMissionEventHandlers

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
Posted on 2015-08-06 - 22:02 (UTC)
SilentSpike
As of Arma 3 version 1.38 you can safely remove mission event handlers without worrying about decrementing higher indices.
EDIT: this command used to decrement other EH ids above the deleted one (e.g EH 0,1,2,3, delete EH 1, EH would be 0,1,2 now and not 0,2,3) - Lou Montana (talk) 19:29, 25 June 2020 (CEST)