mission_task_assign_vehicle

Source: base/tealdef/mission/tasks/assign_vehicle/mission_task_assign_vehicle.d.tl

Notes

Task that waits until player vehicles run on a given line or on a line between two areas.

MissionTaskAssignVehicle

record global base/tealdef/mission/tasks/assign_vehicle/mission_task_assign_vehicle.d.tl:3

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

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

Notes

Task (assign_vehicle) that completes when at least minCount player vehicles of the carrier run on a matching player line. The line is line, any line between a pos1 area and a pos2 area, or the line returned by getRuntimeLine; cargoTypeRes limits the count to vehicles that can carry that cargo.

Example

-- urbangames_campaign_mission_01
taskScript = assign_vehicle as MissionInterface.TaskScript<any, any>,
taskParams : MissionTaskAssignVehicle.Params = {
    pos1 = { { pos = params.stationForestPos.pos, radius = params.stationForestPos.radius } },
    pos2 = { { pos = params.stationHotelPos.pos, radius = params.stationHotelPos.radius } },
},
showInHistory = true,

MissionTaskAssignVehicle.Params

record base/tealdef/mission/tasks/assign_vehicle/mission_task_assign_vehicle.d.tl:4

record Params

Notes

Params of the task.

Used in the base game: 18 times in 6 files

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

taskParams : MissionTaskAssignVehicle.Params = {

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

taskParams : MissionTaskAssignVehicle.Params = {

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

taskParams : MissionTaskAssignVehicle.Params = {

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

local type P = MissionTaskAssignVehicle.Params

mods/release/urbangames_campaign_mission_02/content/mission/mission/mission_story.tl:859

taskParams : MissionTaskAssignVehicle.Params = {

mods/release/urbangames_campaign_mission_01/content/mission/mission/mission_story.tl:993

taskParams : MissionTaskAssignVehicle.Params = {

Fields

Name	Type	Description
line	Engine.Entity	either specific line
pos1	{MissionInterface.PosRadius}	or any line with these multiple start and end positions Start areas of the line. Used when line is not set; any player line between a pos1 and a pos2 area counts.
pos2	{MissionInterface.PosRadius}	End areas of the line.
carrier	Carrier	Carrier of the vehicles (default road).
minCount	integer	Number of vehicles (default 1).
draw	boolean	Draws the pos1 and pos2 areas as zones.
cargoTypeRes	ResName	Counts only vehicles with capacity for this cargo type.

Functions

getPos1() : {MissionInterface.PosRadius} base/tealdef/mission/tasks/assign_vehicle/mission_task_assign_vehicle.d.tl:10

Notes

Returns the start areas; takes precedence over pos1.

Returns {MissionInterface.PosRadius}: Areas.

getPos2() : {MissionInterface.PosRadius} base/tealdef/mission/tasks/assign_vehicle/mission_task_assign_vehicle.d.tl:11

Notes

Returns the end areas; takes precedence over pos2.

Returns {MissionInterface.PosRadius}: Areas.

getRuntimeLine(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : Engine.Entity base/tealdef/mission/tasks/assign_vehicle/mission_task_assign_vehicle.d.tl:14

or any line from a previous task

Returns Engine.Entity

MissionTaskAssignVehicle.State

record base/tealdef/mission/tasks/assign_vehicle/mission_task_assign_vehicle.d.tl:25

record State

Notes

State of the task.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tasks/assign_vehicle/assign_vehicle.tl:5

local type S = MissionTaskAssignVehicle.State

Fields

Name	Type	Description
runtimeLines	{Engine.Entity}	runtime specific line
result	{Engine.Entity}	Matching vehicles found at the last update.