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 static uint32 StationGetRandomBits(const ResolverObject *object)
00225 {
00226   const BaseStation *st = object->u.station.st;
00227   const TileIndex tile = object->u.station.tile;
00228   return (st == NULL ? 0 : st->random_bits) | (tile == INVALID_TILE ? 0 : GetStationTileRandomBits(tile) << 16);
00229 }
00230 
00231 
00232 static uint32 StationGetTriggers(const ResolverObject *object)
00233 {
00234   const BaseStation *st = object->u.station.st;
00235   return st == NULL ? 0 : st->waiting_triggers;
00236 }
00237 
00238 
00239 static void StationSetTriggers(const ResolverObject *object, int triggers)
00240 {
00241   BaseStation *st = const_cast<BaseStation *>(object->u.station.st);
00242   assert(st != NULL);
00243   st->waiting_triggers = triggers;
00244 }
00245 
00251 static struct {
00252   uint32 v40;
00253   uint32 v41;
00254   uint32 v45;
00255   uint32 v46;
00256   uint32 v47;
00257   uint32 v49;
00258   uint8 valid; 
00259 } _svc;
00260 
00261 static uint32 StationGetVariable(const ResolverObject *object, byte variable, uint32 parameter, bool *available)
00262 {
00263   const BaseStation *st = object->u.station.st;
00264   TileIndex tile = object->u.station.tile;
00265 
00266   if (object->scope == VSG_SCOPE_PARENT) {
00267     /* Pass the request on to the town of the station */
00268     Town *t;
00269 
00270     if (st != NULL) {
00271       t = st->town;
00272     } else if (tile != INVALID_TILE) {
00273       t = ClosestTownFromTile(tile, UINT_MAX);
00274     } else {
00275       *available = false;
00276       return UINT_MAX;
00277     }
00278 
00279     return TownGetVariable(variable, parameter, available, t, object->grffile);
00280   }
00281 
00282   if (st == NULL) {
00283     /* Station does not exist, so we're in a purchase list or the land slope check callback. */
00284     switch (variable) {
00285       case 0x40:
00286       case 0x41:
00287       case 0x46:
00288       case 0x47:
00289       case 0x49: return 0x2110000;        // Platforms, tracks & position
00290       case 0x42: return 0;                // Rail type (XXX Get current type from GUI?)
00291       case 0x43: return GetCompanyInfo(_current_company); // Station owner
00292       case 0x44: return 2;                // PBS status
00293       case 0x67: // Land info of nearby tile
00294         if (object->u.station.axis != INVALID_AXIS && tile != INVALID_TILE) {
00295           if (parameter != 0) tile = GetNearbyTile(parameter, tile, true, object->u.station.axis); // only perform if it is required
00296 
00297           Slope tileh = GetTileSlope(tile);
00298           bool swap = (object->u.station.axis == AXIS_Y && HasBit(tileh, CORNER_W) != HasBit(tileh, CORNER_E));
00299 
00300           return GetNearbyTileInformation(tile, object->grffile->grf_version >= 8) ^ (swap ? SLOPE_EW : 0);
00301         }
00302         break;
00303 
00304       case 0xFA: return Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Build date, clamped to a 16 bit value
00305     }
00306 
00307     *available = false;
00308     return UINT_MAX;
00309   }
00310 
00311   switch (variable) {
00312     /* Calculated station variables */
00313     case 0x40:
00314       if (!HasBit(_svc.valid, 0)) { _svc.v40 = GetPlatformInfoHelper(tile, false, false, false); SetBit(_svc.valid, 0); }
00315       return _svc.v40;
00316 
00317     case 0x41:
00318       if (!HasBit(_svc.valid, 1)) { _svc.v41 = GetPlatformInfoHelper(tile, true,  false, false); SetBit(_svc.valid, 1); }
00319       return _svc.v41;
00320 
00321     case 0x42: return GetTerrainType(tile) | (GetReverseRailTypeTranslation(GetRailType(tile), object->u.station.statspec->grf_prop.grffile) << 8);
00322     case 0x43: return GetCompanyInfo(st->owner); // Station owner
00323     case 0x44: return HasStationReservation(tile) ? 7 : 4; // PBS status
00324     case 0x45:
00325       if (!HasBit(_svc.valid, 2)) { _svc.v45 = GetRailContinuationInfo(tile); SetBit(_svc.valid, 2); }
00326       return _svc.v45;
00327 
00328     case 0x46:
00329       if (!HasBit(_svc.valid, 3)) { _svc.v46 = GetPlatformInfoHelper(tile, false, false, true); SetBit(_svc.valid, 3); }
00330       return _svc.v46;
00331 
00332     case 0x47:
00333       if (!HasBit(_svc.valid, 4)) { _svc.v47 = GetPlatformInfoHelper(tile, true,  false, true); SetBit(_svc.valid, 4); }
00334       return _svc.v47;
00335 
00336     case 0x49:
00337       if (!HasBit(_svc.valid, 5)) { _svc.v49 = GetPlatformInfoHelper(tile, false, true, false); SetBit(_svc.valid, 5); }
00338       return _svc.v49;
00339 
00340     case 0x4A: // Animation frame of tile
00341       return GetAnimationFrame(tile);
00342 
00343     /* Variables which use the parameter */
00344     /* Variables 0x60 to 0x65 and 0x69 are handled separately below */
00345     case 0x66: // Animation frame of nearby tile
00346       if (parameter != 0) tile = GetNearbyTile(parameter, tile);
00347       return st->TileBelongsToRailStation(tile) ? GetAnimationFrame(tile) : UINT_MAX;
00348 
00349     case 0x67: { // Land info of nearby tile
00350       Axis axis = GetRailStationAxis(tile);
00351 
00352       if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required
00353 
00354       Slope tileh = GetTileSlope(tile);
00355       bool swap = (axis == AXIS_Y && HasBit(tileh, CORNER_W) != HasBit(tileh, CORNER_E));
00356 
00357       return GetNearbyTileInformation(tile, object->grffile->grf_version >= 8) ^ (swap ? SLOPE_EW : 0);
00358     }
00359 
00360     case 0x68: { // Station info of nearby tiles
00361       TileIndex nearby_tile = GetNearbyTile(parameter, tile);
00362 
00363       if (!HasStationTileRail(nearby_tile)) return 0xFFFFFFFF;
00364 
00365       uint32 grfid = st->speclist[GetCustomStationSpecIndex(tile)].grfid;
00366       bool perpendicular = GetRailStationAxis(tile) != GetRailStationAxis(nearby_tile);
00367       bool same_station = st->TileBelongsToRailStation(nearby_tile);
00368       uint32 res = GB(GetStationGfx(nearby_tile), 1, 2) << 12 | !!perpendicular << 11 | !!same_station << 10;
00369 
00370       if (IsCustomStationSpecIndex(nearby_tile)) {
00371         const StationSpecList ssl = BaseStation::GetByTile(nearby_tile)->speclist[GetCustomStationSpecIndex(nearby_tile)];
00372         res |= 1 << (ssl.grfid != grfid ? 9 : 8) | ssl.localidx;
00373       }
00374       return res;
00375     }
00376 
00377     /* General station variables */
00378     case 0x82: return 50;
00379     case 0x84: return st->string_id;
00380     case 0x86: return 0;
00381     case 0xF0: return st->facilities;
00382     case 0xFA: return Clamp(st->build_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535);
00383   }
00384 
00385   return st->GetNewGRFVariable(object, variable, parameter, available);
00386 }
00387 
00388 uint32 Station::GetNewGRFVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) const
00389 {
00390   switch (variable) {
00391     case 0x48: { // Accepted cargo types
00392       CargoID cargo_type;
00393       uint32 value = 0;
00394 
00395       for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
00396         if (HasBit(this->goods[cargo_type].acceptance_pickup, GoodsEntry::GES_PICKUP)) SetBit(value, cargo_type);
00397       }
00398       return value;
00399     }
00400 
00401     case 0x8A: return this->had_vehicle_of_type;
00402     case 0xF1: return (this->airport.tile != INVALID_TILE) ? this->airport.GetSpec()->ttd_airport_type : ATP_TTDP_LARGE;
00403     case 0xF2: return (this->truck_stops != NULL) ? this->truck_stops->status : 0;
00404     case 0xF3: return (this->bus_stops != NULL)   ? this->bus_stops->status   : 0;
00405     case 0xF6: return this->airport.flags;
00406     case 0xF7: return GB(this->airport.flags, 8, 8);
00407   }
00408 
00409   /* Handle cargo variables with parameter, 0x60 to 0x65 and 0x69 */
00410   if ((variable >= 0x60 && variable <= 0x65) || variable == 0x69) {
00411     CargoID c = GetCargoTranslation(parameter, object->grffile);
00412 
00413     if (c == CT_INVALID) return 0;
00414     const GoodsEntry *ge = &this->goods[c];
00415 
00416     switch (variable) {
00417       case 0x60: return min(ge->cargo.Count(), 4095);
00418       case 0x61: return ge->days_since_pickup;
00419       case 0x62: return ge->rating;
00420       case 0x63: return ge->cargo.DaysInTransit();
00421       case 0x64: return ge->last_speed | (ge->last_age << 8);
00422       case 0x65: return GB(ge->acceptance_pickup, GoodsEntry::GES_ACCEPTANCE, 1) << 3;
00423       case 0x69: return GB(ge->acceptance_pickup, GoodsEntry::GES_EVER_ACCEPTED, 4);
00424     }
00425   }
00426 
00427   /* Handle cargo variables (deprecated) */
00428   if (variable >= 0x8C && variable <= 0xEC) {
00429     const GoodsEntry *g = &this->goods[GB(variable - 0x8C, 3, 4)];
00430     switch (GB(variable - 0x8C, 0, 3)) {
00431       case 0: return g->cargo.Count();
00432       case 1: return GB(min(g->cargo.Count(), 4095), 0, 4) | (GB(g->acceptance_pickup, GoodsEntry::GES_ACCEPTANCE, 1) << 7);
00433       case 2: return g->days_since_pickup;
00434       case 3: return g->rating;
00435       case 4: return g->cargo.Source();
00436       case 5: return g->cargo.DaysInTransit();
00437       case 6: return g->last_speed;
00438       case 7: return g->last_age;
00439     }
00440   }
00441 
00442   DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
00443 
00444   *available = false;
00445   return UINT_MAX;
00446 }
00447 
00448 uint32 Waypoint::GetNewGRFVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) const
00449 {
00450   switch (variable) {
00451     case 0x48: return 0; // Accepted cargo types
00452     case 0x8A: return HVOT_WAYPOINT;
00453     case 0xF1: return 0; // airport type
00454     case 0xF2: return 0; // truck stop status
00455     case 0xF3: return 0; // bus stop status
00456     case 0xF6: return 0; // airport flags
00457     case 0xF7: return 0; // airport flags cont.
00458   }
00459 
00460   /* Handle cargo variables with parameter, 0x60 to 0x65 */
00461   if (variable >= 0x60 && variable <= 0x65) {
00462     return 0;
00463   }
00464 
00465   /* Handle cargo variables (deprecated) */
00466   if (variable >= 0x8C && variable <= 0xEC) {
00467     switch (GB(variable - 0x8C, 0, 3)) {
00468       case 3: return INITIAL_STATION_RATING;
00469       case 4: return INVALID_STATION;
00470       default: return 0;
00471     }
00472   }
00473 
00474   DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
00475 
00476   *available = false;
00477   return UINT_MAX;
00478 }
00479 
00480 static const SpriteGroup *StationResolveReal(const ResolverObject *object, const RealSpriteGroup *group)
00481 {
00482   const BaseStation *bst = object->u.station.st;
00483   const StationSpec *statspec = object->u.station.statspec;
00484   uint set;
00485 
00486   uint cargo = 0;
00487   CargoID cargo_type = object->u.station.cargo_type;
00488 
00489   if (bst == NULL || statspec->cls_id == STAT_CLASS_WAYP) {
00490     return group->loading[0];
00491   }
00492 
00493   const Station *st = Station::From(bst);
00494 
00495   switch (cargo_type) {
00496     case CT_INVALID:
00497     case CT_DEFAULT_NA:
00498     case CT_PURCHASE:
00499       cargo = 0;
00500       break;
00501 
00502     case CT_DEFAULT:
00503       for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
00504         cargo += st->goods[cargo_type].cargo.Count();
00505       }
00506       break;
00507 
00508     default:
00509       cargo = st->goods[cargo_type].cargo.Count();
00510       break;
00511   }
00512 
00513   if (HasBit(statspec->flags, SSF_DIV_BY_STATION_SIZE)) cargo /= (st->train_station.w + st->train_station.h);
00514   cargo = min(0xfff, cargo);
00515 
00516   if (cargo > statspec->cargo_threshold) {
00517     if (group->num_loading > 0) {
00518       set = ((cargo - statspec->cargo_threshold) * group->num_loading) / (4096 - statspec->cargo_threshold);
00519       return group->loading[set];
00520     }
00521   } else {
00522     if (group->num_loaded > 0) {
00523       set = (cargo * group->num_loaded) / (statspec->cargo_threshold + 1);
00524       return group->loaded[set];
00525     }
00526   }
00527 
00528   return group->loading[0];
00529 }
00530 
00531 
00538 void StationStorePSA(ResolverObject *object, uint pos, int32 value)
00539 {
00540   /* Stations have no persistent storage. */
00541   BaseStation *st = object->u.station.st;
00542   if (object->scope != VSG_SCOPE_PARENT || st == NULL) return;
00543 
00544   TownStorePSA(st->town, object->grffile, pos, value);
00545 }
00546 
00547 static void NewStationResolver(ResolverObject *res, const StationSpec *statspec, BaseStation *st, TileIndex tile)
00548 {
00549   res->GetRandomBits = StationGetRandomBits;
00550   res->GetTriggers   = StationGetTriggers;
00551   res->SetTriggers   = StationSetTriggers;
00552   res->GetVariable   = StationGetVariable;
00553   res->ResolveReal   = StationResolveReal;
00554   res->StorePSA      = StationStorePSA;
00555 
00556   res->u.station.st       = st;
00557   res->u.station.statspec = statspec;
00558   res->u.station.tile     = tile;
00559   res->u.station.axis     = INVALID_AXIS;
00560 
00561   res->callback        = CBID_NO_CALLBACK;
00562   res->callback_param1 = 0;
00563   res->callback_param2 = 0;
00564   res->ResetState();
00565 
00566   res->grffile         = (statspec != NULL ? statspec->grf_prop.grffile : NULL);
00567 
00568   /* Invalidate all cached vars */
00569   _svc.valid = 0;
00570 }
00571 
00572 static const SpriteGroup *ResolveStation(ResolverObject *object)
00573 {
00574   const SpriteGroup *group;
00575   CargoID ctype = CT_DEFAULT_NA;
00576 
00577   if (object->u.station.st == NULL) {
00578     /* No station, so we are in a purchase list */
00579     ctype = CT_PURCHASE;
00580   } else if (Station::IsExpected(object->u.station.st)) {
00581     const Station *st = Station::From(object->u.station.st);
00582     /* Pick the first cargo that we have waiting */
00583     const CargoSpec *cs;
00584     FOR_ALL_CARGOSPECS(cs) {
00585       if (object->u.station.statspec->grf_prop.spritegroup[cs->Index()] != NULL &&
00586           !st->goods[cs->Index()].cargo.Empty()) {
00587         ctype = cs->Index();
00588         break;
00589       }
00590     }
00591   }
00592 
00593   group = object->u.station.statspec->grf_prop.spritegroup[ctype];
00594   if (group == NULL) {
00595     ctype = CT_DEFAULT;
00596     group = object->u.station.statspec->grf_prop.spritegroup[ctype];
00597   }
00598 
00599   if (group == NULL) return NULL;
00600 
00601   /* Remember the cargo type we've picked */
00602   object->u.station.cargo_type = ctype;
00603 
00604   return SpriteGroup::Resolve(group, object);
00605 }
00606 
00615 SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32 var10)
00616 {
00617   const SpriteGroup *group;
00618   ResolverObject object;
00619 
00620   NewStationResolver(&object, statspec, st, tile);
00621   object.callback_param1 = var10;
00622 
00623   group = ResolveStation(&object);
00624   if (group == NULL || group->type != SGT_RESULT) return 0;
00625   return group->GetResult() - 0x42D;
00626 }
00627 
00637 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info)
00638 {
00639   const SpriteGroup *group;
00640   ResolverObject object;
00641 
00642   NewStationResolver(&object, statspec, st, tile);
00643   object.callback_param1 = 2; // Indicate we are resolving the foundation sprites
00644   object.callback_param2 = layout | (edge_info << 16);
00645 
00646   ClearRegister(0x100);
00647   group = ResolveStation(&object);
00648   if (group == NULL || group->type != SGT_RESULT) return 0;
00649   return group->GetResult() + GetRegister(0x100);
00650 }
00651 
00652 
00653 uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile)
00654 {
00655   const SpriteGroup *group;
00656   ResolverObject object;
00657 
00658   NewStationResolver(&object, statspec, st, tile);
00659 
00660   object.callback        = callback;
00661   object.callback_param1 = param1;
00662   object.callback_param2 = param2;
00663 
00664   group = ResolveStation(&object);
00665   if (group == NULL) return CALLBACK_FAILED;
00666   return group->GetCallbackResult();
00667 }
00668 
00679 CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte numtracks)
00680 {
00681   TileIndexDiff diff = cur_tile - north_tile;
00682   Slope slope = GetTileSlope(cur_tile);
00683 
00684   ResolverObject object;
00685   NewStationResolver(&object, statspec, NULL, cur_tile);
00686 
00687   object.callback        = CBID_STATION_LAND_SLOPE_CHECK;
00688   object.callback_param1 = slope << 4 | (slope ^ (axis == AXIS_Y && HasBit(slope, CORNER_W) != HasBit(slope, CORNER_E) ? SLOPE_EW : 0));
00689   object.callback_param2 = numtracks << 24 | plat_len << 16 | (axis == AXIS_Y ? TileX(diff) << 8 | TileY(diff) : TileY(diff) << 8 | TileX(diff));
00690   object.u.station.axis  = axis;
00691 
00692   const SpriteGroup *group = ResolveStation(&object);
00693   uint16 cb_res = group != NULL ? group->GetCallbackResult() : CALLBACK_FAILED;
00694 
00695   /* Failed callback means success. */
00696   if (cb_res == CALLBACK_FAILED) return CommandCost();
00697 
00698   /* The meaning of bit 10 is inverted for a grf version < 8. */
00699   if (statspec->grf_prop.grffile->grf_version < 8) ToggleBit(cb_res, 10);
00700   return GetErrorMessageFromLocationCallbackResult(cb_res, statspec->grf_prop.grffile->grfid, STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
00701 }
00702 
00703 
00711 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec)
00712 {
00713   uint i;
00714 
00715   if (statspec == NULL || st == NULL) return 0;
00716 
00717   for (i = 1; i < st->num_specs && i < MAX_SPECLIST; i++) {
00718     if (st->speclist[i].spec == NULL && st->speclist[i].grfid == 0) break;
00719   }
00720 
00721   if (i == MAX_SPECLIST) {
00722     /* As final effort when the spec list is already full...
00723      * try to find the same spec and return that one. This might
00724      * result in slighty "wrong" (as per specs) looking stations,
00725      * but it's fairly unlikely that one reaches the limit anyways.
00726      */
00727     for (i = 1; i < st->num_specs && i < MAX_SPECLIST; i++) {
00728       if (st->speclist[i].spec == statspec) return i;
00729     }
00730 
00731     return -1;
00732   }
00733 
00734   if (exec) {
00735     if (i >= st->num_specs) {
00736       st->num_specs = i + 1;
00737       st->speclist = ReallocT(st->speclist, st->num_specs);
00738 
00739       if (st->num_specs == 2) {
00740         /* Initial allocation */
00741         st->speclist[0].spec     = NULL;
00742         st->speclist[0].grfid    = 0;
00743         st->speclist[0].localidx = 0;
00744       }
00745     }
00746 
00747     st->speclist[i].spec     = statspec;
00748     st->speclist[i].grfid    = statspec->grf_prop.grffile->grfid;
00749     st->speclist[i].localidx = statspec->grf_prop.local_id;
00750   }
00751 
00752   return i;
00753 }
00754 
00755 
00762 void DeallocateSpecFromStation(BaseStation *st, byte specindex)
00763 {
00764   /* specindex of 0 (default) is never freeable */
00765   if (specindex == 0) return;
00766 
00767   ETileArea area = ETileArea(st, INVALID_TILE, TA_WHOLE);
00768   /* Check all tiles over the station to check if the specindex is still in use */
00769   TILE_AREA_LOOP(tile, area) {
00770     if (st->TileBelongsToRailStation(tile) && GetCustomStationSpecIndex(tile) == specindex) {
00771       return;
00772     }
00773   }
00774 
00775   /* This specindex is no longer in use, so deallocate it */
00776   st->speclist[specindex].spec     = NULL;
00777   st->speclist[specindex].grfid    = 0;
00778   st->speclist[specindex].localidx = 0;
00779 
00780   /* If this was the highest spec index, reallocate */
00781   if (specindex == st->num_specs - 1) {
00782     for (; st->speclist[st->num_specs - 1].grfid == 0 && st->num_specs > 1; st->num_specs--) {}
00783 
00784     if (st->num_specs > 1) {
00785       st->speclist = ReallocT(st->speclist, st->num_specs);
00786     } else {
00787       free(st->speclist);
00788       st->num_specs = 0;
00789       st->speclist  = NULL;
00790       st->cached_anim_triggers = 0;
00791       return;
00792     }
00793   }
00794 
00795   StationUpdateAnimTriggers(st);
00796 }
00797 
00808 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station)
00809 {
00810   const DrawTileSprites *sprites = NULL;
00811   const RailtypeInfo *rti = GetRailTypeInfo(railtype);
00812   PaletteID palette = COMPANY_SPRITE_COLOUR(_local_company);
00813   uint tile = 2;
00814 
00815   const StationSpec *statspec = StationClass::Get(sclass)->GetSpec(station);
00816   if (statspec == NULL) return false;
00817 
00818   if (HasBit(statspec->callback_mask, CBM_STATION_SPRITE_LAYOUT)) {
00819     uint16 callback = GetStationCallback(CBID_STATION_SPRITE_LAYOUT, 0x2110000, 0, statspec, NULL, INVALID_TILE);
00820     if (callback != CALLBACK_FAILED) tile = callback;
00821   }
00822 
00823   uint32 total_offset = rti->GetRailtypeSpriteOffset();
00824   uint32 relocation = 0;
00825   uint32 ground_relocation = 0;
00826   const NewGRFSpriteLayout *layout = NULL;
00827   DrawTileSprites tmp_rail_layout;
00828 
00829   if (statspec->renderdata == NULL) {
00830     sprites = GetStationTileLayout(STATION_RAIL, tile + axis);
00831   } else {
00832     layout = &statspec->renderdata[(tile < statspec->tiles) ? tile + axis : (uint)axis];
00833     if (!layout->NeedsPreprocessing()) {
00834       sprites = layout;
00835       layout = NULL;
00836     }
00837   }
00838 
00839   if (layout != NULL) {
00840     /* Sprite layout which needs preprocessing */
00841     bool separate_ground = HasBit(statspec->flags, SSF_SEPARATE_GROUND);
00842     uint32 var10_values = layout->PrepareLayout(total_offset, rti->fallback_railtype, 0, 0, separate_ground);
00843     uint8 var10;
00844     FOR_EACH_SET_BIT(var10, var10_values) {
00845       uint32 var10_relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, var10);
00846       layout->ProcessRegisters(var10, var10_relocation, separate_ground);
00847     }
00848 
00849     tmp_rail_layout.seq = layout->GetLayout(&tmp_rail_layout.ground);
00850     sprites = &tmp_rail_layout;
00851     total_offset = 0;
00852   } else {
00853     /* Simple sprite layout */
00854     ground_relocation = relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, 0);
00855     if (HasBit(sprites->ground.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE)) {
00856       ground_relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, 1);
00857     }
00858     ground_relocation += rti->fallback_railtype;
00859   }
00860 
00861   SpriteID image = sprites->ground.sprite;
00862   PaletteID pal = sprites->ground.pal;
00863   image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
00864   if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
00865 
00866   DrawSprite(image, GroundSpritePaletteTransform(image, pal, palette), x, y);
00867 
00868   DrawRailTileSeqInGUI(x, y, sprites, total_offset, relocation, palette);
00869 
00870   return true;
00871 }
00872 
00873 
00874 const StationSpec *GetStationSpec(TileIndex t)
00875 {
00876   if (!IsCustomStationSpecIndex(t)) return NULL;
00877 
00878   const BaseStation *st = BaseStation::GetByTile(t);
00879   uint specindex = GetCustomStationSpecIndex(t);
00880   return specindex < st->num_specs ? st->speclist[specindex].spec : NULL;
00881 }
00882 
00883 
00890 bool IsStationTileBlocked(TileIndex tile)
00891 {
00892   const StationSpec *statspec = GetStationSpec(tile);
00893 
00894   return statspec != NULL && HasBit(statspec->blocked, GetStationGfx(tile));
00895 }
00896 
00903 bool CanStationTileHavePylons(TileIndex tile)
00904 {
00905   const StationSpec *statspec = GetStationSpec(tile);
00906   uint gfx = GetStationGfx(tile);
00907   /* Default stations do not draw pylons under roofs (gfx >= 4) */
00908   return statspec != NULL ? HasBit(statspec->pylons, gfx) : gfx < 4;
00909 }
00910 
00917 bool CanStationTileHaveWires(TileIndex tile)
00918 {
00919   const StationSpec *statspec = GetStationSpec(tile);
00920   return statspec == NULL || !HasBit(statspec->wires, GetStationGfx(tile));
00921 }
00922 
00924 uint16 GetAnimStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile, int extra_data)
00925 {
00926   return GetStationCallback(callback, param1, param2, statspec, st, tile);
00927 }
00928 
00930 struct StationAnimationBase : public AnimationBase<StationAnimationBase, StationSpec, BaseStation, int, GetAnimStationCallback> {
00931   static const CallbackID cb_animation_speed      = CBID_STATION_ANIMATION_SPEED;
00932   static const CallbackID cb_animation_next_frame = CBID_STATION_ANIM_NEXT_FRAME;
00933 
00934   static const StationCallbackMask cbm_animation_speed      = CBM_STATION_ANIMATION_SPEED;
00935   static const StationCallbackMask cbm_animation_next_frame = CBM_STATION_ANIMATION_NEXT_FRAME;
00936 };
00937 
00938 void AnimateStationTile(TileIndex tile)
00939 {
00940   const StationSpec *ss = GetStationSpec(tile);
00941   if (ss == NULL) return;
00942 
00943   StationAnimationBase::AnimateTile(ss, BaseStation::GetByTile(tile), tile, HasBit(ss->flags, SSF_CB141_RANDOM_BITS));
00944 }
00945 
00946 void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type)
00947 {
00948   /* List of coverage areas for each animation trigger */
00949   static const TriggerArea tas[] = {
00950     TA_TILE, TA_WHOLE, TA_WHOLE, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM, TA_WHOLE
00951   };
00952 
00953   /* Get Station if it wasn't supplied */
00954   if (st == NULL) st = BaseStation::GetByTile(tile);
00955 
00956   /* Check the cached animation trigger bitmask to see if we need
00957    * to bother with any further processing. */
00958   if (!HasBit(st->cached_anim_triggers, trigger)) return;
00959 
00960   uint16 random_bits = Random();
00961   ETileArea area = ETileArea(st, tile, tas[trigger]);
00962 
00963   /* Check all tiles over the station to check if the specindex is still in use */
00964   TILE_AREA_LOOP(tile, area) {
00965     if (st->TileBelongsToRailStation(tile)) {
00966       const StationSpec *ss = GetStationSpec(tile);
00967       if (ss != NULL && HasBit(ss->animation.triggers, trigger)) {
00968         CargoID cargo;
00969         if (cargo_type == CT_INVALID) {
00970           cargo = CT_INVALID;
00971         } else {
00972           cargo = ss->grf_prop.grffile->cargo_map[cargo_type];
00973         }
00974         StationAnimationBase::ChangeAnimationFrame(CBID_STATION_ANIM_START_STOP, ss, st, tile, (random_bits << 16) | Random(), (uint8)trigger | (cargo << 8));
00975       }
00976     }
00977   }
00978 }
00979 
00984 void StationUpdateAnimTriggers(BaseStation *st)
00985 {
00986   st->cached_anim_triggers = 0;
00987 
00988   /* Combine animation trigger bitmask for all station specs
00989    * of this station. */
00990   for (uint i = 0; i < st->num_specs; i++) {
00991     const StationSpec *ss = st->speclist[i].spec;
00992     if (ss != NULL) st->cached_anim_triggers |= ss->animation.triggers;
00993   }
00994 }
00995 
01001 void GetStationResolver(ResolverObject *ro, uint index)
01002 {
01003   NewStationResolver(ro, GetStationSpec(index), Station::GetByTile(index), index);
01004 }