BIS fnc endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
(Created page with "{{Function|= Comments ____________________________________________________________________________________________ | arma3 |= Game name |0.50|= Game version ___________________...")
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


| <pre>/*
| Ends mission with a fade effect. |= Description
 
Description:
Ends mission with specific ending.
 
Parameter(s):
0 (Optional):
STRING - end name (default: "end1")
ARRAY in format [endName,ID], will be composed to "endName_ID" string
1 (Optional): BOOL - true to end mission, false to fail mission (default: true)
2 (Optional):
BOOL - true for signature closing shot (default: true)
NUMBER - duration of a simple fade out to black
3 (Optional): BOOL - false to disable automatic music during signature shot (default: true)
4 (Optional): BOOL - true to cancel all pending tasks (default: false)
 
Returns:
BOOL
*/
 
#define TERMINATE_DEAD if ((missionNamespace getVariable ["BIS_fnc_endMission_checkAliveState",true]) && !ismultiplayer && !alive player) exitwith {{_x cuttext ["","plain"]} foreach [_layerNoise,_layerInterlacing,_layerStatic,_layerEnd]};
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_endMission]]; --> |= Syntax
| [endName,isVictory,fadeType] spawn BIS_fnc_endMission; |= Syntax


|p1= |= Parameter 1
|p1= '''endName''': [[String]] - end type, as used in [[endMission]] command (default: "end1") |=
|p2= '''isVictory''': [[Boolean]] - true to successful end, false for failed end (default: true) |=
|p3= '''fadeType''': [[Boolean]] or [[Number]] - true for signature [[Debriefing|closing shot]]. When number, simple fade to black of given duration is used. |=


| |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
 
|x1= <code>"end1" call BIS_fnc_endMission;</code> |=


|x1= <code></code> |=  
|x2= <code><nowiki>[</nowiki>"epicFail",false,2] call BIS_fnc_endMission;</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[Debriefing]] |= See also


}}
}}
Line 55: Line 36:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:endMission}}]]
 
[[Category:Functions|{{uc:endMission}}]]
[[Category:Arma 3:_Functions|endMission]]
[[Category:{{Name|tkoh}}: Functions|{{uc:endMission}}]]
[[Category:Function Group: Missions|endMission]]
[[Category:{{Name|arma3}}: Functions|{{uc:endMission}}]]

Revision as of 13:12, 25 March 2013

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Ends mission with a fade effect.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[endName,isVictory,fadeType] spawn BIS_fnc_endMission;
Parameters:
endName: String - end type, as used in endMission command (default: "end1")
isVictory: Boolean - true to successful end, false for failed end (default: true)
fadeType: Boolean or Number - true for signature closing shot. When number, simple fade to black of given duration is used.
Return Value:
Nothing

Examples

Example 1:
"end1" call BIS_fnc_endMission;
Example 2:
["epicFail",false,2] call BIS_fnc_endMission;

Additional Information

See also:
Debriefing

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_endMission&oldid=71542"