Module content.gui.entity_window.entity_window_util🔗

[Expand All] [Collapse All]
global record EntityWindowUtil
  
record StockCountsWidgetParams
    entityId: Engine.Entity
    width: integer
    iconWidth: integer
    maxIcons: integer
    groupStocks: boolean
    addDiscardCargoButtons: boolean
    addButtonsToSetStockCargoType: boolean
    sortByType: boolean
end
  
enum DiagramType
    "account"
    "logbook"
    "logbookDiff"
end
  
record DiagramParams
    entityId: Engine.Entity
    logNames: {string}
    labels: {string}
    colors: {Vec4f}
    types: {Builtin.SeriesParam.Type}
    styleClass: string
    chartType: DiagramType
    yMin: number
    yMax: number
    yAxisLabelFormatter: function(number): string
    showTimeScaleSlider: boolean
    showLegend: boolean
    initialNumYearsToDisplay: integer
    minNumYearsToDisplay: integer
    maxNumYearsToDisplay: integer
    legendOrientation: Builtin.Type.Orientation
    yStepScale: number
    currentValueFns: {function() : number}
    focusSlider: boolean
end
  
record ActionBarButton
    
enum Sound
      "Buy"
      "Sell"
      "SendToDepot"
end
    isSpacer: boolean
    icon: string
    description: string
    onClick: function()
    tag: string
    customItem: TreeNodeId
    sound: Sound
    toggleButton: boolean
    onValueChange: function(boolean)
    value: boolean
end
  
record ActionButtonBarParams
    primaryButtons: {ActionBarButton}
    secondaryButtons: {ActionBarButton}
    nextUpFocusRef: ReactRefWrap
end
  
record EntityWindowButtonParams
    tooltip: string
    icon: string
    onClick: function()
end
  
record WorkplacesProgressBarWidgetParams
    entityId: Engine.Entity
    progressBarThresholds: {number}
end
  
record SimPersonDestinationButtonParams
    simPersonEntityId: Engine.Entity
    destinationIndex: integer
    addIconIfMissing: boolean
end
  
record InhabitantsTableParam
    landmark: boolean
    headquarters: boolean
    personCapacityEntityId: Engine.Entity
end
  
record WorkersTableParam
    personCapacityEntityId: Engine.Entity
end
  
record DestinationIconParams
    destinationIndex: integer
    iconClass: string
    tooltipOverride: string
end
  
record PassengerWidgetParams
    vehicleEntity: Engine.Entity
end
  
record VehicleTableColumn
    name: string
    recipe: Recipe<Builtin.TableCellParam>
    sortOrder: function(Engine.Entity, Engine.Entity): boolean
    headerStyleClass: string
    weight: number
end
  
record VehicleTableParams
    entityId: Engine.Entity
    getVehicleEntities: function(Engine.Entity): {Engine.Entity}
    columns: {VehicleTableColumn}
end
  VehicleCell: Recipe<Builtin.TableCellParam>
  VehicleTable: Recipe<VehicleTableParams>
  
record VehicleConditionParams
    entityId: Engine.Entity
    addIcon: boolean
end
  VehicleCondition: Recipe<VehicleConditionParams>
  
record MaintenanceStationPoolProgressBarParams
    entityId: Engine.Entity
end
  
record SubconstructionBalanceParams
    entityId: Engine.Entity
    stepTimer: boolean
    maintenanceType: JournalEntry.Maintenance
end
  
record SendCommandButtonParams
    iconPath: string
    tooltip: string | function() : string
    makeCommand: function(): Command
    isActive: function(): boolean
    isPrimary: boolean
    tag: string
end
  
record RecipeAndParamErased
    recipe: Recipe<<any type>>
    param: any
end
  
record EntityLog
    
record Entry
      durationSeconds: integer
      change: integer
      logName: string
      place: Engine.Entity
end
    
record LoggedState
      time: integer
      place: Engine.Entity
      logName: string
      state: integer
end
    entries: {Entry}
end
  
record MaintenanceBarParam
    entity: Engine.Entity
    maintenancePeriodText: string
    initialCalloutText: string
    gameCtx: GameContext
    showOnRightSide: boolean
    nextUpFocusRef: ReactRefWrap
end
  
record CombinedStockGroupedCountsParam
    initialCalloutTextInputPermanent: string
    initialCalloutTextInputCollapsible: string
    recipeAndParamInputCollapsible: RecipeAndParamErased
    initialCalloutTextOutputPermanent: string
    initialCalloutTextOutputCollapsible: string
    recipeAndParamOutputCollapsible: RecipeAndParamErased
    cardKey: string
    setCollapsibleExpanded: function(string, boolean)
    getCollapsibleExpanded: function(string)
    gameCtx: GameContext
    showOnRightSide: boolean
    showSimplifiedOnly: boolean
    entityId: Engine.Entity
end
  
enum IconQualityType
    "Aloof"
    "Happy"
    "Negative"
    "Positive"
    "Sad"
end
  
record RatingBarParam
    icon: TreeNodeId
    iconPath: string
    tooltip: string
    ratingText: string
    getRatingLabel: function(RatingLevel): string
    barTooltip: string
    value: number
    valueChange: number
    numFractions: integer
    snapValueToFractions: boolean
    onClick: function()
    hideText: boolean
    showIcon: boolean
end
  
record NoiseAndPollutionParams
    noise: integer
    pollution: integer
