mission_vehicle_util

Source: base/tealdef/mission/tasks/vehicle_util/mission_vehicle_util.d.tl

Notes

Vehicle and line helpers used by mission tasks.

MissionVehicleUtil

record global base/tealdef/mission/tasks/vehicle_util/mission_vehicle_util.d.tl:3

global record MissionVehicleUtil

Load: local mission_vehicle_util = ug_require "::/mission/tasks/vehicle_util/mission_vehicle_util.tl"

Notes

Vehicle and line helpers used by mission tasks.

Functions

createLine(stationGroup : Engine.Entity) : Engine.Entity base/tealdef/mission/tasks/vehicle_util/mission_vehicle_util.d.tl:4

Call as mission_vehicle_util.createLine

Notes

Creates a one-stop line at a station group and gives it to a newly spawned AI player.

Parameter	Type	Description
stationGroup	Engine.Entity	Station group of the stop.

Returns Engine.Entity: The new line entity.

Used in the base game: 2 times in 2 files

mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/send_vehicle.tl:59

local newLine = mission_vehicle_util.createLine(stationGroupEntity)

mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/observe_drilling.tl:82

local newLine = mission_vehicle_util.createLine(ctx.params.harborStationGroupEntity)

startVehicle(vehicleEntity : Engine.Entity, stop? : boolean) base/tealdef/mission/tasks/vehicle_util/mission_vehicle_util.d.tl:5

Call as mission_vehicle_util.startVehicle

Notes

Starts or stops a vehicle (user stop flag) if it is not already in that state.

Parameter	Type	Description
vehicleEntity	Engine.Entity	Vehicle.
stop?	boolean	true to stop, otherwise start.

Used in the base game: 3 times in 3 files

base/content/mission/mission/tasks/vehicle_util/start_vehicles.tl:23

mission_vehicle_util.startVehicle(vehicle, ctx.params.stop)

mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/send_vehicle.tl:62

mission_vehicle_util.startVehicle(vehicleEntity)

mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/observe_drilling.tl:84

mission_vehicle_util.startVehicle(ctx.params.shipEntity)

deleteLine(oldLine : Engine.Entity) base/tealdef/mission/tasks/vehicle_util/mission_vehicle_util.d.tl:6

Call as mission_vehicle_util.deleteLine

Notes

Deletes a line if it exists; logs an error if it still has vehicles.

Parameter	Type	Description
oldLine	Engine.Entity	Line entity.

Used in the base game: 2 times in 2 files

base/content/mission/mission/tasks/vehicle_util/sell_vehicles.tl:33

mission_vehicle_util.deleteLine(line)

mods/release/urbangames_campaign_mission_05/content/mission/mission/tasks/drilling/send_vehicle.tl:61

mission_vehicle_util.deleteLine(oldLine)