BIS fnc endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(endName param)
Line 14: Line 14:
| [(endName,isVictory,fadeType,playMusic,completeTasks)] [[spawn]] [[BIS_fnc_endMission]]; |= Syntax
| [(endName,isVictory,fadeType,playMusic,completeTasks)] [[spawn]] [[BIS_fnc_endMission]]; |= Syntax


|p1= '''endName''' (Opional): [[String]] - end type, as used in [[endMission]] command (default: "end1") |=
|p1= '''endName''' (Opional): <br/>[[String]] - end type, as used in [[endMission]] command (default: "end1") <br/>[[Array]] - in format [endName,ID], will be composed to "endName_ID" string |=
|p2= '''isVictory''' (Opional): [[Boolean]] - true to successful end, false for failed end (default: true) |=
|p2= '''isVictory''' (Opional): [[Boolean]] - true to successful end, false for failed end (default: true) |=
|p3= '''fadeType''' (Optional): [[Boolean]] or [[Number]] - true for signature [[Debriefing|closing shot]]. When number, simple fade to black of given duration is used. |=
|p3= '''fadeType''' (Optional): [[Boolean]] or [[Number]] - true for signature [[Debriefing|closing shot]]. When number, simple fade to black of given duration is used. |=

Revision as of 06:39, 26 January 2016

Hover & click on the images for description

Description

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

Syntax

Syntax:
[(endName,isVictory,fadeType,playMusic,completeTasks)] spawn BIS_fnc_endMission;
Parameters:
endName (Opional):
String - end type, as used in endMission command (default: "end1")
Array - in format [endName,ID], will be composed to "endName_ID" string
isVictory (Opional): Boolean - true to successful end, false for failed end (default: true)
fadeType (Optional): Boolean or Number - true for signature closing shot. When number, simple fade to black of given duration is used.
playMusic (Optional): Boolean - false to disable automatic music during closing shot. (default: true)
completeTasks (Optional): Boolean - true to cancel all pending tasks. (default: false)
Return Value:
Boolean

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