station_map.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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef STATION_MAP_H
#define STATION_MAP_H
 
#include "rail_map.h"
#include "road_map.h"
#include "water_map.h"
#include "station_func.h"
#include "rail.h"
#include "road.h"
 
typedef uint8_t StationGfx; 
 
inline StationID GetStationIndex(Tile t)
{
  assert(IsTileType(t, MP_STATION));
  return (StationID)t.m2();
}
 
 
static const int GFX_DOCK_BASE_WATER_PART          =  4; 
static const int GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET =  4; 
 
inline StationType GetStationType(Tile t)
{
  assert(IsTileType(t, MP_STATION));
  return (StationType)GB(t.m6(), 3, 4);
}
 
inline RoadStopType GetRoadStopType(Tile t)
{
  assert(GetStationType(t) == StationType::Truck || GetStationType(t) == StationType::Bus);
  return GetStationType(t) == StationType::Truck ? RoadStopType::Truck : RoadStopType::Bus;
}
 
inline StationGfx GetStationGfx(Tile t)
{
  assert(IsTileType(t, MP_STATION));
  return t.m5();
}
 
inline void SetStationGfx(Tile t, StationGfx gfx)
{
  assert(IsTileType(t, MP_STATION));
  t.m5() = gfx;
}
 
inline bool IsRailStation(Tile t)
{
  return GetStationType(t) == StationType::Rail;
}
 
inline bool IsRailStationTile(Tile t)
{
  return IsTileType(t, MP_STATION) && IsRailStation(t);
}
 
inline bool IsRailWaypoint(Tile t)
{
  return GetStationType(t) == StationType::RailWaypoint;
}
 
inline bool IsRailWaypointTile(Tile t)
{
  return IsTileType(t, MP_STATION) && IsRailWaypoint(t);
}
 
inline bool HasStationRail(Tile t)
{
  return IsRailStation(t) || IsRailWaypoint(t);
}
 
inline bool HasStationTileRail(Tile t)
{
  return IsTileType(t, MP_STATION) && HasStationRail(t);
}
 
inline bool IsAirport(Tile t)
{
  return GetStationType(t) == StationType::Airport;
}
 
inline bool IsAirportTile(Tile t)
{
  return IsTileType(t, MP_STATION) && IsAirport(t);
}
 
bool IsHangar(Tile t);
 
inline bool IsTruckStop(Tile t)
{
  return GetStationType(t) == StationType::Truck;
}
 
inline bool IsBusStop(Tile t)
{
  return GetStationType(t) == StationType::Bus;
}
 
inline bool IsRoadWaypoint(Tile t)
{
  return GetStationType(t) == StationType::RoadWaypoint;
}
 
inline bool IsRoadWaypointTile(Tile t)
{
  return IsTileType(t, MP_STATION) && IsRoadWaypoint(t);
}
 
inline bool IsStationRoadStop(Tile t)
{
  assert(IsTileType(t, MP_STATION));
  return IsTruckStop(t) || IsBusStop(t);
}
 
inline bool IsStationRoadStopTile(Tile t)
{
  return IsTileType(t, MP_STATION) && IsStationRoadStop(t);
}
 
inline bool IsAnyRoadStop(Tile t)
{
  assert(IsTileType(t, MP_STATION));
  return IsTruckStop(t) || IsBusStop(t) || IsRoadWaypoint(t);
}
 
inline bool IsAnyRoadStopTile(Tile t)
{
  return IsTileType(t, MP_STATION) && IsAnyRoadStop(t);
}
 
inline bool IsBayRoadStopTile(Tile t)
{
  return IsStationRoadStopTile(t) && GetStationGfx(t) < GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET;
}
 
inline bool IsDriveThroughStopTile(Tile t)
{
  return IsAnyRoadStopTile(t) && GetStationGfx(t) >= GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET;
}
 
StationGfx GetTranslatedAirportTileID(StationGfx gfx);
 
static inline Roadside GetRoadWaypointRoadside(Tile tile)
{
  assert(IsRoadWaypointTile(tile));
  return static_cast<Roadside>(GB(tile.m3(), 2, 2));
}
 
static inline void SetRoadWaypointRoadside(Tile tile, Roadside s)
{
  assert(IsRoadWaypointTile(tile));
  SB(tile.m3(), 2, 2, to_underlying(s));
}
 
static inline bool IsRoadWaypointOnSnowOrDesert(Tile t)
{
  assert(IsRoadWaypointTile(t));
  return HasBit(t.m8(), 15);
}
 
