mirror of https://github.com/OpenTTD/OpenTTD.git
112 lines
3.9 KiB
C++
112 lines
3.9 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
|
|
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** @file station_type.h Types related to stations. */
|
|
|
|
#ifndef STATION_TYPE_H
|
|
#define STATION_TYPE_H
|
|
|
|
#include "core/smallstack_type.hpp"
|
|
#include "tilearea_type.h"
|
|
|
|
typedef uint16_t StationID;
|
|
typedef uint16_t RoadStopID;
|
|
|
|
struct BaseStation;
|
|
struct Station;
|
|
struct RoadStop;
|
|
struct StationSpec;
|
|
struct Waypoint;
|
|
|
|
static const StationID NEW_STATION = 0xFFFE;
|
|
static const StationID INVALID_STATION = 0xFFFF;
|
|
|
|
typedef SmallStack<StationID, StationID, INVALID_STATION, 8, 0xFFFD> StationIDStack;
|
|
|
|
/** Station types */
|
|
enum StationType {
|
|
STATION_RAIL,
|
|
STATION_AIRPORT,
|
|
STATION_TRUCK,
|
|
STATION_BUS,
|
|
STATION_OILRIG,
|
|
STATION_DOCK,
|
|
STATION_BUOY,
|
|
STATION_WAYPOINT,
|
|
};
|
|
|
|
/** Types of RoadStops */
|
|
enum RoadStopType : uint8_t {
|
|
ROADSTOP_BUS, ///< A standard stop for buses
|
|
ROADSTOP_TRUCK, ///< A standard stop for trucks
|
|
ROADSTOP_END, ///< End of valid types
|
|
};
|
|
|
|
/** The facilities a station might be having */
|
|
enum StationFacility : uint8_t {
|
|
FACIL_NONE = 0, ///< The station has no facilities at all
|
|
FACIL_TRAIN = 1 << 0, ///< Station with train station
|
|
FACIL_TRUCK_STOP = 1 << 1, ///< Station with truck stops
|
|
FACIL_BUS_STOP = 1 << 2, ///< Station with bus stops
|
|
FACIL_AIRPORT = 1 << 3, ///< Station with an airport
|
|
FACIL_DOCK = 1 << 4, ///< Station with a dock
|
|
FACIL_WAYPOINT = 1 << 7, ///< Station is a waypoint
|
|
};
|
|
DECLARE_ENUM_AS_BIT_SET(StationFacility)
|
|
|
|
/** The vehicles that may have visited a station */
|
|
enum StationHadVehicleOfType : uint8_t {
|
|
HVOT_NONE = 0, ///< Station has seen no vehicles
|
|
HVOT_TRAIN = 1 << 1, ///< Station has seen a train
|
|
HVOT_BUS = 1 << 2, ///< Station has seen a bus
|
|
HVOT_TRUCK = 1 << 3, ///< Station has seen a truck
|
|
HVOT_AIRCRAFT = 1 << 4, ///< Station has seen an aircraft
|
|
HVOT_SHIP = 1 << 5, ///< Station has seen a ship
|
|
|
|
HVOT_WAYPOINT = 1 << 6, ///< Station is a waypoint (NewGRF only!)
|
|
};
|
|
DECLARE_ENUM_AS_BIT_SET(StationHadVehicleOfType)
|
|
|
|
/** The different catchment areas used */
|
|
enum CatchmentArea {
|
|
CA_NONE = 0, ///< Catchment when the station has no facilities
|
|
CA_BUS = 3, ///< Catchment for bus stops with "modified catchment" enabled
|
|
CA_TRUCK = 3, ///< Catchment for truck stops with "modified catchment" enabled
|
|
CA_TRAIN = 4, ///< Catchment for train stations with "modified catchment" enabled
|
|
CA_DOCK = 5, ///< Catchment for docks with "modified catchment" enabled
|
|
|
|
CA_UNMODIFIED = 4, ///< Catchment for all stations with "modified catchment" disabled
|
|
|
|
MAX_CATCHMENT = 10, ///< Maximum catchment for airports with "modified catchment" enabled
|
|
};
|
|
|
|
static const uint MAX_LENGTH_STATION_NAME_CHARS = 32; ///< The maximum length of a station name in characters including '\0'
|
|
|
|
struct StationCompare {
|
|
bool operator() (const Station *lhs, const Station *rhs) const;
|
|
};
|
|
|
|
/** List of stations */
|
|
typedef std::set<Station *, StationCompare> StationList;
|
|
|
|
/**
|
|
* Structure contains cached list of stations nearby. The list
|
|
* is created upon first call to GetStations()
|
|
*/
|
|
class StationFinder : TileArea {
|
|
StationList stations; ///< List of stations nearby
|
|
public:
|
|
/**
|
|
* Constructs StationFinder
|
|
* @param area the area to search from
|
|
*/
|
|
StationFinder(const TileArea &area) : TileArea(area) {}
|
|
const StationList *GetStations();
|
|
};
|
|
|
|
#endif /* STATION_TYPE_H */
|