failMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma2 |Game name=
| arma2 |Game name=
Line 7: Line 6:


|gr1= Mission Information |GROUP1=
|gr1= Mission Information |GROUP1=
____________________________________________________________________________________________


| 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.
| 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.
Line 26: Line 24:
{{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.}}
|DESCRIPTION=
|DESCRIPTION=
____________________________________________________________________________________________


| '''failMission''' endtype |SYNTAX=
| '''failMission''' endtype |SYNTAX=
Line 41: Line 38:
|x1= <code>[[failMission]] "LOSER"; </code>|EXAMPLE1=  
|x1= <code>[[failMission]] "LOSER"; </code>|EXAMPLE1=  


____________________________________________________________________________________________


| [[endMission]], [[forceEnd]] |SEEALSO=  
| [[endMission]], [[forceEnd]] |SEEALSO=  


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
}}
}}



Revision as of 01:22, 17 January 2021

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"
  • "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:
endMissionforceEnd

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

Notes

Bottom Section