newgrf_station.cpp

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #include "stdafx.h"
00013 #include "debug.h"
00014 #include "station_base.h"
00015 #include "waypoint_base.h"
00016 #include "roadstop_base.h"
00017 #include "newgrf_cargo.h"
00018 #include "newgrf_station.h"
00019 #include "newgrf_spritegroup.h"
00020 #include "newgrf_sound.h"
00021 #include "newgrf_railtype.h"
00022 #include "town.h"
00023 #include "newgrf_town.h"
00024 #include "company_func.h"
00025 #include "tunnelbridge_map.h"
00026 #include "newgrf_animation_base.h"
00027 #include "newgrf_class_func.h"
00028 
00029 
00030 template <typename Tspec, typename Tid, Tid Tmax>
00031 /* static */ void NewGRFClass<Tspec, Tid, Tmax>::InsertDefaults()
00032 {
00033   /* Set up initial data */
00034   classes[0].global_id = 'DFLT';
00035   classes[0].name = STR_STATION_CLASS_DFLT;
00036   classes[0].Insert(NULL);
00037 
00038   classes[1].global_id = 'WAYP';
00039   classes[1].name = STR_STATION_CLASS_WAYP;
00040   classes[1].Insert(NULL);
00041 }
00042 
00043 template <typename Tspec, typename Tid, Tid Tmax>
00044 bool NewGRFClass<Tspec, Tid, Tmax>::IsUIAvailable(uint index) const
00045 {
00046   return true;
00047 }
00048 
00049 INSTANTIATE_NEWGRF_CLASS_METHODS(StationClass, StationSpec, StationClassID, STAT_CLASS_MAX)
00050 
00051 static const uint MAX_SPECLIST = 255;
00052 
00053 enum TriggerArea {
00054   TA_TILE,
00055   TA_PLATFORM,
00056   TA_WHOLE,
00057 };
00058 
00059 struct ETileArea : TileArea {
00060   ETileArea(const BaseStation *st, TileIndex tile, TriggerArea ta)
00061   {
00062     switch (ta) {
00063       default: NOT_REACHED();
00064 
00065       case TA_TILE:
00066         this->tile = tile;
00067         this->w    = 1;
00068         this->h    = 1;
00069         break;
00070 
00071       case TA_PLATFORM: {
00072         TileIndex start, end;
00073         Axis axis = GetRailStationAxis(tile);
00074         TileIndexDiff delta = TileOffsByDiagDir(AxisToDiagDir(axis));
00075 
00076         for (end = tile; IsRailStationTile(end + delta) && IsCompatibleTrainStationTile(tile, end + delta); end += delta) { /* Nothing */ }
00077         for (start = tile; IsRailStationTile(start - delta) && IsCompatibleTrainStationTile(tile, start - delta); start -= delta) { /* Nothing */ }
00078 
00079         this->tile = start;
00080         this->w = TileX(end) - TileX(start) + 1;
00081         this->h = TileY(end) - TileY(start) + 1;
00082         break;
00083       }
00084 
00085       case TA_WHOLE:
00086         st->GetTileArea(this, Station::IsExpected(st) ? STATION_RAIL : STATION_WAYPOINT);
00087         break;
00088     }
00089   }
00090 };
00091 
00092 
00105 uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred)
00106 {
00107   uint32 retval = 0;
00108 
00109   if (axis == AXIS_X) {
00110     Swap(platforms, length);
00111     Swap(x, y);
00112   }
00113 
00114   if (centred) {
00115     x -= platforms / 2;
00116     y -= length / 2;
00117     x = Clamp(x, -8, 7);
00118     y = Clamp(y, -8, 7);
00119     SB(retval,  0, 4, y & 0xF);
00120     SB(retval,  4, 4, x & 0xF);
00121   } else {
00122     SB(retval,  0, 4, min(15, y));
00123     SB(retval,  4, 4, min(15, length - y - 1));
00124     SB(retval,  8, 4, min(15, x));
00125     SB(retval, 12, 4, min(15, platforms - x - 1));
00126   }
00127   SB(retval, 16, 4, min(15, length));
00128   SB(retval, 20, 4, min(15, platforms));
00129   SB(retval, 24, 4, tile);
00130 
00131   return retval;
00132 }
00133 
00134 
00143 static TileIndex FindRailStationEnd(TileIndex tile, TileIndexDiff delta, bool check_type, bool check_axis)
00144 {
00145   byte orig_type = 0;
00146   Axis orig_axis = AXIS_X;
00147   StationID sid = GetStationIndex(tile);
00148 
00149   if (check_type) orig_type = GetCustomStationSpecIndex(tile);
00150   if (check_axis) orig_axis = GetRailStationAxis(tile);
00151 
00152   for (;;) {
00153     TileIndex new_tile = TILE_ADD(tile, delta);
00154 
00155     if (!IsTileType(new_tile, MP_STATION) || GetStationIndex(new_tile) != sid) break;
00156     if (!HasStationRail(new_tile)) break;
00157     if (check_type && GetCustomStationSpecIndex(new_tile) != orig_type) break;
00158     if (check_axis && GetRailStationAxis(new_tile) != orig_axis) break;
00159 
00160     tile = new_tile;
00161   }
00162   return tile;
00163 }
00164 
00165 
00166 static uint32 GetPlatformInfoHelper(TileIndex tile, bool check_type, bool check_axis, bool centred)
00167 {
00168   int tx = TileX(tile);
00169   int ty = TileY(tile);
00170   int sx = TileX(FindRailStationEnd(tile, TileDiffXY(-1,  0), check_type, check_axis));
00171   int sy = TileY(FindRailStationEnd(tile, TileDiffXY( 0, -1), check_type, check_axis));
00172   int ex = TileX(FindRailStationEnd(tile, TileDiffXY( 1,  0), check_type, check_axis)) + 1;
00173   int ey = TileY(FindRailStationEnd(tile, TileDiffXY( 0,  1), check_type, check_axis)) + 1;
00174 
00175   tx -= sx; ex -= sx;
00176   ty -= sy; ey -= sy;
00177 
00178   return GetPlatformInfo(GetRailStationAxis(tile), GetStationGfx(tile), ex, ey, tx, ty, centred);
00179 }
00180 
00181 
00182 static uint32 GetRailContinuationInfo(TileIndex tile)
00183 {
00184   /* Tile offsets and exit dirs for X axis */
00185   static const Direction x_dir[8] = { DIR_SW, DIR_NE, DIR_SE, DIR_NW, DIR_S, DIR_E, DIR_W, DIR_N };
00186   static const DiagDirection x_exits[8] = { DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SW, DIAGDIR_NE };
00187 
00188   /* Tile offsets and exit dirs for Y axis */
00189   static const Direction y_dir[8] = { DIR_SE, DIR_NW, DIR_SW, DIR_NE, DIR_S, DIR_W, DIR_E, DIR_N };
00190   static const DiagDirection y_exits[8] = { DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SE, DIAGDIR_NW };
00191 
00192   Axis axis = GetRailStationAxis(tile);
00193 
00194   /* Choose appropriate lookup table to use */
00195   const Direction *dir = axis == AXIS_X ? x_dir : y_dir;
00196   const DiagDirection *diagdir = axis == AXIS_X ? x_exits : y_exits;
00197 
00198   uint32 res = 0;
00199   uint i;
00200 
00201   for (i = 0; i < lengthof(x_dir); i++, dir++, diagdir++) {
00202     TileIndex neighbour_tile = tile + TileOffsByDir(*dir);
00203     TrackBits trackbits = TrackStatusToTrackBits(GetTileTrackStatus(neighbour_tile, TRANSPORT_RAIL, 0));
00204     if (trackbits != TRACK_BIT_NONE) {
00205       /* If there is any track on the tile, set the bit in the second byte */
00206       SetBit(res, i + 8);
00207 
00208       /* With tunnels and bridges the tile has tracks, but they are not necessarily connected
00209        * with the next tile because the ramp is not going in the right direction. */
00210       if (IsTileType(neighbour_tile, MP_TUNNELBRIDGE) && GetTunnelBridgeDirection(neighbour_tile) != *diagdir) {
00211         continue;
00212       }
00213 
00214       /* If any track reaches our exit direction, set the bit in the lower byte */
00215       if (trackbits & DiagdirReachesTracks(*diagdir)) SetBit(res, i);
00216     }
00217   }
00218 
00219   return res;
00220 }
00221 
00222 
00223 /* Station Resolver Functions */
00224 /* virtual */ uint32 StationScopeResolver::GetRandomBits() const
00225 {
00226   return (this->st == NULL ? 0 : this->st->random_bits) | (this->tile == INVALID_TILE ? 0 : GetStationTileRandomBits(this->tile) << 16);
00227 }
00228 
00229 
00230 /* virtual */ uint32 StationScopeResolver::GetTriggers() const
00231 {
00232   return this->st == NULL ? 0 : this->st->waiting_triggers;
00233 }
00234 
00235 
00236 /* virtual */ void StationScopeResolver::SetTriggers(int triggers) const
00237 {
00238   BaseStation *st = const_cast<BaseStation *>(this->st);
00239   assert(st != NULL);
00240   st->waiting_triggers = triggers;
00241 }
00242 
00248 static struct {
00249   uint32 v40;
00250   uint32 v41;
00251   uint32 v45;
00252   uint32 v46;
00253   uint32 v47;
00254   uint32 v49;
00255   uint8 valid; 
00256 } _svc;
00257 
00263 TownScopeResolver *StationResolverObject::GetTown()
00264 {
00265   if (this->town_scope == NULL) {
00266     Town *t = NULL;
00267     if (this->station_scope.st != NULL) {
00268       t = this->station_scope.st->town;
00269     } else if (this->station_scope.tile != INVALID_TILE) {
00270       t = ClosestTownFromTile(this->station_scope.tile, UINT_MAX);
00271     }
00272     if (t == NULL) return NULL;
00273     this->town_scope = new TownScopeResolver(this, t, this->station_scope.st == NULL);
00274   }
00275   return this->town_scope;
00276 }
00277 
00278 /* virtual */ uint32 StationScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
00279 {
00280   if (this->st == NULL) {
00281     /* Station does not exist, so we're in a purchase list or the land slope check callback. */
00282     switch (variable) {
00283       case 0x40:
00284       case 0x41:
00285       case 0x46:
00286       case 0x47:
00287       case 0x49: return 0x2110000;        // Platforms, tracks & position
00288       case 0x42: return 0;                // Rail type (XXX Get current type from GUI?)
00289       case 0x43: return GetCompanyInfo(_current_company); // Station owner
00290       case 0x44: return 2;                // PBS status
00291       case 0x67: // Land info of nearby tile
00292         if (this->axis != INVALID_AXIS && this->tile != INVALID_TILE) {
00293           TileIndex tile = this->tile;
00294           if (parameter != 0) tile = GetNearbyTile(parameter, tile, true, this->axis); // only perform if it is required
00295 
00296           Slope tileh = GetTileSlope(tile);
00297           bool swap = (this->axis == AXIS_Y && HasBit(tileh, CORNER_W) != HasBit(tileh, CORNER_E));
00298 
00299           return GetNearbyTileInformation(tile, this->ro->grffile->grf_version >= 8) ^ (swap ? SLOPE_EW : 0);
00300         }
00301         break;
00302 
00303       case 0xFA: return Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Build date, clamped to a 16 bit value
00304     }
00305 
00306     *available = false;
00307     return UINT_MAX;
00308   }
00309 
00310   switch (variable) {
00311     /* Calculated station variables */
00312     case 0x40:
00313       if (!HasBit(_svc.valid, 0)) { _svc.v40 = GetPlatformInfoHelper(this->tile, false, false, false); SetBit(_svc.valid, 0); }
00314       return _svc.v40;
00315 
00316     case 0x41:
00317       if (!HasBit(_svc.valid, 1)) { _svc.v41 = GetPlatformInfoHelper(this->tile, true,  false, false); SetBit(_svc.valid, 1); }
00318       return _svc.v41;
00319 
00320     case 0x42: return GetTerrainType(this->tile) | (GetReverseRailTypeTranslation(GetRailType(this->tile), this->statspec->grf_prop.grffile) << 8);
00321     case 0x43: return GetCompanyInfo(this->st->owner); // Station owner
00322     case 0x44: return HasStationReservation(this->tile) ? 7 : 4; // PBS status
00323     case 0x45:
00324       if (!HasBit(_svc.valid, 2)) { _svc.v45 = GetRailContinuationInfo(this->tile); SetBit(_svc.valid, 2); }
00325       return _svc.v45;
00326 
00327     case 0x46:
00328       if (!HasBit(_svc.valid, 3)) { _svc.v46 = GetPlatformInfoHelper(this->tile, false, false, true); SetBit(_svc.valid, 3); }
00329       return _svc.v46;
00330 
00331     case 0x47:
00332       if (!HasBit(_svc.valid, 4)) { _svc.v47 = GetPlatformInfoHelper(this->tile, true,  false, true); SetBit(_svc.valid, 4); }
00333       return _svc.v47;
00334 
00335     case 0x49:
00336       if (!HasBit(_svc.valid, 5)) { _svc.v49 = GetPlatformInfoHelper(this->tile, false, true, false); SetBit(_svc.valid, 5); }
00337       return _svc.v49;
00338 
00339     case 0x4A: // Animation frame of tile
00340       return GetAnimationFrame(this->tile);
00341 
00342     /* Variables which use the parameter */
00343     /* Variables 0x60 to 0x65 and 0x69 are handled separately below */
00344     case 0x66: { // Animation frame of nearby tile
00345       TileIndex tile = this->tile;
00346       if (parameter != 0) tile = GetNearbyTile(parameter, tile);
00347       return this->st->TileBelongsToRailStation(tile) ? GetAnimationFrame(tile) : UINT_MAX;
00348     }
00349 
00350     case 0x67: { // Land info of nearby tile
00351       Axis axis = GetRailStationAxis(this->tile);
00352       TileIndex tile = this->tile;
00353       if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required
00354 
00355       Slope tileh = GetTileSlope(tile);
00356       bool swap = (axis == AXIS_Y && HasBit(tileh, CORNER_W) != HasBit(tileh, CORNER_E));
00357 
00358       return GetNearbyTileInformation(tile, this->ro->grffile->grf_version >= 8) ^ (swap ? SLOPE_EW : 0);
00359     }
00360 
00361     case 0x68: { // Station info of nearby tiles
00362       TileIndex nearby_tile = GetNearbyTile(parameter, this->tile);
00363 
00364       if (!HasStationTileRail(nearby_tile)) return 0xFFFFFFFF;
00365 
00366       uint32 grfid = this->st->speclist[GetCustomStationSpecIndex(this->tile)].grfid;
00367       bool perpendicular = GetRailStationAxis(this->tile) != GetRailStationAxis(nearby_tile);
00368       bool same_station = this->st->TileBelongsToRailStation(nearby_tile);
00369       uint32 res = GB(GetStationGfx(nearby_tile), 1, 2) << 12 | !!perpendicular << 11 | !!same_station << 10;
00370 
00371       if (IsCustomStationSpecIndex(nearby_tile)) {
00372         const StationSpecList ssl = BaseStation::GetByTile(nearby_tile)->speclist[GetCustomStationSpecIndex(nearby_tile)];
00373         res |= 1 << (ssl.grfid != grfid ? 9 : 8) | ssl.localidx;
00374       }
00375       return res;
00376     }
00377 
00378     /* General station variables */
00379     case 0x82: return 50;
00380     case 0x84: return this->st->string_id;
00381     case 0x86: return 0;
00382     case 0xF0: return this->st->facilities;
00383     case 0xFA: return Clamp(this->st->build_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535);
00384   }
00385 
00386   return this->st->GetNewGRFVariable(this->ro, variable, parameter, available);
00387 }
00388 
00389 uint32 Station::GetNewGRFVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) const
00390 {
00391   switch (variable) {
00392     case 0x48: { // Accepted cargo types
00393       CargoID cargo_type;
00394       uint32 value = 0;
00395 
00396       for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
00397         if (HasBit(this->goods[cargo_type].acceptance_pickup, GoodsEntry::GES_PICKUP)) SetBit(value, cargo_type);
00398       }
00399       return value;
00400     }
00401 
00402     case 0x8A: return this->had_vehicle_of_type;
00403     case 0xF1: return (this->airport.tile != INVALID_TILE) ? this->airport.GetSpec()->ttd_airport_type : ATP_TTDP_LARGE;
00404     case 0xF2: return (this->truck_stops != NULL) ? this->truck_stops->status : 0;
00405     case 0xF3: return (this->bus_stops != NULL)   ? this->bus_stops->status   : 0;
00406     case 0xF6: return this->airport.flags;
00407     case 0xF7: return GB(this->airport.flags, 8, 8);
00408   }
00409 
00410   /* Handle cargo variables with parameter, 0x60 to 0x65 and 0x69 */
00411   if ((variable >= 0x60 && variable <= 0x65) || variable == 0x69) {
00412     CargoID c = GetCargoTranslation(parameter, object->grffile);
00413 
00414     if (c == CT_INVALID) return 0;
00415     const GoodsEntry *ge = &this->goods[c];
00416 
00417     switch (variable) {
00418       case 0x60: return min(ge->cargo.Count(), 4095);
00419       case 0x61: return ge->days_since_pickup;
00420       case 0x62: return ge->rating;
00421       case 0x63: return ge->cargo.DaysInTransit();
00422       case 0x64: return ge->last_speed | (ge->last_age << 8);
00423       case 0x65: return GB(ge->acceptance_pickup, GoodsEntry::GES_ACCEPTANCE, 1) << 3;
00424       case 0x69: return GB(ge->acceptance_pickup, GoodsEntry::GES_EVER_ACCEPTED, 4);
00425     }
00426   }
00427 
00428   /* Handle cargo variables (deprecated) */
00429   if (variable >= 0x8C && variable <= 0xEC) {
00430     const GoodsEntry *g = &this->goods[GB(variable - 0x8C, 3, 4)];
00431     switch (GB(variable - 0x8C, 0, 3)) {
00432       case 0: return g->cargo.Count();
00433       case 1: return GB(min(g->cargo.Count(), 4095), 0, 4) | (GB(g->acceptance_pickup, GoodsEntry::GES_ACCEPTANCE, 1) << 7);
00434       case 2: return g->days_since_pickup;
00435       case 3: return g->rating;
00436       case 4: return g->cargo.Source();
00437       case 5: return g->cargo.DaysInTransit();
00438       case 6: return g->last_speed;
00439       case 7: return g->last_age;
00440     }
00441   }
00442 
00443   DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
00444 
00445   *available = false;
00446   return UINT_MAX;
00447 }
00448 
00449 uint32 Waypoint::GetNewGRFVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) const
00450 {
00451   switch (variable) {
00452     case 0x48: return 0; // Accepted cargo types
00453     case 0x8A: return HVOT_WAYPOINT;
00454     case 0xF1: return 0; // airport type
00455     case 0xF2: return 0; // truck stop status
00456     case 0xF3: return 0; // bus stop status
00457     case 0xF6: return 0; // airport flags
00458     case 0xF7: return 0; // airport flags cont.
00459   }
00460 
00461   /* Handle cargo variables with parameter, 0x60 to 0x65 */
00462   if (variable >= 0x60 && variable <= 0x65) {
00463     return 0;
00464   }
00465 
00466   /* Handle cargo variables (deprecated) */
00467   if (variable >= 0x8C && variable <= 0xEC) {
00468     switch (GB(variable - 0x8C, 0, 3)) {
00469       case 3: return INITIAL_STATION_RATING;
00470       case 4: return INVALID_STATION;
00471       default: return 0;
00472     }
00473   }
00474 
00475   DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
00476 
00477   *available = false;
00478   return UINT_MAX;
00479 }
00480 
00481 /* virtual */ const SpriteGroup *StationResolverObject::ResolveReal(const RealSpriteGroup *group) const
00482 {
00483   if (this->station_scope.st == NULL || this->station_scope.statspec->cls_id == STAT_CLASS_WAYP) {
00484     return group->loading[0];
00485   }
00486 
00487   uint cargo = 0;
00488   const Station *st = Station::From(this->station_scope.st);
00489 
00490   switch (this->station_scope.cargo_type) {
00491     case CT_INVALID:
00492     case CT_DEFAULT_NA:
00493     case CT_PURCHASE:
00494       cargo = 0;
00495       break;
00496 
00497     case CT_DEFAULT:
00498       for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
00499         cargo += st->goods[cargo_type].cargo.Count();
00500       }
00501       break;
00502 
00503     default:
00504       cargo = st->goods[this->station_scope.cargo_type].cargo.Count();
00505       break;
00506   }
00507 
00508   if (HasBit(this->station_scope.statspec->flags, SSF_DIV_BY_STATION_SIZE)) cargo /= (st->train_station.w + st->train_station.h);
00509   cargo = min(0xfff, cargo);
00510 
00511   if (cargo > this->station_scope.statspec->cargo_threshold) {
00512     if (group->num_loading > 0) {
00513       uint set = ((cargo - this->station_scope.statspec->cargo_threshold) * group->num_loading) / (4096 - this->station_scope.statspec->cargo_threshold);
00514       return group->loading[set];
00515     }
00516   } else {
00517     if (group->num_loaded > 0) {
00518       uint set = (cargo * group->num_loaded) / (this->station_scope.statspec->cargo_threshold + 1);
00519       return group->loaded[set];
00520     }
00521   }
00522 
00523   return group->loading[0];
00524 }
00525 
00535 StationResolverObject::StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile,
00536     CallbackID callback, uint32 callback_param1, uint32 callback_param2)
00537   : ResolverObject((statspec != NULL ? statspec->grf_prop.grffile : NULL), callback, callback_param1, callback_param2),
00538   station_scope(this, statspec, st, tile), town_scope(NULL)
00539 {
00540   /* Invalidate all cached vars */
00541   _svc.valid = 0;
00542 }
00543 
00544 StationResolverObject::~StationResolverObject()
00545 {
00546   delete this->town_scope;
00547 }
00548 
00556 StationScopeResolver::StationScopeResolver(ResolverObject *ro, const StationSpec *statspec, BaseStation *st, TileIndex tile)
00557   : ScopeResolver(ro)
00558 {
00559   this->tile = tile;
00560   this->st = st;
00561   this->statspec = statspec;
00562   this->cargo_type = CT_INVALID;
00563   this->axis = INVALID_AXIS;
00564 }
00565 
00566 static const SpriteGroup *ResolveStation(StationResolverObject *object)
00567 {
00568   CargoID ctype = CT_DEFAULT_NA;
00569 
00570   if (object->station_scope.st == NULL) {
00571     /* No station, so we are in a purchase list */
00572     ctype = CT_PURCHASE;
00573   } else if (Station::IsExpected(object->station_scope.st)) {
00574     const Station *st = Station::From(object->station_scope.st);
00575     /* Pick the first cargo that we have waiting */
00576     const CargoSpec *cs;
00577     FOR_ALL_CARGOSPECS(cs) {
00578       if (object->station_scope.statspec->grf_prop.spritegroup[cs->Index()] != NULL &&
00579           !st->goods[cs->Index()].cargo.Empty()) {
00580         ctype = cs->Index();
00581         break;
00582       }
00583     }
00584   }
00585 
00586   const SpriteGroup *group = object->station_scope.statspec->grf_prop.spritegroup[ctype];
00587   if (group == NULL) {
00588     ctype = CT_DEFAULT;
00589     group = object->station_scope.statspec->grf_prop.spritegroup[ctype];
00590     if (group == NULL) return NULL;
00591   }
00592 
00593   /* Remember the cargo type we've picked */
00594   object->station_scope.cargo_type = ctype;
00595 
00596   return SpriteGroup::Resolve(group, object);
00597 }
00598 
00607 SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32 var10)
00608 {
00609   StationResolverObject object(statspec, st, tile, CBID_NO_CALLBACK, var10);
00610   const SpriteGroup *group = ResolveStation(&object);
00611   if (group == NULL || group->type != SGT_RESULT) return 0;
00612   return group->GetResult() - 0x42D;
00613 }
00614 
00624 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info)
00625 {
00626   /* callback_param1 == 2 means  we are resolving the foundation sprites. */
00627   StationResolverObject object(statspec, st, tile, CBID_NO_CALLBACK, 2, layout | (edge_info << 16));
00628 
00629   ClearRegister(0x100);
00630   const SpriteGroup *group = ResolveStation(&object);
00631   if (group == NULL || group->type != SGT_RESULT) return 0;
00632   return group->GetResult() + GetRegister(0x100);
00633 }
00634 
00635 
00636 uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile)
00637 {
00638   StationResolverObject object(statspec, st, tile, callback, param1, param2);
00639   const SpriteGroup *group = ResolveStation(&object);
00640   if (group == NULL) return CALLBACK_FAILED;
00641   return group->GetCallbackResult();
00642 }
00643 
00654 CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte numtracks)
00655 {
00656   TileIndexDiff diff = cur_tile - north_tile;
00657   Slope slope = GetTileSlope(cur_tile);
00658 
00659   StationResolverObject object(statspec, NULL, cur_tile, CBID_STATION_LAND_SLOPE_CHECK,
00660       (slope << 4) | (slope ^ (axis == AXIS_Y && HasBit(slope, CORNER_W) != HasBit(slope, CORNER_E) ? SLOPE_EW : 0)),
00661       (numtracks << 24) | (plat_len << 16) | (axis == AXIS_Y ? TileX(diff) << 8 | TileY(diff) : TileY(diff) << 8 | TileX(diff)));
00662   object.station_scope.axis = axis;
00663 
00664   const SpriteGroup *group = ResolveStation(&object);
00665   uint16 cb_res = group != NULL ? group->GetCallbackResult() : CALLBACK_FAILED;
00666 
00667   /* Failed callback means success. */
00668   if (cb_res == CALLBACK_FAILED) return CommandCost();
00669 
00670   /* The meaning of bit 10 is inverted for a grf version < 8. */
00671   if (statspec->grf_prop.grffile->grf_version < 8) ToggleBit(cb_res, 10);
00672   return GetErrorMessageFromLocationCallbackResult(cb_res, statspec->grf_prop.grffile->grfid, STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
00673 }
00674 
00675 
00683 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec)
00684 {
00685   uint i;
00686 
00687   if (statspec == NULL || st == NULL) return 0;
00688 
00689   for (i = 1; i < st->num_specs && i < MAX_SPECLIST; i++) {
00690     if (st->speclist[i].spec == NULL && st->speclist[i].grfid == 0) break;
00691   }
00692 
00693   if (i == MAX_SPECLIST) {
00694     /* As final effort when the spec list is already full...
00695      * try to find the same spec and return that one. This might
00696      * result in slighty "wrong" (as per specs) looking stations,
00697      * but it's fairly unlikely that one reaches the limit anyways.
00698      */
00699     for (i = 1; i < st->num_specs && i < MAX_SPECLIST; i++) {
00700       if (st->speclist[i].spec == statspec) return i;
00701     }
00702 
00703     return -1;
00704   }
00705 
00706   if (exec) {
00707     if (i >= st->num_specs) {
00708       st->num_specs = i + 1;
00709       st->speclist = ReallocT(st->speclist, st->num_specs);
00710 
00711       if (st->num_specs == 2) {
00712         /* Initial allocation */
00713         st->speclist[0].spec     = NULL;
00714         st->speclist[0].grfid    = 0;
00715         st->speclist[0].localidx = 0;
00716       }
00717     }
00718 
00719     st->speclist[i].spec     = statspec;
00720     st->speclist[i].grfid    = statspec->grf_prop.grffile->grfid;
00721     st->speclist[i].localidx = statspec->grf_prop.local_id;
00722   }
00723 
00724   return i;
00725 }
00726 
00727 
00734 void DeallocateSpecFromStation(BaseStation *st, byte specindex)
00735 {
00736   /* specindex of 0 (default) is never freeable */
00737   if (specindex == 0) return;
00738 
00739   ETileArea area = ETileArea(st, INVALID_TILE, TA_WHOLE);
00740   /* Check all tiles over the station to check if the specindex is still in use */
00741   TILE_AREA_LOOP(tile, area) {
00742     if (st->TileBelongsToRailStation(tile) && GetCustomStationSpecIndex(tile) == specindex) {
00743       return;
00744     }
00745   }
00746 
00747   /* This specindex is no longer in use, so deallocate it */
00748   st->speclist[specindex].spec     = NULL;
00749   st->speclist[specindex].grfid    = 0;
00750   st->speclist[specindex].localidx = 0;
00751 
00752   /* If this was the highest spec index, reallocate */
00753   if (specindex == st->num_specs - 1) {
00754     for (; st->speclist[st->num_specs - 1].grfid == 0 && st->num_specs > 1; st->num_specs--) {}
00755 
00756     if (st->num_specs > 1) {
00757       st->speclist = ReallocT(st->speclist, st->num_specs);
00758     } else {
00759       free(st->speclist);
00760       st->num_specs = 0;
00761       st->speclist  = NULL;
00762       st->cached_anim_triggers = 0;
00763       return;
00764     }
00765   }
00766 
00767   StationUpdateAnimTriggers(st);
00768 }
00769 
00780 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station)
00781 {
00782   const DrawTileSprites *sprites = NULL;
00783   const RailtypeInfo *rti = GetRailTypeInfo(railtype);
00784   PaletteID palette = COMPANY_SPRITE_COLOUR(_local_company);
00785   uint tile = 2;
00786 
00787   const StationSpec *statspec = StationClass::Get(sclass)->GetSpec(station);
00788   if (statspec == NULL) return false;
00789 
00790   if (HasBit(statspec->callback_mask, CBM_STATION_SPRITE_LAYOUT)) {
00791     uint16 callback = GetStationCallback(CBID_STATION_SPRITE_LAYOUT, 0x2110000, 0, statspec, NULL, INVALID_TILE);
00792     if (callback != CALLBACK_FAILED) tile = callback;
00793   }
00794 
00795   uint32 total_offset = rti->GetRailtypeSpriteOffset();
00796   uint32 relocation = 0;
00797   uint32 ground_relocation = 0;
00798   const NewGRFSpriteLayout *layout = NULL;
00799   DrawTileSprites tmp_rail_layout;
00800 
00801   if (statspec->renderdata == NULL) {
00802     sprites = GetStationTileLayout(STATION_RAIL, tile + axis);
00803   } else {
00804     layout = &statspec->renderdata[(tile < statspec->tiles) ? tile + axis : (uint)axis];
00805     if (!layout->NeedsPreprocessing()) {
00806       sprites = layout;
00807       layout = NULL;
00808     }
00809   }
00810 
00811   if (layout != NULL) {
00812     /* Sprite layout which needs preprocessing */
00813     bool separate_ground = HasBit(statspec->flags, SSF_SEPARATE_GROUND);
00814     uint32 var10_values = layout->PrepareLayout(total_offset, rti->fallback_railtype, 0, 0, separate_ground);
00815     uint8 var10;
00816     FOR_EACH_SET_BIT(var10, var10_values) {
00817       uint32 var10_relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, var10);
00818       layout->ProcessRegisters(var10, var10_relocation, separate_ground);
00819     }
00820 
00821     tmp_rail_layout.seq = layout->GetLayout(&tmp_rail_layout.ground);
00822     sprites = &tmp_rail_layout;
00823     total_offset = 0;
00824   } else {
00825     /* Simple sprite layout */
00826     ground_relocation = relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, 0);
00827     if (HasBit(sprites->ground.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE)) {
00828       ground_relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, 1);
00829     }
00830     ground_relocation += rti->fallback_railtype;
00831   }
00832 
00833   SpriteID image = sprites->ground.sprite;
00834   PaletteID pal = sprites->ground.pal;
00835   image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
00836   if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
00837 
00838   DrawSprite(image, GroundSpritePaletteTransform(image, pal, palette), x, y);
00839 
00840   DrawRailTileSeqInGUI(x, y, sprites, total_offset, relocation, palette);
00841 
00842   return true;
00843 }
00844 
00845 
00846 const StationSpec *GetStationSpec(TileIndex t)
00847 {
00848   if (!IsCustomStationSpecIndex(t)) return NULL;
00849 
00850   const BaseStation *st = BaseStation::GetByTile(t);
00851   uint specindex = GetCustomStationSpecIndex(t);
00852   return specindex < st->num_specs ? st->speclist[specindex].spec : NULL;
00853 }
00854 
00855 
00862 bool IsStationTileBlocked(TileIndex tile)
00863 {
00864   const StationSpec *statspec = GetStationSpec(tile);
00865 
00866   return statspec != NULL && HasBit(statspec->blocked, GetStationGfx(tile));
00867 }
00868 
00875 bool CanStationTileHavePylons(TileIndex tile)
00876 {
00877   const StationSpec *statspec = GetStationSpec(tile);
00878   uint gfx = GetStationGfx(tile);
00879   /* Default stations do not draw pylons under roofs (gfx >= 4) */
00880   return statspec != NULL ? HasBit(statspec->pylons, gfx) : gfx < 4;
00881 }
00882 
00889 bool CanStationTileHaveWires(TileIndex tile)
00890 {
00891   const StationSpec *statspec = GetStationSpec(tile);
00892   return statspec == NULL || !HasBit(statspec->wires, GetStationGfx(tile));
00893 }
00894 
00896 uint16 GetAnimStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile, int extra_data)
00897 {
00898   return GetStationCallback(callback, param1, param2, statspec, st, tile);
00899 }
00900 
00902 struct StationAnimationBase : public AnimationBase<StationAnimationBase, StationSpec, BaseStation, int, GetAnimStationCallback> {
00903   static const CallbackID cb_animation_speed      = CBID_STATION_ANIMATION_SPEED;
00904   static const CallbackID cb_animation_next_frame = CBID_STATION_ANIM_NEXT_FRAME;
00905 
00906   static const StationCallbackMask cbm_animation_speed      = CBM_STATION_ANIMATION_SPEED;
00907   static const StationCallbackMask cbm_animation_next_frame = CBM_STATION_ANIMATION_NEXT_FRAME;
00908 };
00909 
00910 void AnimateStationTile(TileIndex tile)
00911 {
00912   const StationSpec *ss = GetStationSpec(tile);
00913   if (ss == NULL) return;
00914 
00915   StationAnimationBase::AnimateTile(ss, BaseStation::GetByTile(tile), tile, HasBit(ss->flags, SSF_CB141_RANDOM_BITS));
00916 }
00917 
00918 void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type)
00919 {
00920   /* List of coverage areas for each animation trigger */
00921   static const TriggerArea tas[] = {
00922     TA_TILE, TA_WHOLE, TA_WHOLE, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM, TA_WHOLE
00923   };
00924 
00925   /* Get Station if it wasn't supplied */
00926   if (st == NULL) st = BaseStation::GetByTile(tile);
00927 
00928   /* Check the cached animation trigger bitmask to see if we need
00929    * to bother with any further processing. */
00930   if (!HasBit(st->cached_anim_triggers, trigger)) return;
00931 
00932   uint16 random_bits = Random();
00933   ETileArea area = ETileArea(st, tile, tas[trigger]);
00934 
00935   /* Check all tiles over the station to check if the specindex is still in use */
00936   TILE_AREA_LOOP(tile, area) {
00937     if (st->TileBelongsToRailStation(tile)) {
00938       const StationSpec *ss = GetStationSpec(tile);
00939       if (ss != NULL && HasBit(ss->animation.triggers, trigger)) {
00940         CargoID cargo;
00941         if (cargo_type == CT_INVALID) {
00942           cargo = CT_INVALID;
00943         } else {
00944           cargo = ss->grf_prop.grffile->cargo_map[cargo_type];
00945         }
00946         StationAnimationBase::ChangeAnimationFrame(CBID_STATION_ANIM_START_STOP, ss, st, tile, (random_bits << 16) | Random(), (uint8)trigger | (cargo << 8));
00947       }
00948     }
00949   }
00950 }
00951 
00956 void StationUpdateAnimTriggers(BaseStation *st)
00957 {
00958   st->cached_anim_triggers = 0;
00959 
00960   /* Combine animation trigger bitmask for all station specs
00961    * of this station. */
00962   for (uint i = 0; i < st->num_specs; i++) {
00963     const StationSpec *ss = st->speclist[i].spec;
00964     if (ss != NULL) st->cached_anim_triggers |= ss->animation.triggers;
00965   }
00966 }
00967