newgrf_station.cpp

Go to the documentation of this file.
00001 /* $Id: newgrf_station.cpp 23154 2011-11-08 17:29:01Z frosch $ */
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.h"
00027 #include "newgrf_animation_base.h"
00028 #include "newgrf_class_func.h"
00029 
00030 
00031 template <typename Tspec, typename Tid, Tid Tmax>
00032 /* static */ void NewGRFClass<Tspec, Tid, Tmax>::InsertDefaults()
00033 {
00034   /* Set up initial data */
00035   classes[0].global_id = 'DFLT';
00036   classes[0].name = STR_STATION_CLASS_DFLT;
00037   classes[0].count = 1;
00038   classes[0].spec = MallocT<StationSpec*>(1);
00039   classes[0].spec[0] = NULL;
00040 
00041   classes[1].global_id = 'WAYP';
00042   classes[1].name = STR_STATION_CLASS_WAYP;
00043   classes[1].count = 1;
00044   classes[1].spec = MallocT<StationSpec*>(1);
00045   classes[1].spec[0] = NULL;
00046 }
00047 
00048 INSTANTIATE_NEWGRF_CLASS_METHODS(StationClass, StationSpec, StationClassID, STAT_CLASS_MAX)
00049 
00050 static const uint MAX_SPECLIST = 255;
00051 
00052 enum TriggerArea {
00053   TA_TILE,
00054   TA_PLATFORM,
00055   TA_WHOLE,
00056 };
00057 
00058 struct ETileArea : TileArea {
00059   ETileArea(const BaseStation *st, TileIndex tile, TriggerArea ta)
00060   {
00061     switch (ta) {
00062       default: NOT_REACHED();
00063 
00064       case TA_TILE:
00065         this->tile = tile;
00066         this->w    = 1;
00067         this->h    = 1;
00068         break;
00069 
00070       case TA_PLATFORM: {
00071         TileIndex start, end;
00072         Axis axis = GetRailStationAxis(tile);
00073         TileIndexDiff delta = TileOffsByDiagDir(AxisToDiagDir(axis));
00074 
00075         for (end = tile; IsRailStationTile(end + delta) && IsCompatibleTrainStationTile(tile, end + delta); end += delta) { /* Nothing */ }
00076         for (start = tile; IsRailStationTile(start - delta) && IsCompatibleTrainStationTile(tile, start - delta); start -= delta) { /* Nothing */ }
00077 
00078         this->tile = start;
00079         this->w = TileX(end) - TileX(start) + 1;
00080         this->h = TileY(end) - TileY(start) + 1;
00081         break;
00082       }
00083 
00084       case TA_WHOLE:
00085         st->GetTileArea(this, Station::IsExpected(st) ? STATION_RAIL : STATION_WAYPOINT);
00086         break;
00087     }
00088   }
00089 };
00090 
00091 
00104 uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred)
00105 {
00106   uint32 retval = 0;
00107 
00108   if (axis == AXIS_X) {
00109     Swap(platforms, length);
00110     Swap(x, y);
00111   }
00112 
00113   if (centred) {
00114     x -= platforms / 2;
00115     y -= length / 2;
00116     x = Clamp(x, -8, 7);
00117     y = Clamp(y, -8, 7);
00118     SB(retval,  0, 4, y & 0xF);
00119     SB(retval,  4, 4, x & 0xF);
00120   } else {
00121     SB(retval,  0, 4, min(15, y));
00122     SB(retval,  4, 4, min(15, length - y - 1));
00123     SB(retval,  8, 4, min(15, x));
00124     SB(retval, 12, 4, min(15, platforms - x - 1));
00125   }
00126   SB(retval, 16, 4, min(15, length));
00127   SB(retval, 20, 4, min(15, platforms));
00128   SB(retval, 24, 4, tile);
00129 
00130   return retval;
00131 }
00132 
00133 
00142 static TileIndex FindRailStationEnd(TileIndex tile, TileIndexDiff delta, bool check_type, bool check_axis)
00143 {
00144   byte orig_type = 0;
00145   Axis orig_axis = AXIS_X;
00146   StationID sid = GetStationIndex(tile);
00147 
00148   if (check_type) orig_type = GetCustomStationSpecIndex(tile);
00149   if (check_axis) orig_axis = GetRailStationAxis(tile);
00150 
00151   for (;;) {
00152     TileIndex new_tile = TILE_ADD(tile, delta);
00153 
00154     if (!IsTileType(new_tile, MP_STATION) || GetStationIndex(new_tile) != sid) break;
00155     if (!HasStationRail(new_tile)) break;
00156     if (check_type && GetCustomStationSpecIndex(new_tile) != orig_type) break;
00157     if (check_axis && GetRailStationAxis(new_tile) != orig_axis) break;
00158 
00159     tile = new_tile;
00160   }
00161   return tile;
00162 }
00163 
00164 
00165 static uint32 GetPlatformInfoHelper(TileIndex tile, bool check_type, bool check_axis, bool centred)
00166 {
00167   int tx = TileX(tile);
00168   int ty = TileY(tile);
00169   int sx = TileX(FindRailStationEnd(tile, TileDiffXY(-1,  0), check_type, check_axis));
00170   int sy = TileY(FindRailStationEnd(tile, TileDiffXY( 0, -1), check_type, check_axis));
00171   int ex = TileX(FindRailStationEnd(tile, TileDiffXY( 1,  0), check_type, check_axis)) + 1;
00172   int ey = TileY(FindRailStationEnd(tile, TileDiffXY( 0,  1), check_type, check_axis)) + 1;
00173 
00174   tx -= sx; ex -= sx;
00175   ty -= sy; ey -= sy;
00176 
00177   return GetPlatformInfo(GetRailStationAxis(tile), GetStationGfx(tile), ex, ey, tx, ty, centred);
00178 }
00179 
00180 
00181 static uint32 GetRailContinuationInfo(TileIndex tile)
00182 {
00183   /* Tile offsets and exit dirs for X axis */
00184   static const Direction x_dir[8] = { DIR_SW, DIR_NE, DIR_SE, DIR_NW, DIR_S, DIR_E, DIR_W, DIR_N };
00185   static const DiagDirection x_exits[8] = { DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SW, DIAGDIR_NE };
00186 
00187   /* Tile offsets and exit dirs for Y axis */
00188   static const Direction y_dir[8] = { DIR_SE, DIR_NW, DIR_SW, DIR_NE, DIR_S, DIR_W, DIR_E, DIR_N };
00189   static const DiagDirection y_exits[8] = { DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SE, DIAGDIR_NW };
00190 
00191   Axis axis = GetRailStationAxis(tile);
00192 
00193   /* Choose appropriate lookup table to use */
00194   const Direction *dir = axis == AXIS_X ? x_dir : y_dir;
00195   const DiagDirection *diagdir = axis == AXIS_X ? x_exits : y_exits;
00196 
00197   uint32 res = 0;
00198   uint i;
00199 
00200   for (i = 0; i < lengthof(x_dir); i++, dir++, diagdir++) {
00201     TileIndex neighbour_tile = tile + TileOffsByDir(*dir);
00202     TrackBits trackbits = TrackStatusToTrackBits(GetTileTrackStatus(neighbour_tile, TRANSPORT_RAIL, 0));
00203     if (trackbits != TRACK_BIT_NONE) {
00204       /* If there is any track on the tile, set the bit in the second byte */
00205       SetBit(res, i + 8);
00206 
00207       /* With tunnels and bridges the tile has tracks, but they are not necessarily connected
00208        * with the next tile because the ramp is not going in the right direction. */
00209       if (IsTileType(neighbour_tile, MP_TUNNELBRIDGE) && GetTunnelBridgeDirection(neighbour_tile) != *diagdir) {
00210         continue;
00211       }
00212 
00213       /* If any track reaches our exit direction, set the bit in the lower byte */
00214       if (trackbits & DiagdirReachesTracks(*diagdir)) SetBit(res, i);
00215     }
00216   }
00217 
00218   return res;
00219 }
00220 
00221 
00222 /* Station Resolver Functions */
00223 static uint32 StationGetRandomBits(const ResolverObject *object)
00224 {
00225   const BaseStation *st = object->u.station.st;
00226   const TileIndex tile = object->u.station.tile;
00227   return (st == NULL ? 0 : st->random_bits) | (tile == INVALID_TILE ? 0 : GetStationTileRandomBits(tile) << 16);
00228 }
00229 
00230 
00231 static uint32 StationGetTriggers(const ResolverObject *object)
00232 {
00233   const BaseStation *st = object->u.station.st;
00234   return st == NULL ? 0 : st->waiting_triggers;
00235 }
00236 
00237 
00238 static void StationSetTriggers(const ResolverObject *object, int triggers)
00239 {
00240   BaseStation *st = const_cast<BaseStation *>(object->u.station.st);
00241   assert(st != NULL);
00242   st->waiting_triggers = triggers;
00243 }
00244 
00250 static struct {
00251   uint32 v40;
00252   uint32 v41;
00253   uint32 v45;
00254   uint32 v46;
00255   uint32 v47;
00256   uint32 v49;
00257   uint8 valid; 
00258 } _svc;
00259 
00260 static uint32 StationGetVariable(const ResolverObject *object, byte variable, uint32 parameter, bool *available)
00261 {
00262   const BaseStation *st = object->u.station.st;
00263   TileIndex tile = object->u.station.tile;
00264 
00265   if (object->scope == VSG_SCOPE_PARENT) {
00266     /* Pass the request on to the town of the station */
00267     Town *t;
00268 
00269     if (st != NULL) {
00270       t = st->town;
00271     } else if (tile != INVALID_TILE) {
00272       t = ClosestTownFromTile(tile, UINT_MAX);
00273     } else {
00274       *available = false;
00275       return UINT_MAX;
00276     }
00277 
00278     return TownGetVariable(variable, parameter, available, t, object->grffile);
00279   }
00280 
00281   if (st == NULL) {
00282     /* Station does not exist, so we're in a purchase list or the land slope check callback. */
00283     switch (variable) {
00284       case 0x40:
00285       case 0x41:
00286       case 0x46:
00287       case 0x47:
00288       case 0x49: return 0x2110000;        // Platforms, tracks & position
00289       case 0x42: return 0;                // Rail type (XXX Get current type from GUI?)
00290       case 0x43: return GetCompanyInfo(_current_company); // Station owner
00291       case 0x44: return 2;                // PBS status
00292       case 0x67: // Land info of nearby tile
00293         if (object->u.station.axis != INVALID_AXIS && tile != INVALID_TILE) {
00294           if (parameter != 0) tile = GetNearbyTile(parameter, tile, true, object->u.station.axis); // only perform if it is required
00295 
00296           Slope tileh = GetTileSlope(tile);
00297           bool swap = (object->u.station.axis == AXIS_Y && HasBit(tileh, CORNER_W) != HasBit(tileh, CORNER_E));
00298 
00299           return GetNearbyTileInformation(tile, object->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(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(tile, true,  false, false); SetBit(_svc.valid, 1); }
00318       return _svc.v41;
00319 
00320     case 0x42: return GetTerrainType(tile) | (GetReverseRailTypeTranslation(GetRailType(tile), object->u.station.statspec->grf_prop.grffile) << 8);
00321     case 0x43: return GetCompanyInfo(st->owner); // Station owner
00322     case 0x44: return HasStationReservation(tile) ? 7 : 4; // PBS status
00323     case 0x45:
00324       if (!HasBit(_svc.valid, 2)) { _svc.v45 = GetRailContinuationInfo(tile); SetBit(_svc.valid, 2); }
00325       return _svc.v45;
00326 
00327     case 0x46:
00328       if (!HasBit(_svc.valid, 3)) { _svc.v46 = GetPlatformInfoHelper(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(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(tile, false, true, false); SetBit(_svc.valid, 5); }
00337       return _svc.v49;
00338 
00339     case 0x4A: // Animation frame of tile
00340       return GetAnimationFrame(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       if (parameter != 0) tile = GetNearbyTile(parameter, tile);
00346       return st->TileBelongsToRailStation(tile) ? GetAnimationFrame(tile) : UINT_MAX;
00347 
00348     case 0x67: { // Land info of nearby tile
00349       Axis axis = GetRailStationAxis(tile);
00350 
00351       if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required
00352 
00353       Slope tileh = GetTileSlope(tile);
00354       bool swap = (axis == AXIS_Y && HasBit(tileh, CORNER_W) != HasBit(tileh, CORNER_E));
00355 
00356       return GetNearbyTileInformation(tile, object->grffile->grf_version >= 8) ^ (swap ? SLOPE_EW : 0);
00357     }
00358 
00359     case 0x68: { // Station info of nearby tiles
00360       TileIndex nearby_tile = GetNearbyTile(parameter, tile);
00361 
00362       if (!HasStationTileRail(nearby_tile)) return 0xFFFFFFFF;
00363 
00364       uint32 grfid = st->speclist[GetCustomStationSpecIndex(tile)].grfid;
00365       bool perpendicular = GetRailStationAxis(tile) != GetRailStationAxis(nearby_tile);
00366       bool same_station = st->TileBelongsToRailStation(nearby_tile);
00367       uint32 res = GB(GetStationGfx(nearby_tile), 1, 2) << 12 | !!perpendicular << 11 | !!same_station << 10;
00368 
00369       if (IsCustomStationSpecIndex(nearby_tile)) {
00370         const StationSpecList ssl = BaseStation::GetByTile(nearby_tile)->speclist[GetCustomStationSpecIndex(nearby_tile)];
00371         res |= 1 << (ssl.grfid != grfid ? 9 : 8) | ssl.localidx;
00372       }
00373       return res;
00374     }
00375 
00376     /* General station variables */
00377     case 0x82: return 50;
00378     case 0x84: return st->string_id;
00379     case 0x86: return 0;
00380     case 0xF0: return st->facilities;
00381     case 0xFA: return Clamp(st->build_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535);
00382   }
00383 
00384   return st->GetNewGRFVariable(object, variable, parameter, available);
00385 }
00386 
00387 uint32 Station::GetNewGRFVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) const
00388 {
00389   switch (variable) {
00390     case 0x48: { // Accepted cargo types
00391       CargoID cargo_type;
00392       uint32 value = 0;
00393 
00394       for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
00395         if (HasBit(this->goods[cargo_type].acceptance_pickup, GoodsEntry::GES_PICKUP)) SetBit(value, cargo_type);
00396       }
00397       return value;
00398     }
00399 
00400     case 0x8A: return this->had_vehicle_of_type;
00401     case 0xF1: return (this->airport.tile != INVALID_TILE) ? this->airport.GetSpec()->ttd_airport_type : ATP_TTDP_LARGE;
00402     case 0xF2: return (this->truck_stops != NULL) ? this->truck_stops->status : 0;
00403     case 0xF3: return (this->bus_stops != NULL)   ? this->bus_stops->status   : 0;
00404     case 0xF6: return this->airport.flags;
00405     case 0xF7: return GB(this->airport.flags, 8, 8);
00406   }
00407 
00408   /* Handle cargo variables with parameter, 0x60 to 0x65 and 0x69 */
00409   if ((variable >= 0x60 && variable <= 0x65) || variable == 0x69) {
00410     CargoID c = GetCargoTranslation(parameter, object->u.station.statspec->grf_prop.grffile);
00411 
00412     if (c == CT_INVALID) return 0;
00413     const GoodsEntry *ge = &this->goods[c];
00414 
00415     switch (variable) {
00416       case 0x60: return min(ge->cargo.Count(), 4095);
00417       case 0x61: return ge->days_since_pickup;
00418       case 0x62: return ge->rating;
00419       case 0x63: return ge->cargo.DaysInTransit();
00420       case 0x64: return ge->last_speed | (ge->last_age << 8);
00421       case 0x65: return GB(ge->acceptance_pickup, GoodsEntry::GES_ACCEPTANCE, 1) << 3;
00422       case 0x69: return GB(ge->acceptance_pickup, GoodsEntry::GES_EVER_ACCEPTED, 4);
00423     }
00424   }
00425 
00426   /* Handle cargo variables (deprecated) */
00427   if (variable >= 0x8C && variable <= 0xEC) {
00428     const GoodsEntry *g = &this->goods[GB(variable - 0x8C, 3, 4)];
00429     switch (GB(variable - 0x8C, 0, 3)) {
00430       case 0: return g->cargo.Count();
00431       case 1: return GB(min(g->cargo.Count(), 4095), 0, 4) | (GB(g->acceptance_pickup, GoodsEntry::GES_ACCEPTANCE, 1) << 7);
00432       case 2: return g->days_since_pickup;
00433       case 3: return g->rating;
00434       case 4: return g->cargo.Source();
00435       case 5: return g->cargo.DaysInTransit();
00436       case 6: return g->last_speed;
00437       case 7: return g->last_age;
00438     }
00439   }
00440 
00441   DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
00442 
00443   *available = false;
00444   return UINT_MAX;
00445 }
00446 
00447 uint32 Waypoint::GetNewGRFVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) const
00448 {
00449   switch (variable) {
00450     case 0x48: return 0; // Accepted cargo types
00451     case 0x8A: return HVOT_WAYPOINT;
00452     case 0xF1: return 0; // airport type
00453     case 0xF2: return 0; // truck stop status
00454     case 0xF3: return 0; // bus stop status
00455     case 0xF6: return 0; // airport flags
00456     case 0xF7: return 0; // airport flags cont.
00457   }
00458 
00459   /* Handle cargo variables with parameter, 0x60 to 0x65 */
00460   if (variable >= 0x60 && variable <= 0x65) {
00461     return 0;
00462   }
00463 
00464   /* Handle cargo variables (deprecated) */
00465   if (variable >= 0x8C && variable <= 0xEC) {
00466     switch (GB(variable - 0x8C, 0, 3)) {
00467       case 3: return INITIAL_STATION_RATING;
00468       case 4: return INVALID_STATION;
00469       default: return 0;
00470     }
00471   }
00472 
00473   DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
00474 
00475   *available = false;
00476   return UINT_MAX;
00477 }
00478 
00479 static const SpriteGroup *StationResolveReal(const ResolverObject *object, const RealSpriteGroup *group)
00480 {
00481   const BaseStation *bst = object->u.station.st;
00482   const StationSpec *statspec = object->u.station.statspec;
00483   uint set;
00484 
00485   uint cargo = 0;
00486   CargoID cargo_type = object->u.station.cargo_type;
00487 
00488   if (bst == NULL || statspec->cls_id == STAT_CLASS_WAYP) {
00489     return group->loading[0];
00490   }
00491 
00492   const Station *st = Station::From(bst);
00493 
00494   switch (cargo_type) {
00495     case CT_INVALID:
00496     case CT_DEFAULT_NA:
00497     case CT_PURCHASE:
00498       cargo = 0;
00499       break;
00500 
00501     case CT_DEFAULT:
00502       for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
00503         cargo += st->goods[cargo_type].cargo.Count();
00504       }
00505       break;
00506 
00507     default:
00508       cargo = st->goods[cargo_type].cargo.Count();
00509       break;
00510   }
00511 
00512   if (HasBit(statspec->flags, SSF_DIV_BY_STATION_SIZE)) cargo /= (st->train_station.w + st->train_station.h);
00513   cargo = min(0xfff, cargo);
00514 
00515   if (cargo > statspec->cargo_threshold) {
00516     if (group->num_loading > 0) {
00517       set = ((cargo - statspec->cargo_threshold) * group->num_loading) / (4096 - statspec->cargo_threshold);
00518       return group->loading[set];
00519     }
00520   } else {
00521     if (group->num_loaded > 0) {
00522       set = (cargo * group->num_loaded) / (statspec->cargo_threshold + 1);
00523       return group->loaded[set];
00524     }
00525   }
00526 
00527   return group->loading[0];
00528 }
00529 
00530 
00537 void StationStorePSA(ResolverObject *object, uint pos, int32 value)
00538 {
00539   /* Stations have no persistent storage. */
00540   BaseStation *st = object->u.station.st;
00541   if (object->scope != VSG_SCOPE_PARENT || st == NULL) return;
00542 
00543   TownStorePSA(st->town, object->grffile, pos, value);
00544 }
00545 
00546 static void NewStationResolver(ResolverObject *res, const StationSpec *statspec, BaseStation *st, TileIndex tile)
00547 {
00548   res->GetRandomBits = StationGetRandomBits;
00549   res->GetTriggers   = StationGetTriggers;
00550   res->SetTriggers   = StationSetTriggers;
00551   res->GetVariable   = StationGetVariable;
00552   res->ResolveReal   = StationResolveReal;
00553   res->StorePSA      = StationStorePSA;
00554 
00555   res->u.station.st       = st;
00556   res->u.station.statspec = statspec;
00557   res->u.station.tile     = tile;
00558   res->u.station.axis     = INVALID_AXIS;
00559 
00560   res->callback        = CBID_NO_CALLBACK;
00561   res->callback_param1 = 0;
00562   res->callback_param2 = 0;
00563   res->ResetState();
00564 
00565   res->grffile         = (statspec != NULL ? statspec->grf_prop.grffile : NULL);
00566 
00567   /* Invalidate all cached vars */
00568   _svc.valid = 0;
00569 }
00570 
00571 static const SpriteGroup *ResolveStation(ResolverObject *object)
00572 {
00573   const SpriteGroup *group;
00574   CargoID ctype = CT_DEFAULT_NA;
00575 
00576   if (object->u.station.st == NULL) {
00577     /* No station, so we are in a purchase list */
00578     ctype = CT_PURCHASE;
00579   } else if (Station::IsExpected(object->u.station.st)) {
00580     const Station *st = Station::From(object->u.station.st);
00581     /* Pick the first cargo that we have waiting */
00582     const CargoSpec *cs;
00583     FOR_ALL_CARGOSPECS(cs) {
00584       if (object->u.station.statspec->grf_prop.spritegroup[cs->Index()] != NULL &&
00585           !st->goods[cs->Index()].cargo.Empty()) {
00586         ctype = cs->Index();
00587         break;
00588       }
00589     }
00590   }
00591 
00592   group = object->u.station.statspec->grf_prop.spritegroup[ctype];
00593   if (group == NULL) {
00594     ctype = CT_DEFAULT;
00595     group = object->u.station.statspec->grf_prop.spritegroup[ctype];
00596   }
00597 
00598   if (group == NULL) return NULL;
00599 
00600   /* Remember the cargo type we've picked */
00601   object->u.station.cargo_type = ctype;
00602 
00603   return SpriteGroup::Resolve(group, object);
00604 }
00605 
00614 SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32 var10)
00615 {
00616   const SpriteGroup *group;
00617   ResolverObject object;
00618 
00619   NewStationResolver(&object, statspec, st, tile);
00620   object.callback_param1 = var10;
00621 
00622   group = ResolveStation(&object);
00623   if (group == NULL || group->type != SGT_RESULT) return 0;
00624   return group->GetResult() - 0x42D;
00625 }
00626 
00636 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info)
00637 {
00638   const SpriteGroup *group;
00639   ResolverObject object;
00640 
00641   NewStationResolver(&object, statspec, st, tile);
00642   object.callback_param1 = 2; // Indicate we are resolving the foundation sprites
00643   object.callback_param2 = layout | (edge_info << 16);
00644 
00645   ClearRegister(0x100);
00646   group = ResolveStation(&object);
00647   if (group == NULL || group->type != SGT_RESULT) return 0;
00648   return group->GetResult() + GetRegister(0x100);
00649 }
00650 
00651 
00652 uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile)
00653 {
00654   const SpriteGroup *group;
00655   ResolverObject object;
00656 
00657   NewStationResolver(&object, statspec, st, tile);
00658 
00659   object.callback        = callback;
00660   object.callback_param1 = param1;
00661   object.callback_param2 = param2;
00662 
00663   group = ResolveStation(&object);
00664   if (group == NULL) return CALLBACK_FAILED;
00665   return group->GetCallbackResult();
00666 }
00667 
00678 CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte numtracks)
00679 {
00680   TileIndexDiff diff = cur_tile - north_tile;
00681   Slope slope = GetTileSlope(cur_tile);
00682 
00683   ResolverObject object;
00684   NewStationResolver(&object, statspec, NULL, cur_tile);
00685 
00686   object.callback        = CBID_STATION_LAND_SLOPE_CHECK;
00687   object.callback_param1 = slope << 4 | (slope ^ (axis == AXIS_Y && HasBit(slope, CORNER_W) != HasBit(slope, CORNER_E) ? SLOPE_EW : 0));
00688   object.callback_param2 = numtracks << 24 | plat_len << 16 | (axis == AXIS_Y ? TileX(diff) << 8 | TileY(diff) : TileY(diff) << 8 | TileX(diff));
00689   object.u.station.axis  = axis;
00690 
00691   const SpriteGroup *group = ResolveStation(&object);
00692   uint16 cb_res = group != NULL ? group->GetCallbackResult() : CALLBACK_FAILED;
00693 
00694   /* Failed callback means success. */
00695   if (cb_res == CALLBACK_FAILED) return CommandCost();
00696 
00697   /* The meaning of bit 10 is inverted for a grf version < 8. */
00698   if (statspec->grf_prop.grffile->grf_version < 8) ToggleBit(cb_res, 10);
00699   return GetErrorMessageFromLocationCallbackResult(cb_res, statspec->grf_prop.grffile->grfid, STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
00700 }
00701 
00702 
00710 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec)
00711 {
00712   uint i;
00713 
00714   if (statspec == NULL || st == NULL) return 0;
00715 
00716   for (i = 1; i < st->num_specs && i < MAX_SPECLIST; i++) {
00717     if (st->speclist[i].spec == NULL && st->speclist[i].grfid == 0) break;
00718   }
00719 
00720   if (i == MAX_SPECLIST) {
00721     /* As final effort when the spec list is already full...
00722      * try to find the same spec and return that one. This might
00723      * result in slighty "wrong" (as per specs) looking stations,
00724      * but it's fairly unlikely that one reaches the limit anyways.
00725      */
00726     for (i = 1; i < st->num_specs && i < MAX_SPECLIST; i++) {
00727       if (st->speclist[i].spec == statspec) return i;
00728     }
00729 
00730     return -1;
00731   }
00732 
00733   if (exec) {
00734     if (i >= st->num_specs) {
00735       st->num_specs = i + 1;
00736       st->speclist = ReallocT(st->speclist, st->num_specs);
00737 
00738       if (st->num_specs == 2) {
00739         /* Initial allocation */
00740         st->speclist[0].spec     = NULL;
00741         st->speclist[0].grfid    = 0;
00742         st->speclist[0].localidx = 0;
00743       }
00744     }
00745 
00746     st->speclist[i].spec     = statspec;
00747     st->speclist[i].grfid    = statspec->grf_prop.grffile->grfid;
00748     st->speclist[i].localidx = statspec->grf_prop.local_id;
00749   }
00750 
00751   return i;
00752 }
00753 
00754 
00761 void DeallocateSpecFromStation(BaseStation *st, byte specindex)
00762 {
00763   /* specindex of 0 (default) is never freeable */
00764   if (specindex == 0) return;
00765 
00766   ETileArea area = ETileArea(st, INVALID_TILE, TA_WHOLE);
00767   /* Check all tiles over the station to check if the specindex is still in use */
00768   TILE_AREA_LOOP(tile, area) {
00769     if (st->TileBelongsToRailStation(tile) && GetCustomStationSpecIndex(tile) == specindex) {
00770       return;
00771     }
00772   }
00773 
00774   /* This specindex is no longer in use, so deallocate it */
00775   st->speclist[specindex].spec     = NULL;
00776   st->speclist[specindex].grfid    = 0;
00777   st->speclist[specindex].localidx = 0;
00778 
00779   /* If this was the highest spec index, reallocate */
00780   if (specindex == st->num_specs - 1) {
00781     for (; st->speclist[st->num_specs - 1].grfid == 0 && st->num_specs > 1; st->num_specs--) {}
00782 
00783     if (st->num_specs > 1) {
00784       st->speclist = ReallocT(st->speclist, st->num_specs);
00785     } else {
00786       free(st->speclist);
00787       st->num_specs = 0;
00788       st->speclist  = NULL;
00789       st->cached_anim_triggers = 0;
00790       return;
00791     }
00792   }
00793 
00794   StationUpdateAnimTriggers(st);
00795 }
00796 
00807 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station)
00808 {
00809   const StationSpec *statspec;
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   statspec = StationClass::Get(sclass, 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 IsStationTileElectrifiable(TileIndex tile)
00904 {
00905   const StationSpec *statspec = GetStationSpec(tile);
00906 
00907   return statspec == NULL ||
00908       HasBit(statspec->pylons, GetStationGfx(tile)) ||
00909       !HasBit(statspec->wires, GetStationGfx(tile));
00910 }
00911 
00913 uint16 GetAnimStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile, int extra_data)
00914 {
00915   return GetStationCallback(callback, param1, param2, statspec, st, tile);
00916 }
00917 
00919 struct StationAnimationBase : public AnimationBase<StationAnimationBase, StationSpec, BaseStation, int, GetAnimStationCallback> {
00920   static const CallbackID cb_animation_speed      = CBID_STATION_ANIMATION_SPEED;
00921   static const CallbackID cb_animation_next_frame = CBID_STATION_ANIM_NEXT_FRAME;
00922 
00923   static const StationCallbackMask cbm_animation_speed      = CBM_STATION_ANIMATION_SPEED;
00924   static const StationCallbackMask cbm_animation_next_frame = CBM_STATION_ANIMATION_NEXT_FRAME;
00925 };
00926 
00927 void AnimateStationTile(TileIndex tile)
00928 {
00929   const StationSpec *ss = GetStationSpec(tile);
00930   if (ss == NULL) return;
00931 
00932   StationAnimationBase::AnimateTile(ss, BaseStation::GetByTile(tile), tile, HasBit(ss->flags, SSF_CB141_RANDOM_BITS));
00933 }
00934 
00935 void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type)
00936 {
00937   /* List of coverage areas for each animation trigger */
00938   static const TriggerArea tas[] = {
00939     TA_TILE, TA_WHOLE, TA_WHOLE, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM, TA_WHOLE
00940   };
00941 
00942   /* Get Station if it wasn't supplied */
00943   if (st == NULL) st = BaseStation::GetByTile(tile);
00944 
00945   /* Check the cached animation trigger bitmask to see if we need
00946    * to bother with any further processing. */
00947   if (!HasBit(st->cached_anim_triggers, trigger)) return;
00948 
00949   uint16 random_bits = Random();
00950   ETileArea area = ETileArea(st, tile, tas[trigger]);
00951 
00952   /* Check all tiles over the station to check if the specindex is still in use */
00953   TILE_AREA_LOOP(tile, area) {
00954     if (st->TileBelongsToRailStation(tile)) {
00955       const StationSpec *ss = GetStationSpec(tile);
00956       if (ss != NULL && HasBit(ss->animation.triggers, trigger)) {
00957         CargoID cargo;
00958         if (cargo_type == CT_INVALID) {
00959           cargo = CT_INVALID;
00960         } else {
00961           cargo = GetReverseCargoTranslation(cargo_type, ss->grf_prop.grffile);
00962         }
00963         StationAnimationBase::ChangeAnimationFrame(CBID_STATION_ANIM_START_STOP, ss, st, tile, (random_bits << 16) | Random(), (uint8)trigger | (cargo << 8));
00964       }
00965     }
00966   }
00967 }
00968 
00973 void StationUpdateAnimTriggers(BaseStation *st)
00974 {
00975   st->cached_anim_triggers = 0;
00976 
00977   /* Combine animation trigger bitmask for all station specs
00978    * of this station. */
00979   for (uint i = 0; i < st->num_specs; i++) {
00980     const StationSpec *ss = st->speclist[i].spec;
00981     if (ss != NULL) st->cached_anim_triggers |= ss->animation.triggers;
00982   }
00983 }
00984 
00990 void GetStationResolver(ResolverObject *ro, uint index)
00991 {
00992   NewStationResolver(ro, GetStationSpec(index), Station::GetByTile(index), index);
00993 }