index / content / gui / line_vehicle_mgmt / line_util

Module content.gui.line_vehicle_mgmt.line_util🔗

global record BufferedLVMSendData line: Engine.Entity vehicle: Engine.Entity stopToSend: integer end
global interface CommonActionParams gameCtx: GameContext parent: ReactNodeRef lvmButtonIAs: LVMButtonIAs iconPaths: LVMIconPaths lineState: ReactStateT<Line.ReactLine> problemCacheState: ReactStateT<ProblemCache> countDataState: ReactStateT<LVMCountData> gamepadInputModeState: ReactStateT<boolean> lvm2D3DModeState: ReactStateT<LVM2D3DMode> lvmSectionState: ReactStateT<LVMSection> lvmActionButtonsState: ReactStateT<LVMActionButtons> moreOptionsState: ReactStateT<boolean> sendToLineHoveredLineState: ReactStateT<Engine.Entity> addStopHoveredStationState: ReactStateT<LineUtil.StationSelectionDetails> preferLineOverTNEdgeState: ReactStateT<boolean> creatingNewLineState: ReactStateT<boolean> vehicleManagerStateRef: ReactRefT<VehicleManagerState> lineManagerStateRef: ReactRefT<LineManagerState> vehicleManagerRef: ReactRefWrapApiT<VehicleManagerParams, VehicleManagerApi> lineAndDepotListRef: ReactRefWrapApiT<LineAndDepotListParams, LineAndDepotListApi> vehicleStoreOpenForDepotAndLineRef: ReactRefT<VehicleStoreOpenInfo> deleteSellRef: ReactRefT<LVMDeleteSell> forceUpdateTag: ReactRefT<string> bufferedSendDataRef: ReactRefT<{BufferedLVMSendData}> prevLvmModeRef: ReactRefT<{LVMMode, <any type>}> lvmDnDDataRef: ReactRefT<LVMDnDData> configureLinesPopoverPosRef: ReactRefWrap sendToLinePopoverPosRef: ReactRefWrap btnBuyVehiclesRef: ReactRefWrap btnSendToLineRef: ReactRefWrap btnNewLineRef: ReactRefWrap switchMode: function({LVMMode, <any type> | LineUtil.StopSelectionDetails}) switchToPrevMode: function() getModeState: function(): {LVMMode, <any type>} addFeedback: function(string, string, FeedbackListUtil.FeedbackDialogParam, number) updateIA: function(LineUtil.GuiContextState) onProcessMouseEvent: function(Gui.Mouse.Event): boolean accessNotificationCacheFn: function(Engine.Entity): {Notification} carrierFn: function(): {Carrier} getDisableHudInteraction: function(): boolean resetLVMDnDData: function() getFirstStopToSendTo: function(Engine.Entity, Engine.Entity): integer addDepotVehiclesToDepotVehicleCompare: function(Engine.Entity) removeDepotVehiclesFromDepotVehicleCompare: function(Engine.Entity) addVehicleToDepotVehicleCompare: function(Engine.Entity, Engine.Entity) removeVehicleFromDepotVehicleCompare: function(Engine.Entity) clearDepotVehicleCompare: function() newLine: function(LineUtil.StationSelectionDetails, {Engine.Entity}) selectLine: function(LineUtil.LineSelectionDetails, boolean, integer) deleteGamepadFocusedLine: function() addStop: function(LineUtil.StationSelectionDetails, integer) removeStop: function(LineUtil.StopSelectionDetails) moveStop: function(LineUtil.StopSelectionDetails, LineUtil.StationSelectionDetails) moveVia: function(integer, integer) addAlternativeTerminal: function(LineUtil.StationSelectionDetails) removeAlternativeTerminal: function(LineUtil.StationSelectionDetails) selectAlternativeTerminal: function(integer, integer, integer, boolean) changeMainTerminal: function(integer, integer, integer) addWaypoint: function(Waypoint, integer) removeWaypoint: function(LineUtil.WaypointSelectionDetails) moveWaypoint: function(LineUtil.WaypointSelectionDetails, Waypoint) addOrRemoveVehicleToVehicleList: function(LineUtil.VehicleDepotDetails) addOrRemoveDepotVehiclesToVehicleList: function(LineUtil.VehicleDepotDetails) addOrRemoveLineVehiclesToVehicleList: function(Engine.Entity, boolean, boolean) isVehicleSelected: function(Engine.Entity): boolean isVehicleInVehicleList: function(Engine.Entity): boolean selectOrDeselectVehicleInVehicleList: function(Engine.Entity, boolean) areAllDepotVehiclesInVehicleList: function(Engine.Entity): boolean openVehicleDepot: function(Engine.Entity, Engine.Entity) areAnyVehiclesInDepot: function(Engine.Entity): boolean selectOrDeselectDepot: function(LineUtil.VehicleDepotDetails) sendVehiclesToLine: function({Engine.Entity}, Engine.Entity) sendVehiclesToDepot: function({Engine.Entity}, Engine.Entity) openWarehouse: function(Engine.Entity) sellVehicle: function(Engine.Entity) openCargoFilter: function(LineUtil.StopSelectionDetails, Vec2f, function()) closeCargoFilter: function() btnNewLineEnabled: function(): boolean btnNewLineOnClick: function() btnSendToLineEnabled: function(): boolean btnSendToLineOnClick: function() btnBuyVehiclesEnabled: function(): boolean btnBuyVehiclesOnClick: function() end
global enum LVM2D3DMode "2D" "3D" end
global enum LVMActionButtons "LMAB" "LPDAB" "LPLAB" "LPPAB" "NONE" "VMAB" end
global record LVMButtonIAs btn2D3D_Switch: string btn2D_ActionButtons: string btn3D_Move: string btn2D_MoreOptions: string btn3D_Configure: string btn2D_NextSection: string btn3D_Delete: string btnMore_SendToLine: string btnMore_NewLine: string btnMore_DeleteSell: string btnMore_BuyVehicle: string modifier3D_PreferWaypoint: string end
global record LVMCountData countLinesWithProblems: integer countLinesSelected: integer countLinesUnselected: integer selectionRatioLines: number countDepotsSelected: integer countDepotsUnselected: integer selectionRatioDepots: number countVehiclesWithProblems: integer countVehiclesSelected: integer countVehiclesUnselected: integer selectionRatioVehicles: number end
global record LVMDeleteSell focusedLine: Engine.Entity focusedVehicle: Engine.Entity focusedStopLine: Engine.Entity focusedStopNumber: integer focusedApiStopIndex0: integer end
global record LVMDisplayData notificationProblemColor: Vec4f contrastColor: Vec4f textColor: Vec4f waypointColor: Vec4f selectedLineColor: Vec4f end
global record LVMDnDData dragStartLineEntity: Engine.Entity dragStartLineRevision: Engine.Revision end
global record LVMIconPaths rowRename: string rowConfigure: string rowMove: string rowDelete: string rowSelectTerminals: string rowLocate: string rowRemove: string rowCart: string problemAlert: string problemArrow: string regSelectTerminals: string regRename: string regAutoRename: string regFilterVisible: string regGradient: string regDragGrip: string abNewLine: string abSendToLine: string abBuyVehicles: string abFilterVisible: string abFilterRoad: string abFilterTram: string abFilterRail: string abFilterWater: string abFilterAir: string abReverse: string abStartStop: string abPaint: string abDuplicate: string abReplace: string abConfigure: string abSendToDepot: string abSell: string abAutoRename: string hudTerminal: string hudConfigureNone: string hudConfigure: string hudMove: string hudAdd: string hudRemove: string end
global enum LVMMode "MAIN" "MOVE_STOP" "MOVE_WAYPOINT" "SEGMENT" "SEND_TO_LINE" end
global enum LVMSection "LM" "LP" "VM" end
global record LineManagerPanelParams commonParams: CommonActionParams end
global record LineUtil
record LineSelectionDetails entity: Engine.Entity stopNumber: integer apiStopIndex0: integer apiWaypointIndex: integer end
record StationSelectionDetails stationGroup: Engine.Entity stationIndex1: integer station: Engine.Entity terminalIndex1: integer flatStationTerminalIndex1: integer end
record SignalSelectionDetails signal: Engine.Entity signalIndex1: integer end
record StopSelectionDetails station: StationSelectionDetails line: Engine.Entity stopNumber: integer apiStopIndex0: integer end
record WaypointSelectionDetails line: Engine.Entity stopNumber: integer apiStopIndex0: integer tag: integer end
record TransportNetworkEdgeSelectionDetails snap: EdgePos end
record VehicleDepotDetails entity: Engine.Entity removeFromList: boolean end
record SelectionDetails entity: Engine.Entity line: LineSelectionDetails station: StationSelectionDetails signal: SignalSelectionDetails stop: StopSelectionDetails waypoint: WaypointSelectionDetails transportNetworkEdge: TransportNetworkEdgeSelectionDetails world: Gui.SelectionDetails.World vehicleDepot: VehicleDepotDetails townData: Gui.SelectionDetails.Town end
record TerminalAlternative alternativePossible: boolean alternativeSelected: boolean color: Vec4f end
record LineHasVehicles hasNoVehicles: boolean hasRoadVehicles: boolean hasRailVehicles: boolean hasTramVehicles: boolean hasAirVehicles: boolean hasWaterVehicles: boolean hasPlanes: boolean hasSmallPlanes: boolean hasHelicopters: boolean hasShips: boolean hasSmallShips: boolean hasLightrailRail: boolean hasLightrailTram: boolean end
record RecipeAndParamErased recipe: Recipe<<any type>> param: any end
record GuiContextState inputActions: {string} iaForwards: {string : React.IaForward} iaHandlers: {string : {React.IaHandler, <any type>, <any type>}} handleClick: function() tooltip: RecipeAndParamErased mouseCursor: integer terrainCirclePolicy: Builtin.TerrainCirclePolicy highlightLine: LineUtil.LineSelectionDetails highlightStop: Gui.SelectionDetails.Stop highlightTerminal: {Engine.Entity, StationTerminal} highlightWaypoint: {Engine.Entity, integer, integer} snapPreview: Gui.SelectionDetails.TransportNetworkEdge player: boolean disableCreateNewLine: boolean showNavigableLayer: boolean showTerminalsForLine: Engine.Entity componentsFilter: {Engine.ComponentType} unselectableComponents: {Engine.ComponentType} hudMaster: Recipe2<Builtin.HudIconParam, CommonActionParams> carriers: {Carrier} end
record ContextBuilder iaHandler: function(string, function(), any, function() : boolean, any, string) iaHandlerExtended: function(string, function(Gui.InputAction.InvokeData), any, function() : boolean, any, string) iaForward: function(string, ReactRefWrap, string) iaClick: function(function()) iaClickOrSelect: function(function(), any, function() : boolean, any) tooltip: function<T>(Recipe<T>, T) setShowNavigableLayer: function(boolean) highlightLine: function(Engine.Entity, integer) highlightTerminal: function(LineUtil.StationSelectionDetails) highlightStop: function(LineUtil.StopSelectionDetails) highlightSignal: function(LineUtil.SignalSelectionDetails) highlightWaypoint: function(LineUtil.WaypointSelectionDetails) showSnapPreview: function(LineUtil.TransportNetworkEdgeSelectionDetails) setPlayer: function(boolean) showTerminalsForLine: function(Engine.Entity) setComponentsFilter: function({Engine.ComponentType}) setUnselectableComponents: function({Engine.ComponentType}) setHudMaster: function<T is CommonActionParams>(Recipe2<Builtin.HudIconParam, T>) setMouseCursor: function(integer) setTerrainCirclePolicy: function(Builtin.TerrainCirclePolicy) result: GuiContextState end
autoAssignTerminals: function(Engine.Entity, {Line.ReactVia}): {Engine.Component.Line.Stop} makeLineColor: function(Engine.Entity): Vec3f makeLineName: function(Engine.Entity): string getReactLineFromGameState: function(Engine.Entity): Line.ReactLine computeStopAndWaypointIndex0: function(Engine.Entity, integer): {integer, integer} computeWaypointIndex0FromTag: function(Engine.Entity, integer, integer): integer computeStopNumber: function(Engine.Entity, integer, integer): integer convertDetails: function(Engine.Entity, Gui.SelectionDetails): SelectionDetails makeNewStop: function(StationSelectionDetails): Line.ReactVia applyInputActionConfig: function(GuiContextState) guiContextEquals: function(GuiContextState, GuiContextState): boolean useContextState: function(function() : LineUtil.ContextBuilder, function(LineUtil.GuiContextState)): LineUtil.GuiContextState, function(LineUtil.GuiContextState) MakeContextBuilder: function(): ContextBuilder makeLineActionDescriptor: function<CommonActionParams, Mode>(CommonActionParams, GameContext, ReactNodeRef, function({Mode, <any type> | LineUtil.StopSelectionDetails | nil}), {Builtin.Type.LineVisualization}, Engine.Entity, {Engine.Entity}, GuiContextState, function(LineUtil.SelectionDetails) : LineUtil.GuiContextState, function(Gui.Mouse.Event) : boolean, boolean, boolean, boolean, LVM2D3DMode, boolean, boolean): TreeNodeId getStationHudPath: function(Carrier, boolean, boolean): string getLineCarriers: function(Line.ReactLine): {Carrier : boolean} isWaypointTooClose: function(Line.ReactLine, Vec3f, integer): boolean calculateFrequencySeconds: function(Engine.Entity): integer getVehicleInstructionName: function(Engine.Entity): string autoLoadConfig: function(Line.ReactLine) isTerminalCargoTypeAllowed: function(Line.ReactTerminal, CargoTypeId): boolean getTerminalAlternative: function(LineUtil.StationSelectionDetails, Line.ReactLine, integer): LineUtil.TerminalAlternative isLineCompatibleWithTransportMode: function(Engine.Entity, TransportMode): boolean getLineHasVehicles: function(Engine.Entity): LineUtil.LineHasVehicles getLineAndVehicleCompatibleTransportModesAndCarrier: function({Engine.Entity}): VehicleStoreUtil.TransportModesAndCarrier isStopProtected: function(Engine.Entity, Engine.Entity, {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}): boolean getBestDepotForLine: function(Engine.Entity): Engine.Entity getTerminal: function(Line.ReactTerminal): Terminal getTerminalLength: function(Engine.Entity, integer): number
record DepotAndLineParams depot: Engine.Entity line: Engine.Entity end
enum RelaxationType "Catenary" "Road" "Train" "TramLanes" "TramTrack" end
getRelaxationType: function({TransportMode : boolean}, {TransportMode : boolean}, {TransportMode : boolean}): LineUtil.RelaxationType getRelaxationText: function(RelaxationType): string end
global record ProblemCache vehiclesAndProblems: {{{Engine.Entity}, VehicleProblem}} vehiclesWithRoundTrips: {Engine.Entity : integer} line2misconfiguredLines: {Engine.Entity : {LineIssue}} line2detailedLineProblems: {Engine.Entity : {{UtilLine.StopState}}} line2problem: {Engine.Entity : boolean} vehicle2problem: {Engine.Entity : boolean} line2vehicleProblemCount: {Engine.Entity : integer} end
global record VehicleProblems vehicles2problem: {Engine.Entity : boolean} problemCount: integer end