static inline void ToggleRoadWaypointOnSnowOrDesert(Tile t)
{
  assert(IsRoadWaypointTile(t));
  ToggleBit(t.m8(), 15);
}
 
inline StationGfx GetAirportGfx(Tile t)
{
  assert(IsAirport(t));
  return GetTranslatedAirportTileID(GetStationGfx(t));
}
 
inline DiagDirection GetBayRoadStopDir(Tile t)
{
  assert(IsBayRoadStopTile(t));
  return static_cast<DiagDirection>(GetStationGfx(t));
}
 
inline Axis GetDriveThroughStopAxis(Tile t)
{
  assert(IsDriveThroughStopTile(t));
  return static_cast<Axis>(GetStationGfx(t) - GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET);
}
 
inline bool IsOilRig(Tile t)
{
  return GetStationType(t) == StationType::Oilrig;
}
 
inline bool IsDock(Tile t)
{
  return GetStationType(t) == StationType::Dock;
}
 
inline bool IsDockTile(Tile t)
{
  return IsTileType(t, MP_STATION) && GetStationType(t) == StationType::Dock;
}
 
inline bool IsBuoy(Tile t)
{
  return GetStationType(t) == StationType::Buoy;
}
 
inline bool IsBuoyTile(Tile t)
{
  return IsTileType(t, MP_STATION) && IsBuoy(t);
}
 
inline bool IsHangarTile(Tile t)
{
  return IsTileType(t, MP_STATION) && IsHangar(t);
}
 
inline bool IsStationTileBlocked(Tile t)
{
  assert(HasStationRail(t));
  return HasBit(t.m3(), 0);
}
 
inline void SetStationTileBlocked(Tile t, bool b)
{
  assert(HasStationRail(t));
  AssignBit(t.m3(), 0, b);
}
 
inline bool CanStationTileHaveWires(Tile t)
{
  assert(HasStationRail(t));
  return HasBit(t.m3(), 1);
}
 
inline void SetStationTileHaveWires(Tile t, bool b)
{
  assert(HasStationRail(t));
  AssignBit(t.m3(), 1, b);
}
 
inline bool CanStationTileHavePylons(Tile t)
{
  assert(HasStationRail(t));
  return HasBit(t.m3(), 2);
}
 
inline void SetStationTileHavePylons(Tile t, bool b)
{
  assert(HasStationRail(t));
  AssignBit(t.m3(), 2, b);
}
 
inline Axis GetRailStationAxis(Tile t)
{
  assert(HasStationRail(t));
  return HasBit(GetStationGfx(t), 0) ? AXIS_Y : AXIS_X;
}
 
inline Track GetRailStationTrack(Tile t)
{
  return AxisToTrack(GetRailStationAxis(t));
}
 
inline TrackBits GetRailStationTrackBits(Tile t)
{
  return AxisToTrackBits(GetRailStationAxis(t));
}
 
inline bool IsCompatibleTrainStationTile(Tile test_tile, Tile station_tile)
{
  assert(IsRailStationTile(station_tile));
  return IsRailStationTile(test_tile) && !IsStationTileBlocked(test_tile) &&
      IsCompatibleRail(GetRailType(test_tile), GetRailType(station_tile)) &&
      GetRailStationAxis(test_tile) == GetRailStationAxis(station_tile) &&
      GetStationIndex(test_tile) == GetStationIndex(station_tile);
}
 
inline bool HasStationReservation(Tile t)
{
  assert(HasStationRail(t));
  return HasBit(t.m6(), 2);
}
 
inline void SetRailStationReservation(Tile t, bool b)
{
  assert(HasStationRail(t));
  AssignBit(t.m6(), 2, b);
}
 
inline TrackBits GetStationReservationTrackBits(Tile t)
{
  return HasStationReservation(t) ? GetRailStationTrackBits(t) : TRACK_BIT_NONE;
}
 
inline DiagDirection GetDockDirection(Tile t)
{
  StationGfx gfx = GetStationGfx(t);
  assert(IsDock(t) && gfx < GFX_DOCK_BASE_WATER_PART);
  return (DiagDirection)(gfx);
}
 
inline bool IsDockWaterPart(Tile t)
{
  assert(IsDockTile(t));
  StationGfx gfx = GetStationGfx(t);
  return gfx >= GFX_DOCK_BASE_WATER_PART;
}
 
inline bool IsCustomStationSpecIndex(Tile t)
{
  assert(HasStationTileRail(t));
  return t.m4() != 0;
}
 