end
  MaintenanceBar: Recipe<MaintenanceBarParam>
  MaintenanceStationPoolProgressBar: Recipe<MaintenanceStationPoolProgressBarParams>
  EntityStockCountsWidget: Recipe<StockCountsWidgetParams>
  CombinedStockGroupedCounts: Recipe<CombinedStockGroupedCountsParam>
  EntityDiagramWidget: Recipe<DiagramParams>
  EntityWindowButton: Recipe<EntityWindowButtonParams>
  ActionButtonBar: Recipe<ActionButtonBarParams>
  PersonCapacityWidget: Recipe<WorkplacesProgressBarWidgetParams>
  GetDestinationIcon: function(DestinationIconParams): TreeNodeId
  SimPersonDestinationButton: Recipe<SimPersonDestinationButtonParams>
  GetMoveModeIcon: function(MoveMode): TreeNodeId
  GetInhabitantsTitle: function(Engine.Entity, boolean): string
  InhabitantsTable: Recipe<InhabitantsTableParam>
  WorkersTable: Recipe<WorkersTableParam>
  EnterCockpitButton: Recipe2<GameContext, Engine.Entity>
  WorkplacesProgressBarWidget: Recipe<WorkplacesProgressBarWidgetParams>
  PassengersWidget: Recipe<PassengerWidgetParams>
  RatingBar: Recipe<RatingBarParam>
  SubconstructionBalance: Recipe<SubconstructionBalanceParams>
  SpeedIndicator: Recipe<Engine.Entity>
  SendCommandButton: Recipe<SendCommandButtonParams>
  NoiseAndPollution: Recipe<NoiseAndPollutionParams>
  makeConfigureOnClickFunction: function(Engine.Entity): function()
  makeProgressBar: function(string, string, string, number, number, number, TreeNodeId): TreeNodeId
  makeRecipeAndParam: function<T>(Recipe<T>, T): RecipeAndParamErased
  makeStockState: function(Engine.Entity): {CargoUtil.StockConfig}
  createStockIcon: function({CargoUtil.StockConfig}, Engine.Entity): TreeNodeId
  getVehicleName: function(Engine.Entity): string
  getEntityLog: function(Engine.Entity, {string}, {string}, integer, {string}, EntityWindowUtil.EntityLog.LoggedState): EntityWindowUtil.EntityLog
  isConstructionModifiable: function(Engine.Entity): boolean
  NotificationWidget: Recipe<Engine.Entity>
  ContentWidgetScrollContainer: Recipe<{TreeNodeId}>
end

Category: globals🔗

EntityWindowUtil🔗

[Expand All] [Collapse All]
global record EntityWindowUtil
  
record StockCountsWidgetParams
    entityId: Engine.Entity
    width: integer
    iconWidth: integer
    maxIcons: integer
    groupStocks: boolean
    addDiscardCargoButtons: boolean
    addButtonsToSetStockCargoType: boolean
    sortByType: boolean
end
  
enum DiagramType
    "account"
    "logbook"
    "logbookDiff"
end
  
record DiagramParams
    entityId: Engine.Entity
    logNames: {string}
    labels: {string}
    colors: {Vec4f}
    types: {Builtin.SeriesParam.Type}
    styleClass: string
    chartType: DiagramType
    yMin: number
    yMax: number
    yAxisLabelFormatter: function(number): string
    showTimeScaleSlider: boolean
    showLegend: boolean
    initialNumYearsToDisplay: integer
    minNumYearsToDisplay: integer
    maxNumYearsToDisplay: integer
    legendOrientation: Builtin.Type.Orientation
    yStepScale: number
    currentValueFns: {function() : number}
    focusSlider: boolean
end
  
record ActionBarButton
    
enum Sound
      "Buy"
      "Sell"
      "SendToDepot"
end
    isSpacer: boolean
    icon: string
    description: string
    onClick: function()
    tag: string
    customItem: TreeNodeId
    sound: Sound
    toggleButton: boolean
    onValueChange: function(boolean)
    value: boolean
end
  
record ActionButtonBarParams
    primaryButtons: {ActionBarButton}
    secondaryButtons: {ActionBarButton}
    nextUpFocusRef: ReactRefWrap
end
  
record EntityWindowButtonParams
    tooltip: string
    icon: string
    onClick: function()
end
  
record WorkplacesProgressBarWidgetParams
    entityId: Engine.Entity
    progressBarThresholds: {number}
end
  
record SimPersonDestinationButtonParams
    simPersonEntityId: Engine.Entity
    destinationIndex: integer
    addIconIfMissing: boolean
end
  
record InhabitantsTableParam
    landmark: boolean
    headquarters: boolean
    personCapacityEntityId: Engine.Entity
end
  
record WorkersTableParam
    personCapacityEntityId: Engine.Entity
end
  
record DestinationIconParams
    destinationIndex: integer
    iconClass: string
    tooltipOverride: string
end
  
record PassengerWidgetParams
    vehicleEntity: Engine.Entity
end
  
record VehicleTableColumn
    name: string
    recipe: Recipe<Builtin.TableCellParam>
    sortOrder: function(Engine.Entity, Engine.Entity): boolean
    headerStyleClass: string
    weight: number
end
  
record VehicleTableParams
    entityId: Engine.Entity
    getVehicleEntities: function(Engine.Entity): {Engine.Entity}
    columns: {VehicleTableColumn}
end
  VehicleCell: Recipe<Builtin.TableCellParam>
  VehicleTable: Recipe<VehicleTableParams>
  
record VehicleConditionParams
    entityId: Engine.Entity
    addIcon: boolean
end
  VehicleCondition: Recipe<VehicleConditionParams>
  
record MaintenanceStationPoolProgressBarParams
    entityId: Engine.Entity
end
  
record SubconstructionBalanceParams
    entityId: Engine.Entity
    stepTimer: boolean
    maintenanceType: JournalEntry.Maintenance
end
  
record SendCommandButtonParams
    iconPath: string
    tooltip: string | function() : string
    makeCommand: function(): Command
    isActive: function(): boolean
    isPrimary: boolean
    tag: string
end
  
record RecipeAndParamErased
    recipe: Recipe<<any type>>
    param: any
end
  
record EntityLog
    
record Entry
      durationSeconds: integer
      change: integer
      logName: string
      place: Engine.Entity
end
    
record LoggedState
      time: integer
      place: Engine.Entity
      logName: string
      state: integer
end
    entries: {Entry}
end
  
record MaintenanceBarParam
    entity: Engine.Entity
    maintenancePeriodText: string
    initialCalloutText: string
    gameCtx: GameContext
    showOnRightSide: boolean
    nextUpFocusRef: ReactRefWrap
end
  
