station_type.h

Go to the documentation of this file.

/*
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef STATION_TYPE_H
#define STATION_TYPE_H
 
#include "core/pool_type.hpp"
#include "tilearea_type.h"
 
using StationID = PoolID<uint16_t, struct StationIDTag, 64000, 0xFFFF>;
static constexpr StationID NEW_STATION{0xFFFD};
static constexpr StationID ADJACENT_STATION{0xFFFE};
 
using RoadStopID = PoolID<uint16_t, struct RoadStopIDTag, 64000, 0xFFFF>;
 
struct BaseStation;
struct Station;
struct RoadStop;
struct StationSpec;
struct Waypoint;

enum class StationType : uint8_t {
  Rail, 
  Airport, 
  Truck, 
  Bus, 
  Oilrig, 
  Dock, 
  Buoy, 
  RailWaypoint, 
  RoadWaypoint, 
  End, 
};

enum class RoadStopType : uint8_t {
  Bus, 
  Truck, 
  End, 
};

enum class StationFacility : uint8_t {
  Train     = 0, 
  TruckStop = 1, 
  BusStop   = 2, 
  Airport   = 3, 
  Dock      = 4, 
  Waypoint  = 7, 
};

using StationFacilities = EnumBitSet<StationFacility, uint8_t>;

static constexpr StationFacility STATION_FACILITY_GHOST{6};

enum class StationVehicleType : uint8_t {
  Train = 1, 
  Bus = 2, 
  Truck = 3, 
  Aircraft = 4, 
  Ship = 5, 
 
  Waypoint = 6, 
};

using StationVehicleTypes = EnumBitSet<StationVehicleType, uint8_t>;

enum class StationRandomTrigger : uint8_t {
  NewCargo, 
  CargoTaken, 
  VehicleArrives, 
  VehicleDeparts, 
  VehicleLoads, 
  PathReservation, 
};

using StationRandomTriggers = EnumBitSet<StationRandomTrigger, uint8_t>;

enum class StationAnimationTrigger : uint8_t {
  Built, 
  NewCargo, 
  CargoTaken, 
  VehicleArrives, 
  VehicleDeparts, 
  VehicleLoads, 
  AcceptanceTick, 
  TileLoop, 
  PathReservation, 
  End, 
};

using StationAnimationTriggers = EnumBitSet<StationAnimationTrigger, uint16_t>;

enum class AirportAnimationTrigger : uint8_t {
  Built, 
  TileLoop, 
  NewCargo, 
  CargoTaken, 
  AcceptanceTick, 
  AirplaneTouchdown, 
};

using AirportAnimationTriggers = EnumBitSet<AirportAnimationTrigger, uint8_t>;
 
/* The different catchment area sizes. */
static constexpr uint CA_NONE = 0; 
static constexpr uint CA_BUS = 3; 
static constexpr uint CA_TRUCK = 3; 
static constexpr uint CA_TRAIN = 4; 
static constexpr uint CA_DOCK = 5; 
 
static constexpr uint CA_UNMODIFIED = 4; 
 
static constexpr uint MAX_CATCHMENT = 10; 
 
static const uint MAX_LENGTH_STATION_NAME_CHARS = 32; 
 
struct StationCompare {
  bool operator() (const Station *lhs, const Station *rhs) const;
};

typedef std::set<Station *, StationCompare> StationList;

class StationFinder : TileArea {
  StationList stations; 
public:
  StationFinder(const TileArea &area) : TileArea(area) {}
  const StationList &GetStations();
};
 
#endif /* STATION_TYPE_H */