mission_task_relay_update

Source: base/tealdef/mission/tasks/utility/mission_task_relay_update.d.tl

Notes

Task that runs a custom update function until it reports completion.

MissionTaskRelayUpdate

record global base/tealdef/mission/tasks/utility/mission_task_relay_update.d.tl:3

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

Load: local relay_update = ug_require "::/mission/tasks/utility/relay_update.tl"

Notes

Task (relay_update) that calls onUpdateFn every update and completes when it returns true.

MissionTaskRelayUpdate.Params

record base/tealdef/mission/tasks/utility/mission_task_relay_update.d.tl:4

record Params

Notes

Params of the task.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tasks/utility/relay_update.tl:3

local type P = MissionTaskRelayUpdate.Params

Functions

onUpdateFn(ctx : MissionInterface.TaskContext<MissionTaskRelayUpdate.State, MissionTaskRelayUpdate.Params>, readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : boolean base/tealdef/mission/tasks/utility/mission_task_relay_update.d.tl:5

Notes

Custom update function; may keep data in ctx.state.customState.

Parameter	Type	Description
ctx	MissionInterface.TaskContext<MissionTaskRelayUpdate.State, MissionTaskRelayUpdate.Params>	Context of the task.
readOnlyApi	MissionInterface.MissionTaskReadOnlyApi	Read-only mission API.

Returns boolean: true to complete the task.

MissionTaskRelayUpdate.State

record base/tealdef/mission/tasks/utility/mission_task_relay_update.d.tl:7

record State

Notes

State of the task.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tasks/utility/relay_update.tl:2

local type S = MissionTaskRelayUpdate.State

Fields

Name	Type	Description
customState	any	Free slot for onUpdateFn.
isComplete	boolean	Last result of onUpdateFn.