record CombinedStockGroupedCountsParam
    initialCalloutTextInputPermanent: string
    initialCalloutTextInputCollapsible: string
    recipeAndParamInputCollapsible: RecipeAndParamErased
    initialCalloutTextOutputPermanent: string
    initialCalloutTextOutputCollapsible: string
    recipeAndParamOutputCollapsible: RecipeAndParamErased
    cardKey: string
    setCollapsibleExpanded: function(string, boolean)
    getCollapsibleExpanded: function(string)
    gameCtx: GameContext
    showOnRightSide: boolean
    showSimplifiedOnly: boolean
    entityId: Engine.Entity
end
  
enum IconQualityType
    "Aloof"
    "Happy"
    "Negative"
    "Positive"
    "Sad"
end
  
record RatingBarParam
    icon: TreeNodeId
    iconPath: string
    tooltip: string
    ratingText: string
    getRatingLabel: function(RatingLevel): string
    barTooltip: string
    value: number
    valueChange: number
    numFractions: integer
    snapValueToFractions: boolean
    onClick: function()
    hideText: boolean
    showIcon: boolean
end
  
record NoiseAndPollutionParams
    noise: integer
    pollution: integer
end
  MaintenanceBar: Recipe<MaintenanceBarParam>
  MaintenanceStationPoolProgressBar: Recipe<MaintenanceStationPoolProgressBarParams>
  EntityStockCountsWidget: Recipe<StockCountsWidgetParams>
  CombinedStockGroupedCounts: Recipe<CombinedStockGroupedCountsParam>
  EntityDiagramWidget: Recipe<DiagramParams>
  EntityWindowButton: Recipe<EntityWindowButtonParams>
  ActionButtonBar: Recipe<ActionButtonBarParams>
  PersonCapacityWidget: Recipe<WorkplacesProgressBarWidgetParams>
  GetDestinationIcon: function(DestinationIconParams): TreeNodeId
  SimPersonDestinationButton: Recipe<SimPersonDestinationButtonParams>
  GetMoveModeIcon: function(MoveMode): TreeNodeId
  GetInhabitantsTitle: function(Engine.Entity, boolean): string
  InhabitantsTable: Recipe<InhabitantsTableParam>
  WorkersTable: Recipe<WorkersTableParam>
  EnterCockpitButton: Recipe2<GameContext, Engine.Entity>
  WorkplacesProgressBarWidget: Recipe<WorkplacesProgressBarWidgetParams>
  PassengersWidget: Recipe<PassengerWidgetParams>
  RatingBar: Recipe<RatingBarParam>
  SubconstructionBalance: Recipe<SubconstructionBalanceParams>
  SpeedIndicator: Recipe<Engine.Entity>
  SendCommandButton: Recipe<SendCommandButtonParams>
  NoiseAndPollution: Recipe<NoiseAndPollutionParams>
  makeConfigureOnClickFunction: function(Engine.Entity): function()
  makeProgressBar: function(string, string, string, number, number, number, TreeNodeId): TreeNodeId
  makeRecipeAndParam: function<T>(Recipe<T>, T): RecipeAndParamErased
  makeStockState: function(Engine.Entity): {CargoUtil.StockConfig}
  createStockIcon: function({CargoUtil.StockConfig}, Engine.Entity): TreeNodeId
  getVehicleName: function(Engine.Entity): string
  getEntityLog: function(Engine.Entity, {string}, {string}, integer, {string}, EntityWindowUtil.EntityLog.LoggedState): EntityWindowUtil.EntityLog
  isConstructionModifiable: function(Engine.Entity): boolean
  NotificationWidget: Recipe<Engine.Entity>
  ContentWidgetScrollContainer: Recipe<{TreeNodeId}>
end

EntityWindowUtil.StockCountsWidgetParams🔗

record EntityWindowUtil.StockCountsWidgetParams
  entityId: Engine.Entity
  width: integer
  iconWidth: integer
  maxIcons: integer
  groupStocks: boolean
  addDiscardCargoButtons: boolean
  addButtonsToSetStockCargoType: boolean
  sortByType: boolean
end

EntityWindowUtil.StockCountsWidgetParams.entityId🔗

EntityWindowUtil.StockCountsWidgetParams.entityId: Engine.Entity

EntityWindowUtil.StockCountsWidgetParams.width🔗

EntityWindowUtil.StockCountsWidgetParams.width: integer

EntityWindowUtil.StockCountsWidgetParams.iconWidth🔗

EntityWindowUtil.StockCountsWidgetParams.iconWidth: integer

EntityWindowUtil.StockCountsWidgetParams.maxIcons🔗

EntityWindowUtil.StockCountsWidgetParams.maxIcons: integer

EntityWindowUtil.StockCountsWidgetParams.groupStocks🔗

EntityWindowUtil.StockCountsWidgetParams.groupStocks: boolean

EntityWindowUtil.StockCountsWidgetParams.addDiscardCargoButtons🔗

EntityWindowUtil.StockCountsWidgetParams.addDiscardCargoButtons: boolean

EntityWindowUtil.StockCountsWidgetParams.addButtonsToSetStockCargoType🔗

EntityWindowUtil.StockCountsWidgetParams.addButtonsToSetStockCargoType: boolean

EntityWindowUtil.StockCountsWidgetParams.sortByType🔗

EntityWindowUtil.StockCountsWidgetParams.sortByType: boolean

EntityWindowUtil.DiagramType🔗

enum EntityWindowUtil.DiagramType
  "account"
  "logbook"
  "logbookDiff"
end

EntityWindowUtil.DiagramType."account"🔗

EntityWindowUtil.DiagramType."logbook"🔗

EntityWindowUtil.DiagramType."logbookDiff"🔗

EntityWindowUtil.DiagramParams🔗

record EntityWindowUtil.DiagramParams
  entityId: Engine.Entity
  logNames: {string}
  labels: {string}
  colors: {Vec4f}
  types: {Builtin.SeriesParam.Type}
  styleClass: string
  chartType: DiagramType
  yMin: number
  yMax: number
  yAxisLabelFormatter: function(number): string
  showTimeScaleSlider: boolean
  showLegend: boolean
  initialNumYearsToDisplay: integer
  minNumYearsToDisplay: integer
  maxNumYearsToDisplay: integer
  legendOrientation: Builtin.Type.Orientation
  yStepScale: number
  currentValueFns: {function() : number}
  focusSlider: boolean
