mission_task_start_vehicles

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

Notes

Task that starts or stops vehicles.

MissionTaskStartVehicles

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

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

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

Notes

Task (start_vehicles) that starts (or stops) vehicles once conditionFn holds, then completes.

MissionTaskStartVehicles.Params

record base/tealdef/mission/tasks/vehicle_util/mission_task_start_vehicles.d.tl:4

record Params

Notes

Params of the task.

Used in the base game: 2 times in 2 files

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

local type P = MissionTaskStartVehicles.Params

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

taskParams : MissionTaskStartVehicles.Params = {

Fields

Name	Type	Description
vehicles	{Engine.Entity}	Vehicles to start or stop.
stop	boolean	Stops the vehicles instead of starting them.
skipInvalidEntities	boolean	Skips entities that do not exist.

Functions

conditionFn() : boolean base/tealdef/mission/tasks/vehicle_util/mission_task_start_vehicles.d.tl:6

Notes

Condition checked every update; nil acts at once.

Returns boolean: true to start the vehicles now.

overruleComplete(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : boolean base/tealdef/mission/tasks/vehicle_util/mission_task_start_vehicles.d.tl:7

Notes

Completes the task without touching the vehicles when it returns true.

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

Returns boolean: true to complete the task.

MissionTaskStartVehicles.State

record base/tealdef/mission/tasks/vehicle_util/mission_task_start_vehicles.d.tl:11

record State

Notes

State of the task.

Used in the base game: 1 time in 1 file

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

local type S = MissionTaskStartVehicles.State

Fields

Name	Type	Description
isComplete	boolean	The task is done.