mission_task_build_path¶

Source: base/tealdef/mission/tasks/build_path/mission_task_build_path.d.tl

Notes

Task that waits until the transport network connects pairs of entities or areas.

MissionTaskBuildPath¶

record global base/tealdef/mission/tasks/build_path/mission_task_build_path.d.tl:3

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

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

Notes

Task (build_path) that completes when a path exists for every pair, between the network nodes in two areas or between two entities. With more than one pair a counter is shown, and the unconnected areas are drawn.

Example

-- urbangames_campaign_mission_01
taskScript = build_path as MissionInterface.TaskScript<any, any>,
taskParams = {
    zonesToConnect = {
        {
            { pos = params.connectStreets_1_1_zone.pos, radius = params.connectStreets_1_1_zone.radius + 5 },
            { pos = params.connectStreets_1_2_zone.pos, radius = params.connectStreets_1_2_zone.radius + 5 },
        },
    },
    transportMode = api.type["enum"].TransportMode.TRUCK,
},

MissionTaskBuildPath.Params¶

record base/tealdef/mission/tasks/build_path/mission_task_build_path.d.tl:5

record Params

Notes

Params of the task. Area pairs take precedence over entity pairs.

Used in the base game: 6 times in 4 files

base/content/mission/mission/tutorial/tutorial_story.tl:1231

taskParams : MissionTaskBuildPath.Params = {

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

taskParams : MissionTaskBuildPath.Params = {

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

taskParams : MissionTaskBuildPath.Params = {

base/content/mission/mission/tasks/build_path/build_path.tl:7

local type P = MissionTaskBuildPath.Params

Fields

Name	Type	Description
`entitiesToConnect`	`{{Engine.Entity, Engine.Entity}}`	Pairs of entities (stations, constructions, network entities) to connect.
`zonesToConnect`	`{{MissionInterface.PosRadius, MissionInterface.PosRadius}}`	Pairs of areas to connect.
`renderZonesForEntities`	`{{MissionInterface.PosRadius, MissionInterface.PosRadius}}`	Area pairs drawn instead of the connected areas.
`transportMode`	`TransportMode`	Transport mode the path must allow (default train).

Functions

getZonesToConnect() : {{MissionInterface.PosRadius, MissionInterface.PosRadius}} base/tealdef/mission/tasks/build_path/mission_task_build_path.d.tl:8

Notes

Returns the area pairs; takes precedence over zonesToConnect.

Returns {{MissionInterface.PosRadius, MissionInterface.PosRadius}}: Area pairs.

getEntitiesToConnect(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : {{Engine.Entity, Engine.Entity}} base/tealdef/mission/tasks/build_path/mission_task_build_path.d.tl:10

Notes

Returns the entity pairs every update; takes precedence over entitiesToConnect.

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

Returns {{Engine.Entity, Engine.Entity}}: Entity pairs.

MissionTaskBuildPath.State¶

record base/tealdef/mission/tasks/build_path/mission_task_build_path.d.tl:14

record State

Notes

State of the task.

Used in the base game: 2 times in 1 file

base/content/mission/mission/tasks/build_path/build_path.tl:6

local type S = MissionTaskBuildPath.State

Fields

Name	Type	Description
`complete`	`{boolean}`	Per pair, whether it is connected.
`runtimeEntitiesToConnect`	`{{Engine.Entity, Engine.Entity}}`	Entity pairs in use.