BIS fnc onEnd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "|= Game name" to "|Game name=")
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| tkoh |= Game name
| tkoh |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Register code to be executed after mission end. |DESCRIPTION=
 
____________________________________________________________________________________________
Description:
Register code to be executed after mission end.


Parameter(s):
| argument call [[BIS_fnc_onEnd]] |SYNTAX=
_this:
CODE
ARRAY - code with custom arguments in format [CODE,ARG1,ARG2,...]
NUMBER - remove code of given index


Returns:
|p1= argument:
NUMBER - index of onEnd code
* [[Code]] - code to be executed
*/
* [[Array]] - code with arguments in format [code, arguments]
* [[Number]] - remove code at given index
&nbsp;|PARAMETER1=


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Number]] - index of onEnd code |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_onEnd]]; --> |= Syntax
|x1= <code>_onEndIndex = { [[player]] [[addRating]] 10000; } [[call]] [[BIS_fnc_onEnd]];</code> |EXAMPLE1=


|p1= |= Parameter 1
|x2= <code>_onEndIndex = [{ { [[_x]] [[addRating]] 10000; } [[forEach]] [[_this]]; }, [[units]] [[group]] [[player]]] [[call]] [[BIS_fnc_onEnd]];</code> |EXAMPLE2=
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=
| [[Event Scripts]], [[Arma_3:_Event_Handlers/addMissionEventHandler#Ended|Ended Mission Event Handler]] |SEEALSO=
____________________________________________________________________________________________
 
| |= See also
 
}}
}}



Revision as of 00:51, 31 August 2019

Hover & click on the images for description

Description

Description:
Register code to be executed after mission end.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
argument call BIS_fnc_onEnd
Parameters:
argument:
  • 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:
_onEndIndex = { player addRating 10000; } call BIS_fnc_onEnd;
Example 2:
_onEndIndex = [{ { _x addRating 10000; } forEach _this; }, units group player] call BIS_fnc_onEnd;

Additional Information

See also:
Event ScriptsEnded 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

Notes

Bottom Section