OpenTTD
waypoint_base.h
Go to the documentation of this file.
1 /* $Id: waypoint_base.h 26085 2013-11-24 14:41:19Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #ifndef WAYPOINT_BASE_H
13 #define WAYPOINT_BASE_H
14 
15 #include "base_station_base.h"
16 
18 struct Waypoint FINAL : SpecializedStation<Waypoint, true> {
19  uint16 town_cn;
20 
26  ~Waypoint();
27 
28  void UpdateVirtCoord();
29 
30  /* virtual */ inline bool TileBelongsToRailStation(TileIndex tile) const
31  {
32  return IsRailWaypointTile(tile) && GetStationIndex(tile) == this->index;
33  }
34 
35  /* virtual */ uint32 GetNewGRFVariable(const struct ResolverObject &object, byte variable, byte parameter, bool *available) const;
36 
37  /* virtual */ void GetTileArea(TileArea *ta, StationType type) const;
38 
39  /* virtual */ uint GetPlatformLength(TileIndex tile, DiagDirection dir) const
40  {
41  return 1;
42  }
43 
44  /* virtual */ uint GetPlatformLength(TileIndex tile) const
45  {
46  return 1;
47  }
48 
53  inline bool IsSingleTile() const
54  {
55  return (this->facilities & FACIL_TRAIN) != 0 && this->train_station.w == 1 && this->train_station.h == 1;
56  }
57 
64  inline bool IsOfType(const Waypoint *wp) const
65  {
66  return this->string_id == wp->string_id;
67  }
68 };
69 
74 #define FOR_ALL_WAYPOINTS(var) FOR_ALL_BASE_STATIONS_OF_TYPE(Waypoint, var)
75 
76 #endif /* WAYPOINT_BASE_H */
uint16 town_cn
The N-1th waypoint for this town (consecutive number)
Definition: waypoint_base.h:19
Interface for SpriteGroup-s to access the gamestate.
TileArea train_station
Tile area the train &#39;station&#39; part covers.
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
static bool IsRailWaypointTile(TileIndex t)
Is this tile a station tile and a rail waypoint?
Definition: station_map.h:124
Representation of a waypoint.
Definition: waypoint_base.h:18
uint16 w
The width of the area.
Definition: tilearea_type.h:20
uint32 GetNewGRFVariable(const struct ResolverObject &object, byte variable, byte parameter, bool *available) const
Helper function to get a NewGRF variable that isn&#39;t implemented by the base class.
bool TileBelongsToRailStation(TileIndex tile) const
Check whether a specific tile belongs to this station.
Definition: waypoint_base.h:30
uint GetPlatformLength(TileIndex tile, DiagDirection dir) const
Determines the REMAINING length of a platform, starting at (and including) the given tile...
Definition: waypoint_base.h:39
bool IsSingleTile() const
Is this a single tile waypoint?
Definition: waypoint_base.h:53
Represents the covered area of e.g.
Definition: tilearea_type.h:18
StationFacilityByte facilities
The facilities that this station has.
DiagDirection
Enumeration for diagonal directions.
static StationID GetStationIndex(TileIndex t)
Get StationID from a tile.
Definition: station_map.h:29
StationType
Station types.
Definition: station_type.h:35
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
bool IsOfType(const Waypoint *wp) const
Is the "type" of waypoint the same as the given waypoint, i.e.
Definition: waypoint_base.h:64
void UpdateVirtCoord()
Update the virtual coords needed to draw the waypoint sign.
Station with train station.
Definition: station_type.h:55
uint GetPlatformLength(TileIndex tile) const
Obtain the length of a platform.
Definition: waypoint_base.h:44
Base classes/functions for base stations.
Waypoint(TileIndex tile=INVALID_TILE)
Create a waypoint at the given tile.
Definition: waypoint_base.h:25
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:85
void GetTileArea(TileArea *ta, StationType type) const
Get the tile area for a given station type.
Definition: waypoint.cpp:35
uint16 h
The height of the area.
Definition: tilearea_type.h:21
StringID string_id
Default name (town area) of station.
Class defining several overloaded accessors so we don&#39;t have to cast base stations that often...