Files
@ r16193:3bdec9156497
Branch filter:
Location: cpp/openttd-patchpack/source/src/base_station_base.h - annotation
r16193:3bdec9156497
8.2 KiB
text/x-c
(svn r20903) -Update from WebTranslator v3.0:
catalan - 2 changes by arnau
croatian - 2 changes by VoyagerOne
dutch - 2 changes by habell
finnish - 4 changes by jpx_
french - 2 changes by glx
german - 2 changes by planetmaker
ido - 34 changes by Edwardo
marathi - 40 changes by jcravi
polish - 2 changes by voythas
russian - 2 changes by Lone_Wolf
serbian - 2 changes by etran
spanish - 2 changes by Terkhen
catalan - 2 changes by arnau
croatian - 2 changes by VoyagerOne
dutch - 2 changes by habell
finnish - 4 changes by jpx_
french - 2 changes by glx
german - 2 changes by planetmaker
ido - 34 changes by Edwardo
marathi - 40 changes by jcravi
polish - 2 changes by voythas
russian - 2 changes by Lone_Wolf
serbian - 2 changes by etran
spanish - 2 changes by Terkhen
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | r12467:b4ba97896a21 r12467:b4ba97896a21 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r14737:40252806a75b r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r14737:40252806a75b r14752:ebcf936bf2ae r12515:abd5af2c2638 r14753:66a6d88d47ea r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r14736:e919fd200318 r12515:abd5af2c2638 r12515:abd5af2c2638 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12515:abd5af2c2638 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12498:1d729aa61006 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12493:6da69ce1ff42 r12498:1d729aa61006 r12493:6da69ce1ff42 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r12487:7b0d87481daf r13004:7de4c6068404 r13004:7de4c6068404 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r13806:2bc44cc74256 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 r12467:b4ba97896a21 | /* $Id$ */
/*
* 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/>.
*/
/** @file base_station_base.h Base classes/functions for base stations. */
#ifndef BASE_STATION_BASE_H
#define BASE_STATION_BASE_H
#include "core/pool_type.hpp"
#include "command_type.h"
#include "viewport_type.h"
#include "station_map.h"
typedef Pool<BaseStation, StationID, 32, 64000> StationPool;
extern StationPool _station_pool;
struct StationSpecList {
const StationSpec *spec;
uint32 grfid; ///< GRF ID of this custom station
uint8 localidx; ///< Station ID within GRF of station
};
/** StationRect - used to track station spread out rectangle - cheaper than scanning whole map */
struct StationRect : public Rect {
enum StationRectMode
{
ADD_TEST = 0,
ADD_TRY,
ADD_FORCE
};
StationRect();
void MakeEmpty();
bool PtInExtendedRect(int x, int y, int distance = 0) const;
bool IsEmpty() const;
CommandCost BeforeAddTile(TileIndex tile, StationRectMode mode);
CommandCost BeforeAddRect(TileIndex tile, int w, int h, StationRectMode mode);
bool AfterRemoveTile(BaseStation *st, TileIndex tile);
bool AfterRemoveRect(BaseStation *st, TileArea ta);
static bool ScanForStationTiles(StationID st_id, int left_a, int top_a, int right_a, int bottom_a);
StationRect& operator = (const Rect &src);
};
/** Base class for all station-ish types */
struct BaseStation : StationPool::PoolItem<&_station_pool> {
TileIndex xy; ///< Base tile of the station
ViewportSign sign; ///< NOSAVE: Dimensions of sign
byte delete_ctr; ///< Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is deleted.
char *name; ///< Custom name
StringID string_id; ///< Default name (town area) of station
Town *town; ///< The town this station is associated with
OwnerByte owner; ///< The owner of this station
StationFacilityByte facilities; ///< The facilities that this station has
uint8 num_specs; ///< Number of specs in the speclist
StationSpecList *speclist; ///< List of station specs of this station
Date build_date; ///< Date of construction
uint16 random_bits; ///< Random bits assigned to this station
byte waiting_triggers; ///< Waiting triggers (NewGRF) for this station
uint8 cached_anim_triggers; ///< NOSAVE: Combined animation trigger bitmask, used to determine if trigger processing should happen.
TileArea train_station; ///< Tile area the train 'station' part covers
StationRect rect; ///< NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions
/**
* Initialize the base station.
* @param tile The location of the station sign
*/
BaseStation(TileIndex tile) :
xy(tile),
train_station(INVALID_TILE, 0, 0)
{
}
virtual ~BaseStation();
/**
* Check whether a specific tile belongs to this station.
* @param tile the tile to check
* @return true if the tile belongs to this station
*/
virtual bool TileBelongsToRailStation(TileIndex tile) const = 0;
/**
* Helper function to get a NewGRF variable that isn't implemented by the base class.
* @param object the resolver object related to this query
* @param variable that is queried
* @param parameter parameter for that variable
* @param available will return false if ever the variable asked for does not exist
* @return the value stored in the corresponding variable
*/
virtual uint32 GetNewGRFVariable(const struct ResolverObject *object, byte variable, byte parameter, bool *available) const = 0;
/**
* Update the coordinated of the sign (as shown in the viewport).
*/
virtual void UpdateVirtCoord() = 0;
/**
* Get the tile area for a given station type.
* @param ta tile area to fill.
* @param type the type of the area
*/
virtual void GetTileArea(TileArea *ta, StationType type) const = 0;
/**
* Obtain the length of a platform
* @pre tile must be a rail station tile
* @param tile A tile that contains the platform in question
* @return The length of the platform
*/
virtual uint GetPlatformLength(TileIndex tile) const = 0;
/**
* Determines the REMAINING length of a platform, starting at (and including)
* the given tile.
* @param tile the tile from which to start searching. Must be a rail station tile
* @param dir The direction in which to search.
* @return The platform length
*/
virtual uint GetPlatformLength(TileIndex tile, DiagDirection dir) const = 0;
/**
* Get the base station belonging to a specific tile.
* @param tile The tile to get the base station from.
* @return the station associated with that tile.
*/
static FORCEINLINE BaseStation *GetByTile(TileIndex tile)
{
return BaseStation::Get(GetStationIndex(tile));
}
/**
* Check whether the base station currently is in use; in use means
* that it is not scheduled for deletion and that it still has some
* facilities left.
* @return true if still in use
*/
FORCEINLINE bool IsInUse() const
{
return (this->facilities & ~FACIL_WAYPOINT) != 0;
}
static void PostDestructor(size_t index);
};
#define FOR_ALL_BASE_STATIONS(var) FOR_ALL_ITEMS_FROM(BaseStation, station_index, var, 0)
/**
* Class defining several overloaded accessors so we don't
* have to cast base stations that often
*/
template <class T, bool Tis_waypoint>
struct SpecializedStation : public BaseStation {
static const StationFacility EXPECTED_FACIL = Tis_waypoint ? FACIL_WAYPOINT : FACIL_NONE; ///< Specialized type
/**
* Set station type correctly
* @param tile The base tile of the station.
*/
FORCEINLINE SpecializedStation<T, Tis_waypoint>(TileIndex tile) :
BaseStation(tile)
{
this->facilities = EXPECTED_FACIL;
}
/**
* Helper for checking whether the given station is of this type.
* @param st the station to check.
* @return true if the station is the type we expect it to be.
*/
static FORCEINLINE bool IsExpected(const BaseStation *st)
{
return (st->facilities & FACIL_WAYPOINT) == EXPECTED_FACIL;
}
/**
* Tests whether given index is a valid index for station of this type
* @param index tested index
* @return is this index valid index of T?
*/
static FORCEINLINE bool IsValidID(size_t index)
{
return BaseStation::IsValidID(index) && IsExpected(BaseStation::Get(index));
}
/**
* Gets station with given index
* @return pointer to station with given index casted to T *
*/
static FORCEINLINE T *Get(size_t index)
{
return (T *)BaseStation::Get(index);
}
/**
* Returns station if the index is a valid index for this station type
* @return pointer to station with given index if it's a station of this type
*/
static FORCEINLINE T *GetIfValid(size_t index)
{
return IsValidID(index) ? Get(index) : NULL;
}
/**
* Get the station belonging to a specific tile.
* @param tile The tile to get the station from.
* @return the station associated with that tile.
*/
static FORCEINLINE T *GetByTile(TileIndex tile)
{
return GetIfValid(GetStationIndex(tile));
}
/**
* Converts a BaseStation to SpecializedStation with type checking.
* @param st BaseStation pointer
* @return pointer to SpecializedStation
*/
static FORCEINLINE T *From(BaseStation *st)
{
assert(IsExpected(st));
return (T *)st;
}
/**
* Converts a const BaseStation to const SpecializedStation with type checking.
* @param st BaseStation pointer
* @return pointer to SpecializedStation
*/
static FORCEINLINE const T *From(const BaseStation *st)
{
assert(IsExpected(st));
return (const T *)st;
}
};
#define FOR_ALL_BASE_STATIONS_OF_TYPE(name, var) FOR_ALL_ITEMS_FROM(name, station_index, var, 0) if (name::IsExpected(var))
#endif /* STATION_BASE_H */
|