src/depot_map.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 depot_map.h Map related accessors for depots. */
   9
  10 #ifndef DEPOT_MAP_H
  11 #define DEPOT_MAP_H
  12
  13 #include "station_map.h"
  14
  15 /**
  16  * Check if a tile is a depot and it is a depot of the given type.
  17  */
  18 inline bool IsDepotTypeTile(Tile tile, TransportType type)
  19 {
  20         switch (type) {
  21                 default: NOT_REACHED();
  22                 case TRANSPORT_RAIL:
  23                         return IsRailDepotTile(tile);
  24
  25                 case TRANSPORT_ROAD:
  26                         return IsRoadDepotTile(tile);
  27
  28                 case TRANSPORT_WATER:
  29                         return IsShipDepotTile(tile);
  30
  31                 case TRANSPORT_AIR:
  32                         return IsHangarTile(tile);
  33         }
  34 }
  35
  36 /**
  37  * Is the given tile a tile with a depot on it?
  38  * @param tile the tile to check
  39  * @return true if and only if there is a depot on the tile.
  40  */
  41 inline bool IsDepotTile(Tile tile)
  42 {
  43         return IsRailDepotTile(tile) || IsRoadDepotTile(tile) || IsShipDepotTile(tile) || IsHangarTile(tile);
  44 }
  45
  46 /**
  47  * Get the index of which depot is attached to the tile.
  48  * @param t the tile
  49  * @pre IsRailDepotTile(t) || IsRoadDepotTile(t) || IsShipDepotTile(t)
  50  * @return DepotID
  51  */
  52 inline DepotID GetDepotIndex(Tile t)
  53 {
  54         /* Hangars don't have a Depot class, thus store no DepotID. */
  55         assert(IsRailDepotTile(t) || IsRoadDepotTile(t) || IsShipDepotTile(t));
  56         return t.m2();
  57 }
  58
  59 /**
  60  * Get the type of vehicles that can use a depot
  61  * @param t The tile
  62  * @pre IsDepotTile(t)
  63  * @return the type of vehicles that can use the depot
  64  */
  65 inline VehicleType GetDepotVehicleType(Tile t)
  66 {
  67         switch (GetTileType(t)) {
  68                 default: NOT_REACHED();
  69                 case MP_RAILWAY: return VEH_TRAIN;
  70                 case MP_ROAD:    return VEH_ROAD;
  71                 case MP_WATER:   return VEH_SHIP;
  72                 case MP_STATION: return VEH_AIRCRAFT;
  73         }
  74 }
  75
  76 #endif /* DEPOT_MAP_H */