Skip to content

vehicle_list_react_util

Source: base/tealdef/gui/line_vehicle_mgmt/vehicle_list_react_util.d.tl

Notes

The vehicle list table of the line and vehicle manager (vehicle selection checkbox, line or depot, name and icons per row).

VehicleListReactUtil

record global base/tealdef/gui/line_vehicle_mgmt/vehicle_list_react_util.d.tl:3

global record VehicleListReactUtil

Notes

Vehicle list table of the line and vehicle manager.

Fields

Name Type Description
VehicleList Recipe<VehicleListParams> Recipe of the vehicle list, a keyboard-navigable DataTable sorted by line by default.

VehicleListReactUtil.VehicleListParams

record base/tealdef/gui/line_vehicle_mgmt/vehicle_list_react_util.d.tl:4

record VehicleListParams

Notes

Parameters of VehicleList.

Used in the base game: 1 time in 1 file

base/content/gui/gui/line_vehicle_mgmt/vehicle_list_react_util.tl:525

vehicle_list_react_util.VehicleList = react.RegisterRecipe("VehicleList", function(vehicleListParams : VehicleListReactUtil.VehicleListParams) : TreeNodeId

Fields

Name Type Description
vehicles {Engine.Entity} Vehicle entities shown as rows.
managerRef ReactRefWrapApiT<VehicleManagerParams, VehicleManagerApi> Ref to the vehicle manager; its API is used to read and change the vehicle selection.
managerActionButtonsRef ReactRefWrap Passed by the manager window but not used by VehicleList itself.
commonParams CommonActionParams Shared action parameters of the manager window (gamepad mode, more-options state, ...).

Functions

onClickSelectLineOrDepot(entity : Engine.Entity, isLine : boolean) base/tealdef/gui/line_vehicle_mgmt/vehicle_list_react_util.d.tl:12

Notes

Called when the line / depot button of a row is clicked; isLine tells which one the entity is.

onClickSelectVehicle(vehicleEntity : Engine.Entity) base/tealdef/gui/line_vehicle_mgmt/vehicle_list_react_util.d.tl:13

Notes

Called when a vehicle row is clicked (the manager toggles the vehicle's selection). Double-clicking a row makes the camera follow the vehicle.