OpenTTD
Enumerations | Functions
station_gui.h File Reference

Contains enums and function declarations connected with stations GUI. More...

#include "command_type.h"
#include "tilearea_type.h"
#include "window_type.h"

Go to the source code of this file.

Enumerations

enum  StationCoverageType { SCT_PASSENGERS_ONLY, SCT_NON_PASSENGERS_ONLY, SCT_ALL }
 Types of cargo to display for station coverage. More...
 

Functions

int DrawStationCoverageAreaText (int left, int right, int top, StationCoverageType sct, int rad, bool supplies)
 Calculates and draws the accepted or supplied cargo around the selected tile(s) More...
 
void CheckRedrawStationCoverage (const Window *w)
 Check whether we need to redraw the station coverage text. More...
 
void ShowSelectStationIfNeeded (const CommandContainer &cmd, TileArea ta)
 Show the station selection window when needed. More...
 
void ShowSelectWaypointIfNeeded (const CommandContainer &cmd, TileArea ta)
 Show the waypoint selection window when needed. More...
 

Detailed Description

Contains enums and function declarations connected with stations GUI.

Definition in file station_gui.h.

Enumeration Type Documentation

◆ StationCoverageType

Types of cargo to display for station coverage.

Enumerator
SCT_PASSENGERS_ONLY 

Draw only passenger class cargoes.

SCT_NON_PASSENGERS_ONLY 

Draw all non-passenger class cargoes.

SCT_ALL 

Draw all cargoes.

Definition at line 21 of file station_gui.h.

Function Documentation

◆ CheckRedrawStationCoverage()

void CheckRedrawStationCoverage ( const Window w)

Check whether we need to redraw the station coverage text.

If it is needed actually make the window for redrawing.

Parameters
wthe window to check.

Definition at line 88 of file station_gui.cpp.

Referenced by BuildDocksStationWindow::OnTick(), BuildAirportWindow::OnTick(), BuildRoadStationWindow::OnTick(), and BuildRailStationWindow::OnTick().

◆ DrawStationCoverageAreaText()

int DrawStationCoverageAreaText ( int  left,
int  right,
int  top,
StationCoverageType  sct,
int  rad,
bool  supplies 
)

Calculates and draws the accepted or supplied cargo around the selected tile(s)

Parameters
leftx position where the string is to be drawn
rightthe right most position to draw on
topy position where the string is to be drawn
sctwhich type of cargo is to be displayed (passengers/non-passengers)
radradius around selected tile(s) to be searched
suppliesif supplied cargoes should be drawn, else accepted cargoes
Returns
Returns the y value below the string that was drawn

Definition at line 56 of file station_gui.cpp.

References TileVirtXY().

◆ ShowSelectStationIfNeeded()

void ShowSelectStationIfNeeded ( const CommandContainer cmd,
TileArea  ta 
)

Show the station selection window when needed.

If not, build the station.

Parameters
cmdCommand to build the station.
taArea to build the station in

Definition at line 2408 of file station_gui.cpp.

◆ ShowSelectWaypointIfNeeded()

void ShowSelectWaypointIfNeeded ( const CommandContainer cmd,
TileArea  ta 
)

Show the waypoint selection window when needed.

If not, build the waypoint.

Parameters
cmdCommand to build the waypoint.
taArea to build the waypoint in

Definition at line 2418 of file station_gui.cpp.