BIS fnc endMission: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
_FR_starfox64 (talk | contribs) (Added missing parameters) |
||
| Line 12: | Line 12: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [(endName,isVictory,fadeType)] 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): [[String]] - end type, as used in [[endMission]] command (default: "end1") |= | ||
|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. |= | ||
|p4= '''playMusic''' (Optional): [[Boolean]] - false to disable automatic music during [[Debriefing|closing shot]]. (default: true) |= | |||
|p5= '''completeTasks''' (Optional): [[Boolean]] - true to cancel all pending tasks. (default: false) |= | |||
| [[Boolean]] |= Return value | | [[Boolean]] |= Return value | ||
Revision as of 02:55, 9 August 2015
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")
- 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