Category: globals🔗

BufferedLVMSendData🔗

global record BufferedLVMSendData line: Engine.Entity vehicle: Engine.Entity stopToSend: integer end

BufferedLVMSendData.line🔗

BufferedLVMSendData.line: Engine.Entity

BufferedLVMSendData.vehicle🔗

BufferedLVMSendData.vehicle: Engine.Entity

BufferedLVMSendData.stopToSend🔗

BufferedLVMSendData.stopToSend: integer

CommonActionParams🔗

global interface CommonActionParams gameCtx: GameContext parent: ReactNodeRef lvmButtonIAs: LVMButtonIAs iconPaths: LVMIconPaths lineState: ReactStateT<Line.ReactLine> problemCacheState: ReactStateT<ProblemCache> countDataState: ReactStateT<LVMCountData> gamepadInputModeState: ReactStateT<boolean> lvm2D3DModeState: ReactStateT<LVM2D3DMode> lvmSectionState: ReactStateT<LVMSection> lvmActionButtonsState: ReactStateT<LVMActionButtons> moreOptionsState: ReactStateT<boolean> sendToLineHoveredLineState: ReactStateT<Engine.Entity> addStopHoveredStationState: ReactStateT<LineUtil.StationSelectionDetails> preferLineOverTNEdgeState: ReactStateT<boolean> creatingNewLineState: ReactStateT<boolean> vehicleManagerStateRef: ReactRefT<VehicleManagerState> lineManagerStateRef: ReactRefT<LineManagerState> vehicleManagerRef: ReactRefWrapApiT<VehicleManagerParams, VehicleManagerApi> lineAndDepotListRef: ReactRefWrapApiT<LineAndDepotListParams, LineAndDepotListApi> vehicleStoreOpenForDepotAndLineRef: ReactRefT<VehicleStoreOpenInfo> deleteSellRef: ReactRefT<LVMDeleteSell> forceUpdateTag: ReactRefT<string> bufferedSendDataRef: ReactRefT<{BufferedLVMSendData}> prevLvmModeRef: ReactRefT<{LVMMode, <any type>}> lvmDnDDataRef: ReactRefT<LVMDnDData> configureLinesPopoverPosRef: ReactRefWrap sendToLinePopoverPosRef: ReactRefWrap btnBuyVehiclesRef: ReactRefWrap btnSendToLineRef: ReactRefWrap btnNewLineRef: ReactRefWrap switchMode: function({LVMMode, <any type> | LineUtil.StopSelectionDetails}) switchToPrevMode: function() getModeState: function(): {LVMMode, <any type>} addFeedback: function(string, string, FeedbackListUtil.FeedbackDialogParam, number) updateIA: function(LineUtil.GuiContextState) onProcessMouseEvent: function(Gui.Mouse.Event): boolean accessNotificationCacheFn: function(Engine.Entity): {Notification} carrierFn: function(): {Carrier} getDisableHudInteraction: function(): boolean resetLVMDnDData: function() getFirstStopToSendTo: function(Engine.Entity, Engine.Entity): integer addDepotVehiclesToDepotVehicleCompare: function(Engine.Entity) removeDepotVehiclesFromDepotVehicleCompare: function(Engine.Entity) addVehicleToDepotVehicleCompare: function(Engine.Entity, Engine.Entity) removeVehicleFromDepotVehicleCompare: function(Engine.Entity) clearDepotVehicleCompare: function() newLine: function(LineUtil.StationSelectionDetails, {Engine.Entity}) selectLine: function(LineUtil.LineSelectionDetails, boolean, integer) deleteGamepadFocusedLine: function() addStop: function(LineUtil.StationSelectionDetails, integer) removeStop: function(LineUtil.StopSelectionDetails) moveStop: function(LineUtil.StopSelectionDetails, LineUtil.StationSelectionDetails) moveVia: function(integer, integer) addAlternativeTerminal: function(LineUtil.StationSelectionDetails) removeAlternativeTerminal: function(LineUtil.StationSelectionDetails) selectAlternativeTerminal: function(integer, integer, integer, boolean) changeMainTerminal: function(integer, integer, integer) addWaypoint: function(Waypoint, integer) removeWaypoint: function(LineUtil.WaypointSelectionDetails) moveWaypoint: function(LineUtil.WaypointSelectionDetails, Waypoint) addOrRemoveVehicleToVehicleList: function(LineUtil.VehicleDepotDetails) addOrRemoveDepotVehiclesToVehicleList: function(LineUtil.VehicleDepotDetails) addOrRemoveLineVehiclesToVehicleList: function(Engine.Entity, boolean, boolean) isVehicleSelected: function(Engine.Entity): boolean isVehicleInVehicleList: function(Engine.Entity): boolean selectOrDeselectVehicleInVehicleList: function(Engine.Entity, boolean) areAllDepotVehiclesInVehicleList: function(Engine.Entity): boolean openVehicleDepot: function(Engine.Entity, Engine.Entity) areAnyVehiclesInDepot: function(Engine.Entity): boolean selectOrDeselectDepot: function(LineUtil.VehicleDepotDetails) sendVehiclesToLine: function({Engine.Entity}, Engine.Entity) sendVehiclesToDepot: function({Engine.Entity}, Engine.Entity) openWarehouse: function(Engine.Entity) sellVehicle: function(Engine.Entity) openCargoFilter: function(LineUtil.StopSelectionDetails, Vec2f, function()) closeCargoFilter: function() btnNewLineEnabled: function(): boolean btnNewLineOnClick: function() btnSendToLineEnabled: function(): boolean btnSendToLineOnClick: function() btnBuyVehiclesEnabled: function(): boolean btnBuyVehiclesOnClick: function() end

CommonActionParams.gameCtx🔗

CommonActionParams.gameCtx: GameContext

CommonActionParams.parent🔗

CommonActionParams.parent: ReactNodeRef

CommonActionParams.lvmButtonIAs🔗

CommonActionParams.lvmButtonIAs: LVMButtonIAs

CommonActionParams.iconPaths🔗

CommonActionParams.iconPaths: LVMIconPaths

CommonActionParams.lineState🔗

CommonActionParams.lineState: ReactStateT<Line.ReactLine>

CommonActionParams.problemCacheState🔗

CommonActionParams.problemCacheState: ReactStateT<ProblemCache>

CommonActionParams.countDataState🔗

CommonActionParams.countDataState: ReactStateT<LVMCountData>

CommonActionParams.gamepadInputModeState🔗

CommonActionParams.gamepadInputModeState: ReactStateT<boolean>

CommonActionParams.lvm2D3DModeState🔗

CommonActionParams.lvm2D3DModeState: ReactStateT<LVM2D3DMode>

CommonActionParams.lvmSectionState🔗

CommonActionParams.lvmSectionState: ReactStateT<LVMSection>

CommonActionParams.lvmActionButtonsState🔗

CommonActionParams.lvmActionButtonsState: ReactStateT<LVMActionButtons>

CommonActionParams.moreOptionsState🔗

CommonActionParams.moreOptionsState: ReactStateT<boolean>

CommonActionParams.sendToLineHoveredLineState🔗

CommonActionParams.sendToLineHoveredLineState: ReactStateT<Engine.Entity>

CommonActionParams.addStopHoveredStationState🔗

CommonActionParams.addStopHoveredStationState: ReactStateT<LineUtil.StationSelectionDetails>

CommonActionParams.preferLineOverTNEdgeState🔗

CommonActionParams.preferLineOverTNEdgeState: ReactStateT<boolean>

