BIS fnc onEnd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[[^|]+\| *([a-zA-Z= _]+) *\]\]([^<]*)<\/code>" to "<code>$1$2$3</code>")
m (Some wiki formatting)
 
(One intermediate revision by the same user not shown)
Line 10: Line 10:


|descr= Register code to be executed after mission end.
|descr= Register code to be executed after mission end.
{{Feature|arma3|
Replaced by [[Arma 3: Mission Event Handlers#Ended|"Ended" mission event handler]].<br>
This function now exists only because of backward compatibility.
}}


|s1= argument call [[BIS_fnc_onEnd]]
|s1= argument call [[BIS_fnc_onEnd]]


|p1= argument:
|p1= argument: [[Code]], [[Array]] or [[Number]]:
* [[Code]] - code to be executed
* [[Code]] - code to be executed
* [[Array]] - code with arguments in format [code, arguments]
* [[Array]] - code with arguments in format [code, arguments]
Line 20: Line 24:
|r1= [[Number]] - index of onEnd code
|r1= [[Number]] - index of onEnd code


|x1= <code>private _onEndIndex = { player addRating 10000; } call BIS_fnc_onEnd;</code>
|x1= <sqf>private _onEndIndex = { player addRating 10000; } call BIS_fnc_onEnd;</sqf>


|x2= <code>private _onEndIndex = [{ { _x addRating 10000; } forEach _this; }, units group player] call BIS_fnc_onEnd;</code>
|x2= <sqf>private _onEndIndex = [{ { _x addRating 10000; } forEach _this; }, units group player] call BIS_fnc_onEnd;</sqf>


|seealso= [[Event Scripts]] [[Arma 3: Mission Event Handlers#Ended|Ended Mission Event Handler]]
|seealso= [[Event Scripts]] [[Arma 3: Mission Event Handlers#Ended|Ended Mission Event Handler]]
}}
}}

Latest revision as of 14:27, 3 August 2022

Hover & click on the images for description

Description

Description:
Register code to be executed after mission end.
Arma 3
Replaced by "Ended" mission event handler.
This function now exists only because of backward compatibility.
Execution:
call
Groups:
Event Handlers

Syntax

Syntax:
argument call BIS_fnc_onEnd
Parameters:
argument: Code, Array or Number:
  • Code - code to be executed
  • Array - code with arguments in format [code, arguments]
  • Number - remove code at given index
Return Value:
Number - index of onEnd code

Examples

Example 1:
private _onEndIndex = { player addRating 10000; } call BIS_fnc_onEnd;
Example 2:
private _onEndIndex = [{ { _x addRating 10000; } forEach _this; }, units group player] call BIS_fnc_onEnd;

Additional Information

See also:
Event Scripts Ended Mission Event Handler

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