mission_task_wait_event¶

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

Notes

Task that completes when a matching engine-side script event arrives.

MissionTaskWaitEvent¶

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

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

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

Notes

Task (wait_event) that completes when an engine-side script event matches one of the candidates.

Example

-- urbangames_campaign_mission_02: wait until a dialogue has finished
taskScript = wait_event as MissionInterface.TaskScript<any, any>,
taskParams = {
    candidates = {
        { id = "mission-dialogue", name = "on-finish-dialogue" },
    },
},

MissionTaskWaitEvent.EventDesc¶

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

record EventDesc

Notes

Event pattern; nil fields match anything, param is compared deeply.

Fields

Name	Type	Description
`src`	`string`	Event source.
`id`	`string`	Event id.
`name`	`string`	Event name.
`param`	`any`	Event parameter.

MissionTaskWaitEvent.Params¶

record base/tealdef/mission/tasks/wait/mission_task_wait_event.d.tl:10

record Params

Notes

Params of the task.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tasks/wait/wait_event.tl:4

local type P = MissionTaskWaitEvent.Params

Fields

Name	Type	Description
`candidates`	`{EventDesc}`	Event patterns; any match completes the task.

MissionTaskWaitEvent.State¶

record base/tealdef/mission/tasks/wait/mission_task_wait_event.d.tl:13

record State

Notes

State of the task.

Used in the base game: 1 time in 1 file

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

local type S = MissionTaskWaitEvent.State

Fields

Name	Type	Description
`isComplete`	`boolean`	A matching event arrived.