mission_task_transport_cargo¶

Source: base/tealdef/mission/tasks/transport_cargo/mission_task_transport_cargo.d.tl

Notes

Task that waits until an amount of cargo was delivered to targets.

MissionTaskTransportCargo¶

record global base/tealdef/mission/tasks/transport_cargo/mission_task_transport_cargo.d.tl:3

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

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

Notes

Task (transport_cargo) that counts deliveries of a cargo type to the targets (optionally only from given sources) through the arrival tracker and completes at minCount. Shows a counter with the cargo icon.

Example

-- urbangames_campaign_mission_01
taskScript = transport_cargo as MissionInterface.TaskScript<any, any>,
taskParams : MissionTaskTransportCargo.Params = {
    cargoTypeRes = "::/cargos/logs/logs.cargo",
    targets = { params.entity_hotelTarget },
    minCount = 6,
},
showInHistory = true,

MissionTaskTransportCargo.Params¶

record base/tealdef/mission/tasks/transport_cargo/mission_task_transport_cargo.d.tl:4

record Params

Notes

Params of the task.

Used in the base game: 54 times in 13 files

base/content/mission/mission/tutorial/tutorial_story_branch_b.tl:506

taskParams : MissionTaskTransportCargo.Params = {

base/content/mission/mission/tutorial/tutorial_story_branch_a.tl:408

taskParams : MissionTaskTransportCargo.Params = {

base/content/mission/mission/tasks/transport_cargo/transport_cargo.tl:4

local type P = MissionTaskTransportCargo.Params

base/content/mission/mission/tasks/transport_cargo/transport_cargo_observer.tl:24

local state = readOnlyApi.getTaskState(task) as MissionInterface.TaskState<MissionTaskTransportCargo.State, MissionTaskTransportCargo.Params>

base/content/mission/mission/tasks/auto_builder/track_builder.tl:107

local prev : MissionTaskTransportCargo.State = (readOnlyApi.getTaskState(ctx.params.ownerTask) as MissionInterface.TaskState<MissionTaskTransportCargo.State, Mi

mods/release/urbangames_campaign_mission_03/content/mission/mission/mission_story.tl:355

taskParams : MissionTaskTransportCargo.Params = {

… and 7 more files.

Fields

Name	Type	Description
`cargoTypeRes`	`string`	Cargo type resource to count (e.g. `"::/cargos/logs/logs.cargo"`).
`targets`	`{Engine.Entity}`	Delivery targets (towns, constructions or their entities).
`sources`	`{Engine.Entity}`	Only cargo from these sources counts.
`minCount`	`integer`	Amount to deliver.
`fakeMinCount`	`integer`	Maximum shown in the progress instead of `minCount`.

Functions

getTargets() : {Engine.Entity} base/tealdef/mission/tasks/transport_cargo/mission_task_transport_cargo.d.tl:7

Notes

Returns the targets when the task starts; takes precedence over targets.

Returns {Engine.Entity}: Target entities.

getMinCount(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : integer base/tealdef/mission/tasks/transport_cargo/mission_task_transport_cargo.d.tl:12

Notes

Returns the amount to deliver when minCount is not set.

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

Returns integer: Amount to deliver.

MissionTaskTransportCargo.State¶

record base/tealdef/mission/tasks/transport_cargo/mission_task_transport_cargo.d.tl:14

record State

Notes

State of the task.

Used in the base game: 23 times in 6 files

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

local type S = MissionTaskTransportCargo.State

base/content/mission/mission/tasks/transport_cargo/transport_cargo_observer.tl:24

local state = readOnlyApi.getTaskState(task) as MissionInterface.TaskState<MissionTaskTransportCargo.State, MissionTaskTransportCargo.Params>

base/content/mission/mission/tasks/auto_builder/track_builder.tl:107

local prev : MissionTaskTransportCargo.State = (readOnlyApi.getTaskState(ctx.params.ownerTask) as MissionInterface.TaskState<MissionTaskTransportCargo.State, Mi

mods/release/urbangames_campaign_mission_07/content/mission/mission/mission_story.tl:217

local bonus = (getTaskState("task_bonus") as MissionInterface.TaskState<MissionTaskTransportCargo.State, MissionTaskTransportCargo.Params>)

mods/release/urbangames_campaign_mission_04/content/mission/mission/mission_story.tl:768

local state = (getTaskState("transport_wood_stage") as MissionInterface.TaskState<MissionTaskTransportCargo.State, MissionTaskTransportCargo.Params>)

mods/release/urbangames_campaign_mission_08/content/mission/mission/mission_story.tl:187

local state = (readOnlyApi.getTaskState(mission_task_util.makeTaskKey("task_machine_parts", "urbangames_campaign_mission_08::/mission/mission.script")) as Missi

Fields

Name	Type	Description
`result`	`integer`	Amount delivered so far.
`minCount`	`integer`	Amount to deliver.
`cargoTypeId`	`CargoTypeId`	Id of the cargo type.
`ids`	`{string : {Engine.Entity}}`	Arrival-tracker filter name -> `{target, source}`.