CommonActionParams.creatingNewLineState🔗

CommonActionParams.creatingNewLineState: ReactStateT<boolean>

CommonActionParams.vehicleManagerStateRef🔗

CommonActionParams.vehicleManagerStateRef: ReactRefT<VehicleManagerState>

CommonActionParams.lineManagerStateRef🔗

CommonActionParams.lineManagerStateRef: ReactRefT<LineManagerState>

CommonActionParams.vehicleManagerRef🔗

CommonActionParams.vehicleManagerRef: ReactRefWrapApiT<VehicleManagerParams, VehicleManagerApi>

CommonActionParams.lineAndDepotListRef🔗

CommonActionParams.lineAndDepotListRef: ReactRefWrapApiT<LineAndDepotListParams, LineAndDepotListApi>

CommonActionParams.vehicleStoreOpenForDepotAndLineRef🔗

CommonActionParams.vehicleStoreOpenForDepotAndLineRef: ReactRefT<VehicleStoreOpenInfo>

CommonActionParams.deleteSellRef🔗

CommonActionParams.deleteSellRef: ReactRefT<LVMDeleteSell>

CommonActionParams.forceUpdateTag🔗

CommonActionParams.forceUpdateTag: ReactRefT<string>

CommonActionParams.bufferedSendDataRef🔗

CommonActionParams.bufferedSendDataRef: ReactRefT<{BufferedLVMSendData}>

CommonActionParams.prevLvmModeRef🔗

CommonActionParams.prevLvmModeRef: ReactRefT<{LVMMode, <any type>}>

CommonActionParams.lvmDnDDataRef🔗

CommonActionParams.lvmDnDDataRef: ReactRefT<LVMDnDData>

CommonActionParams.configureLinesPopoverPosRef🔗

CommonActionParams.configureLinesPopoverPosRef: ReactRefWrap

CommonActionParams.sendToLinePopoverPosRef🔗

CommonActionParams.sendToLinePopoverPosRef: ReactRefWrap

CommonActionParams.btnBuyVehiclesRef🔗

CommonActionParams.btnBuyVehiclesRef: ReactRefWrap

CommonActionParams.btnSendToLineRef🔗

CommonActionParams.btnSendToLineRef: ReactRefWrap

CommonActionParams.btnNewLineRef🔗

CommonActionParams.btnNewLineRef: ReactRefWrap

CommonActionParams.switchMode🔗

function CommonActionParams.switchMode({LVMMode, <any type> | LineUtil.StopSelectionDetails})
Parameters
  • {LVMMode, <any type> | LineUtil.StopSelectionDetails}

CommonActionParams.switchToPrevMode🔗

function CommonActionParams.switchToPrevMode()

CommonActionParams.getModeState🔗

function CommonActionParams.getModeState(): {LVMMode, <any type>}
Returns
  1. {LVMMode, <any type>}

CommonActionParams.addFeedback🔗

function CommonActionParams.addFeedback(string, string, FeedbackListUtil.FeedbackDialogParam, number)
Parameters
  • string
  • string
  • FeedbackListUtil.FeedbackDialogParam
  • number

CommonActionParams.updateIA🔗

function CommonActionParams.updateIA(LineUtil.GuiContextState)
Parameters
  • LineUtil.GuiContextState

CommonActionParams.onProcessMouseEvent🔗

function CommonActionParams.onProcessMouseEvent(Gui.Mouse.Event): boolean
Parameters
  • Gui.Mouse.Event
Returns
  1. boolean

CommonActionParams.accessNotificationCacheFn🔗

function CommonActionParams.accessNotificationCacheFn(Engine.Entity): {Notification}
Parameters
  • Engine.Entity
Returns
  1. {Notification}

CommonActionParams.carrierFn🔗

function CommonActionParams.carrierFn(): {Carrier}
Returns
  1. {Carrier}

CommonActionParams.getDisableHudInteraction🔗

function CommonActionParams.getDisableHudInteraction(): boolean
Returns
  1. boolean

CommonActionParams.resetLVMDnDData🔗

function CommonActionParams.resetLVMDnDData()

CommonActionParams.getFirstStopToSendTo🔗

function CommonActionParams.getFirstStopToSendTo(Engine.Entity, Engine.Entity): integer
Parameters
  • Engine.Entity
  • Engine.Entity
Returns
  1. integer

CommonActionParams.addDepotVehiclesToDepotVehicleCompare🔗

function CommonActionParams.addDepotVehiclesToDepotVehicleCompare(Engine.Entity)
Parameters
  • Engine.Entity

CommonActionParams.removeDepotVehiclesFromDepotVehicleCompare🔗

function CommonActionParams.removeDepotVehiclesFromDepotVehicleCompare(Engine.Entity)
Parameters
  • Engine.Entity

CommonActionParams.addVehicleToDepotVehicleCompare🔗

function CommonActionParams.addVehicleToDepotVehicleCompare(Engine.Entity, Engine.Entity)
Parameters
  • Engine.Entity
  • Engine.Entity

CommonActionParams.removeVehicleFromDepotVehicleCompare🔗

function CommonActionParams.removeVehicleFromDepotVehicleCompare(Engine.Entity)
Parameters
  • Engine.Entity

CommonActionParams.clearDepotVehicleCompare🔗

function CommonActionParams.clearDepotVehicleCompare()

CommonActionParams.newLine🔗

function CommonActionParams.newLine(LineUtil.StationSelectionDetails, {Engine.Entity})
Parameters
  • LineUtil.StationSelectionDetails
  • {Engine.Entity}

CommonActionParams.selectLine🔗

function CommonActionParams.selectLine(LineUtil.LineSelectionDetails, boolean, integer)
Parameters
  • LineUtil.LineSelectionDetails
  • boolean
  • integer

CommonActionParams.deleteGamepadFocusedLine🔗

function CommonActionParams.deleteGamepadFocusedLine()

CommonActionParams.addStop🔗

function CommonActionParams.addStop(LineUtil.StationSelectionDetails, integer)
Parameters
  • LineUtil.StationSelectionDetails
  • integer

CommonActionParams.removeStop🔗

function CommonActionParams.removeStop(LineUtil.StopSelectionDetails)
Parameters
  • LineUtil.StopSelectionDetails

CommonActionParams.moveStop🔗

function CommonActionParams.moveStop(LineUtil.StopSelectionDetails, LineUtil.StationSelectionDetails)
Parameters
  • LineUtil.StopSelectionDetails
  • LineUtil.StationSelectionDetails

CommonActionParams.moveVia🔗

function CommonActionParams.moveVia(integer, integer)
Parameters
  • integer
  • integer

CommonActionParams.addAlternativeTerminal🔗

function CommonActionParams.addAlternativeTerminal(LineUtil.StationSelectionDetails)
Parameters
  • LineUtil.StationSelectionDetails

CommonActionParams.removeAlternativeTerminal🔗

function CommonActionParams.removeAlternativeTerminal(LineUtil.StationSelectionDetails)
Parameters
  • LineUtil.StationSelectionDetails

CommonActionParams.selectAlternativeTerminal🔗

function CommonActionParams.selectAlternativeTerminal(integer, integer, integer, boolean)
Parameters
  • integer
  • integer
  • integer
  • boolean

CommonActionParams.changeMainTerminal🔗

function CommonActionParams.changeMainTerminal(integer, integer, integer)
Parameters
  • integer
  • integer
  • integer

CommonActionParams.addWaypoint🔗

function CommonActionParams.addWaypoint(Waypoint, integer)
Parameters
  • Waypoint
  • integer

CommonActionParams.removeWaypoint🔗

function CommonActionParams.removeWaypoint(LineUtil.WaypointSelectionDetails)
Parameters
  • LineUtil.WaypointSelectionDetails

CommonActionParams.moveWaypoint🔗

function CommonActionParams.moveWaypoint(LineUtil.WaypointSelectionDetails, Waypoint)
Parameters
  • LineUtil.WaypointSelectionDetails
  • Waypoint

CommonActionParams.addOrRemoveVehicleToVehicleList🔗

function CommonActionParams.addOrRemoveVehicleToVehicleList(LineUtil.VehicleDepotDetails)
Parameters
  • LineUtil.VehicleDepotDetails

CommonActionParams.addOrRemoveDepotVehiclesToVehicleList🔗

function CommonActionParams.addOrRemoveDepotVehiclesToVehicleList(LineUtil.VehicleDepotDetails)
Parameters
  • LineUtil.VehicleDepotDetails

CommonActionParams.addOrRemoveLineVehiclesToVehicleList🔗

function CommonActionParams.addOrRemoveLineVehiclesToVehicleList(Engine.Entity, boolean, boolean)
Parameters
  • Engine.Entity
  • boolean
  • boolean

CommonActionParams.isVehicleSelected🔗

function CommonActionParams.isVehicleSelected(Engine.Entity): boolean
Parameters
  • Engine.Entity
Returns
  1. boolean

CommonActionParams.isVehicleInVehicleList🔗

function CommonActionParams.isVehicleInVehicleList(Engine.Entity): boolean
Parameters
  • Engine.Entity
Returns
  1. boolean

CommonActionParams.selectOrDeselectVehicleInVehicleList🔗

function CommonActionParams.selectOrDeselectVehicleInVehicleList(Engine.Entity, boolean)
Parameters
  • Engine.Entity
  • boolean

CommonActionParams.areAllDepotVehiclesInVehicleList🔗

function CommonActionParams.areAllDepotVehiclesInVehicleList(Engine.Entity): boolean
Parameters
  • Engine.Entity
Returns
  1. boolean

CommonActionParams.openVehicleDepot🔗

function CommonActionParams.openVehicleDepot(Engine.Entity, Engine.Entity)
Parameters
  • Engine.Entity
  • Engine.Entity

CommonActionParams.areAnyVehiclesInDepot🔗

function CommonActionParams.areAnyVehiclesInDepot(Engine.Entity): boolean
Parameters
  • Engine.Entity
Returns
  1. boolean

CommonActionParams.selectOrDeselectDepot🔗

function CommonActionParams.selectOrDeselectDepot(LineUtil.VehicleDepotDetails)
Parameters
  • LineUtil.VehicleDepotDetails

CommonActionParams.sendVehiclesToLine🔗

function CommonActionParams.sendVehiclesToLine({Engine.Entity}, Engine.Entity)
Parameters
  • {Engine.Entity}
  • Engine.Entity

CommonActionParams.sendVehiclesToDepot🔗

function CommonActionParams.sendVehiclesToDepot({Engine.Entity}, Engine.Entity)
Parameters
  • {Engine.Entity}
  • Engine.Entity

CommonActionParams.openWarehouse🔗

function CommonActionParams.openWarehouse(Engine.Entity)
Parameters
  • Engine.Entity

CommonActionParams.sellVehicle🔗

function CommonActionParams.sellVehicle(Engine.Entity)
Parameters
  • Engine.Entity

CommonActionParams.openCargoFilter🔗

function CommonActionParams.openCargoFilter(LineUtil.StopSelectionDetails, Vec2f, function())
Parameters
  • LineUtil.StopSelectionDetails
  • Vec2f
  • function()

CommonActionParams.closeCargoFilter🔗

function CommonActionParams.closeCargoFilter()

CommonActionParams.btnNewLineEnabled🔗

function CommonActionParams.btnNewLineEnabled(): boolean
Returns
  1. boolean

CommonActionParams.btnNewLineOnClick🔗