end

EntityWindowUtil.DiagramParams.entityId🔗

EntityWindowUtil.DiagramParams.entityId: Engine.Entity

EntityWindowUtil.DiagramParams.logNames🔗

EntityWindowUtil.DiagramParams.logNames: {string}

EntityWindowUtil.DiagramParams.labels🔗

EntityWindowUtil.DiagramParams.labels: {string}

EntityWindowUtil.DiagramParams.colors🔗

EntityWindowUtil.DiagramParams.colors: {Vec4f}

EntityWindowUtil.DiagramParams.types🔗

EntityWindowUtil.DiagramParams.types: {Builtin.SeriesParam.Type}

EntityWindowUtil.DiagramParams.styleClass🔗

EntityWindowUtil.DiagramParams.styleClass: string

EntityWindowUtil.DiagramParams.chartType🔗

EntityWindowUtil.DiagramParams.chartType: DiagramType

EntityWindowUtil.DiagramParams.yMin🔗

EntityWindowUtil.DiagramParams.yMin: number

EntityWindowUtil.DiagramParams.yMax🔗

EntityWindowUtil.DiagramParams.yMax: number

EntityWindowUtil.DiagramParams.yAxisLabelFormatter🔗

function EntityWindowUtil.DiagramParams.yAxisLabelFormatter(number): string

Parameters

• number

Returns

1. string

EntityWindowUtil.DiagramParams.showTimeScaleSlider🔗

EntityWindowUtil.DiagramParams.showTimeScaleSlider: boolean

EntityWindowUtil.DiagramParams.showLegend🔗

EntityWindowUtil.DiagramParams.showLegend: boolean

EntityWindowUtil.DiagramParams.initialNumYearsToDisplay🔗

EntityWindowUtil.DiagramParams.initialNumYearsToDisplay: integer

EntityWindowUtil.DiagramParams.minNumYearsToDisplay🔗

EntityWindowUtil.DiagramParams.minNumYearsToDisplay: integer

EntityWindowUtil.DiagramParams.maxNumYearsToDisplay🔗

EntityWindowUtil.DiagramParams.maxNumYearsToDisplay: integer

EntityWindowUtil.DiagramParams.legendOrientation🔗

EntityWindowUtil.DiagramParams.legendOrientation: Builtin.Type.Orientation

EntityWindowUtil.DiagramParams.yStepScale🔗

EntityWindowUtil.DiagramParams.yStepScale: number

EntityWindowUtil.DiagramParams.currentValueFns🔗

EntityWindowUtil.DiagramParams.currentValueFns: {function() : number}

EntityWindowUtil.DiagramParams.focusSlider🔗

EntityWindowUtil.DiagramParams.focusSlider: boolean

EntityWindowUtil.ActionBarButton🔗

[Expand All] [Collapse All]
record EntityWindowUtil.ActionBarButton
  
enum Sound
    "Buy"
    "Sell"
    "SendToDepot"
end
  isSpacer: boolean
  icon: string
  description: string
  onClick: function()
  tag: string
  customItem: TreeNodeId
  sound: Sound
  toggleButton: boolean
  onValueChange: function(boolean)
  value: boolean
end

EntityWindowUtil.ActionBarButton.Sound🔗

enum EntityWindowUtil.ActionBarButton.Sound
  "Buy"
  "Sell"
  "SendToDepot"
end

EntityWindowUtil.ActionBarButton.Sound."Buy"🔗

EntityWindowUtil.ActionBarButton.Sound."Sell"🔗

EntityWindowUtil.ActionBarButton.Sound."SendToDepot"🔗

EntityWindowUtil.ActionBarButton.isSpacer🔗

EntityWindowUtil.ActionBarButton.isSpacer: boolean

EntityWindowUtil.ActionBarButton.icon🔗

EntityWindowUtil.ActionBarButton.icon: string

EntityWindowUtil.ActionBarButton.description🔗

EntityWindowUtil.ActionBarButton.description: string

EntityWindowUtil.ActionBarButton.onClick🔗

function EntityWindowUtil.ActionBarButton.onClick()

EntityWindowUtil.ActionBarButton.tag🔗

EntityWindowUtil.ActionBarButton.tag: string

EntityWindowUtil.ActionBarButton.customItem🔗

EntityWindowUtil.ActionBarButton.customItem: TreeNodeId

EntityWindowUtil.ActionBarButton.sound🔗

EntityWindowUtil.ActionBarButton.sound: Sound

EntityWindowUtil.ActionBarButton.toggleButton🔗

EntityWindowUtil.ActionBarButton.toggleButton: boolean

EntityWindowUtil.ActionBarButton.onValueChange🔗

function EntityWindowUtil.ActionBarButton.onValueChange(boolean)

Parameters

• boolean

EntityWindowUtil.ActionBarButton.value🔗

EntityWindowUtil.ActionBarButton.value: boolean

EntityWindowUtil.ActionButtonBarParams🔗

record EntityWindowUtil.ActionButtonBarParams
  primaryButtons: {ActionBarButton}
  secondaryButtons: {ActionBarButton}
  nextUpFocusRef: ReactRefWrap
end

EntityWindowUtil.ActionButtonBarParams.primaryButtons🔗

EntityWindowUtil.ActionButtonBarParams.primaryButtons: {ActionBarButton}

EntityWindowUtil.ActionButtonBarParams.secondaryButtons🔗

EntityWindowUtil.ActionButtonBarParams.secondaryButtons: {ActionBarButton}

EntityWindowUtil.ActionButtonBarParams.nextUpFocusRef🔗

EntityWindowUtil.ActionButtonBarParams.nextUpFocusRef: ReactRefWrap

EntityWindowUtil.EntityWindowButtonParams🔗

record EntityWindowUtil.EntityWindowButtonParams
  tooltip: string
  icon: string
  onClick: function()
end

EntityWindowUtil.EntityWindowButtonParams.tooltip🔗

EntityWindowUtil.EntityWindowButtonParams.tooltip: string

