manager_tooltips_util

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

Notes

Tooltip recipes shown next to the cursor while the Line & Vehicle Manager tool is active (prefix LM = line management, VM = vehicle management).

ManagerTooltipsUtil

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

global record ManagerTooltipsUtil

Load: local manager_tooltips_util = ug_require "/gui/line_vehicle_mgmt/manager_tooltips_util.tl"

Notes

Cursor tooltips of the Line & Vehicle Manager, set with ContextBuilder.tooltip.

Fields

Name	Type	Description
Debug	Recipe<string>	Debug tooltip showing the given message. used 1× in the base game
Default	Recipe<any>	"Select a line, vehicle, station or depot."
SelectLine	Recipe<LineUtil.LineSelectionDetails>	"Select ." for a picked line (nothing if the line does not exist). used 1× in the base game
AddVehicleToSelection	Recipe<Engine.Entity>	"Add to selection." used 1× in the base game
RemoveVehicleFromSelection	Recipe<Engine.Entity>	"Remove from selection." used 1× in the base game
AddVehicleToList	Recipe<Engine.Entity>	"Add to list." used 1× in the base game
RemoveVehicleFromList	Recipe<Engine.Entity>	"Remove from list."
OpenDepot	Recipe<Engine.Entity>	"Buy vehicles at ." used 1× in the base game
AddOrRemoveDepotVehiclesToVehicleList	Recipe<LineUtil.VehicleDepotDetails>	"Add vehicles in to list." or "Remove vehicles in from list.", depending on removeFromList. used 1× in the base game
OpenWarehouse	Recipe<Engine.Entity>	"Open ." used 1× in the base game
CreateLine	Recipe<LineUtil.StationSelectionDetails>	"Create new line starting at ." used 2× in the base game
CreateLineError	Recipe<any>	"Start new line is currently disabled." used 2× in the base game
LMDefault	Recipe<any>	"Select a station to add stops."
LMDefaultMoveStop	Recipe<any>	"Select the station to which the stop should be moved." used 1× in the base game
LMDefaultMoveWaypoint	Recipe<any>	"Select the location to which the waypoint should be moved." used 1× in the base game
LMSelectSection	Recipe<integer>	"Select line section ." for the given stop number. used 1× in the base game
LMSelectSectionFirst	Recipe<any>	"Select a segment." used 1× in the base game
LMMoveStopTarget	Recipe<LineUtil.StationSelectionDetails>	"Move stop to [terminal ]." used 1× in the base game
LMMoveStopTargetError	Recipe<any>	"Cannot move stop here." used 1× in the base game
LMMoveWaypoint	Recipe<LineUtil.WaypointSelectionDetails>	"Move waypoint ." used 1× in the base game
LMSelectDepotForLine	Recipe<LineUtil.DepotAndLineParams>	"Buy vehicles for at ." used 1× in the base game
LMMoveWaypointTarget	Recipe<Waypoint>	"Move waypoint to ." or "Move waypoint here." used 2× in the base game
LMWaypointTooClose	Recipe<Waypoint>	"Too close to other waypoint." used 1× in the base game
LMWaterWaypointOnLand	Recipe<Waypoint>	"Ship waypoints must be on water." used 2× in the base game
LMAddStop	Recipe<LineUtil.StationSelectionDetails>	"Add stop at [terminal ]." used 1× in the base game
LMAddWaypoint	Recipe<Waypoint>	"Add waypoint here." used 2× in the base game
LMPromptWaypointModifier	Recipe<Waypoint>	Hint to hold the precision-mode input action to add a waypoint. used 2× in the base game
VMDefault	Recipe<integer>	"Select a line, station or depot to send vehicles to." used 1× in the base game
VMSendToLine	Recipe<SendToLineOrDepotParams>	"Send vehicle(s) to ." used 1× in the base game
VMSendToNewLine	Recipe<integer>	"Create new line from this stop and assign vehicle(s)." used 1× in the base game
VMSendToDepot	Recipe<SendToLineOrDepotParams>	"Send vehicle(s) to ." used 1× in the base game

Functions

makeSelectLineTooltip(entity : Engine.Entity) : string base/tealdef/gui/line_vehicle_mgmt/manager_tooltips_util.d.tl:12

Call as manager_tooltips_util.makeSelectLineTooltip

Notes

Returns "Select ." for the entity.

Returns string

Used in the base game: 1 time in 1 file

base/content/gui/gui/line_vehicle_mgmt/manager_hud_util.tl:142

tooltip = manager_tooltips_util.makeSelectLineTooltip(lineEntityAndColor.entity),

makeAddVehicleToSelectionTooltip(Engine.Entity) : string base/tealdef/gui/line_vehicle_mgmt/manager_tooltips_util.d.tl:14

Call as manager_tooltips_util.makeAddVehicleToSelectionTooltip

Notes

Returns "Add to selection.".

Returns string

Used in the base game: 1 time in 1 file

base/content/gui/gui/line_vehicle_mgmt/manager_hud_util.tl:1300

tooltips[vehicleEntity] = manager_tooltips_util.makeAddVehicleToSelectionTooltip(vehicleEntity)

makeRemoveVehicleFromSelectionTooltip(Engine.Entity) : string base/tealdef/gui/line_vehicle_mgmt/manager_tooltips_util.d.tl:16

Call as manager_tooltips_util.makeRemoveVehicleFromSelectionTooltip

Notes

Returns "Remove from selection.".

Returns string

Used in the base game: 1 time in 1 file

base/content/gui/gui/line_vehicle_mgmt/manager_hud_util.tl:1297

tooltips[vehicleEntity] = manager_tooltips_util.makeRemoveVehicleFromSelectionTooltip(vehicleEntity)

makeAddVehicleToListTooltip(Engine.Entity) : string base/tealdef/gui/line_vehicle_mgmt/manager_tooltips_util.d.tl:18

Call as manager_tooltips_util.makeAddVehicleToListTooltip

Notes

Returns "Add to list.".

Returns string

Used in the base game: 1 time in 1 file

base/content/gui/gui/line_vehicle_mgmt/manager_hud_util.tl:1303

tooltips[vehicleEntity] = manager_tooltips_util.makeAddVehicleToListTooltip(vehicleEntity)

ManagerTooltipsUtil.SendToLineOrDepotParams

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

record SendToLineOrDepotParams

Notes

Parameters of the VMSendToLine and VMSendToDepot tooltips.

Used in the base game: 4 times in 2 files

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:1243

local sendToLineParams : ManagerTooltipsUtil.SendToLineOrDepotParams = {

base/content/gui/gui/line_vehicle_mgmt/manager_tooltips_util.tl:245

manager_tooltips_util.VMSendToLine = react.RegisterRecipe("VMSendToLine", function(params : ManagerTooltipsUtil.SendToLineOrDepotParams) : TreeNodeId

Fields

Name	Type	Description
numVehicles	integer	Number of vehicles to send.
lineOrDepotEntity	Engine.Entity	Target line or depot.