function CommonActionParams.btnNewLineOnClick()

CommonActionParams.btnSendToLineEnabled🔗

function CommonActionParams.btnSendToLineEnabled(): boolean
Returns
  1. boolean

CommonActionParams.btnSendToLineOnClick🔗

function CommonActionParams.btnSendToLineOnClick()

CommonActionParams.btnBuyVehiclesEnabled🔗

function CommonActionParams.btnBuyVehiclesEnabled(): boolean
Returns
  1. boolean

CommonActionParams.btnBuyVehiclesOnClick🔗

function CommonActionParams.btnBuyVehiclesOnClick()

LVM2D3DMode🔗

global enum LVM2D3DMode "2D" "3D" end

LVM2D3DMode."2D"🔗

LVM2D3DMode."3D"🔗

LVMActionButtons🔗

global enum LVMActionButtons "LMAB" "LPDAB" "LPLAB" "LPPAB" "NONE" "VMAB" end

LVMActionButtons."LMAB"🔗

LVMActionButtons."LPDAB"🔗

LVMActionButtons."LPLAB"🔗

LVMActionButtons."LPPAB"🔗

LVMActionButtons."NONE"🔗

LVMActionButtons."VMAB"🔗

LVMButtonIAs🔗

global record LVMButtonIAs btn2D3D_Switch: string btn2D_ActionButtons: string btn3D_Move: string btn2D_MoreOptions: string btn3D_Configure: string btn2D_NextSection: string btn3D_Delete: string btnMore_SendToLine: string btnMore_NewLine: string btnMore_DeleteSell: string btnMore_BuyVehicle: string modifier3D_PreferWaypoint: string end

LVMButtonIAs.btn2D3D_Switch🔗

LVMButtonIAs.btn2D3D_Switch: string

LVMButtonIAs.btn2D_ActionButtons🔗

LVMButtonIAs.btn2D_ActionButtons: string

LVMButtonIAs.btn3D_Move🔗

LVMButtonIAs.btn3D_Move: string

LVMButtonIAs.btn2D_MoreOptions🔗

LVMButtonIAs.btn2D_MoreOptions: string

LVMButtonIAs.btn3D_Configure🔗

LVMButtonIAs.btn3D_Configure: string

LVMButtonIAs.btn2D_NextSection🔗

LVMButtonIAs.btn2D_NextSection: string

LVMButtonIAs.btn3D_Delete🔗

LVMButtonIAs.btn3D_Delete: string

LVMButtonIAs.btnMore_SendToLine🔗

LVMButtonIAs.btnMore_SendToLine: string

LVMButtonIAs.btnMore_NewLine🔗

LVMButtonIAs.btnMore_NewLine: string

LVMButtonIAs.btnMore_DeleteSell🔗

LVMButtonIAs.btnMore_DeleteSell: string

LVMButtonIAs.btnMore_BuyVehicle🔗

LVMButtonIAs.btnMore_BuyVehicle: string

LVMButtonIAs.modifier3D_PreferWaypoint🔗

LVMButtonIAs.modifier3D_PreferWaypoint: string

LVMCountData🔗

global record LVMCountData countLinesWithProblems: integer countLinesSelected: integer countLinesUnselected: integer selectionRatioLines: number countDepotsSelected: integer countDepotsUnselected: integer selectionRatioDepots: number countVehiclesWithProblems: integer countVehiclesSelected: integer countVehiclesUnselected: integer selectionRatioVehicles: number end

LVMCountData.countLinesWithProblems🔗

LVMCountData.countLinesWithProblems: integer

LVMCountData.countLinesSelected🔗

LVMCountData.countLinesSelected: integer

LVMCountData.countLinesUnselected🔗

LVMCountData.countLinesUnselected: integer

LVMCountData.selectionRatioLines🔗

LVMCountData.selectionRatioLines: number

LVMCountData.countDepotsSelected🔗

LVMCountData.countDepotsSelected: integer

LVMCountData.countDepotsUnselected🔗

LVMCountData.countDepotsUnselected: integer

LVMCountData.selectionRatioDepots🔗

LVMCountData.selectionRatioDepots: number

LVMCountData.countVehiclesWithProblems🔗

LVMCountData.countVehiclesWithProblems: integer

LVMCountData.countVehiclesSelected🔗

LVMCountData.countVehiclesSelected: integer

LVMCountData.countVehiclesUnselected🔗

LVMCountData.countVehiclesUnselected: integer

LVMCountData.selectionRatioVehicles🔗

LVMCountData.selectionRatioVehicles: number

LVMDeleteSell🔗

global record LVMDeleteSell focusedLine: Engine.Entity focusedVehicle: Engine.Entity focusedStopLine: Engine.Entity focusedStopNumber: integer focusedApiStopIndex0: integer end

LVMDeleteSell.focusedLine🔗

LVMDeleteSell.focusedLine: Engine.Entity

LVMDeleteSell.focusedVehicle🔗

LVMDeleteSell.focusedVehicle: Engine.Entity

LVMDeleteSell.focusedStopLine🔗

LVMDeleteSell.focusedStopLine: Engine.Entity

LVMDeleteSell.focusedStopNumber🔗

LVMDeleteSell.focusedStopNumber: integer

LVMDeleteSell.focusedApiStopIndex0🔗

LVMDeleteSell.focusedApiStopIndex0: integer

LVMDisplayData🔗

global record LVMDisplayData notificationProblemColor: Vec4f contrastColor: Vec4f textColor: Vec4f waypointColor: Vec4f selectedLineColor: Vec4f end

LVMDisplayData.notificationProblemColor🔗

LVMDisplayData.notificationProblemColor: Vec4f

LVMDisplayData.contrastColor🔗

LVMDisplayData.contrastColor: Vec4f

LVMDisplayData.textColor🔗

LVMDisplayData.textColor: Vec4f

LVMDisplayData.waypointColor🔗

LVMDisplayData.waypointColor: Vec4f

LVMDisplayData.selectedLineColor🔗

LVMDisplayData.selectedLineColor: Vec4f

LVMDnDData🔗

global record LVMDnDData dragStartLineEntity: Engine.Entity dragStartLineRevision: Engine.Revision end

LVMDnDData.dragStartLineEntity🔗

LVMDnDData.dragStartLineEntity: Engine.Entity

LVMDnDData.dragStartLineRevision🔗

LVMDnDData.dragStartLineRevision: Engine.Revision

LVMIconPaths🔗

global record LVMIconPaths rowRename: string rowConfigure: string rowMove: string rowDelete: string rowSelectTerminals: string rowLocate: string rowRemove: string rowCart: string problemAlert: string problemArrow: string regSelectTerminals: string regRename: string regAutoRename: string regFilterVisible: string regGradient: string regDragGrip: string abNewLine: string abSendToLine: string abBuyVehicles: string abFilterVisible: string abFilterRoad: string abFilterTram: string abFilterRail: string abFilterWater: string abFilterAir: string abReverse: string abStartStop: string abPaint: string abDuplicate: string abReplace: string abConfigure: string abSendToDepot: string abSell: string abAutoRename: string hudTerminal: string hudConfigureNone: string hudConfigure: string hudMove: string hudAdd: string hudRemove: string end

LVMIconPaths.rowRename🔗

LVMIconPaths.rowRename: string

LVMIconPaths.rowConfigure🔗

LVMIconPaths.rowConfigure: string

LVMIconPaths.rowMove🔗

LVMIconPaths.rowMove: string

LVMIconPaths.rowDelete🔗

LVMIconPaths.rowDelete: string

LVMIconPaths.rowSelectTerminals🔗

LVMIconPaths.rowSelectTerminals: string

LVMIconPaths.rowLocate🔗

LVMIconPaths.rowLocate: string

LVMIconPaths.rowRemove🔗

LVMIconPaths.rowRemove: string

LVMIconPaths.rowCart🔗

LVMIconPaths.rowCart: string

LVMIconPaths.problemAlert🔗

LVMIconPaths.problemAlert: string

LVMIconPaths.problemArrow🔗

LVMIconPaths.problemArrow: string

LVMIconPaths.regSelectTerminals🔗

LVMIconPaths.regSelectTerminals: string

LVMIconPaths.regRename🔗

LVMIconPaths.regRename: string

LVMIconPaths.regAutoRename🔗

LVMIconPaths.regAutoRename: string

LVMIconPaths.regFilterVisible🔗

LVMIconPaths.regFilterVisible: string

LVMIconPaths.regGradient🔗

LVMIconPaths.regGradient: string

LVMIconPaths.regDragGrip🔗

LVMIconPaths.regDragGrip: string

LVMIconPaths.abNewLine🔗

LVMIconPaths.abNewLine: string

LVMIconPaths.abSendToLine🔗

LVMIconPaths.abSendToLine: string

LVMIconPaths.abBuyVehicles🔗

LVMIconPaths.abBuyVehicles: string

LVMIconPaths.abFilterVisible🔗

LVMIconPaths.abFilterVisible: string

LVMIconPaths.abFilterRoad🔗

LVMIconPaths.abFilterRoad: string

LVMIconPaths.abFilterTram🔗

LVMIconPaths.abFilterTram: string

LVMIconPaths.abFilterRail🔗

LVMIconPaths.abFilterRail: string

LVMIconPaths.abFilterWater🔗

LVMIconPaths.abFilterWater: string

LVMIconPaths.abFilterAir🔗

LVMIconPaths.abFilterAir: string

LVMIconPaths.abReverse🔗

LVMIconPaths.abReverse: string

LVMIconPaths.abStartStop🔗

LVMIconPaths.abStartStop: string

LVMIconPaths.abPaint🔗

LVMIconPaths.abPaint: string

LVMIconPaths.abDuplicate🔗

LVMIconPaths.abDuplicate: string

LVMIconPaths.abReplace🔗

LVMIconPaths.abReplace: string

LVMIconPaths.abConfigure🔗

LVMIconPaths.abConfigure: string

LVMIconPaths.abSendToDepot🔗

LVMIconPaths.abSendToDepot: string

LVMIconPaths.abSell🔗

LVMIconPaths.abSell: string

LVMIconPaths.abAutoRename🔗

LVMIconPaths.abAutoRename: string

LVMIconPaths.hudTerminal🔗

LVMIconPaths.hudTerminal: string

LVMIconPaths.hudConfigureNone🔗

LVMIconPaths.hudConfigureNone: string

LVMIconPaths.hudConfigure🔗

LVMIconPaths.hudConfigure: string

LVMIconPaths.hudMove🔗

LVMIconPaths.hudMove: string

LVMIconPaths.hudAdd🔗

LVMIconPaths.hudAdd: string

LVMIconPaths.hudRemove🔗

LVMIconPaths.hudRemove: string

LVMMode🔗

global enum LVMMode "MAIN" "MOVE_STOP" "MOVE_WAYPOINT" "SEGMENT" "SEND_TO_LINE" end

LVMMode."MAIN"🔗

LVMMode."MOVE_STOP"🔗

LVMMode."MOVE_WAYPOINT"🔗

LVMMode."SEGMENT"🔗

LVMMode."SEND_TO_LINE"🔗

LVMSection🔗

global enum LVMSection "LM" "LP" "VM" end

LVMSection."LM"🔗

LVMSection."LP"🔗

LVMSection."VM"🔗

LineManagerPanelParams🔗

global record LineManagerPanelParams commonParams: CommonActionParams end