EntityWindowUtil.EntityWindowButtonParams.icon🔗

EntityWindowUtil.EntityWindowButtonParams.icon: string

EntityWindowUtil.EntityWindowButtonParams.onClick🔗

function EntityWindowUtil.EntityWindowButtonParams.onClick()

EntityWindowUtil.WorkplacesProgressBarWidgetParams🔗

record EntityWindowUtil.WorkplacesProgressBarWidgetParams
  entityId: Engine.Entity
  progressBarThresholds: {number}
end

EntityWindowUtil.WorkplacesProgressBarWidgetParams.entityId🔗

EntityWindowUtil.WorkplacesProgressBarWidgetParams.entityId: Engine.Entity

EntityWindowUtil.WorkplacesProgressBarWidgetParams.progressBarThresholds🔗

EntityWindowUtil.WorkplacesProgressBarWidgetParams.progressBarThresholds: {number}

EntityWindowUtil.SimPersonDestinationButtonParams🔗

record EntityWindowUtil.SimPersonDestinationButtonParams
  simPersonEntityId: Engine.Entity
  destinationIndex: integer
  addIconIfMissing: boolean
end

EntityWindowUtil.SimPersonDestinationButtonParams.simPersonEntityId🔗

EntityWindowUtil.SimPersonDestinationButtonParams.simPersonEntityId: Engine.Entity

EntityWindowUtil.SimPersonDestinationButtonParams.destinationIndex🔗

EntityWindowUtil.SimPersonDestinationButtonParams.destinationIndex: integer

EntityWindowUtil.SimPersonDestinationButtonParams.addIconIfMissing🔗

EntityWindowUtil.SimPersonDestinationButtonParams.addIconIfMissing: boolean

EntityWindowUtil.InhabitantsTableParam🔗

record EntityWindowUtil.InhabitantsTableParam
  landmark: boolean
  headquarters: boolean
  personCapacityEntityId: Engine.Entity
end

EntityWindowUtil.InhabitantsTableParam.landmark🔗

EntityWindowUtil.InhabitantsTableParam.landmark: boolean

EntityWindowUtil.InhabitantsTableParam.headquarters🔗

EntityWindowUtil.InhabitantsTableParam.headquarters: boolean

EntityWindowUtil.InhabitantsTableParam.personCapacityEntityId🔗

EntityWindowUtil.InhabitantsTableParam.personCapacityEntityId: Engine.Entity

EntityWindowUtil.WorkersTableParam🔗

record EntityWindowUtil.WorkersTableParam
  personCapacityEntityId: Engine.Entity
end

EntityWindowUtil.WorkersTableParam.personCapacityEntityId🔗

EntityWindowUtil.WorkersTableParam.personCapacityEntityId: Engine.Entity

EntityWindowUtil.DestinationIconParams🔗

record EntityWindowUtil.DestinationIconParams
  destinationIndex: integer
  iconClass: string
  tooltipOverride: string
end

EntityWindowUtil.DestinationIconParams.destinationIndex🔗

EntityWindowUtil.DestinationIconParams.destinationIndex: integer

EntityWindowUtil.DestinationIconParams.iconClass🔗

EntityWindowUtil.DestinationIconParams.iconClass: string

EntityWindowUtil.DestinationIconParams.tooltipOverride🔗

EntityWindowUtil.DestinationIconParams.tooltipOverride: string

EntityWindowUtil.PassengerWidgetParams🔗

record EntityWindowUtil.PassengerWidgetParams
  vehicleEntity: Engine.Entity
end

EntityWindowUtil.PassengerWidgetParams.vehicleEntity🔗

EntityWindowUtil.PassengerWidgetParams.vehicleEntity: Engine.Entity

EntityWindowUtil.VehicleTableColumn🔗

record EntityWindowUtil.VehicleTableColumn
  name: string
  recipe: Recipe<Builtin.TableCellParam>
  sortOrder: function(Engine.Entity, Engine.Entity): boolean
  headerStyleClass: string
  weight: number
end

EntityWindowUtil.VehicleTableColumn.name🔗

EntityWindowUtil.VehicleTableColumn.name: string

EntityWindowUtil.VehicleTableColumn.recipe🔗

EntityWindowUtil.VehicleTableColumn.recipe: Recipe<Builtin.TableCellParam>

EntityWindowUtil.VehicleTableColumn.sortOrder🔗

function EntityWindowUtil.VehicleTableColumn.sortOrder(Engine.Entity, Engine.Entity): boolean

Parameters

• Engine.Entity
• Engine.Entity

Returns

1. boolean

EntityWindowUtil.VehicleTableColumn.headerStyleClass🔗

EntityWindowUtil.VehicleTableColumn.headerStyleClass: string

EntityWindowUtil.VehicleTableColumn.weight🔗

EntityWindowUtil.VehicleTableColumn.weight: number

EntityWindowUtil.VehicleTableParams🔗

record EntityWindowUtil.VehicleTableParams
  entityId: Engine.Entity
  getVehicleEntities: function(Engine.Entity): {Engine.Entity}
  columns: {VehicleTableColumn}
end

EntityWindowUtil.VehicleTableParams.entityId🔗

EntityWindowUtil.VehicleTableParams.entityId: Engine.Entity

EntityWindowUtil.VehicleTableParams.getVehicleEntities🔗

function EntityWindowUtil.VehicleTableParams.getVehicleEntities(Engine.Entity): {Engine.Entity}

Parameters

• Engine.Entity

Returns

1. {Engine.Entity}

EntityWindowUtil.VehicleTableParams.columns🔗

EntityWindowUtil.VehicleTableParams.columns: {VehicleTableColumn}

EntityWindowUtil.VehicleCell🔗

EntityWindowUtil.VehicleCell: Recipe<Builtin.TableCellParam>

EntityWindowUtil.VehicleTable🔗

EntityWindowUtil.VehicleTable: Recipe<VehicleTableParams>

EntityWindowUtil.VehicleConditionParams🔗

record EntityWindowUtil.VehicleConditionParams
  entityId: Engine.Entity
  addIcon: boolean
end

