src/depot_func.h

   1 /* $Id$ */
   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
  10 /** @file depot_func.h Functions related to depots. */
  11
  12 #ifndef DEPOT_FUNC_H
  13 #define DEPOT_FUNC_H
  14
  15 #include "transport_type.h"
  16 #include "vehicle_type.h"
  17 #include "slope_func.h"
  18 #include "map/depot.h"
  19
  20 void ShowDepotWindow(TileIndex tile, VehicleType type);
  21
  22 void DeleteDepotHighlightOfVehicle(const Vehicle *v);
  23
  24 /**
  25  * Find out if the slope of the tile is suitable to build a depot of given direction
  26  * @param direction The direction in which the depot's exit points
  27  * @param tileh The slope of the tile in question
  28  * @return true if the construction is possible
  29  */
  30 static inline bool CanBuildDepotByTileh(DiagDirection direction, Slope tileh)
  31 {
  32         assert(tileh != SLOPE_FLAT);
  33         Slope entrance_corners = InclinedSlope(direction);
  34         /* For steep slopes both entrance corners must be raised (i.e. neither of them is the lowest corner),
  35          * For non-steep slopes at least one corner must be raised. */
  36         return IsSteepSlope(tileh) ? (tileh & entrance_corners) == entrance_corners : (tileh & entrance_corners) != 0;
  37 }
  38
  39 /**
  40  * Check if a tile is a depot and it is a depot of the given type.
  41  */
  42 static inline bool IsDepotTypeTile(TileIndex tile, TransportType type)
  43 {
  44         switch (type) {
  45                 default: NOT_REACHED();
  46                 case TRANSPORT_RAIL:
  47                         return IsRailDepotTile(tile);
  48
  49                 case TRANSPORT_ROAD:
  50                         return IsRoadDepotTile(tile);
  51
  52                 case TRANSPORT_WATER:
  53                         return IsShipDepotTile(tile);
  54         }
  55 }
  56
  57 /**
  58  * Get the type of vehicles that can use a depot
  59  * @param t The tile
  60  * @pre IsGroundDepotTile(t) || IsShipDepotTile(t) || IsStationTile(t)
  61  * @return The type of vehicles that can use the depot
  62  */
  63 static inline VehicleType GetDepotVehicleType(TileIndex t)
  64 {
  65         switch (GetTileType(t)) {
  66                 default: NOT_REACHED();
  67                 case TT_WATER:   return VEH_SHIP;
  68                 case TT_STATION: return VEH_AIRCRAFT;
  69                 case TT_MISC:
  70                         assert(IsGroundDepotTile(t));
  71                         return IsRailDepot(t) ? VEH_TRAIN : VEH_ROAD;
  72         }
  73 }
  74
  75 #endif /* DEPOT_FUNC_H */