failMission: Difference between revisions

Latest revision as of 11:51, 26 March 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:

Finish the mission. If the server is set to run persistent mission, failMission will not end the mission when last player gets kicked to the lobby. Use endMission to end the mission. The end type can be:

"CONTINUE" - this is default type, basically an alias to do nothing
"KILLED"
"LOSER"
"END1"
"END2"
"END3"
"END4"
"END5"
"END6"

Mission saves won't be deleted.

To maintain Arma 3 visual style, it is recommended to use BIS_fnc_endMission instead.

Groups:

Mission Information

Syntax

Syntax:: failMission endtype
Parameters:: endtype: String
Return Value:: Nothing

Examples

Example 1:: failMission "LOSER";

Additional Information

See also:: missionEnd endMission forceEnd

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2 |= Game name
+|game1= arma2
+|version1= 1.00
-|1.00|= Game version
+|game2= arma2oa
-____________________________________________________________________________________________
+|version2= 1.50
-| Finish the mission.
+|game3= tkoh
+|version3= 1.00
+|game4= arma3
+|version4= 0.50
+|gr1= Mission Information
+|descr= Finish the mission. If the server is set to run persistent mission, [[failMission]] will not end the mission when last player gets kicked to the lobby. Use [[endMission]] to end the mission.
 The end type can be:
-* "CONTINUE"
+* "CONTINUE" - this is default type, basically an alias to do nothing
 * "KILLED"
 * "LOSER"
@@ Line 20: / Line 28: @@
 * "END6"
-'''Mission saves won't be deleted'''.
+'''Mission saves won't be deleted'''.<br><br>
-|= Description
-____________________________________________________________________________________________
-| '''failMission''' end type |= Syntax
-|p1= end type: [[String]] -  |= PARAMETER1
+{{Feature|arma3|To maintain Arma 3 visual style, it is recommended to use [[BIS_fnc_endMission]] instead.}}
-|p2= |= PARAMETER2
+|s1= [[failMission]] endtype
-|p3= |= PARAMETER3
+|p1= endtype: [[String]]
+|r1= [[Nothing]]
-| Nothing |= RETURNVALUE
+|x1= <sqf>failMission "LOSER";</sqf>
+|seealso= [[missionEnd]] [[endMission]] [[forceEnd]]
-|x1= <code>failMission "LOSER"; </code>|= EXAMPLE1
-____________________________________________________________________________________________
-| [[endMission]], [[forceEnd]] |= SEEALSO
-|  |= MPBEHAVIOUR
-____________________________________________________________________________________________
 }}
-<h3 style='display:none'>Notes</h3>
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style='display:none'>Bottom Section</h3>
-[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]