vehicle_eow¶

Source: base/tealdef/gui/entity_window/vehicle/vehicle_eow.d.tl

Notes

Plugin types of the vehicle window (vehicle_eow.script.tl).

VehicleEow¶

record global base/tealdef/gui/entity_window/vehicle/vehicle_eow.d.tl:3

global record VehicleEow

Load: local vehicle_eow = ug_require "/gui/entity_window/vehicle/vehicle_eow.script.tl"

Notes

Plugin types of the vehicle window.

Fields

Name	Type	Description
`VehicleEowExtensionPoint`	`ExtensionPoint<VehicleWidgetPluginParams>`	Extension point of the vehicle window; register plugins with a resource of type `"react-plugin ::VehicleEowExtensionPoint"`. used 1× in the base game
`NotificationPlugin`	`Recipe<VehicleWidgetPluginParams>`	Notification cards of the vehicle; registered with order 0.
`VehicleBasicsPlugin`	`Recipe<VehicleWidgetPluginParams>`	"Basics" card with the line, a card with the cargo on board (passengers table for own passenger vehicles) and a noise and pollution card; registered with order 10.
`VehicleConditionPlugin`	`Recipe<VehicleWidgetPluginParams>`	"Condition" card with the condition bar and maintenance history, plus a card with the vehicle parts and their details; registered with order 50.
`VehicleBalancePlugin`	`Recipe<VehicleWidgetPluginParams>`	"Balance" card with an income and running costs chart; registered with order 70 and condition `isPlayerOwned`.

Functions

isPlayerOwned(VehicleWidgetPluginParams) : boolean base/tealdef/gui/entity_window/vehicle/vehicle_eow.d.tl:29

Call as vehicle_eow.isPlayerOwned

Notes

Plugin condition; true if the vehicle is owned by the local player.

Returns boolean

Used in the base game: 1 time in 1 file

base/content/gui/gui/entity_window/vehicle/vehicle.tl:290

local hasMaintenanceBar = vehicle_eow.isPlayerOwned(extensionParams)

VehicleEow.StaticVehicleInfoState¶

record base/tealdef/gui/entity_window/vehicle/vehicle_eow.d.tl:5

record StaticVehicleInfoState

Notes

Vehicle data of the vehicle window that rarely changes.

Used in the base game: 1 time in 1 file

base/content/gui/gui/entity_window/vehicle/vehicle.tl:170

local makeStaticVehicleInfoState = function() : VehicleEow.StaticVehicleInfoState

Fields

Name	Type	Description
`modelIds`	`{integer}`	Model ids of the vehicle parts (e.g. locomotive and wagons), in order.
`carrier`	`Carrier`	Carrier of the first vehicle part, from its `transportVehicle` metadata.
`modifiers`	`Engine.Component.TransportVehicle.Modifiers`	Modifiers of the transport vehicle (`TRANSPORT_VEHICLE.modifiers`).
`canTransportPassengers`	`boolean`	True if the vehicle has passenger capacity.
`vehicleSpecialization`	`{string}`	Cargo classes the compartments of all parts can load.

VehicleEow.VehicleEowState¶

record base/tealdef/gui/entity_window/vehicle/vehicle_eow.d.tl:13

record VehicleEowState

Notes

State of the vehicle window passed to the plugins.

Fields

Name	Type	Description
`staticVehicleInfo`	`StaticVehicleInfoState`	Vehicle data that rarely changes.

VehicleEow.VehicleWidgetPluginParams¶

record base/tealdef/gui/entity_window/vehicle/vehicle_eow.d.tl:17

record VehicleWidgetPluginParams is EowExtensionUtil.IEowWidgetsExtensionParams

Notes

Parameters passed to the plugins of the vehicle window.

Used in the base game: 6 times in 2 files

base/content/gui/gui/entity_window/vehicle/vehicle.tl:232

local extensionParams : VehicleEow.VehicleWidgetPluginParams = {

base/content/gui/gui/entity_window/vehicle/vehicle_eow.script.tl:26

vehicle_eow.NotificationPlugin = react.RegisterPluginRecipe(vehicle_eow.VehicleEowExtensionPoint, "NotificationPlugin", function(params : VehicleEow.VehicleWidg

Fields

Name	Type	Description
`state`	`VehicleEowState`	Window state.