Skip to content

mission_task_stop_config

Source: base/tealdef/mission/tasks/create_line/mission_task_stop_config.d.tl

Notes

Task that waits until a line loads a cargo at a stop.

MissionTaskStopConfig

record global base/tealdef/mission/tasks/create_line/mission_task_stop_config.d.tl:3

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

Load: local stop_config = ug_require "::/mission/tasks/create_line/stop_config.tl"

Notes

Task (stop_config) that completes when the stop of a line in the loadStop area is set to load the cargo type.

MissionTaskStopConfig.Params

record base/tealdef/mission/tasks/create_line/mission_task_stop_config.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/create_line/stop_config.tl:2

local type P = MissionTaskStopConfig.Params

Fields

Name Type Description
loadStop MissionInterface.PosRadius Area of the stop.
cargoTypeRes ResName Cargo type to load.

Functions

getLine(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : Engine.Entity base/tealdef/mission/tasks/create_line/mission_task_stop_config.d.tl:6

Notes

Returns the line to check; called until a line is stored.

Parameter Type Description
readOnlyApi MissionInterface.MissionTaskReadOnlyApi Read-only mission API.

Returns Engine.Entity: Line entity.

MissionTaskStopConfig.State

record base/tealdef/mission/tasks/create_line/mission_task_stop_config.d.tl:9

record State

Notes

State of the task.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tasks/create_line/stop_config.tl:1

local type S = MissionTaskStopConfig.State

Fields

Name Type Description
cargoTypeId CargoTypeId Id of the cargo type.
line Engine.Entity Line being checked.
isComplete boolean The stop loads the cargo.