endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added saves info)
m (Fiiix)
 
(52 intermediate revisions by 7 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 |= Arguments in MP
|game3= tkoh
|version3= 1.00


|eff= local |= Effects in MP
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| Finish the mission. The end type can be "CONTINUE","KILLED","LOSER","END1","END2","END3","END4","END5", or "END6". '''Mission saves are deleted'''. Use [[failMission]] if they should not. |= Description
|arg= local
____________________________________________________________________________________________


| '''endMission''' end type |= Syntax
|eff= local


|p1= end type: [[String]] -  |= PARAMETER1
|gr1= Mission Information


|p2= |= PARAMETER2
|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.}}


|p3= |= PARAMETER3
|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}}).


| Nothing |= RETURNVALUE
|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"
* "LOSER"
* "END1"
* "END2"
* "END3"
* "END4"
* "END5"
* "END6"
}}


|x1= <code>endMission "END1"</code>|= EXAMPLE1
|r1= [[Nothing]]


____________________________________________________________________________________________
|x1= <sqf>endMission "END1";</sqf>


| mp = To end mission properly so that everyone goes to debriefing at the same time, this command should be executed on every machine.
|x2= <sqf>["END1"] remoteExec ["endMission", 0, true]; // Arma 3</sqf>
| [[failMission]] |= SEEALSO
 
____________________________________________________________________________________________
|seealso= [[missionEnd]] [[failMission]] [[forceEnd]]
}}
}}
<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|{{uc:{{PAGENAME}}}}]]

Latest revision as of 16:26, 17 April 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
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
Retrieved from "https://community.bistudio.com/wiki?title=endMission&oldid=338926"