src/waypoint_base.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file waypoint_base.h Base of waypoints. */
   9
  10 #ifndef WAYPOINT_BASE_H
  11 #define WAYPOINT_BASE_H
  12
  13 #include "base_station_base.h"
  14
  15 /**
  16  * Flags for Waypoint::waypoint_flags.
  17  */
  18 enum WaypointFlags {
  19         WPF_ROAD                    = 0, ///< This is a road waypoint
  20 };
  21
  22 /** Representation of a waypoint. */
  23 struct Waypoint final : SpecializedStation<Waypoint, true> {
  24         uint16_t town_cn;    ///< The N-1th waypoint for this town (consecutive number)
  25         uint16_t waypoint_flags{}; ///< Waypoint flags, see WaypointFlags
  26         TileArea road_waypoint_area; ///< Tile area the road waypoint part covers
  27
  28         /**
  29          * Create a waypoint at the given tile.
  30          * @param tile The location of the waypoint.
  31          */
  32         Waypoint(TileIndex tile = INVALID_TILE) : SpecializedStation<Waypoint, true>(tile) { }
  33         ~Waypoint();
  34
  35         void UpdateVirtCoord() override;
  36
  37         void MoveSign(TileIndex new_xy) override;
  38
  39         inline bool TileBelongsToRailStation(TileIndex tile) const override
  40         {
  41                 return IsRailWaypointTile(tile) && GetStationIndex(tile) == this->index;
  42         }
  43
  44         uint32_t GetNewGRFVariable(const struct ResolverObject &object, uint8_t variable, uint8_t parameter, bool &available) const override;
  45
  46         void GetTileArea(TileArea *ta, StationType type) const override;
  47
  48         uint GetPlatformLength(TileIndex, DiagDirection) const override
  49         {
  50                 return 1;
  51         }
  52
  53         uint GetPlatformLength(TileIndex) const override
  54         {
  55                 return 1;
  56         }
  57
  58         /**
  59          * Is this a single tile waypoint?
  60          * @return true if it is.
  61          */
  62         inline bool IsSingleTile() const
  63         {
  64                 return (this->facilities & FACIL_TRAIN) != 0 && this->train_station.w == 1 && this->train_station.h == 1;
  65         }
  66
  67         /**
  68          * Is the "type" of waypoint the same as the given waypoint,
  69          * i.e. are both a rail waypoint or are both a buoy?
  70          * @param wp The waypoint to compare to.
  71          * @return true iff their types are equal.
  72          */
  73         inline bool IsOfType(const Waypoint *wp) const
  74         {
  75                 return this->string_id == wp->string_id;
  76         }
  77 };
  78
  79 #endif /* WAYPOINT_BASE_H */