BIS fnc endMission: Difference between revisions
Jump to navigation
Jump to search
Take On Helicopters
Arma 3
Lou Montana (talk | contribs) m (Text replacement - "{{Template:TabView" to "{{TabView") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| Line 3: | Line 3: | ||
|selected= 2 | |selected= 2 | ||
|title1= {{ | |title1= {{TabView/GameTitle|tkoh}} | ||
|content1= | |content1= | ||
{{RV|type=function | {{RV|type=function | ||
| Line 38: | Line 38: | ||
}} | }} | ||
|title2= {{ | |title2= {{TabView/GameTitle|arma3}} | ||
|content2= | |content2= | ||
{{RV|type=function | {{RV|type=function | ||
Revision as of 20:47, 21 August 2021
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:
["mission2", 1, "You won"] call BIS_fnc_endMission; // endMission "mission2_1"- Example 2:
["mission2", 1, "You lose", false] call BIS_fnc_endMission; // failMission "mission2_1"
Additional Information
- See also:
- DebriefingendMissionfailMission
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
- String - End type from
- 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: (Optional, default false): Boolean - True to cancel all pending tasks
- Return Value:
- Boolean
Examples
- Example 1:
"end1" call BIS_fnc_endMission;- Example 2:
["epicFail", false, 2] call BIS_fnc_endMission;
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 March 21, 2016 - 11:12 (UTC)
- R3vo
- To end a multiplayer mission one can use
["end1", true] remoteExecCall ["BIS_fnc_endMission", 0];- see also BIS_fnc_endMissionServer.