failMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - "\| *p([0-9]+) *=([^↵]+) -↵" to "|p$1=$2")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| arma2
|game1= arma2
|version1= 1.00


|1.00
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50


|gr1= Mission Information
|gr1= Mission Information


| 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.
|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:
The end type can be:
* "CONTINUE"
* "CONTINUE" - this is default type, basically an alias to do nothing
* "KILLED"
* "KILLED"
* "LOSER"
* "LOSER"
Line 24: Line 32:
{{Feature|arma3|To maintain Arma 3 visual style, it is recommended to use [[BIS_fnc_endMission]] instead.}}
{{Feature|arma3|To maintain Arma 3 visual style, it is recommended to use [[BIS_fnc_endMission]] instead.}}


|s1= [[failMission]] endtype


| '''failMission''' endtype
|p1= endtype: [[String]]
 
|r1= [[Nothing]]
|p1= endtype: [[String]] -
 
|p2=
 
|p3=
 
| [[Nothing]]
 
 
|x1= <code>[[failMission]] "LOSER"; </code>
 


| [[endMission]], [[forceEnd]]
|x1= <sqf>failMission "LOSER";</sqf>


| |MPBEHAVIOUR=  
|seealso= [[missionEnd]] [[endMission]] [[forceEnd]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 12:51, 26 March 2024

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.

Arma 3
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