LineManagerPanelParams.commonParams🔗

LineManagerPanelParams.commonParams: CommonActionParams

LineUtil🔗

global record LineUtil
record LineSelectionDetails entity: Engine.Entity stopNumber: integer apiStopIndex0: integer apiWaypointIndex: integer end
record StationSelectionDetails stationGroup: Engine.Entity stationIndex1: integer station: Engine.Entity terminalIndex1: integer flatStationTerminalIndex1: integer end
record SignalSelectionDetails signal: Engine.Entity signalIndex1: integer end
record StopSelectionDetails station: StationSelectionDetails line: Engine.Entity stopNumber: integer apiStopIndex0: integer end
record WaypointSelectionDetails line: Engine.Entity stopNumber: integer apiStopIndex0: integer tag: integer end
record TransportNetworkEdgeSelectionDetails snap: EdgePos end
record VehicleDepotDetails entity: Engine.Entity removeFromList: boolean end
record SelectionDetails entity: Engine.Entity line: LineSelectionDetails station: StationSelectionDetails signal: SignalSelectionDetails stop: StopSelectionDetails waypoint: WaypointSelectionDetails transportNetworkEdge: TransportNetworkEdgeSelectionDetails world: Gui.SelectionDetails.World vehicleDepot: VehicleDepotDetails townData: Gui.SelectionDetails.Town end
record TerminalAlternative alternativePossible: boolean alternativeSelected: boolean color: Vec4f end
record LineHasVehicles hasNoVehicles: boolean hasRoadVehicles: boolean hasRailVehicles: boolean hasTramVehicles: boolean hasAirVehicles: boolean hasWaterVehicles: boolean hasPlanes: boolean hasSmallPlanes: boolean hasHelicopters: boolean hasShips: boolean hasSmallShips: boolean hasLightrailRail: boolean hasLightrailTram: boolean end
record RecipeAndParamErased recipe: Recipe<<any type>> param: any end
record GuiContextState inputActions: {string} iaForwards: {string : React.IaForward} iaHandlers: {string : {React.IaHandler, <any type>, <any type>}} handleClick: function() tooltip: RecipeAndParamErased mouseCursor: integer terrainCirclePolicy: Builtin.TerrainCirclePolicy highlightLine: LineUtil.LineSelectionDetails highlightStop: Gui.SelectionDetails.Stop highlightTerminal: {Engine.Entity, StationTerminal} highlightWaypoint: {Engine.Entity, integer, integer} snapPreview: Gui.SelectionDetails.TransportNetworkEdge player: boolean disableCreateNewLine: boolean showNavigableLayer: boolean showTerminalsForLine: Engine.Entity componentsFilter: {Engine.ComponentType} unselectableComponents: {Engine.ComponentType} hudMaster: Recipe2<Builtin.HudIconParam, CommonActionParams> carriers: {Carrier} end
record ContextBuilder iaHandler: function(string, function(), any, function() : boolean, any, string) iaHandlerExtended: function(string, function(Gui.InputAction.InvokeData), any, function() : boolean, any, string) iaForward: function(string, ReactRefWrap, string) iaClick: function(function()) iaClickOrSelect: function(function(), any, function() : boolean, any) tooltip: function<T>(Recipe<T>, T) setShowNavigableLayer: function(boolean) highlightLine: function(Engine.Entity, integer) highlightTerminal: function(LineUtil.StationSelectionDetails) highlightStop: function(LineUtil.StopSelectionDetails) highlightSignal: function(LineUtil.SignalSelectionDetails) highlightWaypoint: function(LineUtil.WaypointSelectionDetails) showSnapPreview: function(LineUtil.TransportNetworkEdgeSelectionDetails) setPlayer: function(boolean) showTerminalsForLine: function(Engine.Entity) setComponentsFilter: function({Engine.ComponentType}) setUnselectableComponents: function({Engine.ComponentType}) setHudMaster: function<T is CommonActionParams>(Recipe2<Builtin.HudIconParam, T>) setMouseCursor: function(integer) setTerrainCirclePolicy: function(Builtin.TerrainCirclePolicy) result: GuiContextState end
autoAssignTerminals: function(Engine.Entity, {Line.ReactVia}): {Engine.Component.Line.Stop} makeLineColor: function(Engine.Entity): Vec3f makeLineName: function(Engine.Entity): string getReactLineFromGameState: function(Engine.Entity): Line.ReactLine computeStopAndWaypointIndex0: function(Engine.Entity, integer): {integer, integer} computeWaypointIndex0FromTag: function(Engine.Entity, integer, integer): integer computeStopNumber: function(Engine.Entity, integer, integer): integer convertDetails: function(Engine.Entity, Gui.SelectionDetails): SelectionDetails makeNewStop: function(StationSelectionDetails): Line.ReactVia applyInputActionConfig: function(GuiContextState) guiContextEquals: function(GuiContextState, GuiContextState): boolean useContextState: function(function() : LineUtil.ContextBuilder, function(LineUtil.GuiContextState)): LineUtil.GuiContextState, function(LineUtil.GuiContextState) MakeContextBuilder: function(): ContextBuilder makeLineActionDescriptor: function<CommonActionParams, Mode>(CommonActionParams, GameContext, ReactNodeRef, function({Mode, <any type> | LineUtil.StopSelectionDetails | nil}), {Builtin.Type.LineVisualization}, Engine.Entity, {Engine.Entity}, GuiContextState, function(LineUtil.SelectionDetails) : LineUtil.GuiContextState, function(Gui.Mouse.Event) : boolean, boolean, boolean, boolean, LVM2D3DMode, boolean, boolean): TreeNodeId getStationHudPath: function(Carrier, boolean, boolean): string getLineCarriers: function(Line.ReactLine): {Carrier : boolean} isWaypointTooClose: function(Line.ReactLine, Vec3f, integer): boolean calculateFrequencySeconds: function(Engine.Entity): integer getVehicleInstructionName: function(Engine.Entity): string autoLoadConfig: function(Line.ReactLine) isTerminalCargoTypeAllowed: function(Line.ReactTerminal, CargoTypeId): boolean getTerminalAlternative: function(LineUtil.StationSelectionDetails, Line.ReactLine, integer): LineUtil.TerminalAlternative isLineCompatibleWithTransportMode: function(Engine.Entity, TransportMode): boolean getLineHasVehicles: function(Engine.Entity): LineUtil.LineHasVehicles getLineAndVehicleCompatibleTransportModesAndCarrier: function({Engine.Entity}): VehicleStoreUtil.TransportModesAndCarrier isStopProtected: function(Engine.Entity, Engine.Entity, {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}): boolean getBestDepotForLine: function(Engine.Entity): Engine.Entity getTerminal: function(Line.ReactTerminal): Terminal getTerminalLength: function(Engine.Entity, integer): number
record DepotAndLineParams depot: Engine.Entity line: Engine.Entity end
enum RelaxationType "Catenary" "Road" "Train" "TramLanes" "TramTrack" end
getRelaxationType: function({TransportMode : boolean}, {TransportMode : boolean}, {TransportMode : boolean}): LineUtil.RelaxationType getRelaxationText: function(RelaxationType): string end

LineUtil.LineSelectionDetails🔗

record LineUtil.LineSelectionDetails entity: Engine.Entity stopNumber: integer apiStopIndex0: integer apiWaypointIndex: integer end

LineUtil.LineSelectionDetails.entity🔗

LineUtil.LineSelectionDetails.entity: Engine.Entity

LineUtil.LineSelectionDetails.stopNumber🔗

LineUtil.LineSelectionDetails.stopNumber: integer

LineUtil.LineSelectionDetails.apiStopIndex0🔗

LineUtil.LineSelectionDetails.apiStopIndex0: integer

LineUtil.LineSelectionDetails.apiWaypointIndex🔗

LineUtil.LineSelectionDetails.apiWaypointIndex: integer

LineUtil.StationSelectionDetails🔗

record LineUtil.StationSelectionDetails stationGroup: Engine.Entity stationIndex1: integer station: Engine.Entity terminalIndex1: integer flatStationTerminalIndex1: integer end

LineUtil.StationSelectionDetails.stationGroup🔗

LineUtil.StationSelectionDetails.stationGroup: Engine.Entity

LineUtil.StationSelectionDetails.stationIndex1🔗

LineUtil.StationSelectionDetails.stationIndex1: integer

LineUtil.StationSelectionDetails.station🔗

LineUtil.StationSelectionDetails.station: Engine.Entity

LineUtil.StationSelectionDetails.terminalIndex1🔗

LineUtil.StationSelectionDetails.terminalIndex1: integer

LineUtil.StationSelectionDetails.flatStationTerminalIndex1🔗

LineUtil.StationSelectionDetails.flatStationTerminalIndex1: integer

LineUtil.SignalSelectionDetails🔗

record LineUtil.SignalSelectionDetails signal: Engine.Entity signalIndex1: integer end

LineUtil.SignalSelectionDetails.signal🔗

LineUtil.SignalSelectionDetails.signal: Engine.Entity

LineUtil.SignalSelectionDetails.signalIndex1🔗

LineUtil.SignalSelectionDetails.signalIndex1: integer

LineUtil.StopSelectionDetails🔗

record LineUtil.StopSelectionDetails station: StationSelectionDetails line: Engine.Entity stopNumber: integer apiStopIndex0: integer end

LineUtil.StopSelectionDetails.station🔗

LineUtil.StopSelectionDetails.station: StationSelectionDetails

LineUtil.StopSelectionDetails.line🔗

LineUtil.StopSelectionDetails.line: Engine.Entity

LineUtil.StopSelectionDetails.stopNumber🔗

LineUtil.StopSelectionDetails.stopNumber: integer

LineUtil.StopSelectionDetails.apiStopIndex0🔗

LineUtil.StopSelectionDetails.apiStopIndex0: integer

LineUtil.WaypointSelectionDetails🔗

record LineUtil.WaypointSelectionDetails line: Engine.Entity stopNumber: integer apiStopIndex0: integer tag: integer end

LineUtil.WaypointSelectionDetails.line🔗

LineUtil.WaypointSelectionDetails.line: Engine.Entity

LineUtil.WaypointSelectionDetails.stopNumber🔗

LineUtil.WaypointSelectionDetails.stopNumber: integer

LineUtil.WaypointSelectionDetails.apiStopIndex0🔗

LineUtil.WaypointSelectionDetails.apiStopIndex0: integer

LineUtil.WaypointSelectionDetails.tag🔗

LineUtil.WaypointSelectionDetails.tag: integer

LineUtil.TransportNetworkEdgeSelectionDetails🔗

record LineUtil.TransportNetworkEdgeSelectionDetails snap: EdgePos end

LineUtil.TransportNetworkEdgeSelectionDetails.snap🔗

LineUtil.TransportNetworkEdgeSelectionDetails.snap: EdgePos

LineUtil.VehicleDepotDetails🔗

record LineUtil.VehicleDepotDetails entity: Engine.Entity removeFromList: boolean end

LineUtil.VehicleDepotDetails.entity🔗

LineUtil.VehicleDepotDetails.entity: Engine.Entity

LineUtil.VehicleDepotDetails.removeFromList🔗

LineUtil.VehicleDepotDetails.removeFromList: boolean

LineUtil.SelectionDetails🔗

