endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Fiiix)
 
(29 intermediate revisions by 3 users not shown)
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


|arg= local |Multiplayer Arguments=
|game3= tkoh
|version3= 1.00


|eff= local |Multiplayer Effects=
|game4= arma3
|version4= 0.50


|gr1= Mission Information |GROUP1=
|arg= local
____________________________________________________________________________________________


| Finish the mission.
|eff= local


The end type can be:
|gr1= Mission Information
* "CONTINUE"
 
|descr= Finish the mission.
'''Mission saves are deleted'''. Use [[failMission]] if they should not be.
{{Feature|arma3|To maintain {{arma3}} visual style, it is recommended to use [[BIS_fnc_endMission]] instead.}}
 
|mp= To end mission properly so that everyone goes to debriefing at the same time, this command should be executed on every machine (see {{Link|#Example 2}}).
 
|s1= [[endMission]] endType
 
|p1= endType: [[String]] - can be a custom one {{GVI|arma3|1.00|size= 0.75}}, or one of:
{{Columns|2|
* "CONTINUE" (does nothing)
* "KILLED"
* "KILLED"
* "LOSER"
* "LOSER"
Line 25: Line 38:
* "END5"
* "END5"
* "END6"
* "END6"
}}


'''Mission saves are deleted'''. Use [[failMission]] if they should not.<br><br>
|r1= [[Nothing]]
{{Feature|arma3|To maintain Arma 3 visual style, it is recommended to use [[BIS_fnc_endMission]] instead.}}
|DESCRIPTION=
____________________________________________________________________________________________
 
| '''endMission''' endType |SYNTAX=
 
|p1= endType: [[String]] -  |PARAMETER1=


|p2= |PARAMETER2=  
|x1= <sqf>endMission "END1";</sqf>


|p3= |PARAMETER3=  
|x2= <sqf>["END1"] remoteExec ["endMission", 0, true]; // Arma 3</sqf>


| [[Nothing]] |RETURNVALUE=
|seealso= [[missionEnd]] [[failMission]] [[forceEnd]]
 
 
|x1= <code>[[endMission]] "END1";</code>|EXAMPLE1=
 
____________________________________________________________________________________________
 
| mp = To end mission properly so that everyone goes to debriefing at the same time, this command should be executed on every machine.
| [[failMission]], [[forceEnd]] |SEEALSO=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:26, 17 April 2023

Hover & click on the images for description

Description

Description:
Finish the mission. Mission saves are deleted. Use failMission if they should not be.
Arma 3
To maintain Arma 3 visual style, it is recommended to use BIS_fnc_endMission instead.
Multiplayer:
To end mission properly so that everyone goes to debriefing at the same time, this command should be executed on every machine (see Example 2).
Groups:
Mission Information

Syntax

Syntax:
endMission endType
Parameters:
endType: String - can be a custom one Arma 3 logo black.png1.00, or one of:
  • "CONTINUE" (does nothing)
  • "KILLED"
  • "LOSER"
  • "END1"
  • "END2"
  • "END3"
  • "END4"
  • "END5"
  • "END6"
Return Value:
Nothing

Examples

Example 1:
endMission "END1";
Example 2:
["END1"] remoteExec ["endMission", 0, true]; // Arma 3

Additional Information

See also:
missionEnd failMission 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