EntityWindowUtil.VehicleConditionParams.entityId🔗

EntityWindowUtil.VehicleConditionParams.entityId: Engine.Entity

EntityWindowUtil.VehicleConditionParams.addIcon🔗

EntityWindowUtil.VehicleConditionParams.addIcon: boolean

EntityWindowUtil.VehicleCondition🔗

EntityWindowUtil.VehicleCondition: Recipe<VehicleConditionParams>

EntityWindowUtil.MaintenanceStationPoolProgressBarParams🔗

record EntityWindowUtil.MaintenanceStationPoolProgressBarParams
  entityId: Engine.Entity
end

EntityWindowUtil.MaintenanceStationPoolProgressBarParams.entityId🔗

EntityWindowUtil.MaintenanceStationPoolProgressBarParams.entityId: Engine.Entity

EntityWindowUtil.SubconstructionBalanceParams🔗

record EntityWindowUtil.SubconstructionBalanceParams
  entityId: Engine.Entity
  stepTimer: boolean
  maintenanceType: JournalEntry.Maintenance
end

EntityWindowUtil.SubconstructionBalanceParams.entityId🔗

EntityWindowUtil.SubconstructionBalanceParams.entityId: Engine.Entity

EntityWindowUtil.SubconstructionBalanceParams.stepTimer🔗

EntityWindowUtil.SubconstructionBalanceParams.stepTimer: boolean

EntityWindowUtil.SubconstructionBalanceParams.maintenanceType🔗

EntityWindowUtil.SubconstructionBalanceParams.maintenanceType: JournalEntry.Maintenance

EntityWindowUtil.SendCommandButtonParams🔗

record EntityWindowUtil.SendCommandButtonParams
  iconPath: string
  tooltip: string | function() : string
  makeCommand: function(): Command
  isActive: function(): boolean
  isPrimary: boolean
  tag: string
end

EntityWindowUtil.SendCommandButtonParams.iconPath🔗

EntityWindowUtil.SendCommandButtonParams.iconPath: string

EntityWindowUtil.SendCommandButtonParams.tooltip🔗

EntityWindowUtil.SendCommandButtonParams.tooltip: string | function() : string

EntityWindowUtil.SendCommandButtonParams.makeCommand🔗

function EntityWindowUtil.SendCommandButtonParams.makeCommand(): Command

Returns

1. Command

EntityWindowUtil.SendCommandButtonParams.isActive🔗

function EntityWindowUtil.SendCommandButtonParams.isActive(): boolean

Returns

1. boolean

EntityWindowUtil.SendCommandButtonParams.isPrimary🔗

EntityWindowUtil.SendCommandButtonParams.isPrimary: boolean

EntityWindowUtil.SendCommandButtonParams.tag🔗

EntityWindowUtil.SendCommandButtonParams.tag: string

EntityWindowUtil.RecipeAndParamErased🔗

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

EntityWindowUtil.RecipeAndParamErased.recipe🔗

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

EntityWindowUtil.RecipeAndParamErased.param🔗

EntityWindowUtil.RecipeAndParamErased.param: any

EntityWindowUtil.EntityLog🔗

[Expand All] [Collapse All]
record EntityWindowUtil.EntityLog
  
record Entry
    durationSeconds: integer
    change: integer
    logName: string
    place: Engine.Entity
end
  
record LoggedState
    time: integer
    place: Engine.Entity
    logName: string
    state: integer
end
  entries: {Entry}
end

EntityWindowUtil.EntityLog.Entry🔗

record EntityWindowUtil.EntityLog.Entry
  durationSeconds: integer
  change: integer
  logName: string
  place: Engine.Entity
end

EntityWindowUtil.EntityLog.Entry.durationSeconds🔗

EntityWindowUtil.EntityLog.Entry.durationSeconds: integer

EntityWindowUtil.EntityLog.Entry.change🔗

EntityWindowUtil.EntityLog.Entry.change: integer

EntityWindowUtil.EntityLog.Entry.logName🔗

EntityWindowUtil.EntityLog.Entry.logName: string

EntityWindowUtil.EntityLog.Entry.place🔗

EntityWindowUtil.EntityLog.Entry.place: Engine.Entity

EntityWindowUtil.EntityLog.LoggedState🔗

record EntityWindowUtil.EntityLog.LoggedState
  time: integer
  place: Engine.Entity
  logName: string
  state: integer
end

EntityWindowUtil.EntityLog.LoggedState.time🔗

EntityWindowUtil.EntityLog.LoggedState.time: integer

EntityWindowUtil.EntityLog.LoggedState.place🔗

EntityWindowUtil.EntityLog.LoggedState.place: Engine.Entity

EntityWindowUtil.EntityLog.LoggedState.logName🔗

EntityWindowUtil.EntityLog.LoggedState.logName: string

EntityWindowUtil.EntityLog.LoggedState.state🔗

EntityWindowUtil.EntityLog.LoggedState.state: integer

EntityWindowUtil.EntityLog.entries🔗

EntityWindowUtil.EntityLog.entries: {Entry}

EntityWindowUtil.MaintenanceBarParam🔗

record EntityWindowUtil.MaintenanceBarParam
  entity: Engine.Entity
  maintenancePeriodText: string
  initialCalloutText: string
  gameCtx: GameContext
  showOnRightSide: boolean
  nextUpFocusRef: ReactRefWrap
end

EntityWindowUtil.MaintenanceBarParam.entity🔗

EntityWindowUtil.MaintenanceBarParam.entity: Engine.Entity

EntityWindowUtil.MaintenanceBarParam.maintenancePeriodText🔗

EntityWindowUtil.MaintenanceBarParam.maintenancePeriodText: string

EntityWindowUtil.MaintenanceBarParam.initialCalloutText🔗

EntityWindowUtil.MaintenanceBarParam.initialCalloutText: string

EntityWindowUtil.MaintenanceBarParam.gameCtx🔗

EntityWindowUtil.MaintenanceBarParam.gameCtx: GameContext

EntityWindowUtil.MaintenanceBarParam.showOnRightSide🔗

EntityWindowUtil.MaintenanceBarParam.showOnRightSide: boolean