record LineUtil.SelectionDetails entity: Engine.Entity line: LineSelectionDetails station: StationSelectionDetails signal: SignalSelectionDetails stop: StopSelectionDetails waypoint: WaypointSelectionDetails transportNetworkEdge: TransportNetworkEdgeSelectionDetails world: Gui.SelectionDetails.World vehicleDepot: VehicleDepotDetails townData: Gui.SelectionDetails.Town end

LineUtil.SelectionDetails.entity🔗

LineUtil.SelectionDetails.entity: Engine.Entity

LineUtil.SelectionDetails.line🔗

LineUtil.SelectionDetails.line: LineSelectionDetails

LineUtil.SelectionDetails.station🔗

LineUtil.SelectionDetails.station: StationSelectionDetails

LineUtil.SelectionDetails.signal🔗

LineUtil.SelectionDetails.signal: SignalSelectionDetails

LineUtil.SelectionDetails.stop🔗

LineUtil.SelectionDetails.stop: StopSelectionDetails

LineUtil.SelectionDetails.waypoint🔗

LineUtil.SelectionDetails.waypoint: WaypointSelectionDetails

LineUtil.SelectionDetails.transportNetworkEdge🔗

LineUtil.SelectionDetails.transportNetworkEdge: TransportNetworkEdgeSelectionDetails

LineUtil.SelectionDetails.world🔗

LineUtil.SelectionDetails.world: Gui.SelectionDetails.World

LineUtil.SelectionDetails.vehicleDepot🔗

LineUtil.SelectionDetails.vehicleDepot: VehicleDepotDetails

LineUtil.SelectionDetails.townData🔗

LineUtil.SelectionDetails.townData: Gui.SelectionDetails.Town

LineUtil.TerminalAlternative🔗

record LineUtil.TerminalAlternative alternativePossible: boolean alternativeSelected: boolean color: Vec4f end

LineUtil.TerminalAlternative.alternativePossible🔗

LineUtil.TerminalAlternative.alternativePossible: boolean

LineUtil.TerminalAlternative.alternativeSelected🔗

LineUtil.TerminalAlternative.alternativeSelected: boolean

LineUtil.TerminalAlternative.color🔗

LineUtil.TerminalAlternative.color: Vec4f

LineUtil.LineHasVehicles🔗

record LineUtil.LineHasVehicles hasNoVehicles: boolean hasRoadVehicles: boolean hasRailVehicles: boolean hasTramVehicles: boolean hasAirVehicles: boolean hasWaterVehicles: boolean hasPlanes: boolean hasSmallPlanes: boolean hasHelicopters: boolean hasShips: boolean hasSmallShips: boolean hasLightrailRail: boolean hasLightrailTram: boolean end

LineUtil.LineHasVehicles.hasNoVehicles🔗

LineUtil.LineHasVehicles.hasNoVehicles: boolean

LineUtil.LineHasVehicles.hasRoadVehicles🔗

LineUtil.LineHasVehicles.hasRoadVehicles: boolean

LineUtil.LineHasVehicles.hasRailVehicles🔗

LineUtil.LineHasVehicles.hasRailVehicles: boolean

LineUtil.LineHasVehicles.hasTramVehicles🔗

LineUtil.LineHasVehicles.hasTramVehicles: boolean

LineUtil.LineHasVehicles.hasAirVehicles🔗

LineUtil.LineHasVehicles.hasAirVehicles: boolean

LineUtil.LineHasVehicles.hasWaterVehicles🔗

LineUtil.LineHasVehicles.hasWaterVehicles: boolean

LineUtil.LineHasVehicles.hasPlanes🔗

LineUtil.LineHasVehicles.hasPlanes: boolean

LineUtil.LineHasVehicles.hasSmallPlanes🔗

LineUtil.LineHasVehicles.hasSmallPlanes: boolean

LineUtil.LineHasVehicles.hasHelicopters🔗

LineUtil.LineHasVehicles.hasHelicopters: boolean

LineUtil.LineHasVehicles.hasShips🔗

LineUtil.LineHasVehicles.hasShips: boolean

LineUtil.LineHasVehicles.hasSmallShips🔗

LineUtil.LineHasVehicles.hasSmallShips: boolean

LineUtil.LineHasVehicles.hasLightrailRail🔗

LineUtil.LineHasVehicles.hasLightrailRail: boolean

LineUtil.LineHasVehicles.hasLightrailTram🔗

LineUtil.LineHasVehicles.hasLightrailTram: boolean

LineUtil.RecipeAndParamErased🔗

record LineUtil.RecipeAndParamErased recipe: Recipe<<any type>> param: any end

LineUtil.RecipeAndParamErased.recipe🔗

LineUtil.RecipeAndParamErased.recipe: Recipe<<any type>>

LineUtil.RecipeAndParamErased.param🔗

LineUtil.RecipeAndParamErased.param: any

LineUtil.GuiContextState🔗

record LineUtil.GuiContextState inputActions: {string} iaForwards: {string : React.IaForward} iaHandlers: {string : {React.IaHandler, <any type>, <any type>}} handleClick: function() tooltip: RecipeAndParamErased mouseCursor: integer terrainCirclePolicy: Builtin.TerrainCirclePolicy highlightLine: LineUtil.LineSelectionDetails highlightStop: Gui.SelectionDetails.Stop highlightTerminal: {Engine.Entity, StationTerminal} highlightWaypoint: {Engine.Entity, integer, integer} snapPreview: Gui.SelectionDetails.TransportNetworkEdge player: boolean disableCreateNewLine: boolean showNavigableLayer: boolean showTerminalsForLine: Engine.Entity componentsFilter: {Engine.ComponentType} unselectableComponents: {Engine.ComponentType} hudMaster: Recipe2<Builtin.HudIconParam, CommonActionParams> carriers: {Carrier} end

LineUtil.GuiContextState.inputActions🔗

LineUtil.GuiContextState.inputActions: {string}

LineUtil.GuiContextState.iaForwards🔗

LineUtil.GuiContextState.iaForwards: {string : React.IaForward}

LineUtil.GuiContextState.iaHandlers🔗

LineUtil.GuiContextState.iaHandlers: {string : {React.IaHandler, <any type>, <any type>}}

LineUtil.GuiContextState.handleClick🔗

function LineUtil.GuiContextState.handleClick()

LineUtil.GuiContextState.tooltip🔗

LineUtil.GuiContextState.tooltip: RecipeAndParamErased

LineUtil.GuiContextState.mouseCursor🔗

LineUtil.GuiContextState.mouseCursor: integer

LineUtil.GuiContextState.terrainCirclePolicy🔗

LineUtil.GuiContextState.terrainCirclePolicy: Builtin.TerrainCirclePolicy

LineUtil.GuiContextState.highlightLine🔗

LineUtil.GuiContextState.highlightLine: LineUtil.LineSelectionDetails

LineUtil.GuiContextState.highlightStop🔗

LineUtil.GuiContextState.highlightStop: Gui.SelectionDetails.Stop

LineUtil.GuiContextState.highlightTerminal🔗

LineUtil.GuiContextState.highlightTerminal: {Engine.Entity, StationTerminal}

LineUtil.GuiContextState.highlightWaypoint🔗

LineUtil.GuiContextState.highlightWaypoint: {Engine.Entity, integer, integer}

LineUtil.GuiContextState.snapPreview🔗

LineUtil.GuiContextState.snapPreview: Gui.SelectionDetails.TransportNetworkEdge

LineUtil.GuiContextState.player🔗

LineUtil.GuiContextState.player: boolean

LineUtil.GuiContextState.disableCreateNewLine🔗

LineUtil.GuiContextState.disableCreateNewLine: boolean

LineUtil.GuiContextState.showNavigableLayer🔗

LineUtil.GuiContextState.showNavigableLayer: boolean

LineUtil.GuiContextState.showTerminalsForLine🔗

LineUtil.GuiContextState.showTerminalsForLine: Engine.Entity

LineUtil.GuiContextState.componentsFilter🔗

LineUtil.GuiContextState.componentsFilter: {Engine.ComponentType}

LineUtil.GuiContextState.unselectableComponents🔗

LineUtil.GuiContextState.unselectableComponents: {Engine.ComponentType}

LineUtil.GuiContextState.hudMaster🔗

LineUtil.GuiContextState.hudMaster: Recipe2<Builtin.HudIconParam, CommonActionParams>

LineUtil.GuiContextState.carriers🔗

LineUtil.GuiContextState.carriers: {Carrier}

LineUtil.ContextBuilder🔗

record LineUtil.ContextBuilder iaHandler: function(string, function(), any, function() : boolean, any, string) iaHandlerExtended: function(string, function(Gui.InputAction.InvokeData), any, function() : boolean, any, string) iaForward: function(string, ReactRefWrap, string) iaClick: function(function()) iaClickOrSelect: function(function(), any, function() : boolean, any) tooltip: function<T>(Recipe<T>, T) setShowNavigableLayer: function(boolean) highlightLine: function(Engine.Entity, integer) highlightTerminal: function(LineUtil.StationSelectionDetails) highlightStop: function(LineUtil.StopSelectionDetails) highlightSignal: function(LineUtil.SignalSelectionDetails) highlightWaypoint: function(LineUtil.WaypointSelectionDetails) showSnapPreview: function(LineUtil.TransportNetworkEdgeSelectionDetails) setPlayer: function(boolean) showTerminalsForLine: function(Engine.Entity) setComponentsFilter: function({Engine.ComponentType}) setUnselectableComponents: function({Engine.ComponentType}) setHudMaster: function<T is CommonActionParams>(Recipe2<Builtin.HudIconParam, T>) setMouseCursor: function(integer) setTerrainCirclePolicy: function(Builtin.TerrainCirclePolicy) result: GuiContextState end

LineUtil.ContextBuilder.iaHandler🔗

function LineUtil.ContextBuilder.iaHandler(string, function(), any, function() : boolean, any, string)
Parameters
  • string
  • function()
  • any
  • function(): boolean
  • any
  • string

LineUtil.ContextBuilder.iaHandlerExtended🔗

function LineUtil.ContextBuilder.iaHandlerExtended(string, function(Gui.InputAction.InvokeData), any, function() : boolean, any, string)
Parameters
  • string
  • function(Gui.InputAction.InvokeData)
  • any
  • function(): boolean
  • any
  • string

LineUtil.ContextBuilder.iaForward🔗

function LineUtil.ContextBuilder.iaForward(string, ReactRefWrap, string)
Parameters
  • string
  • ReactRefWrap
  • string

LineUtil.ContextBuilder.iaClick🔗

function LineUtil.ContextBuilder.iaClick(function())
Parameters
  • function()

LineUtil.ContextBuilder.iaClickOrSelect🔗

function LineUtil.ContextBuilder.iaClickOrSelect(function(), any, function() : boolean, any)
Parameters
  • function()
  • any
  • function(): boolean
  • any

LineUtil.ContextBuilder.tooltip🔗

function LineUtil.ContextBuilder.tooltip<T>(Recipe<T>, T)
Type Parameters
  • T
Parameters
  • Recipe<T>
  • T

LineUtil.ContextBuilder.setShowNavigableLayer🔗

function LineUtil.ContextBuilder.setShowNavigableLayer(boolean)
Parameters
  • boolean

LineUtil.ContextBuilder.highlightLine🔗

function LineUtil.ContextBuilder.highlightLine(Engine.Entity, integer)
Parameters
  • Engine.Entity
  • integer

LineUtil.ContextBuilder.highlightTerminal🔗

