missionEnd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add example)
mNo edit summary
 
(3 intermediate revisions by one other user not shown)
Line 10: Line 10:
|s1= [[missionEnd]]
|s1= [[missionEnd]]


|r1= [[Array]] - in format [endType, failMission, isFailed] (or empty array if the mission is not ending), where:
|r1= [[Array]] in format [endType, failMission, isFailed] (or empty array if the mission is not ending), where:
* endType : [[String]] - the ending that was passed to [[failMission]] or [[endMission]]
* endType : [[String]] - the ending that was passed to [[failMission]] or [[endMission]]
* failMission: [[Boolean]] - [[true]] if the mission ended via [[failMission]], [[false]] if via [[endMission]]
* failMission: [[Boolean]] - [[true]] if the mission ended via [[failMission]], [[false]] if via [[endMission]]
* isFailed: [[Boolean]] - engine idea of how mission ended. For example if mission ended via [[failMission]] but the type of ending was not "Killed", ''isFailed'' is [[false]]
* isFailed: [[Boolean]] - engine idea of how mission ended. For example if mission ended via [[failMission]] but the type of ending was not "Killed", ''isFailed'' is [[false]]


|x1= <code>[[private]] _misssionEnd = [[missionEnd]];</code>
|x1= <sqf>private _endInfo = missionEnd;</sqf>


|x2= <code>[[missionEnd]] [[params]] ["_endType", "_failMission", "_isFailed"];</code>
|x2= <sqf>missionEnd params ["_endType", "_failMission", "_isFailed"];</sqf>


|seealso= [[endMission]], [[failMission]], [[forceEnd]]
|seealso= [[endMission]] [[failMission]] [[forceEnd]]
}}
}}

Latest revision as of 04:18, 28 September 2023

Hover & click on the images for description

Description

Description:
Returns mission end type and how it was ended or an empty array [] is mission was not ended.
Groups:
Mission Information

Syntax

Syntax:
missionEnd
Return Value:
Array in format [endType, failMission, isFailed] (or empty array if the mission is not ending), where:

Examples

Example 1:
private _endInfo = missionEnd;
Example 2:
missionEnd params ["_endType", "_failMission", "_isFailed"];

Additional Information

See also:
endMission 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