src/newgrf_station.cpp

   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 newgrf_station.cpp Functions for dealing with station classes and custom stations. */
  11
  12 #include "stdafx.h"
  13 #include "debug.h"
  14 #include "station_base.h"
  15 #include "waypoint_base.h"
  16 #include "roadstop_base.h"
  17 #include "newgrf_cargo.h"
  18 #include "newgrf_station.h"
  19 #include "newgrf_spritegroup.h"
  20 #include "newgrf_sound.h"
  21 #include "newgrf_railtype.h"
  22 #include "town.h"
  23 #include "newgrf_town.h"
  24 #include "company_func.h"
  25 #include "tunnelbridge_map.h"
  26 #include "newgrf_animation_base.h"
  27 #include "newgrf_class_func.h"
  28
  29 #include "safeguards.h"
  30
  31
  32 template <typename Tspec, typename Tid, Tid Tmax>
  33 /* static */ void NewGRFClass<Tspec, Tid, Tmax>::InsertDefaults()
  34 {
  35         /* Set up initial data */
  36         classes[0].global_id = 'DFLT';
  37         classes[0].name = STR_STATION_CLASS_DFLT;
  38         classes[0].Insert(NULL);
  39
  40         classes[1].global_id = 'WAYP';
  41         classes[1].name = STR_STATION_CLASS_WAYP;
  42         classes[1].Insert(NULL);
  43 }
  44
  45 template <typename Tspec, typename Tid, Tid Tmax>
  46 bool NewGRFClass<Tspec, Tid, Tmax>::IsUIAvailable(uint index) const
  47 {
  48         return true;
  49 }
  50
  51 INSTANTIATE_NEWGRF_CLASS_METHODS(StationClass, StationSpec, StationClassID, STAT_CLASS_MAX)
  52
  53 static const uint NUM_STATIONSSPECS_PER_STATION = 255; ///< Maximum number of parts per station.
  54
  55 enum TriggerArea {
  56         TA_TILE,
  57         TA_PLATFORM,
  58         TA_WHOLE,
  59 };
  60
  61 struct ETileArea : TileArea {
  62         ETileArea(const BaseStation *st, TileIndex tile, TriggerArea ta)
  63         {
  64                 switch (ta) {
  65                         default: NOT_REACHED();
  66
  67                         case TA_TILE:
  68                                 this->tile = tile;
  69                                 this->w    = 1;
  70                                 this->h    = 1;
  71                                 break;
  72
  73                         case TA_PLATFORM: {
  74                                 TileIndex start, end;
  75                                 Axis axis = GetRailStationAxis(tile);
  76                                 TileIndexDiff delta = TileOffsByDiagDir(AxisToDiagDir(axis));
  77
  78                                 for (end = tile; IsRailStationTile(end + delta) && IsCompatibleTrainStationTile(end + delta, tile); end += delta) { /* Nothing */ }
  79                                 for (start = tile; IsRailStationTile(start - delta) && IsCompatibleTrainStationTile(start - delta, tile); start -= delta) { /* Nothing */ }
  80
  81                                 this->tile = start;
  82                                 this->w = TileX(end) - TileX(start) + 1;
  83                                 this->h = TileY(end) - TileY(start) + 1;
  84                                 break;
  85                         }
  86
  87                         case TA_WHOLE:
  88                                 st->GetTileArea(this, Station::IsExpected(st) ? STATION_RAIL : STATION_WAYPOINT);
  89                                 break;
  90                 }
  91         }
  92 };
  93
  94
  95 /**
  96  * Evaluate a tile's position within a station, and return the result in a bit-stuffed format.
  97  * if not centered: .TNLcCpP, if centered: .TNL..CP
  98  * - T = Tile layout number (#GetStationGfx)
  99  * - N = Number of platforms
 100  * - L = Length of platforms
 101  * - C = Current platform number from start, c = from end
 102  * - P = Position along platform from start, p = from end
 103  * .
 104  * if centered, C/P start from the centre and c/p are not available.
 105  * @return Platform information in bit-stuffed format.
 106  */
 107 uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred)
 108 {
 109         uint32 retval = 0;
 110
 111         if (axis == AXIS_X) {
 112                 Swap(platforms, length);
 113                 Swap(x, y);
 114         }
 115
 116         if (centred) {
 117                 x -= platforms / 2;
 118                 y -= length / 2;
 119                 x = Clamp(x, -8, 7);
 120                 y = Clamp(y, -8, 7);
 121                 SB(retval,  0, 4, y & 0xF);
 122                 SB(retval,  4, 4, x & 0xF);
 123         } else {
 124                 SB(retval,  0, 4, min(15, y));
 125                 SB(retval,  4, 4, min(15, length - y - 1));
 126                 SB(retval,  8, 4, min(15, x));
 127                 SB(retval, 12, 4, min(15, platforms - x - 1));
 128         }
 129         SB(retval, 16, 4, min(15, length));
 130         SB(retval, 20, 4, min(15, platforms));
 131         SB(retval, 24, 4, tile);
 132
 133         return retval;
 134 }
 135
 136
 137 /**
 138  * Find the end of a railway station, from the \a tile, in the direction of \a delta.
 139  * @param tile Start tile.
 140  * @param delta Movement direction.
 141  * @param check_type Stop when the custom station type changes.
 142  * @param check_axis Stop when the station direction changes.
 143  * @return Found end of the railway station.
 144  */
 145 static TileIndex FindRailStationEnd(TileIndex tile, TileIndexDiff delta, bool check_type, bool check_axis)
 146 {
 147         byte orig_type = 0;
 148         Axis orig_axis = AXIS_X;
 149         StationID sid = GetStationIndex(tile);
 150
 151         if (check_type) orig_type = GetCustomStationSpecIndex(tile);
 152         if (check_axis) orig_axis = GetRailStationAxis(tile);
 153
 154         for (;;) {
 155                 TileIndex new_tile = TILE_ADD(tile, delta);
 156
 157                 if (!IsTileType(new_tile, MP_STATION) || GetStationIndex(new_tile) != sid) break;
 158                 if (!HasStationRail(new_tile)) break;
 159                 if (check_type && GetCustomStationSpecIndex(new_tile) != orig_type) break;
 160                 if (check_axis && GetRailStationAxis(new_tile) != orig_axis) break;
 161
 162                 tile = new_tile;
 163         }
 164         return tile;
 165 }
 166
 167
 168 static uint32 GetPlatformInfoHelper(TileIndex tile, bool check_type, bool check_axis, bool centred)
 169 {
 170         int tx = TileX(tile);
 171         int ty = TileY(tile);
 172         int sx = TileX(FindRailStationEnd(tile, TileDiffXY(-1,  0), check_type, check_axis));
 173         int sy = TileY(FindRailStationEnd(tile, TileDiffXY( 0, -1), check_type, check_axis));
 174         int ex = TileX(FindRailStationEnd(tile, TileDiffXY( 1,  0), check_type, check_axis)) + 1;
 175         int ey = TileY(FindRailStationEnd(tile, TileDiffXY( 0,  1), check_type, check_axis)) + 1;
 176
 177         tx -= sx; ex -= sx;
 178         ty -= sy; ey -= sy;
 179
 180         return GetPlatformInfo(GetRailStationAxis(tile), GetStationGfx(tile), ex, ey, tx, ty, centred);
 181 }
 182
 183
 184 static uint32 GetRailContinuationInfo(TileIndex tile)
 185 {
 186         /* Tile offsets and exit dirs for X axis */
 187         static const Direction x_dir[8] = { DIR_SW, DIR_NE, DIR_SE, DIR_NW, DIR_S, DIR_E, DIR_W, DIR_N };
 188         static const DiagDirection x_exits[8] = { DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SW, DIAGDIR_NE };
 189
 190         /* Tile offsets and exit dirs for Y axis */
 191         static const Direction y_dir[8] = { DIR_SE, DIR_NW, DIR_SW, DIR_NE, DIR_S, DIR_W, DIR_E, DIR_N };
 192         static const DiagDirection y_exits[8] = { DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SE, DIAGDIR_NW };
 193
 194         Axis axis = GetRailStationAxis(tile);
 195
 196         /* Choose appropriate lookup table to use */
 197         const Direction *dir = axis == AXIS_X ? x_dir : y_dir;
 198         const DiagDirection *diagdir = axis == AXIS_X ? x_exits : y_exits;
 199
 200         uint32 res = 0;
 201         uint i;
 202
 203         for (i = 0; i < lengthof(x_dir); i++, dir++, diagdir++) {
 204                 TileIndex neighbour_tile = tile + TileOffsByDir(*dir);
 205                 TrackBits trackbits = TrackStatusToTrackBits(GetTileTrackStatus(neighbour_tile, TRANSPORT_RAIL, 0));
 206                 if (trackbits != TRACK_BIT_NONE) {
 207                         /* If there is any track on the tile, set the bit in the second byte */
 208                         SetBit(res, i + 8);
 209
 210                         /* With tunnels and bridges the tile has tracks, but they are not necessarily connected
 211                          * with the next tile because the ramp is not going in the right direction. */
 212                         if (IsTileType(neighbour_tile, MP_TUNNELBRIDGE) && GetTunnelBridgeDirection(neighbour_tile) != *diagdir) {
 213                                 continue;
 214                         }
 215
 216                         /* If any track reaches our exit direction, set the bit in the lower byte */
 217                         if (trackbits & DiagdirReachesTracks(*diagdir)) SetBit(res, i);
 218                 }
 219         }
 220
 221         return res;
 222 }
 223
 224
 225 /* Station Resolver Functions */
 226 /* virtual */ uint32 StationScopeResolver::GetRandomBits() const
 227 {
 228         return (this->st == NULL ? 0 : this->st->random_bits) | (this->tile == INVALID_TILE ? 0 : GetStationTileRandomBits(this->tile) << 16);
 229 }
 230
 231
 232 /* virtual */ uint32 StationScopeResolver::GetTriggers() const
 233 {
 234         return this->st == NULL ? 0 : this->st->waiting_triggers;
 235 }
 236
 237
 238 /**
 239  * Station variable cache
 240  * This caches 'expensive' station variable lookups which iterate over
 241  * several tiles that may be called multiple times per Resolve().
 242  */
 243 static struct {
 244         uint32 v40;
 245         uint32 v41;
 246         uint32 v45;
 247         uint32 v46;
 248         uint32 v47;
 249         uint32 v49;
 250         uint8 valid; ///< Bits indicating what variable is valid (for each bit, \c 0 is invalid, \c 1 is valid).
 251 } _svc;
 252
 253 /**
 254  * Get the town scope associated with a station, if it exists.
 255  * On the first call, the town scope is created (if possible).
 256  * @return Town scope, if available.
 257  */
 258 TownScopeResolver *StationResolverObject::GetTown()
 259 {
 260         if (this->town_scope == NULL) {
 261                 Town *t = NULL;
 262                 if (this->station_scope.st != NULL) {
 263                         t = this->station_scope.st->town;
 264                 } else if (this->station_scope.tile != INVALID_TILE) {
 265                         t = ClosestTownFromTile(this->station_scope.tile, UINT_MAX);
 266                 }
 267                 if (t == NULL) return NULL;
 268                 this->town_scope = new TownScopeResolver(*this, t, this->station_scope.st == NULL);
 269         }
 270         return this->town_scope;
 271 }
 272
 273 /* virtual */ uint32 StationScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
 274 {
 275         if (this->st == NULL) {
 276                 /* Station does not exist, so we're in a purchase list or the land slope check callback. */
 277                 switch (variable) {
 278                         case 0x40:
 279                         case 0x41:
 280                         case 0x46:
 281                         case 0x47:
 282                         case 0x49: return 0x2110000;        // Platforms, tracks & position
 283                         case 0x42: return 0;                // Rail type (XXX Get current type from GUI?)
 284                         case 0x43: return GetCompanyInfo(_current_company); // Station owner
 285                         case 0x44: return 2;                // PBS status
 286                         case 0x67: // Land info of nearby tile
 287                                 if (this->axis != INVALID_AXIS && this->tile != INVALID_TILE) {
 288                                         TileIndex tile = this->tile;
 289                                         if (parameter != 0) tile = GetNearbyTile(parameter, tile, true, this->axis); // only perform if it is required
 290
 291                                         Slope tileh = GetTileSlope(tile);
 292                                         bool swap = (this->axis == AXIS_Y && HasBit(tileh, CORNER_W) != HasBit(tileh, CORNER_E));
 293
 294                                         return GetNearbyTileInformation(tile, this->ro.grffile->grf_version >= 8) ^ (swap ? SLOPE_EW : 0);
 295                                 }
 296                                 break;
 297
 298                         case 0xFA: return Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Build date, clamped to a 16 bit value
 299                 }
 300
 301                 *available = false;
 302                 return UINT_MAX;
 303         }
 304
 305         switch (variable) {
 306                 /* Calculated station variables */
 307                 case 0x40:
 308                         if (!HasBit(_svc.valid, 0)) { _svc.v40 = GetPlatformInfoHelper(this->tile, false, false, false); SetBit(_svc.valid, 0); }
 309                         return _svc.v40;
 310
 311                 case 0x41:
 312                         if (!HasBit(_svc.valid, 1)) { _svc.v41 = GetPlatformInfoHelper(this->tile, true,  false, false); SetBit(_svc.valid, 1); }
 313                         return _svc.v41;
 314
 315                 case 0x42: return GetTerrainType(this->tile) | (GetReverseRailTypeTranslation(GetRailType(this->tile), this->statspec->grf_prop.grffile) << 8);
 316                 case 0x43: return GetCompanyInfo(this->st->owner); // Station owner
 317                 case 0x44: return HasStationReservation(this->tile) ? 7 : 4; // PBS status
 318                 case 0x45:
 319                         if (!HasBit(_svc.valid, 2)) { _svc.v45 = GetRailContinuationInfo(this->tile); SetBit(_svc.valid, 2); }
 320                         return _svc.v45;
 321
 322                 case 0x46:
 323                         if (!HasBit(_svc.valid, 3)) { _svc.v46 = GetPlatformInfoHelper(this->tile, false, false, true); SetBit(_svc.valid, 3); }
 324                         return _svc.v46;
 325
 326                 case 0x47:
 327                         if (!HasBit(_svc.valid, 4)) { _svc.v47 = GetPlatformInfoHelper(this->tile, true,  false, true); SetBit(_svc.valid, 4); }
 328                         return _svc.v47;
 329
 330                 case 0x49:
 331                         if (!HasBit(_svc.valid, 5)) { _svc.v49 = GetPlatformInfoHelper(this->tile, false, true, false); SetBit(_svc.valid, 5); }
 332                         return _svc.v49;
 333
 334                 case 0x4A: // Animation frame of tile
 335                         return GetAnimationFrame(this->tile);
 336
 337                 /* Variables which use the parameter */
 338                 /* Variables 0x60 to 0x65 and 0x69 are handled separately below */
 339                 case 0x66: { // Animation frame of nearby tile
 340                         TileIndex tile = this->tile;
 341                         if (parameter != 0) tile = GetNearbyTile(parameter, tile);
 342                         return this->st->TileBelongsToRailStation(tile) ? GetAnimationFrame(tile) : UINT_MAX;
 343                 }
 344
 345                 case 0x67: { // Land info of nearby tile
 346                         Axis axis = GetRailStationAxis(this->tile);
 347                         TileIndex tile = this->tile;
 348                         if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required
 349
 350                         Slope tileh = GetTileSlope(tile);
 351                         bool swap = (axis == AXIS_Y && HasBit(tileh, CORNER_W) != HasBit(tileh, CORNER_E));
 352
 353                         return GetNearbyTileInformation(tile, this->ro.grffile->grf_version >= 8) ^ (swap ? SLOPE_EW : 0);
 354                 }
 355
 356                 case 0x68: { // Station info of nearby tiles
 357                         TileIndex nearby_tile = GetNearbyTile(parameter, this->tile);
 358
 359                         if (!HasStationTileRail(nearby_tile)) return 0xFFFFFFFF;
 360
 361                         uint32 grfid = this->st->speclist[GetCustomStationSpecIndex(this->tile)].grfid;
 362                         bool perpendicular = GetRailStationAxis(this->tile) != GetRailStationAxis(nearby_tile);
 363                         bool same_station = this->st->TileBelongsToRailStation(nearby_tile);
 364                         uint32 res = GB(GetStationGfx(nearby_tile), 1, 2) << 12 | !!perpendicular << 11 | !!same_station << 10;
 365
 366                         if (IsCustomStationSpecIndex(nearby_tile)) {
 367                                 const StationSpecList ssl = BaseStation::GetByTile(nearby_tile)->speclist[GetCustomStationSpecIndex(nearby_tile)];
 368                                 res |= 1 << (ssl.grfid != grfid ? 9 : 8) | ssl.localidx;
 369                         }
 370                         return res;
 371                 }
 372
 373                 /* General station variables */
 374                 case 0x82: return 50;
 375                 case 0x84: return this->st->string_id;
 376                 case 0x86: return 0;
 377                 case 0xF0: return this->st->facilities;
 378                 case 0xFA: return Clamp(this->st->build_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535);
 379         }
 380
 381         return this->st->GetNewGRFVariable(this->ro, variable, parameter, available);
 382 }
 383
 384 uint32 Station::GetNewGRFVariable(const ResolverObject &object, byte variable, byte parameter, bool *available) const
 385 {
 386         switch (variable) {
 387                 case 0x48: { // Accepted cargo types
 388                         CargoID cargo_type;
 389                         uint32 value = 0;
 390
 391                         for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
 392                                 if (HasBit(this->goods[cargo_type].status, GoodsEntry::GES_ACCEPTANCE)) SetBit(value, cargo_type);
 393                         }
 394                         return value;
 395                 }
 396
 397                 case 0x8A: return this->had_vehicle_of_type;
 398                 case 0xF1: return (this->airport.tile != INVALID_TILE) ? this->airport.GetSpec()->ttd_airport_type : ATP_TTDP_LARGE;
 399                 case 0xF2: return (this->truck_stops != NULL) ? this->truck_stops->status : 0;
 400                 case 0xF3: return (this->bus_stops != NULL)   ? this->bus_stops->status   : 0;
 401                 case 0xF6: return this->airport.flags;
 402                 case 0xF7: return GB(this->airport.flags, 8, 8);
 403         }
 404
 405         /* Handle cargo variables with parameter, 0x60 to 0x65 and 0x69 */
 406         if ((variable >= 0x60 && variable <= 0x65) || variable == 0x69) {
 407                 CargoID c = GetCargoTranslation(parameter, object.grffile);
 408
 409                 if (c == CT_INVALID) {
 410                         switch (variable) {
 411                                 case 0x62: return 0xFFFFFFFF;
 412                                 case 0x64: return 0xFF00;
 413                                 default:   return 0;
 414                         }
 415                 }
 416                 const GoodsEntry *ge = &this->goods[c];
 417
 418                 switch (variable) {
 419                         case 0x60: return min(ge->cargo.TotalCount(), 4095);
 420                         case 0x61: return ge->HasVehicleEverTriedLoading() ? ge->time_since_pickup : 0;
 421                         case 0x62: return ge->HasRating() ? ge->rating : 0xFFFFFFFF;
 422                         case 0x63: return ge->cargo.DaysInTransit();
 423                         case 0x64: return ge->HasVehicleEverTriedLoading() ? ge->last_speed | (ge->last_age << 8) : 0xFF00;
 424                         case 0x65: return GB(ge->status, GoodsEntry::GES_ACCEPTANCE, 1) << 3;
 425                         case 0x69: {
 426                                 assert_compile((int)GoodsEntry::GES_EVER_ACCEPTED + 1 == (int)GoodsEntry::GES_LAST_MONTH);
 427                                 assert_compile((int)GoodsEntry::GES_EVER_ACCEPTED + 2 == (int)GoodsEntry::GES_CURRENT_MONTH);
 428                                 assert_compile((int)GoodsEntry::GES_EVER_ACCEPTED + 3 == (int)GoodsEntry::GES_ACCEPTED_BIGTICK);
 429                                 return GB(ge->status, GoodsEntry::GES_EVER_ACCEPTED, 4);
 430                         }
 431                 }
 432         }
 433
 434         /* Handle cargo variables (deprecated) */
 435         if (variable >= 0x8C && variable <= 0xEC) {
 436                 const GoodsEntry *g = &this->goods[GB(variable - 0x8C, 3, 4)];
 437                 switch (GB(variable - 0x8C, 0, 3)) {
 438                         case 0: return g->cargo.TotalCount();
 439                         case 1: return GB(min(g->cargo.TotalCount(), 4095), 0, 4) | (GB(g->status, GoodsEntry::GES_ACCEPTANCE, 1) << 7);
 440                         case 2: return g->time_since_pickup;
 441                         case 3: return g->rating;
 442                         case 4: return g->cargo.Source();
 443                         case 5: return g->cargo.DaysInTransit();
 444                         case 6: return g->last_speed;
 445                         case 7: return g->last_age;
 446                 }
 447         }
 448
 449         DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
 450
 451         *available = false;
 452         return UINT_MAX;
 453 }
 454
 455 uint32 Waypoint::GetNewGRFVariable(const ResolverObject &object, byte variable, byte parameter, bool *available) const
 456 {
 457         switch (variable) {
 458                 case 0x48: return 0; // Accepted cargo types
 459                 case 0x8A: return HVOT_WAYPOINT;
 460                 case 0xF1: return 0; // airport type
 461                 case 0xF2: return 0; // truck stop status
 462                 case 0xF3: return 0; // bus stop status
 463                 case 0xF6: return 0; // airport flags
 464                 case 0xF7: return 0; // airport flags cont.
 465         }
 466
 467         /* Handle cargo variables with parameter, 0x60 to 0x65 */
 468         if (variable >= 0x60 && variable <= 0x65) {
 469                 return 0;
 470         }
 471
 472         /* Handle cargo variables (deprecated) */
 473         if (variable >= 0x8C && variable <= 0xEC) {
 474                 switch (GB(variable - 0x8C, 0, 3)) {
 475                         case 3: return INITIAL_STATION_RATING;
 476                         case 4: return INVALID_STATION;
 477                         default: return 0;
 478                 }
 479         }
 480
 481         DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
 482
 483         *available = false;
 484         return UINT_MAX;
 485 }
 486
 487 /* virtual */ const SpriteGroup *StationResolverObject::ResolveReal(const RealSpriteGroup *group) const
 488 {
 489         if (this->station_scope.st == NULL || this->station_scope.statspec->cls_id == STAT_CLASS_WAYP) {
 490                 return group->loading[0];
 491         }
 492
 493         uint cargo = 0;
 494         const Station *st = Station::From(this->station_scope.st);
 495
 496         switch (this->station_scope.cargo_type) {
 497                 case CT_INVALID:
 498                 case CT_DEFAULT_NA:
 499                 case CT_PURCHASE:
 500                         cargo = 0;
 501                         break;
 502
 503                 case CT_DEFAULT:
 504                         for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
 505                                 cargo += st->goods[cargo_type].cargo.TotalCount();
 506                         }
 507                         break;
 508
 509                 default:
 510                         cargo = st->goods[this->station_scope.cargo_type].cargo.TotalCount();
 511                         break;
 512         }
 513
 514         if (HasBit(this->station_scope.statspec->flags, SSF_DIV_BY_STATION_SIZE)) cargo /= (st->train_station.w + st->train_station.h);
 515         cargo = min(0xfff, cargo);
 516
 517         if (cargo > this->station_scope.statspec->cargo_threshold) {
 518                 if (group->num_loading > 0) {
 519                         uint set = ((cargo - this->station_scope.statspec->cargo_threshold) * group->num_loading) / (4096 - this->station_scope.statspec->cargo_threshold);
 520                         return group->loading[set];
 521                 }
 522         } else {
 523                 if (group->num_loaded > 0) {
 524                         uint set = (cargo * group->num_loaded) / (this->station_scope.statspec->cargo_threshold + 1);
 525                         return group->loaded[set];
 526                 }
 527         }
 528
 529         return group->loading[0];
 530 }
 531
 532 /**
 533  * Resolver for stations.
 534  * @param statspec Station (type) specification.
 535  * @param st Instance of the station.
 536  * @param tile %Tile of the station.
 537  * @param callback Callback ID.
 538  * @param callback_param1 First parameter (var 10) of the callback.
 539  * @param callback_param2 Second parameter (var 18) of the callback.
 540  */
 541 StationResolverObject::StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile,
 542                 CallbackID callback, uint32 callback_param1, uint32 callback_param2)
 543         : ResolverObject(statspec->grf_prop.grffile, callback, callback_param1, callback_param2),
 544         station_scope(*this, statspec, st, tile), town_scope(NULL)
 545 {
 546         /* Invalidate all cached vars */
 547         _svc.valid = 0;
 548
 549         CargoID ctype = CT_DEFAULT_NA;
 550
 551         if (this->station_scope.st == NULL) {
 552                 /* No station, so we are in a purchase list */
 553                 ctype = CT_PURCHASE;
 554         } else if (Station::IsExpected(this->station_scope.st)) {
 555                 const Station *st = Station::From(this->station_scope.st);
 556                 /* Pick the first cargo that we have waiting */
 557                 const CargoSpec *cs;
 558                 FOR_ALL_CARGOSPECS(cs) {
 559                         if (this->station_scope.statspec->grf_prop.spritegroup[cs->Index()] != NULL &&
 560                                         st->goods[cs->Index()].cargo.TotalCount() > 0) {
 561                                 ctype = cs->Index();
 562                                 break;
 563                         }
 564                 }
 565         }
 566
 567         if (this->station_scope.statspec->grf_prop.spritegroup[ctype] == NULL) {
 568                 ctype = CT_DEFAULT;
 569         }
 570
 571         /* Remember the cargo type we've picked */
 572         this->station_scope.cargo_type = ctype;
 573         this->root_spritegroup = this->station_scope.statspec->grf_prop.spritegroup[this->station_scope.cargo_type];
 574 }
 575
 576 StationResolverObject::~StationResolverObject()
 577 {
 578         delete this->town_scope;
 579 }
 580
 581 /**
 582  * Resolve sprites for drawing a station tile.
 583  * @param statspec Station spec
 584  * @param st Station (NULL in GUI)
 585  * @param tile Station tile being drawn (INVALID_TILE in GUI)
 586  * @param var10 Value to put in variable 10; normally 0; 1 when resolving the groundsprite and SSF_SEPARATE_GROUND is set.
 587  * @return First sprite of the Action 1 spriteset to use, minus an offset of 0x42D to accommodate for weird NewGRF specs.
 588  */
 589 SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32 var10)
 590 {
 591         StationResolverObject object(statspec, st, tile, CBID_NO_CALLBACK, var10);
 592         const SpriteGroup *group = object.Resolve();
 593         if (group == NULL || group->type != SGT_RESULT) return 0;
 594         return group->GetResult() - 0x42D;
 595 }
 596
 597 /**
 598  * Resolve the sprites for custom station foundations.
 599  * @param statspec Station spec
 600  * @param st Station
 601  * @param tile Station tile being drawn
 602  * @param layout Spritelayout as returned by previous callback
 603  * @param edge_info Information about northern tile edges; whether they need foundations or merge into adjacent tile's foundations.
 604  * @return First sprite of a set of foundation sprites for various slopes, or 0 if default foundations shall be drawn.
 605  */
 606 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info)
 607 {
 608         /* callback_param1 == 2 means  we are resolving the foundation sprites. */
 609         StationResolverObject object(statspec, st, tile, CBID_NO_CALLBACK, 2, layout | (edge_info << 16));
 610
 611         const SpriteGroup *group = object.Resolve();
 612         if (group == NULL || group->type != SGT_RESULT) return 0;
 613
 614         /* Note: SpriteGroup::Resolve zeroes all registers, so register 0x100 is initialised to 0. (compatibility) */
 615         return group->GetResult() + GetRegister(0x100);
 616 }
 617
 618
 619 uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile)
 620 {
 621         StationResolverObject object(statspec, st, tile, callback, param1, param2);
 622         return object.ResolveCallback();
 623 }
 624
 625 /**
 626  * Check the slope of a tile of a new station.
 627  * @param north_tile Norther tile of the station rect.
 628  * @param cur_tile Tile to check.
 629  * @param statspec Station spec.
 630  * @param axis Axis of the new station.
 631  * @param plat_len Platform length.
 632  * @param numtracks Number of platforms.
 633  * @return Succeeded or failed command.
 634  */
 635 CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte numtracks)
 636 {
 637         TileIndexDiff diff = cur_tile - north_tile;
 638         Slope slope = GetTileSlope(cur_tile);
 639
 640         StationResolverObject object(statspec, NULL, cur_tile, CBID_STATION_LAND_SLOPE_CHECK,
 641                         (slope << 4) | (slope ^ (axis == AXIS_Y && HasBit(slope, CORNER_W) != HasBit(slope, CORNER_E) ? SLOPE_EW : 0)),
 642                         (numtracks << 24) | (plat_len << 16) | (axis == AXIS_Y ? TileX(diff) << 8 | TileY(diff) : TileY(diff) << 8 | TileX(diff)));
 643         object.station_scope.axis = axis;
 644
 645         uint16 cb_res = object.ResolveCallback();
 646
 647         /* Failed callback means success. */
 648         if (cb_res == CALLBACK_FAILED) return CommandCost();
 649
 650         /* The meaning of bit 10 is inverted for a grf version < 8. */
 651         if (statspec->grf_prop.grffile->grf_version < 8) ToggleBit(cb_res, 10);
 652         return GetErrorMessageFromLocationCallbackResult(cb_res, statspec->grf_prop.grffile, STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
 653 }
 654
 655
 656 /**
 657  * Allocate a StationSpec to a Station. This is called once per build operation.
 658  * @param statspec StationSpec to allocate.
 659  * @param st Station to allocate it to.
 660  * @param exec Whether to actually allocate the spec.
 661  * @return Index within the Station's spec list, or -1 if the allocation failed.
 662  */
 663 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec)
 664 {
 665         uint i;
 666
 667         if (statspec == NULL || st == NULL) return 0;
 668
 669         for (i = 1; i < st->num_specs && i < NUM_STATIONSSPECS_PER_STATION; i++) {
 670                 if (st->speclist[i].spec == NULL && st->speclist[i].grfid == 0) break;
 671         }
 672
 673         if (i == NUM_STATIONSSPECS_PER_STATION) {
 674                 /* As final effort when the spec list is already full...
 675                  * try to find the same spec and return that one. This might
 676                  * result in slightly "wrong" (as per specs) looking stations,
 677                  * but it's fairly unlikely that one reaches the limit anyways.
 678                  */
 679                 for (i = 1; i < st->num_specs && i < NUM_STATIONSSPECS_PER_STATION; i++) {
 680                         if (st->speclist[i].spec == statspec) return i;
 681                 }
 682
 683                 return -1;
 684         }
 685
 686         if (exec) {
 687                 if (i >= st->num_specs) {
 688                         st->num_specs = i + 1;
 689                         st->speclist = ReallocT(st->speclist, st->num_specs);
 690
 691                         if (st->num_specs == 2) {
 692                                 /* Initial allocation */
 693                                 st->speclist[0].spec     = NULL;
 694                                 st->speclist[0].grfid    = 0;
 695                                 st->speclist[0].localidx = 0;
 696                         }
 697                 }
 698
 699                 st->speclist[i].spec     = statspec;
 700                 st->speclist[i].grfid    = statspec->grf_prop.grffile->grfid;
 701                 st->speclist[i].localidx = statspec->grf_prop.local_id;
 702
 703                 StationUpdateCachedTriggers(st);
 704         }
 705
 706         return i;
 707 }
 708
 709
 710 /**
 711  * Deallocate a StationSpec from a Station. Called when removing a single station tile.
 712  * @param st Station to work with.
 713  * @param specindex Index of the custom station within the Station's spec list.
 714  * @return Indicates whether the StationSpec was deallocated.
 715  */
 716 void DeallocateSpecFromStation(BaseStation *st, byte specindex)
 717 {
 718         /* specindex of 0 (default) is never freeable */
 719         if (specindex == 0) return;
 720
 721         ETileArea area = ETileArea(st, INVALID_TILE, TA_WHOLE);
 722         /* Check all tiles over the station to check if the specindex is still in use */
 723         TILE_AREA_LOOP(tile, area) {
 724                 if (st->TileBelongsToRailStation(tile) && GetCustomStationSpecIndex(tile) == specindex) {
 725                         return;
 726                 }
 727         }
 728
 729         /* This specindex is no longer in use, so deallocate it */
 730         st->speclist[specindex].spec     = NULL;
 731         st->speclist[specindex].grfid    = 0;
 732         st->speclist[specindex].localidx = 0;
 733
 734         /* If this was the highest spec index, reallocate */
 735         if (specindex == st->num_specs - 1) {
 736                 for (; st->speclist[st->num_specs - 1].grfid == 0 && st->num_specs > 1; st->num_specs--) {}
 737
 738                 if (st->num_specs > 1) {
 739                         st->speclist = ReallocT(st->speclist, st->num_specs);
 740                 } else {
 741                         free(st->speclist);
 742                         st->num_specs = 0;
 743                         st->speclist  = NULL;
 744                         st->cached_anim_triggers = 0;
 745                         st->cached_cargo_triggers = 0;
 746                         return;
 747                 }
 748         }
 749
 750         StationUpdateCachedTriggers(st);
 751 }
 752
 753 /**
 754  * Draw representation of a station tile for GUI purposes.
 755  * @param x Position x of image.
 756  * @param y Position y of image.
 757  * @param axis Axis.
 758  * @param railtype Rail type.
 759  * @param sclass, station Type of station.
 760  * @param station station ID
 761  * @return True if the tile was drawn (allows for fallback to default graphic)
 762  */
 763 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station)
 764 {
 765         const DrawTileSprites *sprites = NULL;
 766         const RailtypeInfo *rti = GetRailTypeInfo(railtype);
 767         PaletteID palette = COMPANY_SPRITE_COLOUR(_local_company);
 768         uint tile = 2;
 769
 770         const StationSpec *statspec = StationClass::Get(sclass)->GetSpec(station);
 771         if (statspec == NULL) return false;
 772
 773         if (HasBit(statspec->callback_mask, CBM_STATION_SPRITE_LAYOUT)) {
 774                 uint16 callback = GetStationCallback(CBID_STATION_SPRITE_LAYOUT, 0x2110000, 0, statspec, NULL, INVALID_TILE);
 775                 if (callback != CALLBACK_FAILED) tile = callback;
 776         }
 777
 778         uint32 total_offset = rti->GetRailtypeSpriteOffset();
 779         uint32 relocation = 0;
 780         uint32 ground_relocation = 0;
 781         const NewGRFSpriteLayout *layout = NULL;
 782         DrawTileSprites tmp_rail_layout;
 783
 784         if (statspec->renderdata == NULL) {
 785                 sprites = GetStationTileLayout(STATION_RAIL, tile + axis);
 786         } else {
 787                 layout = &statspec->renderdata[(tile < statspec->tiles) ? tile + axis : (uint)axis];
 788                 if (!layout->NeedsPreprocessing()) {
 789                         sprites = layout;
 790                         layout = NULL;
 791                 }
 792         }
 793
 794         if (layout != NULL) {
 795                 /* Sprite layout which needs preprocessing */
 796                 bool separate_ground = HasBit(statspec->flags, SSF_SEPARATE_GROUND);
 797                 uint32 var10_values = layout->PrepareLayout(total_offset, rti->fallback_railtype, 0, 0, separate_ground);
 798                 uint8 var10;
 799                 FOR_EACH_SET_BIT(var10, var10_values) {
 800                         uint32 var10_relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, var10);
 801                         layout->ProcessRegisters(var10, var10_relocation, separate_ground);
 802                 }
 803
 804                 tmp_rail_layout.seq = layout->GetLayout(&tmp_rail_layout.ground);
 805                 sprites = &tmp_rail_layout;
 806                 total_offset = 0;
 807         } else {
 808                 /* Simple sprite layout */
 809                 ground_relocation = relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, 0);
 810                 if (HasBit(sprites->ground.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE)) {
 811                         ground_relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, 1);
 812                 }
 813                 ground_relocation += rti->fallback_railtype;
 814         }
 815
 816         SpriteID image = sprites->ground.sprite;
 817         PaletteID pal = sprites->ground.pal;
 818         RailTrackOffset overlay_offset;
 819         if (rti->UsesOverlay() && SplitGroundSpriteForOverlay(NULL, &image, &overlay_offset)) {
 820                 SpriteID ground = GetCustomRailSprite(rti, INVALID_TILE, RTSG_GROUND);
 821                 DrawSprite(image, PAL_NONE, x, y);
 822                 DrawSprite(ground + overlay_offset, PAL_NONE, x, y);
 823         } else {
 824                 image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
 825                 if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
 826                 DrawSprite(image, GroundSpritePaletteTransform(image, pal, palette), x, y);
 827         }
 828
 829         DrawRailTileSeqInGUI(x, y, sprites, total_offset, relocation, palette);
 830
 831         return true;
 832 }
 833
 834
 835 const StationSpec *GetStationSpec(TileIndex t)
 836 {
 837         if (!IsCustomStationSpecIndex(t)) return NULL;
 838
 839         const BaseStation *st = BaseStation::GetByTile(t);
 840         uint specindex = GetCustomStationSpecIndex(t);
 841         return specindex < st->num_specs ? st->speclist[specindex].spec : NULL;
 842 }
 843
 844
 845 /**
 846  * Check whether a rail station tile is NOT traversable.
 847  * @param tile %Tile to test.
 848  * @return Station tile is blocked.
 849  * @note This could be cached (during build) in the map array to save on all the dereferencing.
 850  */
 851 bool IsStationTileBlocked(TileIndex tile)
 852 {
 853         const StationSpec *statspec = GetStationSpec(tile);
 854
 855         return statspec != NULL && HasBit(statspec->blocked, GetStationGfx(tile));
 856 }
 857
 858 /**
 859  * Check if a rail station tile shall have pylons when electrified.
 860  * @param tile %Tile to test.
 861  * @return Tile shall have pylons.
 862  * @note This could be cached (during build) in the map array to save on all the dereferencing.
 863  */
 864 bool CanStationTileHavePylons(TileIndex tile)
 865 {
 866         const StationSpec *statspec = GetStationSpec(tile);
 867         uint gfx = GetStationGfx(tile);
 868         /* Default stations do not draw pylons under roofs (gfx >= 4) */
 869         return statspec != NULL ? HasBit(statspec->pylons, gfx) : gfx < 4;
 870 }
 871
 872 /**
 873  * Check if a rail station tile shall have wires when electrified.
 874  * @param tile %Tile to test.
 875  * @return Tile shall have wires.
 876  * @note This could be cached (during build) in the map array to save on all the dereferencing.
 877  */
 878 bool CanStationTileHaveWires(TileIndex tile)
 879 {
 880         const StationSpec *statspec = GetStationSpec(tile);
 881         return statspec == NULL || !HasBit(statspec->wires, GetStationGfx(tile));
 882 }
 883
 884 /** Wrapper for animation control, see #GetStationCallback. */
 885 uint16 GetAnimStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile, int extra_data)
 886 {
 887         return GetStationCallback(callback, param1, param2, statspec, st, tile);
 888 }
 889
 890 /** Helper class for animation control. */
 891 struct StationAnimationBase : public AnimationBase<StationAnimationBase, StationSpec, BaseStation, int, GetAnimStationCallback> {
 892         static const CallbackID cb_animation_speed      = CBID_STATION_ANIMATION_SPEED;
 893         static const CallbackID cb_animation_next_frame = CBID_STATION_ANIM_NEXT_FRAME;
 894
 895         static const StationCallbackMask cbm_animation_speed      = CBM_STATION_ANIMATION_SPEED;
 896         static const StationCallbackMask cbm_animation_next_frame = CBM_STATION_ANIMATION_NEXT_FRAME;
 897 };
 898
 899 void AnimateStationTile(TileIndex tile)
 900 {
 901         const StationSpec *ss = GetStationSpec(tile);
 902         if (ss == NULL) return;
 903
 904         StationAnimationBase::AnimateTile(ss, BaseStation::GetByTile(tile), tile, HasBit(ss->flags, SSF_CB141_RANDOM_BITS));
 905 }
 906
 907 void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type)
 908 {
 909         /* List of coverage areas for each animation trigger */
 910         static const TriggerArea tas[] = {
 911                 TA_TILE, TA_WHOLE, TA_WHOLE, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM, TA_WHOLE
 912         };
 913
 914         /* Get Station if it wasn't supplied */
 915         if (st == NULL) st = BaseStation::GetByTile(tile);
 916
 917         /* Check the cached animation trigger bitmask to see if we need
 918          * to bother with any further processing. */
 919         if (!HasBit(st->cached_anim_triggers, trigger)) return;
 920
 921         uint16 random_bits = Random();
 922         ETileArea area = ETileArea(st, tile, tas[trigger]);
 923
 924         /* Check all tiles over the station to check if the specindex is still in use */
 925         TILE_AREA_LOOP(tile, area) {
 926                 if (st->TileBelongsToRailStation(tile)) {
 927                         const StationSpec *ss = GetStationSpec(tile);
 928                         if (ss != NULL && HasBit(ss->animation.triggers, trigger)) {
 929                                 CargoID cargo;
 930                                 if (cargo_type == CT_INVALID) {
 931                                         cargo = CT_INVALID;
 932                                 } else {
 933                                         cargo = ss->grf_prop.grffile->cargo_map[cargo_type];
 934                                 }
 935                                 StationAnimationBase::ChangeAnimationFrame(CBID_STATION_ANIM_START_STOP, ss, st, tile, (random_bits << 16) | Random(), (uint8)trigger | (cargo << 8));
 936                         }
 937                 }
 938         }
 939 }
 940
 941 /**
 942  * Trigger station randomisation
 943  * @param st station being triggered
 944  * @param tile specific tile of platform to trigger
 945  * @param trigger trigger type
 946  * @param cargo_type cargo type causing trigger
 947  */
 948 void TriggerStationRandomisation(Station *st, TileIndex tile, StationRandomTrigger trigger, CargoID cargo_type)
 949 {
 950         /* List of coverage areas for each animation trigger */
 951         static const TriggerArea tas[] = {
 952                 TA_WHOLE, TA_WHOLE, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM
 953         };
 954
 955         /* Get Station if it wasn't supplied */
 956         if (st == NULL) st = Station::GetByTile(tile);
 957
 958         /* Check the cached cargo trigger bitmask to see if we need
 959          * to bother with any further processing. */
 960         if (st->cached_cargo_triggers == 0) return;
 961         if (cargo_type != CT_INVALID && !HasBit(st->cached_cargo_triggers, cargo_type)) return;
 962
 963         uint32 whole_reseed = 0;
 964         ETileArea area = ETileArea(st, tile, tas[trigger]);
 965
 966         uint32 empty_mask = 0;
 967         if (trigger == SRT_CARGO_TAKEN) {
 968                 /* Create a bitmask of completely empty cargo types to be matched */
 969                 for (CargoID i = 0; i < NUM_CARGO; i++) {
 970                         if (st->goods[i].cargo.TotalCount() == 0) {
 971                                 SetBit(empty_mask, i);
 972                         }
 973                 }
 974         }
 975
 976         /* Store triggers now for var 5F */
 977         SetBit(st->waiting_triggers, trigger);
 978         uint32 used_triggers = 0;
 979
 980         /* Check all tiles over the station to check if the specindex is still in use */
 981         TILE_AREA_LOOP(tile, area) {
 982                 if (st->TileBelongsToRailStation(tile)) {
 983                         const StationSpec *ss = GetStationSpec(tile);
 984                         if (ss == NULL) continue;
 985
 986                         /* Cargo taken "will only be triggered if all of those
 987                          * cargo types have no more cargo waiting." */
 988                         if (trigger == SRT_CARGO_TAKEN) {
 989                                 if ((ss->cargo_triggers & ~empty_mask) != 0) continue;
 990                         }
 991
 992                         if (cargo_type == CT_INVALID || HasBit(ss->cargo_triggers, cargo_type)) {
 993                                 StationResolverObject object(ss, st, tile, CBID_RANDOM_TRIGGER, 0);
 994                                 object.waiting_triggers = st->waiting_triggers;
 995
 996                                 const SpriteGroup *group = object.Resolve();
 997                                 if (group == NULL) continue;
 998
 999                                 used_triggers |= object.used_triggers;
1000
1001                                 uint32 reseed = object.GetReseedSum();
1002                                 if (reseed != 0) {
1003                                         whole_reseed |= reseed;
1004                                         reseed >>= 16;
1005
1006                                         /* Set individual tile random bits */
1007                                         uint8 random_bits = GetStationTileRandomBits(tile);
1008                                         random_bits &= ~reseed;
1009                                         random_bits |= Random() & reseed;
1010                                         SetStationTileRandomBits(tile, random_bits);
1011
1012                                         MarkTileDirtyByTile(tile);
1013                                 }
1014                         }
1015                 }
1016         }
1017
1018         /* Update whole station random bits */
1019         st->waiting_triggers &= ~used_triggers;
1020         if ((whole_reseed & 0xFFFF) != 0) {
1021                 st->random_bits &= ~whole_reseed;
1022                 st->random_bits |= Random() & whole_reseed;
1023         }
1024 }
1025
1026 /**
1027  * Update the cached animation trigger bitmask for a station.
1028  * @param st Station to update.
1029  */
1030 void StationUpdateCachedTriggers(BaseStation *st)
1031 {
1032         st->cached_anim_triggers = 0;
1033         st->cached_cargo_triggers = 0;
1034
1035         /* Combine animation trigger bitmask for all station specs
1036          * of this station. */
1037         for (uint i = 0; i < st->num_specs; i++) {
1038                 const StationSpec *ss = st->speclist[i].spec;
1039                 if (ss != NULL) {
1040                         st->cached_anim_triggers |= ss->animation.triggers;
1041                         st->cached_cargo_triggers |= ss->cargo_triggers;
1042                 }
1043         }
1044 }
1045