function LineUtil.ContextBuilder.highlightTerminal(LineUtil.StationSelectionDetails)
Parameters
  • LineUtil.StationSelectionDetails

LineUtil.ContextBuilder.highlightStop🔗

function LineUtil.ContextBuilder.highlightStop(LineUtil.StopSelectionDetails)
Parameters
  • LineUtil.StopSelectionDetails

LineUtil.ContextBuilder.highlightSignal🔗

function LineUtil.ContextBuilder.highlightSignal(LineUtil.SignalSelectionDetails)
Parameters
  • LineUtil.SignalSelectionDetails

LineUtil.ContextBuilder.highlightWaypoint🔗

function LineUtil.ContextBuilder.highlightWaypoint(LineUtil.WaypointSelectionDetails)
Parameters
  • LineUtil.WaypointSelectionDetails

LineUtil.ContextBuilder.showSnapPreview🔗

function LineUtil.ContextBuilder.showSnapPreview(LineUtil.TransportNetworkEdgeSelectionDetails)
Parameters
  • LineUtil.TransportNetworkEdgeSelectionDetails

LineUtil.ContextBuilder.setPlayer🔗

function LineUtil.ContextBuilder.setPlayer(boolean)
Parameters
  • boolean

LineUtil.ContextBuilder.showTerminalsForLine🔗

function LineUtil.ContextBuilder.showTerminalsForLine(Engine.Entity)
Parameters
  • Engine.Entity

LineUtil.ContextBuilder.setComponentsFilter🔗

function LineUtil.ContextBuilder.setComponentsFilter({Engine.ComponentType})
Parameters
  • {Engine.ComponentType}

LineUtil.ContextBuilder.setUnselectableComponents🔗

function LineUtil.ContextBuilder.setUnselectableComponents({Engine.ComponentType})
Parameters
  • {Engine.ComponentType}

LineUtil.ContextBuilder.setHudMaster🔗

function LineUtil.ContextBuilder.setHudMaster<T is CommonActionParams>(Recipe2<Builtin.HudIconParam, T>)
Type Parameters
  • T ( is CommonActionParams)
Parameters
  • Recipe2<Builtin.HudIconParam, T>

LineUtil.ContextBuilder.setMouseCursor🔗

function LineUtil.ContextBuilder.setMouseCursor(integer)
Parameters
  • integer

LineUtil.ContextBuilder.setTerrainCirclePolicy🔗

function LineUtil.ContextBuilder.setTerrainCirclePolicy(Builtin.TerrainCirclePolicy)
Parameters
  • Builtin.TerrainCirclePolicy

LineUtil.ContextBuilder.result🔗

LineUtil.ContextBuilder.result: GuiContextState

LineUtil.autoAssignTerminals🔗

function LineUtil.autoAssignTerminals(Engine.Entity, {Line.ReactVia}): {Engine.Component.Line.Stop}
Parameters
  • Engine.Entity
  • {Line.ReactVia}
Returns
  1. {Engine.Component.Line.Stop}

LineUtil.makeLineColor🔗

function LineUtil.makeLineColor(Engine.Entity): Vec3f
Parameters
  • Engine.Entity
Returns
  1. Vec3f

LineUtil.makeLineName🔗

function LineUtil.makeLineName(Engine.Entity): string
Parameters
  • Engine.Entity
Returns
  1. string

LineUtil.getReactLineFromGameState🔗

function LineUtil.getReactLineFromGameState(Engine.Entity): Line.ReactLine
Parameters
  • Engine.Entity
Returns
  1. Line.ReactLine

LineUtil.computeStopAndWaypointIndex0🔗

function LineUtil.computeStopAndWaypointIndex0(Engine.Entity, integer): {integer, integer}
Parameters
  • Engine.Entity
  • integer
Returns
  1. {integer, integer}

LineUtil.computeWaypointIndex0FromTag🔗

function LineUtil.computeWaypointIndex0FromTag(Engine.Entity, integer, integer): integer
Parameters
  • Engine.Entity
  • integer
  • integer
Returns
  1. integer

LineUtil.computeStopNumber🔗

function LineUtil.computeStopNumber(Engine.Entity, integer, integer): integer
Parameters
  • Engine.Entity
  • integer
  • integer
Returns
  1. integer

LineUtil.convertDetails🔗

function LineUtil.convertDetails(Engine.Entity, Gui.SelectionDetails): SelectionDetails
Parameters
  • Engine.Entity
  • Gui.SelectionDetails
Returns
  1. SelectionDetails

LineUtil.makeNewStop🔗

function LineUtil.makeNewStop(StationSelectionDetails): Line.ReactVia
Parameters
  • StationSelectionDetails
Returns
  1. Line.ReactVia

LineUtil.applyInputActionConfig🔗

function LineUtil.applyInputActionConfig(GuiContextState)
Parameters
  • GuiContextState

LineUtil.guiContextEquals🔗

function LineUtil.guiContextEquals(GuiContextState, GuiContextState): boolean
Parameters
  • GuiContextState
  • GuiContextState
Returns
  1. boolean

LineUtil.useContextState🔗

function LineUtil.useContextState(function() : LineUtil.ContextBuilder, function(LineUtil.GuiContextState)): LineUtil.GuiContextState, function(LineUtil.GuiContextState)
Parameters
  • function(): LineUtil.ContextBuilder
  • function(LineUtil.GuiContextState)
Returns
  1. LineUtil.GuiContextState
  2. function(LineUtil.GuiContextState)

LineUtil.MakeContextBuilder🔗

function LineUtil.MakeContextBuilder(): ContextBuilder
Returns
  1. ContextBuilder

LineUtil.makeLineActionDescriptor🔗

function LineUtil.makeLineActionDescriptor<CommonActionParams, Mode>(CommonActionParams, GameContext, ReactNodeRef, function({Mode, <any type> | LineUtil.StopSelectionDetails | nil}), {Builtin.Type.LineVisualization}, Engine.Entity, {Engine.Entity}, GuiContextState, function(LineUtil.SelectionDetails) : LineUtil.GuiContextState, function(Gui.Mouse.Event) : boolean, boolean, boolean, boolean, LVM2D3DMode, boolean, boolean): TreeNodeId
Type Parameters
  • CommonActionParams
  • Mode
Parameters
  • CommonActionParams
  • GameContext
  • ReactNodeRef
  • function({Mode, <any type> | LineUtil.StopSelectionDetails | nil})
  • {Builtin.Type.LineVisualization}
  • Engine.Entity
  • {Engine.Entity}
  • GuiContextState
  • function(LineUtil.SelectionDetails): LineUtil.GuiContextState
  • function(Gui.Mouse.Event): boolean
  • boolean
  • boolean
  • boolean
  • LVM2D3DMode
  • boolean
  • boolean
Returns
  1. TreeNodeId

LineUtil.getStationHudPath🔗

function LineUtil.getStationHudPath(Carrier, boolean, boolean): string
Parameters
  • Carrier
  • boolean
  • boolean
Returns
  1. string

LineUtil.getLineCarriers🔗

function LineUtil.getLineCarriers(Line.ReactLine): {Carrier : boolean}
Parameters
  • Line.ReactLine
Returns
  1. {Carrier : boolean}

LineUtil.isWaypointTooClose🔗

function LineUtil.isWaypointTooClose(Line.ReactLine, Vec3f, integer): boolean
Parameters
  • Line.ReactLine
  • Vec3f
  • integer
Returns
  1. boolean

LineUtil.calculateFrequencySeconds🔗

function LineUtil.calculateFrequencySeconds(Engine.Entity): integer
Parameters
  • Engine.Entity
Returns
  1. integer

LineUtil.getVehicleInstructionName🔗

function LineUtil.getVehicleInstructionName(Engine.Entity): string
Parameters
  • Engine.Entity
Returns
  1. string

LineUtil.autoLoadConfig🔗

function LineUtil.autoLoadConfig(Line.ReactLine)
Parameters
  • Line.ReactLine

LineUtil.isTerminalCargoTypeAllowed🔗

function LineUtil.isTerminalCargoTypeAllowed(Line.ReactTerminal, CargoTypeId): boolean
Parameters
  • Line.ReactTerminal
  • CargoTypeId
Returns
  1. boolean

LineUtil.getTerminalAlternative🔗

function LineUtil.getTerminalAlternative(LineUtil.StationSelectionDetails, Line.ReactLine, integer): LineUtil.TerminalAlternative
Parameters
  • LineUtil.StationSelectionDetails
  • Line.ReactLine
  • integer
Returns
  1. LineUtil.TerminalAlternative

LineUtil.isLineCompatibleWithTransportMode🔗

function LineUtil.isLineCompatibleWithTransportMode(Engine.Entity, TransportMode): boolean
Parameters
  • Engine.Entity
  • TransportMode
Returns
  1. boolean

LineUtil.getLineHasVehicles🔗

function LineUtil.getLineHasVehicles(Engine.Entity): LineUtil.LineHasVehicles
Parameters
  • Engine.Entity
Returns
  1. LineUtil.LineHasVehicles

LineUtil.getLineAndVehicleCompatibleTransportModesAndCarrier🔗

function LineUtil.getLineAndVehicleCompatibleTransportModesAndCarrier({Engine.Entity}): VehicleStoreUtil.TransportModesAndCarrier
Parameters
  • {Engine.Entity}
Returns
  1. VehicleStoreUtil.TransportModesAndCarrier

LineUtil.isStopProtected🔗

function LineUtil.isStopProtected(Engine.Entity, Engine.Entity, {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}): boolean
Parameters
  • Engine.Entity
  • Engine.Entity
  • {Engine.Entity : GameContext.Filters.ProtectionConfig | boolean}
Returns
  1. boolean

LineUtil.getBestDepotForLine🔗

function LineUtil.getBestDepotForLine(Engine.Entity): Engine.Entity
Parameters
  • Engine.Entity
Returns
  1. Engine.Entity

LineUtil.getTerminal🔗

function LineUtil.getTerminal(Line.ReactTerminal): Terminal
Parameters
  • Line.ReactTerminal
Returns
  1. Terminal

LineUtil.getTerminalLength🔗

function LineUtil.getTerminalLength(Engine.Entity, integer): number
Parameters
  • Engine.Entity
  • integer
Returns
  1. number

LineUtil.DepotAndLineParams🔗

record LineUtil.DepotAndLineParams depot: Engine.Entity line: Engine.Entity end

LineUtil.DepotAndLineParams.depot🔗

LineUtil.DepotAndLineParams.depot: Engine.Entity

LineUtil.DepotAndLineParams.line🔗

LineUtil.DepotAndLineParams.line: Engine.Entity

LineUtil.RelaxationType🔗

enum LineUtil.RelaxationType "Catenary" "Road" "Train" "TramLanes" "TramTrack" end

LineUtil.RelaxationType."Catenary"🔗

LineUtil.RelaxationType."Road"🔗

LineUtil.RelaxationType."Train"🔗

LineUtil.RelaxationType."TramLanes"🔗

LineUtil.RelaxationType."TramTrack"🔗

LineUtil.getRelaxationType🔗

function LineUtil.getRelaxationType({TransportMode : boolean}, {TransportMode : boolean}, {TransportMode : boolean}): LineUtil.RelaxationType
Parameters
  • {TransportMode : boolean}
  • {TransportMode : boolean}
  • {TransportMode : boolean}
Returns
  1. LineUtil.RelaxationType

