BIS fnc endMission: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(One intermediate revision by the same user not shown) | |||
Line 56: | Line 56: | ||
|p1= endName (Optional, default "end1"): | |p1= endName (Optional, default "end1"): | ||
* [[String]] - | * [[String]] - end type from <sqf inline>configFile >> "CfgDebriefing"</sqf>. Same as with [[endMission]] and [[failMission]] | ||
* [[Array]] - | * [[Array]] - in format [endName, ID], will be composed to "endName_ID" string | ||
|p2= isVictory: [[Boolean]] - (Optional, default [[true]]) [[true]] for successful end, false for failed end | |p2= isVictory: [[Boolean]] - (Optional, default [[true]]) [[true]] for successful end, false for failed end | ||
Line 63: | Line 63: | ||
|p3= fadeType: [[Boolean]] or [[Number]] - (Optional, default [[true]]) true for signature [[Debriefing|closing shot]]. When number, simple fade to black of given duration is used | |p3= fadeType: [[Boolean]] or [[Number]] - (Optional, default [[true]]) true for signature [[Debriefing|closing shot]]. When number, simple fade to black of given duration is used | ||
|p4= playMusic: [[Boolean]] - (Optional, default [[true]]) [[false | |p4= playMusic: [[Boolean]] - (Optional, default [[true]]) [[false]] to disable automatic music during [[Debriefing|closing shot]] | ||
|p5= cancelTasks: (Optional, default [[false]]) | |p5= cancelTasks: [[Boolean]] - (Optional, default [[false]]) [[true]] to cancel all pending tasks | ||
|r1= [[Boolean]] | |r1= [[Boolean]] |
Latest revision as of 01:44, 22 May 2023
Take On Helicopters
Arma 3
Description
- Description:
- Ends mission with the specified ending. Always ends with a 4 seconds black out effect.
- Execution:
- call
- Groups:
- Missions
Syntax
- Syntax:
- [nextMission, endingId, displayText, isSuccess, code] call BIS_fnc_endMission
- Parameters:
- nextMission: String - (Optional, default worldName)
- endingId: Number - (Optional, default 1)
- displayText: String - (Optional, default "") text displayed on black out
- isSuccess: Boolean - (Optional, default true) true to endMission, false to failMission
- successCode: Code - code executed right before mission ends, only if isSuccess is set to true
- Return Value:
- Boolean
Examples
- Example 1:
- Example 2:
Additional Information
- See also:
- Debriefing endMission failMission
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
Description
- Description:
- Ends mission with a signature shot or a fade effect, marks it finished for Steam and activates a key in format activateKey format ["BIS_%1.%2_done", missionName, worldName];.
- Execution:
- call
- Groups:
- Missions
Syntax
- Syntax:
- [endName, isVictory, fadeType, playMusic, cancelTasks] call BIS_fnc_endMission
- Parameters:
- endName (Optional, default "end1"):
- String - end type from configFile >> "CfgDebriefing". Same as with endMission and failMission
- Array - in format [endName, ID], will be composed to "endName_ID" string
- isVictory: Boolean - (Optional, default true) true for successful end, false for failed end
- fadeType: Boolean or Number - (Optional, default true) true for signature closing shot. When number, simple fade to black of given duration is used
- playMusic: Boolean - (Optional, default true) false to disable automatic music during closing shot
- cancelTasks: Boolean - (Optional, default false) true to cancel all pending tasks
- Return Value:
- Boolean
Examples
- Example 1:
- Example 2:
Additional Information
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
- Posted on Mar 21, 2016 - 11:12 (UTC)
- To end a multiplayer mission one can use ["end1", true] remoteExecCall ["BIS_fnc_endMission"]; - see also BIS_fnc_endMissionServer.