tron@2186: /* $Id$ */
tron@2186:
truelight@1313: #ifndef DEPOT_H
truelight@1313: #define DEPOT_H
truelight@1313:
celestar@2085: /** @file depot.h Header files for depots (not hangars)
celestar@2085: * @see depot.c */
celestar@2085:
truelight@1313: #include "pool.h"
matthijs@1330: #include "tile.h"
tron@2153: #include "variables.h"
truelight@1313:
truelight@1313: struct Depot {
truelight@1313: TileIndex xy;
truelight@1313: uint16 town_index;
truelight@1313: uint16 index;
truelight@1313: };
truelight@1313:
truelight@1313: extern MemoryPool _depot_pool;
truelight@1313:
truelight@1313: /**
truelight@1313: * Get the pointer to the depot with index 'index'
truelight@1313: */
truelight@1313: static inline Depot *GetDepot(uint index)
truelight@1313: {
truelight@1313: return (Depot*)GetItemFromPool(&_depot_pool, index);
truelight@1313: }
truelight@1313:
truelight@1313: /**
truelight@1313: * Get the current size of the DepotPool
truelight@1313: */
truelight@1313: static inline uint16 GetDepotPoolSize(void)
truelight@1313: {
truelight@1313: return _depot_pool.total_items;
truelight@1313: }
truelight@1313:
tron@1718: static inline bool IsDepotIndex(uint index)
tron@1718: {
tron@1718: return index < GetDepotPoolSize();
tron@1718: }
tron@1718:
truelight@1313: #define FOR_ALL_DEPOTS_FROM(d, start) for (d = GetDepot(start); d != NULL; d = (d->index + 1 < GetDepotPoolSize()) ? GetDepot(d->index + 1) : NULL)
truelight@1313: #define FOR_ALL_DEPOTS(d) FOR_ALL_DEPOTS_FROM(d, 0)
truelight@1313:
truelight@1313: #define MIN_SERVINT_PERCENT 5
truelight@1313: #define MAX_SERVINT_PERCENT 90
truelight@1313: #define MIN_SERVINT_DAYS 30
truelight@1313: #define MAX_SERVINT_DAYS 800
truelight@1313:
Darkvater@1790: /** Get the service interval domain.
Darkvater@1790: * Get the new proposed service interval for the vehicle is indeed, clamped
Darkvater@1790: * within the given bounds. @see MIN_SERVINT_PERCENT ,etc.
Darkvater@1790: * @param index proposed service interval
Darkvater@1790: */
Darkvater@1790: static inline uint16 GetServiceIntervalClamped(uint index)
Darkvater@1790: {
Darkvater@1790: return (_patches.servint_ispercent) ? clamp(index, MIN_SERVINT_PERCENT, MAX_SERVINT_PERCENT) : clamp(index, MIN_SERVINT_DAYS, MAX_SERVINT_DAYS);
Darkvater@1790: }
Darkvater@1790:
truelight@1313: VARDEF TileIndex _last_built_train_depot_tile;
truelight@1313: VARDEF TileIndex _last_built_road_depot_tile;
truelight@1313: VARDEF TileIndex _last_built_aircraft_depot_tile;
truelight@1313: VARDEF TileIndex _last_built_ship_depot_tile;
truelight@1313:
matthijs@1330: /**
matthijs@1330: * Check if a depot really exists.
matthijs@1330: */
tron@1718: static inline bool IsValidDepot(const Depot* depot)
matthijs@1330: {
matthijs@1330: return depot->xy != 0; /* XXX: Replace by INVALID_TILE someday */
matthijs@1330: }
matthijs@1330:
matthijs@1330: /**
matthijs@1330: * Check if a tile is a depot of the given type.
matthijs@1330: */
matthijs@1330: static inline bool IsTileDepotType(TileIndex tile, TransportType type)
matthijs@1330: {
matthijs@1330: switch(type)
matthijs@1330: {
matthijs@1330: case TRANSPORT_RAIL:
tron@2049: return IsTileType(tile, MP_RAILWAY) && (_m[tile].m5 & 0xFC) == 0xC0;
tron@1959:
matthijs@1330: case TRANSPORT_ROAD:
tron@2049: return IsTileType(tile, MP_STREET) && (_m[tile].m5 & 0xF0) == 0x20;
tron@1959:
matthijs@1330: case TRANSPORT_WATER:
tron@2049: return IsTileType(tile, MP_WATER) && (_m[tile].m5 & ~3) == 0x80;
tron@1959:
matthijs@1330: default:
matthijs@1330: assert(0);
matthijs@1330: return false;
matthijs@1330: }
matthijs@1330: }
matthijs@1330:
matthijs@1650: /**
matthijs@1650: * Returns the direction the exit of the depot on the given tile is facing.
matthijs@1650: */
matthijs@1942: static inline DiagDirection GetDepotDirection(TileIndex tile, TransportType type)
matthijs@1650: {
matthijs@1650: assert(IsTileDepotType(tile, type));
matthijs@1650:
matthijs@1650: switch (type)
matthijs@1650: {
matthijs@1650: case TRANSPORT_RAIL:
matthijs@1650: case TRANSPORT_ROAD:
matthijs@1650: /* Rail and road store a diagonal direction in bits 0 and 1 */
tron@2493: return (DiagDirection)GB(_m[tile].m5, 0, 2);
matthijs@1650: case TRANSPORT_WATER:
matthijs@1650: /* Water is stubborn, it stores the directions in a different order. */
tron@2493: switch (GB(_m[tile].m5, 0, 2)) {
matthijs@1942: case 0: return DIAGDIR_NE;
matthijs@1942: case 1: return DIAGDIR_SW;
matthijs@1942: case 2: return DIAGDIR_NW;
matthijs@1942: case 3: return DIAGDIR_SE;
matthijs@1650: }
matthijs@1650: default:
matthijs@1942: return INVALID_DIAGDIR; /* Not reached */
matthijs@1650: }
matthijs@1650: }
matthijs@1650:
celestar@2085: /**
celestar@2085: Find out if the slope of the tile is suitable to build a depot of given direction
celestar@2085: @param direction The direction in which the depot's exit points. Starts with 0 as NE and goes Clockwise
celestar@2085: @param tileh The slope of the tile in question
celestar@2085: @return true if the construction is possible
celestar@2085:
celestar@2085:
celestar@2085: This is checked by the ugly 0x4C >> direction magic, which does the following:
celestar@2085: 0x4C is 0100 1100 and tileh has only bits 0..3 set (steep tiles are ruled out)
celestar@2085: So: for direction (only the significant bits are shown)
celestar@2085: 00 (exit towards NE) we need either bit 2 or 3 set in tileh: 0x4C >> 0 = 1100
celestar@2085: 01 (exit towards SE) we need either bit 1 or 2 set in tileh: 0x4C >> 1 = 0110
celestar@2085: 02 (exit towards SW) we need either bit 0 or 1 set in tileh: 0x4C >> 2 = 0011
celestar@2085: 03 (exit towards NW) we need either bit 0 or 4 set in tileh: 0x4C >> 3 = 1001
celestar@2085: So ((0x4C >> p2) & tileh) determines whether the depot can be built on the current tileh
celestar@2085: */
celestar@2085: static inline bool CanBuildDepotByTileh(uint32 direction, uint tileh)
celestar@2085: {
celestar@2085: return (0x4C >> direction) & tileh;
celestar@2085: }
celestar@2085:
celestar@2085:
tron@1977: Depot *GetDepotByTile(TileIndex tile);
truelight@1313: void InitializeDepot(void);
truelight@1313: Depot *AllocateDepot(void);
tron@1977: void DoDeleteDepot(TileIndex tile);
truelight@1313:
truelight@1313: #endif /* DEPOT_H */