mission_task_finish¶

Source: base/tealdef/mission/tasks/finish/mission_task_finish.d.tl

Notes

Task that ends the mission and shows the mission-end window.

MissionTaskFinish¶

record global base/tealdef/mission/tasks/finish/mission_task_finish.d.tl:3

global record MissionTaskFinish is MissionInterface.TaskScript<MissionTaskFinish.State, MissionTaskFinish.Params>

Load: local finish = ug_require "::/mission/tasks/finish/finish.tl"

Notes

Task (finish) that ends the mission. The mission window shows the end screen for it; the task completes when the player confirms (MissionEndWindow / completeMission).

Example

-- urbangames_campaign_mission_03: mission lost
taskScript = finish as MissionInterface.TaskScript<any, any>,
taskParams = { success = false },
taskInfo = {},

MissionTaskFinish.Params¶

record base/tealdef/mission/tasks/finish/mission_task_finish.d.tl:4

record Params

Notes

Params of the task; without params the mission counts as won.

Used in the base game: 2 times in 1 file

base/content/mission/mission/tasks/finish/finish.tl:3

local type P = MissionTaskFinish.Params

Fields

Name	Type	Description
`success`	`boolean`	The mission was won.
`isTutorial`	`boolean`	The finished mission is the tutorial.

MissionTaskFinish.StateType¶

enum base/tealdef/mission/tasks/finish/mission_task_finish.d.tl:8

enum StateType

Notes

Progress of the end screen.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tasks/finish/finish.tl:7

SetStateType = function(ctx : TaskContext<S, P>, state : MissionTaskFinish.StateType)

Value	Description
`"Initial"`	Not shown yet.
`"Showing"`	End screen shown.
`"Complete"`	Confirmed by the player.

MissionTaskFinish.State¶

record base/tealdef/mission/tasks/finish/mission_task_finish.d.tl:13

record State

Notes

State of the task.

Used in the base game: 3 times in 2 files

base/content/mission/mission/mission_framework/mission_framework_react.tl:76

local specificState = task.specific as MissionTaskFinish.State

base/content/mission/mission/tasks/finish/finish.tl:2

local type S = MissionTaskFinish.State

Fields

Name	Type	Description
`state`	`StateType`	Progress of the end screen.
`success`	`boolean`	The mission was won.
`isTutorial`	`boolean`	The finished mission is the tutorial.