EntityWindowUtil.MaintenanceBarParam.nextUpFocusRef🔗

EntityWindowUtil.MaintenanceBarParam.nextUpFocusRef: ReactRefWrap

EntityWindowUtil.CombinedStockGroupedCountsParam🔗

record EntityWindowUtil.CombinedStockGroupedCountsParam
  initialCalloutTextInputPermanent: string
  initialCalloutTextInputCollapsible: string
  recipeAndParamInputCollapsible: RecipeAndParamErased
  initialCalloutTextOutputPermanent: string
  initialCalloutTextOutputCollapsible: string
  recipeAndParamOutputCollapsible: RecipeAndParamErased
  cardKey: string
  setCollapsibleExpanded: function(string, boolean)
  getCollapsibleExpanded: function(string)
  gameCtx: GameContext
  showOnRightSide: boolean
  showSimplifiedOnly: boolean
  entityId: Engine.Entity
end

EntityWindowUtil.CombinedStockGroupedCountsParam.initialCalloutTextInputPermanent🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.initialCalloutTextInputPermanent: string

EntityWindowUtil.CombinedStockGroupedCountsParam.initialCalloutTextInputCollapsible🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.initialCalloutTextInputCollapsible: string

EntityWindowUtil.CombinedStockGroupedCountsParam.recipeAndParamInputCollapsible🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.recipeAndParamInputCollapsible: RecipeAndParamErased

EntityWindowUtil.CombinedStockGroupedCountsParam.initialCalloutTextOutputPermanent🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.initialCalloutTextOutputPermanent: string

EntityWindowUtil.CombinedStockGroupedCountsParam.initialCalloutTextOutputCollapsible🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.initialCalloutTextOutputCollapsible: string

EntityWindowUtil.CombinedStockGroupedCountsParam.recipeAndParamOutputCollapsible🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.recipeAndParamOutputCollapsible: RecipeAndParamErased

EntityWindowUtil.CombinedStockGroupedCountsParam.cardKey🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.cardKey: string

EntityWindowUtil.CombinedStockGroupedCountsParam.setCollapsibleExpanded🔗

function EntityWindowUtil.CombinedStockGroupedCountsParam.setCollapsibleExpanded(string, boolean)

Parameters

• string
• boolean

EntityWindowUtil.CombinedStockGroupedCountsParam.getCollapsibleExpanded🔗

function EntityWindowUtil.CombinedStockGroupedCountsParam.getCollapsibleExpanded(string)

Parameters

• string

EntityWindowUtil.CombinedStockGroupedCountsParam.gameCtx🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.gameCtx: GameContext

EntityWindowUtil.CombinedStockGroupedCountsParam.showOnRightSide🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.showOnRightSide: boolean

EntityWindowUtil.CombinedStockGroupedCountsParam.showSimplifiedOnly🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.showSimplifiedOnly: boolean

EntityWindowUtil.CombinedStockGroupedCountsParam.entityId🔗

EntityWindowUtil.CombinedStockGroupedCountsParam.entityId: Engine.Entity

EntityWindowUtil.IconQualityType🔗

enum EntityWindowUtil.IconQualityType
  "Aloof"
  "Happy"
  "Negative"
  "Positive"
  "Sad"
end

EntityWindowUtil.IconQualityType."Aloof"🔗

EntityWindowUtil.IconQualityType."Happy"🔗

EntityWindowUtil.IconQualityType."Negative"🔗

EntityWindowUtil.IconQualityType."Positive"🔗

EntityWindowUtil.IconQualityType."Sad"🔗

EntityWindowUtil.RatingBarParam🔗

record EntityWindowUtil.RatingBarParam
  icon: TreeNodeId
  iconPath: string
  tooltip: string
  ratingText: string
  getRatingLabel: function(RatingLevel): string
  barTooltip: string
  value: number
  valueChange: number
  numFractions: integer
  snapValueToFractions: boolean
  onClick: function()
  hideText: boolean
  showIcon: boolean
end

EntityWindowUtil.RatingBarParam.icon🔗

EntityWindowUtil.RatingBarParam.icon: TreeNodeId

EntityWindowUtil.RatingBarParam.iconPath🔗

EntityWindowUtil.RatingBarParam.iconPath: string

EntityWindowUtil.RatingBarParam.tooltip🔗

EntityWindowUtil.RatingBarParam.tooltip: string

EntityWindowUtil.RatingBarParam.ratingText🔗

EntityWindowUtil.RatingBarParam.ratingText: string

EntityWindowUtil.RatingBarParam.getRatingLabel🔗

function EntityWindowUtil.RatingBarParam.getRatingLabel(RatingLevel): string

Parameters

• RatingLevel

Returns

1. string

EntityWindowUtil.RatingBarParam.barTooltip🔗

EntityWindowUtil.RatingBarParam.barTooltip: string

EntityWindowUtil.RatingBarParam.value🔗

EntityWindowUtil.RatingBarParam.value: number

EntityWindowUtil.RatingBarParam.valueChange🔗

EntityWindowUtil.RatingBarParam.valueChange: number

EntityWindowUtil.RatingBarParam.numFractions🔗

EntityWindowUtil.RatingBarParam.numFractions: integer

EntityWindowUtil.RatingBarParam.snapValueToFractions🔗

EntityWindowUtil.RatingBarParam.snapValueToFractions: boolean

EntityWindowUtil.RatingBarParam.onClick🔗

function EntityWindowUtil.RatingBarParam.onClick()

EntityWindowUtil.RatingBarParam.hideText🔗

EntityWindowUtil.RatingBarParam.hideText: boolean

EntityWindowUtil.RatingBarParam.showIcon🔗

EntityWindowUtil.RatingBarParam.showIcon: boolean

EntityWindowUtil.NoiseAndPollutionParams🔗

record EntityWindowUtil.NoiseAndPollutionParams
  noise: integer
  pollution: integer
end

EntityWindowUtil.NoiseAndPollutionParams.noise🔗

EntityWindowUtil.NoiseAndPollutionParams.noise: integer

EntityWindowUtil.NoiseAndPollutionParams.pollution🔗