inline void SetCustomStationSpecIndex(Tile t, uint8_t specindex)
{
  assert(HasStationTileRail(t));
  t.m4() = specindex;
}
 
inline uint GetCustomStationSpecIndex(Tile t)
{
  assert(HasStationTileRail(t));
  return t.m4();
}
 
inline bool IsCustomRoadStopSpecIndex(Tile t)
{
  assert(IsAnyRoadStopTile(t));
  return GB(t.m8(), 0, 6) != 0;
}
 
inline void SetCustomRoadStopSpecIndex(Tile t, uint8_t specindex)
{
  assert(IsAnyRoadStopTile(t));
  SB(t.m8(), 0, 6, specindex);
}
 
inline uint GetCustomRoadStopSpecIndex(Tile t)
{
  assert(IsAnyRoadStopTile(t));
  return GB(t.m8(), 0, 6);
}
 
inline void SetStationTileRandomBits(Tile t, uint8_t random_bits)
{
  assert(IsTileType(t, MP_STATION));
  SB(t.m3(), 4, 4, random_bits);
}
 
inline uint8_t GetStationTileRandomBits(Tile t)
{
  assert(IsTileType(t, MP_STATION));
  return GB(t.m3(), 4, 4);
}
 
inline void MakeStation(Tile t, Owner o, StationID sid, StationType st, uint8_t section, WaterClass wc = WaterClass::Invalid)
{
  SetTileType(t, MP_STATION);
  SetTileOwner(t, o);
  SetWaterClass(t, wc);
  SetDockingTile(t, false);
  t.m2() = sid.base();
  t.m3() = 0;
  t.m4() = 0;
  t.m5() = section;
  SB(t.m6(), 2, 1, 0);
  SB(t.m6(), 3, 4, to_underlying(st));
  SB(t.m6(), 7, 1, 0);
  t.m7() = 0;
  t.m8() = 0;
}
 
inline void MakeRailStation(Tile t, Owner o, StationID sid, Axis a, uint8_t section, RailType rt)
{
  MakeStation(t, o, sid, StationType::Rail, section + a);
  SetRailType(t, rt);
  SetRailStationReservation(t, false);
}
 
inline void MakeRailWaypoint(Tile t, Owner o, StationID sid, Axis a, uint8_t section, RailType rt)
{
  MakeStation(t, o, sid, StationType::RailWaypoint, section + a);
  SetRailType(t, rt);
  SetRailStationReservation(t, false);
}
 
inline void MakeRoadStop(Tile t, Owner o, StationID sid, RoadStopType rst, RoadType road_rt, RoadType tram_rt, DiagDirection d)
{
  MakeStation(t, o, sid, (rst == RoadStopType::Bus ? StationType::Bus : StationType::Truck), d);
  SetRoadTypes(t, road_rt, tram_rt);
  SetRoadOwner(t, RTT_ROAD, o);
  SetRoadOwner(t, RTT_TRAM, o);
}
 
inline void MakeDriveThroughRoadStop(Tile t, Owner station, Owner road, Owner tram, StationID sid, StationType rst, RoadType road_rt, RoadType tram_rt, Axis a)
{
  MakeStation(t, station, sid, rst, GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET + a);
  SetRoadTypes(t, road_rt, tram_rt);
  SetRoadOwner(t, RTT_ROAD, road);
  SetRoadOwner(t, RTT_TRAM, tram);
}
 
inline void MakeAirport(Tile t, Owner o, StationID sid, uint8_t section, WaterClass wc)
{
  MakeStation(t, o, sid, StationType::Airport, section, wc);
}
 
inline void MakeBuoy(Tile t, StationID sid, WaterClass wc)
{
  /* Make the owner of the buoy tile the same as the current owner of the
   * water tile. In this way, we can reset the owner of the water to its
   * original state when the buoy gets removed. */
  MakeStation(t, GetTileOwner(t), sid, StationType::Buoy, 0, wc);
}
 
inline void MakeDock(Tile t, Owner o, StationID sid, DiagDirection d, WaterClass wc)
{
  MakeStation(t, o, sid, StationType::Dock, d);
  MakeStation(TileIndex(t) + TileOffsByDiagDir(d), o, sid, StationType::Dock, GFX_DOCK_BASE_WATER_PART + DiagDirToAxis(d), wc);
}
 
inline void MakeOilrig(Tile t, StationID sid, WaterClass wc)
{
  MakeStation(t, OWNER_NONE, sid, StationType::Oilrig, 0, wc);
}
 
#endif /* STATION_MAP_H */