Skip to content

mission_task_wait

Source: base/tealdef/mission/tasks/wait/mission_task_wait.d.tl

Notes

Task that completes after a fixed time.

MissionTaskWait

record global base/tealdef/mission/tasks/wait/mission_task_wait.d.tl:3

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

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

Notes

Task (wait) that completes after a time span in GUI time or in simulation time.

Example

-- urbangames_campaign_mission_03
if taskKey == "missionEnd" then
    return {
        taskScript = wait as MissionInterface.TaskScript<any, any>,
        taskParams = { guiTimeSeconds = 1 },
        followup = { { taskKey = "missionEndScreen" } },
    }
end

MissionTaskWait.Params

record base/tealdef/mission/tasks/wait/mission_task_wait.d.tl:4

record Params

Notes

How long to wait; guiTimeSeconds takes precedence when both are set.

Used in the base game: 1 time in 1 file

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

local type P = MissionTaskWait.Params

Fields

Name Type Description
simTimeSeconds number in simulation time (affected by game speed)
guiTimeSeconds number in approximated wall clock time (not affected by game speed, except that it is delayed when the game lags)

MissionTaskWait.State

record base/tealdef/mission/tasks/wait/mission_task_wait.d.tl:8

record State

Notes

End times computed when the task spawns.

Used in the base game: 1 time in 1 file

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

local type S = MissionTaskWait.State

Fields

Name Type Description
endSimTimeMs number Game time (ms) at which the task completes.
endGuiTimeSeconds number Mission GUI time (seconds) at which the task completes.