EntityWindowUtil.NoiseAndPollutionParams.pollution: integer

EntityWindowUtil.MaintenanceBar🔗

EntityWindowUtil.MaintenanceBar: Recipe<MaintenanceBarParam>

EntityWindowUtil.MaintenanceStationPoolProgressBar🔗

EntityWindowUtil.MaintenanceStationPoolProgressBar: Recipe<MaintenanceStationPoolProgressBarParams>

EntityWindowUtil.EntityStockCountsWidget🔗

EntityWindowUtil.EntityStockCountsWidget: Recipe<StockCountsWidgetParams>

EntityWindowUtil.CombinedStockGroupedCounts🔗

EntityWindowUtil.CombinedStockGroupedCounts: Recipe<CombinedStockGroupedCountsParam>

EntityWindowUtil.EntityDiagramWidget🔗

EntityWindowUtil.EntityDiagramWidget: Recipe<DiagramParams>

EntityWindowUtil.EntityWindowButton🔗

EntityWindowUtil.EntityWindowButton: Recipe<EntityWindowButtonParams>

EntityWindowUtil.ActionButtonBar🔗

EntityWindowUtil.ActionButtonBar: Recipe<ActionButtonBarParams>

EntityWindowUtil.PersonCapacityWidget🔗

EntityWindowUtil.PersonCapacityWidget: Recipe<WorkplacesProgressBarWidgetParams>

EntityWindowUtil.GetDestinationIcon🔗

function EntityWindowUtil.GetDestinationIcon(DestinationIconParams): TreeNodeId

Parameters

• DestinationIconParams

Returns

1. TreeNodeId

EntityWindowUtil.SimPersonDestinationButton🔗

EntityWindowUtil.SimPersonDestinationButton: Recipe<SimPersonDestinationButtonParams>

EntityWindowUtil.GetMoveModeIcon🔗

function EntityWindowUtil.GetMoveModeIcon(MoveMode): TreeNodeId

Parameters

• MoveMode

Returns

1. TreeNodeId

EntityWindowUtil.GetInhabitantsTitle🔗

function EntityWindowUtil.GetInhabitantsTitle(Engine.Entity, boolean): string

Parameters

• Engine.Entity
• boolean

Returns

1. string

EntityWindowUtil.InhabitantsTable🔗

EntityWindowUtil.InhabitantsTable: Recipe<InhabitantsTableParam>

EntityWindowUtil.WorkersTable🔗

EntityWindowUtil.WorkersTable: Recipe<WorkersTableParam>

EntityWindowUtil.EnterCockpitButton🔗

EntityWindowUtil.EnterCockpitButton: Recipe2<GameContext, Engine.Entity>

EntityWindowUtil.WorkplacesProgressBarWidget🔗

EntityWindowUtil.WorkplacesProgressBarWidget: Recipe<WorkplacesProgressBarWidgetParams>

EntityWindowUtil.PassengersWidget🔗

EntityWindowUtil.PassengersWidget: Recipe<PassengerWidgetParams>

EntityWindowUtil.RatingBar🔗

EntityWindowUtil.RatingBar: Recipe<RatingBarParam>

EntityWindowUtil.SubconstructionBalance🔗

EntityWindowUtil.SubconstructionBalance: Recipe<SubconstructionBalanceParams>

EntityWindowUtil.SpeedIndicator🔗

EntityWindowUtil.SpeedIndicator: Recipe<Engine.Entity>

EntityWindowUtil.SendCommandButton🔗

EntityWindowUtil.SendCommandButton: Recipe<SendCommandButtonParams>

EntityWindowUtil.NoiseAndPollution🔗

EntityWindowUtil.NoiseAndPollution: Recipe<NoiseAndPollutionParams>

EntityWindowUtil.makeConfigureOnClickFunction🔗

function EntityWindowUtil.makeConfigureOnClickFunction(Engine.Entity): function()

Parameters

• Engine.Entity

Returns

1. function()

EntityWindowUtil.makeProgressBar🔗

function EntityWindowUtil.makeProgressBar(string, string, string, number, number, number, TreeNodeId): TreeNodeId

Parameters

• string
• string
• string
• number
• number
• number
• TreeNodeId

Returns

1. TreeNodeId

EntityWindowUtil.makeRecipeAndParam🔗

function EntityWindowUtil.makeRecipeAndParam<T>(Recipe<T>, T): RecipeAndParamErased

Type Parameters

• T

Parameters

• Recipe<T>
• T

Returns

1. RecipeAndParamErased

EntityWindowUtil.makeStockState🔗

function EntityWindowUtil.makeStockState(Engine.Entity): {CargoUtil.StockConfig}

Parameters

• Engine.Entity

Returns

1. {CargoUtil.StockConfig}

EntityWindowUtil.createStockIcon🔗

function EntityWindowUtil.createStockIcon({CargoUtil.StockConfig}, Engine.Entity): TreeNodeId

Parameters

• {CargoUtil.StockConfig}
• Engine.Entity

Returns

1. TreeNodeId

EntityWindowUtil.getVehicleName🔗

function EntityWindowUtil.getVehicleName(Engine.Entity): string

Parameters

• Engine.Entity

Returns

1. string

EntityWindowUtil.getEntityLog🔗

function EntityWindowUtil.getEntityLog(Engine.Entity, {string}, {string}, integer, {string}, EntityWindowUtil.EntityLog.LoggedState): EntityWindowUtil.EntityLog

Parameters

• Engine.Entity
• {string}
• {string}
• integer
• {string}
• EntityWindowUtil.EntityLog.LoggedState

Returns

1. EntityWindowUtil.EntityLog

EntityWindowUtil.isConstructionModifiable🔗

function EntityWindowUtil.isConstructionModifiable(Engine.Entity): boolean

Parameters

• Engine.Entity

Returns

1. boolean

EntityWindowUtil.NotificationWidget🔗

EntityWindowUtil.NotificationWidget: Recipe<Engine.Entity>

EntityWindowUtil.ContentWidgetScrollContainer🔗

EntityWindowUtil.ContentWidgetScrollContainer: Recipe<{TreeNodeId}>