LineUtil.getRelaxationText🔗

function LineUtil.getRelaxationText(RelaxationType): string
Parameters
  • RelaxationType
Returns
  1. string

ProblemCache🔗

global record ProblemCache vehiclesAndProblems: {{{Engine.Entity}, VehicleProblem}} vehiclesWithRoundTrips: {Engine.Entity : integer} line2misconfiguredLines: {Engine.Entity : {LineIssue}} line2detailedLineProblems: {Engine.Entity : {{UtilLine.StopState}}} line2problem: {Engine.Entity : boolean} vehicle2problem: {Engine.Entity : boolean} line2vehicleProblemCount: {Engine.Entity : integer} end

ProblemCache.vehiclesAndProblems🔗

ProblemCache.vehiclesAndProblems: {{{Engine.Entity}, VehicleProblem}}

ProblemCache.vehiclesWithRoundTrips🔗

ProblemCache.vehiclesWithRoundTrips: {Engine.Entity : integer}

ProblemCache.line2misconfiguredLines🔗

ProblemCache.line2misconfiguredLines: {Engine.Entity : {LineIssue}}

ProblemCache.line2detailedLineProblems🔗

ProblemCache.line2detailedLineProblems: {Engine.Entity : {{UtilLine.StopState}}}

ProblemCache.line2problem🔗

ProblemCache.line2problem: {Engine.Entity : boolean}

ProblemCache.vehicle2problem🔗

ProblemCache.vehicle2problem: {Engine.Entity : boolean}

ProblemCache.line2vehicleProblemCount🔗

ProblemCache.line2vehicleProblemCount: {Engine.Entity : integer}

VehicleProblems🔗

global record VehicleProblems vehicles2problem: {Engine.Entity : boolean} problemCount: integer end

VehicleProblems.vehicles2problem🔗

VehicleProblems.vehicles2problem: {Engine.Entity : boolean}

VehicleProblems.problemCount🔗

VehicleProblems.problemCount: integer
Transport Fever 3 Wiki
Gameplay ReferenceComing soon
●
Modding Manual
  • api
  • api.cmd
  • api.engine
  • api.engine.system
  • api.engine.util
  • api.gui
  • api.res
  • api.type
  • api.type.mod
  • api.type.modhub
  • api.type.transformator
  • app
  • main
  • content
    • base
      • difficulty_util
      • model_metadata_util
      • post_run_util
    • climates
      • gen
        • map_gen_util_serialized
    • game_mechanics
      • achievements
        • sound
          • achievement_sfx
      • celebrations
        • celebration_react_util
        • gui
          • sound
            • celebration_sfx
      • company
        • company
        • company_metadata
        • company_progression_util
        • company_react_util
        • company_static_util
        • company_util
        • explorations
          • exploration_plane
        • prospection_metadata
        • sound
          • company_sfx
      • emission
        • emission_config_metadata
        • emission_metadata
        • emissions
      • finance
        • account
        • finances_react_util
        • finances_util
        • loan
        • loan_util
        • sound
          • finance_sfx
      • fun_elements
        • blimp_util
        • custom_entity_util
        • fun_elements
        • rocket_util
        • ufo_util
      • game_time
        • game_time
      • industries
        • industries
      • notifications
        • gui
          • notification_colors
          • sound
            • notification_sfx
        • notification_legacy_util
        • notification_util
        • notifications
        • types
          • notification_react_util
          • notification_types
      • subventions
        • specific_subvention
        • subvention
        • subvention_legacy_util
        • subvention_util
        • subventions_gui
      • towns
        • district_colors
        • sound
          • town_sfx
        • town_cargo
        • town_growth_metadata
        • town_marketing_metadata
        • town_react_util
        • town_util
        • town_util_parallel
        • towns
    • gui
      • construction
        • construction_colors
        • construction_desc_react_util
        • construction_menu
        • construction_react_util
        • sound
          • construction_sfx
        • track_description_metadata
        • track_modifier_metadata
      • context_helper
        • context_helper
      • entity_window
        • animal
          • animal_eow
        • empty_construction
          • empty_construction_eow
        • entity_window_hud
        • entity_window_util
        • eow_extension_util
        • fun_elements
          • fun_elements_eow
        • gameplay_colors
        • industry
          • industry_eow
        • industry_react_util
        • line
          • line_eow
        • maintenance_station
          • maintenance_station_eow
        • perk
          • perk_eow
        • sim_person
          • sim_person_eow
        • station_group
          • station_group_eow
        • town
          • town_eow
        • town_building
          • town_building_eow
        • vehicle
          • vehicle_eow
        • view_manager
        • view_manager_util
        • warehouse
          • warehouse_eow
      • game_bar
        • game_bar
        • game_bar_widgets
      • guidesystem
        • sound
          • guidesystem_sfx
      • hud
        • hud_gui_config
        • hud_react_util
      • layers
        • layer_cargo
        • layer_cargo_flow
        • layer_colors
        • layer_noise
        • layer_pollution
        • layer_public_transport
        • layer_react_util
        • layer_traffic
        • layers_button_ridge
      • line_vehicle_mgmt
        • cargofilter_window
        • feedback_list_util
        • line
        • line_react_util
        • line_util
        • manager_hud_util
        • manager_tooltips_util
        • manager_window
        • sound
          • lvm_sfx
        • vehicle_list_react_util
        • vehicle_react_util
        • vehicle_store
        • vehicle_store_table
        • vehicle_store_util
        • vehicle_store_window
        • vehicle_util
      • main
        • button_react_util
        • callout_react_util
        • cargo_react_util
        • cargo_util
        • collapsible_checkbox_list
        • content_card
        • credits_react_util
        • default_colors
        • disable_features
        • engine_react_util
        • free_cam_options
        • game_context
        • game_react_globals
        • game_tooltips
        • game_windows
        • gui_react_util
        • gui_res_modding
        • hud_icon_toolbox
        • industry_util
        • input_action_colors
        • main_mod_button_area
        • menu_category_util
        • mod_entry_point
        • particle_colors
        • particle_react_util
        • popover_react_util
        • radial_menu_extension
        • script_param_util
        • selection_colors
        • selector
        • selector_react_util
        • styleutil
        • tile_list_react_util
        • tool_react_util
        • town_hud_react_util
      • map_editor
        • map_editor
      • menu
        • dialog_react_util
        • difficulty_react_util
        • graphics_presets_util
        • main_menu
        • map_preview_colors
        • menu_icon_react_util
        • menu_util
        • mod_colors
        • mod_manager_react_util
        • mod_util
        • new_game_react_util
        • paradox_react_util
        • releasenotes_util
        • savegame_react_util
        • sound
          • main_menu_sfx
      • sound
        • gui_comp_sfx
      • statistics
        • statistics
        • statistics_react_util
    • industries
      • industry_productivity_util
      • industry_workers
    • infrastructure
      • traffic_light
        • traffic_light
    • landmarks
      • hq
        • headquarter_util_serialized
      • landmark
      • landmark_util
      • landmark_util_serialized
    • mission
      • arrival_tracker
      • builder_util
      • calendar
      • guide_system
        • guide_system_react
        • guides
          • guide_event
          • guide_generic
          • guide_state
          • guide_timer
          • guide_ui_event
      • mission_boot_util
      • mission_colors
      • mission_framework
        • mission_end_window_util
        • mission_framework_react
        • mission_framework_react_util
        • mission_framework_util
        • mission_framework_util_entity
        • mission_framework_util_line
        • mission_interface
      • mission_pathfinding_util
      • mission_react_util
      • mission_task_util
      • mission_types
      • modifier
      • name_util
      • tasks
        • assign_vehicle
          • mission_task_assign_vehicle
          • mission_task_visit_stations_ordered
        • auto_builder
          • mission_task_electrify
          • mission_task_track_builder
          • prepare_track_building_util
        • build_construction
          • mission_task_build_construction
          • mission_task_build_construction_util
          • mission_task_build_construction_variant
        • build_path
          • mission_task_build_path
        • bulldoze
          • mission_task_auto_bulldoze
          • mission_task_bulldoze
        • buy_vehicle
          • mission_task_buy_vehicle
          • mission_task_clone_vehicle
        • click_and_collect_custom_entity
          • mission_task_collect_entity
          • mission_task_spawn_entity
        • click_entity
          • mission_task_click_entity
        • connect_nodes
          • mission_task_connect_nodes
        • create_line
          • mission_task_create_line
          • mission_task_create_line_for_towns
          • mission_task_stop_config
        • cutscene
          • mission_task_cutscene
        • dialogue
          • mission_task_dialogue
        • finish
          • mission_task_finish
        • guide
          • mission_task_guide
          • mission_task_guide_collect_entity
        • join
          • mission_task_join
        • mission_dialogue_data
        • non_bulldozable
          • mission_task_non_bulldozable
        • observe_entity
          • mission_task_observe_entity
        • page
          • mission_task_page
        • spawn_sims
          • mission_task_spawn_sims
          • sampling_util
        • subsidies
          • mission_task_guide_subsidies
          • mission_task_subsidies
        • task_decorator
        • town_rating
          • mission_task_town_rating
          • mission_task_town_rating_observer
        • town_size
          • mission_task_town_size
        • transfer_ownership
          • mission_task_transfer_ownership
          • transfer_ownership_util
        • transport_cargo
          • mission_task_empty_stocks
          • mission_task_industry_boosted
          • mission_task_transport_cargo
          • mission_task_transport_cargo_faster
          • mission_task_transport_cargo_observer
          • mission_task_transport_passengers
        • utility
          • mission_task_cargo_needs
          • mission_task_check_entities
          • mission_task_check_landmark_level
          • mission_task_clouds
          • mission_task_highlight
          • mission_task_industry_activity
          • mission_task_landmark_requirements
          • mission_task_play_sound
          • mission_task_protected_entities
          • mission_task_relay_update
          • mission_task_send_command
          • mission_task_send_event
          • mission_task_store_any
          • mission_task_substitute_constructions
          • mission_task_time_of_day
          • mission_task_town_development
          • mission_town_util
        • vehicle_util
          • mission_task_replace_vehicles
          • mission_task_sell_vehicles
          • mission_task_start_vehicles
          • mission_task_vehicle_modifier
          • mission_task_vehicle_position
          • mission_vehicle_util
        • wait
          • mission_task_wait
          • mission_task_wait_event
          • mission_task_wait_for
          • mission_task_wait_ui_event
        • waypoints
          • mission_task_waypoints
      • tutorial
        • tasks
          • mission_task_tutorial_init
        • tutorial_story_util
    • scripts
      • app_util
      • audio_util
      • builtin
      • construction
        • asset_util
        • collider_util_serialized
        • construction_config_metadata
        • construction_specialization_metadata
        • construction_util_serialized
        • lane_util_serialized
        • modules_util_serialized
        • param_util
        • street_util_serialized
      • entity_util
      • gamescript
      • journal
      • lang_util
      • log
      • mat4
      • math_util
      • metadata_util
      • polygon_util
      • random_util
      • react
      • soundset
      • string_util
      • table_util
      • tex_util
      • transformator_util
      • util
        • config_util
        • listutil
        • romberg_util
        • town_growth_function
      • vec2
      • vec3
      • vec4
    • stations
      • station_metadata
    • vehicle
      • vehicle_modifier

Generated 19-08-2026

Transport Fever 3 ● Urban Games © 2026