# newgrf_station.cpp

Go to the documentation of this file.

    00001 /* $Id: newgrf_station.cpp 24905 2013-01-11 07:39:25Z peter1138 $ */
    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_ACCEPTANCE)) 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) {
    00415       switch (variable) {
    00416         case 0x62: return 0xFFFFFFFF;
    00417         case 0x64: return 0xFF00;
    00418         default:   return 0;
    00419       }
    00420     }
    00421     const GoodsEntry *ge = &this->goods[c];
    00422
    00423     switch (variable) {
    00424       case 0x60: return min(ge->cargo.Count(), 4095);
    00425       case 0x61: return ge->HasVehicleEverTriedLoading() ? ge->time_since_pickup : 0;
    00426       case 0x62: return HasBit(ge->acceptance_pickup, GoodsEntry::GES_PICKUP) ? ge->rating : 0xFFFFFFFF;
    00427       case 0x63: return ge->cargo.DaysInTransit();
    00428       case 0x64: return ge->HasVehicleEverTriedLoading() ? ge->last_speed | (ge->last_age << 8) : 0xFF00;
    00429       case 0x65: return GB(ge->acceptance_pickup, GoodsEntry::GES_ACCEPTANCE, 1) << 3;
    00430       case 0x69: {
    00431         assert_compile((int)GoodsEntry::GES_EVER_ACCEPTED + 1 == (int)GoodsEntry::GES_LAST_MONTH);
    00432         assert_compile((int)GoodsEntry::GES_EVER_ACCEPTED + 2 == (int)GoodsEntry::GES_CURRENT_MONTH);
    00433         assert_compile((int)GoodsEntry::GES_EVER_ACCEPTED + 3 == (int)GoodsEntry::GES_ACCEPTED_BIGTICK);
    00434         return GB(ge->acceptance_pickup, GoodsEntry::GES_EVER_ACCEPTED, 4);
    00435       }
    00436     }
    00437   }
    00438
    00439   /* Handle cargo variables (deprecated) */
    00440   if (variable >= 0x8C && variable <= 0xEC) {
    00441     const GoodsEntry *g = &this->goods[GB(variable - 0x8C, 3, 4)];
    00442     switch (GB(variable - 0x8C, 0, 3)) {
    00443       case 0: return g->cargo.Count();
    00444       case 1: return GB(min(g->cargo.Count(), 4095), 0, 4) | (GB(g->acceptance_pickup, GoodsEntry::GES_ACCEPTANCE, 1) << 7);
    00445       case 2: return g->time_since_pickup;
    00446       case 3: return g->rating;
    00447       case 4: return g->cargo.Source();
    00448       case 5: return g->cargo.DaysInTransit();
    00449       case 6: return g->last_speed;
    00450       case 7: return g->last_age;
    00451     }
    00452   }
    00453
    00454   DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
    00455
    00456   *available = false;
    00457   return UINT_MAX;
    00458 }
    00459
    00460 uint32 Waypoint::GetNewGRFVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) const
    00461 {
    00462   switch (variable) {
    00463     case 0x48: return 0; // Accepted cargo types
    00464     case 0x8A: return HVOT_WAYPOINT;
    00465     case 0xF1: return 0; // airport type
    00466     case 0xF2: return 0; // truck stop status
    00467     case 0xF3: return 0; // bus stop status
    00468     case 0xF6: return 0; // airport flags
    00469     case 0xF7: return 0; // airport flags cont.
    00470   }
    00471
    00472   /* Handle cargo variables with parameter, 0x60 to 0x65 */
    00473   if (variable >= 0x60 && variable <= 0x65) {
    00474     return 0;
    00475   }
    00476
    00477   /* Handle cargo variables (deprecated) */
    00478   if (variable >= 0x8C && variable <= 0xEC) {
    00479     switch (GB(variable - 0x8C, 0, 3)) {
    00480       case 3: return INITIAL_STATION_RATING;
    00481       case 4: return INVALID_STATION;
    00482       default: return 0;
    00483     }
    00484   }
    00485
    00486   DEBUG(grf, 1, "Unhandled station variable 0x%X", variable);
    00487
    00488   *available = false;
    00489   return UINT_MAX;
    00490 }
    00491
    00492 /* virtual */ const SpriteGroup *StationResolverObject::ResolveReal(const RealSpriteGroup *group) const
    00493 {
    00494   if (this->station_scope.st == NULL || this->station_scope.statspec->cls_id == STAT_CLASS_WAYP) {
    00495     return group->loading[0];
    00496   }
    00497
    00498   uint cargo = 0;
    00499   const Station *st = Station::From(this->station_scope.st);
    00500
    00501   switch (this->station_scope.cargo_type) {
    00502     case CT_INVALID:
    00503     case CT_DEFAULT_NA:
    00504     case CT_PURCHASE:
    00505       cargo = 0;
    00506       break;
    00507
    00508     case CT_DEFAULT:
    00509       for (CargoID cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
    00510         cargo += st->goods[cargo_type].cargo.Count();
    00511       }
    00512       break;
    00513
    00514     default:
    00515       cargo = st->goods[this->station_scope.cargo_type].cargo.Count();
    00516       break;
    00517   }
    00518
    00519   if (HasBit(this->station_scope.statspec->flags, SSF_DIV_BY_STATION_SIZE)) cargo /= (st->train_station.w + st->train_station.h);
    00520   cargo = min(0xfff, cargo);
    00521
    00522   if (cargo > this->station_scope.statspec->cargo_threshold) {
    00523     if (group->num_loading > 0) {
    00524       uint set = ((cargo - this->station_scope.statspec->cargo_threshold) * group->num_loading) / (4096 - this->station_scope.statspec->cargo_threshold);
    00525       return group->loading[set];
    00526     }
    00527   } else {
    00528     if (group->num_loaded > 0) {
    00529       uint set = (cargo * group->num_loaded) / (this->station_scope.statspec->cargo_threshold + 1);
    00530       return group->loaded[set];
    00531     }
    00532   }
    00533
    00534   return group->loading[0];
    00535 }
    00536
    00546 StationResolverObject::StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile,
    00547     CallbackID callback, uint32 callback_param1, uint32 callback_param2)
    00548   : ResolverObject((statspec != NULL ? statspec->grf_prop.grffile : NULL), callback, callback_param1, callback_param2),
    00549   station_scope(this, statspec, st, tile), town_scope(NULL)
    00550 {
    00551   /* Invalidate all cached vars */
    00552   _svc.valid = 0;
    00553 }
    00554
    00555 StationResolverObject::~StationResolverObject()
    00556 {
    00557   delete this->town_scope;
    00558 }
    00559
    00567 StationScopeResolver::StationScopeResolver(ResolverObject *ro, const StationSpec *statspec, BaseStation *st, TileIndex tile)
    00568   : ScopeResolver(ro)
    00569 {
    00570   this->tile = tile;
    00571   this->st = st;
    00572   this->statspec = statspec;
    00573   this->cargo_type = CT_INVALID;
    00574   this->axis = INVALID_AXIS;
    00575 }
    00576
    00577 static const SpriteGroup *ResolveStation(StationResolverObject *object)
    00578 {
    00579   CargoID ctype = CT_DEFAULT_NA;
    00580
    00581   if (object->station_scope.st == NULL) {
    00582     /* No station, so we are in a purchase list */
    00583     ctype = CT_PURCHASE;
    00584   } else if (Station::IsExpected(object->station_scope.st)) {
    00585     const Station *st = Station::From(object->station_scope.st);
    00586     /* Pick the first cargo that we have waiting */
    00587     const CargoSpec *cs;
    00588     FOR_ALL_CARGOSPECS(cs) {
    00589       if (object->station_scope.statspec->grf_prop.spritegroup[cs->Index()] != NULL &&
    00590           !st->goods[cs->Index()].cargo.Empty()) {
    00591         ctype = cs->Index();
    00592         break;
    00593       }
    00594     }
    00595   }
    00596
    00597   const SpriteGroup *group = object->station_scope.statspec->grf_prop.spritegroup[ctype];
    00598   if (group == NULL) {
    00599     ctype = CT_DEFAULT;
    00600     group = object->station_scope.statspec->grf_prop.spritegroup[ctype];
    00601     if (group == NULL) return NULL;
    00602   }
    00603
    00604   /* Remember the cargo type we've picked */
    00605   object->station_scope.cargo_type = ctype;
    00606
    00607   return SpriteGroup::Resolve(group, object);
    00608 }
    00609
    00618 SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32 var10)
    00619 {
    00620   StationResolverObject object(statspec, st, tile, CBID_NO_CALLBACK, var10);
    00621   const SpriteGroup *group = ResolveStation(&object);
    00622   if (group == NULL || group->type != SGT_RESULT) return 0;
    00623   return group->GetResult() - 0x42D;
    00624 }
    00625
    00635 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info)
    00636 {
    00637   /* callback_param1 == 2 means  we are resolving the foundation sprites. */
    00638   StationResolverObject object(statspec, st, tile, CBID_NO_CALLBACK, 2, layout | (edge_info << 16));
    00639
    00640   ClearRegister(0x100);
    00641   const SpriteGroup *group = ResolveStation(&object);
    00642   if (group == NULL || group->type != SGT_RESULT) return 0;
    00643   return group->GetResult() + GetRegister(0x100);
    00644 }
    00645
    00646
    00647 uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile)
    00648 {
    00649   StationResolverObject object(statspec, st, tile, callback, param1, param2);
    00650   const SpriteGroup *group = ResolveStation(&object);
    00651   if (group == NULL) return CALLBACK_FAILED;
    00652   return group->GetCallbackResult();
    00653 }
    00654
    00665 CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte numtracks)
    00666 {
    00667   TileIndexDiff diff = cur_tile - north_tile;
    00668   Slope slope = GetTileSlope(cur_tile);
    00669
    00670   StationResolverObject object(statspec, NULL, cur_tile, CBID_STATION_LAND_SLOPE_CHECK,
    00671       (slope << 4) | (slope ^ (axis == AXIS_Y && HasBit(slope, CORNER_W) != HasBit(slope, CORNER_E) ? SLOPE_EW : 0)),
    00672       (numtracks << 24) | (plat_len << 16) | (axis == AXIS_Y ? TileX(diff) << 8 | TileY(diff) : TileY(diff) << 8 | TileX(diff)));
    00673   object.station_scope.axis = axis;
    00674
    00675   const SpriteGroup *group = ResolveStation(&object);
    00676   uint16 cb_res = group != NULL ? group->GetCallbackResult() : CALLBACK_FAILED;
    00677
    00678   /* Failed callback means success. */
    00679   if (cb_res == CALLBACK_FAILED) return CommandCost();
    00680
    00681   /* The meaning of bit 10 is inverted for a grf version < 8. */
    00682   if (statspec->grf_prop.grffile->grf_version < 8) ToggleBit(cb_res, 10);
    00683   return GetErrorMessageFromLocationCallbackResult(cb_res, statspec->grf_prop.grffile->grfid, STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
    00684 }
    00685
    00686
    00694 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec)
    00695 {
    00696   uint i;
    00697
    00698   if (statspec == NULL || st == NULL) return 0;
    00699
    00700   for (i = 1; i < st->num_specs && i < MAX_SPECLIST; i++) {
    00701     if (st->speclist[i].spec == NULL && st->speclist[i].grfid == 0) break;
    00702   }
    00703
    00704   if (i == MAX_SPECLIST) {
    00705     /* As final effort when the spec list is already full...
    00706      * try to find the same spec and return that one. This might
    00707      * result in slightly "wrong" (as per specs) looking stations,
    00708      * but it's fairly unlikely that one reaches the limit anyways.
    00709      */
    00710     for (i = 1; i < st->num_specs && i < MAX_SPECLIST; i++) {
    00711       if (st->speclist[i].spec == statspec) return i;
    00712     }
    00713
    00714     return -1;
    00715   }
    00716
    00717   if (exec) {
    00718     if (i >= st->num_specs) {
    00719       st->num_specs = i + 1;
    00720       st->speclist = ReallocT(st->speclist, st->num_specs);
    00721
    00722       if (st->num_specs == 2) {
    00723         /* Initial allocation */
    00724         st->speclist[0].spec     = NULL;
    00725         st->speclist[0].grfid    = 0;
    00726         st->speclist[0].localidx = 0;
    00727       }
    00728     }
    00729
    00730     st->speclist[i].spec     = statspec;
    00731     st->speclist[i].grfid    = statspec->grf_prop.grffile->grfid;
    00732     st->speclist[i].localidx = statspec->grf_prop.local_id;
    00733
    00734     StationUpdateCachedTriggers(st);
    00735   }
    00736
    00737   return i;
    00738 }
    00739
    00740
    00747 void DeallocateSpecFromStation(BaseStation *st, byte specindex)
    00748 {
    00749   /* specindex of 0 (default) is never freeable */
    00750   if (specindex == 0) return;
    00751
    00752   ETileArea area = ETileArea(st, INVALID_TILE, TA_WHOLE);
    00753   /* Check all tiles over the station to check if the specindex is still in use */
    00754   TILE_AREA_LOOP(tile, area) {
    00755     if (st->TileBelongsToRailStation(tile) && GetCustomStationSpecIndex(tile) == specindex) {
    00756       return;
    00757     }
    00758   }
    00759
    00760   /* This specindex is no longer in use, so deallocate it */
    00761   st->speclist[specindex].spec     = NULL;
    00762   st->speclist[specindex].grfid    = 0;
    00763   st->speclist[specindex].localidx = 0;
    00764
    00765   /* If this was the highest spec index, reallocate */
    00766   if (specindex == st->num_specs - 1) {
    00767     for (; st->speclist[st->num_specs - 1].grfid == 0 && st->num_specs > 1; st->num_specs--) {}
    00768
    00769     if (st->num_specs > 1) {
    00770       st->speclist = ReallocT(st->speclist, st->num_specs);
    00771     } else {
    00772       free(st->speclist);
    00773       st->num_specs = 0;
    00774       st->speclist  = NULL;
    00775       st->cached_anim_triggers = 0;
    00776       st->cached_cargo_triggers = 0;
    00777       return;
    00778     }
    00779   }
    00780
    00781   StationUpdateCachedTriggers(st);
    00782 }
    00783
    00794 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station)
    00795 {
    00796   const DrawTileSprites *sprites = NULL;
    00797   const RailtypeInfo *rti = GetRailTypeInfo(railtype);
    00798   PaletteID palette = COMPANY_SPRITE_COLOUR(_local_company);
    00799   uint tile = 2;
    00800
    00801   const StationSpec *statspec = StationClass::Get(sclass)->GetSpec(station);
    00802   if (statspec == NULL) return false;
    00803
    00804   if (HasBit(statspec->callback_mask, CBM_STATION_SPRITE_LAYOUT)) {
    00805     uint16 callback = GetStationCallback(CBID_STATION_SPRITE_LAYOUT, 0x2110000, 0, statspec, NULL, INVALID_TILE);
    00806     if (callback != CALLBACK_FAILED) tile = callback;
    00807   }
    00808
    00809   uint32 total_offset = rti->GetRailtypeSpriteOffset();
    00810   uint32 relocation = 0;
    00811   uint32 ground_relocation = 0;
    00812   const NewGRFSpriteLayout *layout = NULL;
    00813   DrawTileSprites tmp_rail_layout;
    00814
    00815   if (statspec->renderdata == NULL) {
    00816     sprites = GetStationTileLayout(STATION_RAIL, tile + axis);
    00817   } else {
    00818     layout = &statspec->renderdata[(tile < statspec->tiles) ? tile + axis : (uint)axis];
    00819     if (!layout->NeedsPreprocessing()) {
    00820       sprites = layout;
    00821       layout = NULL;
    00822     }
    00823   }
    00824
    00825   if (layout != NULL) {
    00826     /* Sprite layout which needs preprocessing */
    00827     bool separate_ground = HasBit(statspec->flags, SSF_SEPARATE_GROUND);
    00828     uint32 var10_values = layout->PrepareLayout(total_offset, rti->fallback_railtype, 0, 0, separate_ground);
    00829     uint8 var10;
    00830     FOR_EACH_SET_BIT(var10, var10_values) {
    00831       uint32 var10_relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, var10);
    00832       layout->ProcessRegisters(var10, var10_relocation, separate_ground);
    00833     }
    00834
    00835     tmp_rail_layout.seq = layout->GetLayout(&tmp_rail_layout.ground);
    00836     sprites = &tmp_rail_layout;
    00837     total_offset = 0;
    00838   } else {
    00839     /* Simple sprite layout */
    00840     ground_relocation = relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, 0);
    00841     if (HasBit(sprites->ground.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE)) {
    00842       ground_relocation = GetCustomStationRelocation(statspec, NULL, INVALID_TILE, 1);
    00843     }
    00844     ground_relocation += rti->fallback_railtype;
    00845   }
    00846
    00847   SpriteID image = sprites->ground.sprite;
    00848   PaletteID pal = sprites->ground.pal;
    00849   RailTrackOffset overlay_offset;
    00850   if (rti != NULL && rti->UsesOverlay() && SplitGroundSpriteForOverlay(NULL, &image, &overlay_offset)) {
    00851     SpriteID ground = GetCustomRailSprite(rti, INVALID_TILE, RTSG_GROUND);
    00852     DrawSprite(image, PAL_NONE, x, y);
    00853     DrawSprite(ground + overlay_offset, PAL_NONE, x, y);
    00854   } else {
    00855     image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
    00856     if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
    00857     DrawSprite(image, GroundSpritePaletteTransform(image, pal, palette), x, y);
    00858   }
    00859
    00860   DrawRailTileSeqInGUI(x, y, sprites, total_offset, relocation, palette);
    00861
    00862   return true;
    00863 }
    00864
    00865
    00866 const StationSpec *GetStationSpec(TileIndex t)
    00867 {
    00868   if (!IsCustomStationSpecIndex(t)) return NULL;
    00869
    00870   const BaseStation *st = BaseStation::GetByTile(t);
    00871   uint specindex = GetCustomStationSpecIndex(t);
    00872   return specindex < st->num_specs ? st->speclist[specindex].spec : NULL;
    00873 }
    00874
    00875
    00882 bool IsStationTileBlocked(TileIndex tile)
    00883 {
    00884   const StationSpec *statspec = GetStationSpec(tile);
    00885
    00886   return statspec != NULL && HasBit(statspec->blocked, GetStationGfx(tile));
    00887 }
    00888
    00895 bool CanStationTileHavePylons(TileIndex tile)
    00896 {
    00897   const StationSpec *statspec = GetStationSpec(tile);
    00898   uint gfx = GetStationGfx(tile);
    00899   /* Default stations do not draw pylons under roofs (gfx >= 4) */
    00900   return statspec != NULL ? HasBit(statspec->pylons, gfx) : gfx < 4;
    00901 }
    00902
    00909 bool CanStationTileHaveWires(TileIndex tile)
    00910 {
    00911   const StationSpec *statspec = GetStationSpec(tile);
    00912   return statspec == NULL || !HasBit(statspec->wires, GetStationGfx(tile));
    00913 }
    00914
    00916 uint16 GetAnimStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile, int extra_data)
    00917 {
    00918   return GetStationCallback(callback, param1, param2, statspec, st, tile);
    00919 }
    00920
    00922 struct StationAnimationBase : public AnimationBase<StationAnimationBase, StationSpec, BaseStation, int, GetAnimStationCallback> {
    00923   static const CallbackID cb_animation_speed      = CBID_STATION_ANIMATION_SPEED;
    00924   static const CallbackID cb_animation_next_frame = CBID_STATION_ANIM_NEXT_FRAME;
    00925
    00926   static const StationCallbackMask cbm_animation_speed      = CBM_STATION_ANIMATION_SPEED;
    00927   static const StationCallbackMask cbm_animation_next_frame = CBM_STATION_ANIMATION_NEXT_FRAME;
    00928 };
    00929
    00930 void AnimateStationTile(TileIndex tile)
    00931 {
    00932   const StationSpec *ss = GetStationSpec(tile);
    00933   if (ss == NULL) return;
    00934
    00935   StationAnimationBase::AnimateTile(ss, BaseStation::GetByTile(tile), tile, HasBit(ss->flags, SSF_CB141_RANDOM_BITS));
    00936 }
    00937
    00938 void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type)
    00939 {
    00940   /* List of coverage areas for each animation trigger */
    00941   static const TriggerArea tas[] = {
    00942     TA_TILE, TA_WHOLE, TA_WHOLE, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM, TA_WHOLE
    00943   };
    00944
    00945   /* Get Station if it wasn't supplied */
    00946   if (st == NULL) st = BaseStation::GetByTile(tile);
    00947
    00948   /* Check the cached animation trigger bitmask to see if we need
    00949    * to bother with any further processing. */
    00950   if (!HasBit(st->cached_anim_triggers, trigger)) return;
    00951
    00952   uint16 random_bits = Random();
    00953   ETileArea area = ETileArea(st, tile, tas[trigger]);
    00954
    00955   /* Check all tiles over the station to check if the specindex is still in use */
    00956   TILE_AREA_LOOP(tile, area) {
    00957     if (st->TileBelongsToRailStation(tile)) {
    00958       const StationSpec *ss = GetStationSpec(tile);
    00959       if (ss != NULL && HasBit(ss->animation.triggers, trigger)) {
    00960         CargoID cargo;
    00961         if (cargo_type == CT_INVALID) {
    00962           cargo = CT_INVALID;
    00963         } else {
    00964           cargo = ss->grf_prop.grffile->cargo_map[cargo_type];
    00965         }
    00966         StationAnimationBase::ChangeAnimationFrame(CBID_STATION_ANIM_START_STOP, ss, st, tile, (random_bits << 16) | Random(), (uint8)trigger | (cargo << 8));
    00967       }
    00968     }
    00969   }
    00970 }
    00971
    00979 void TriggerStationRandomisation(Station *st, TileIndex tile, StationRandomTrigger trigger, CargoID cargo_type)
    00980 {
    00981   /* List of coverage areas for each animation trigger */
    00982   static const TriggerArea tas[] = {
    00983     TA_WHOLE, TA_WHOLE, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM, TA_PLATFORM
    00984   };
    00985
    00986   /* Get Station if it wasn't supplied */
    00987   if (st == NULL) st = Station::GetByTile(tile);
    00988
    00989   /* Check the cached cargo trigger bitmask to see if we need
    00990    * to bother with any further processing. */
    00991   if (st->cached_cargo_triggers == 0) return;
    00992   if (cargo_type != CT_INVALID && !HasBit(st->cached_cargo_triggers, cargo_type)) return;
    00993
    00994   uint32 whole_reseed = 0;
    00995   ETileArea area = ETileArea(st, tile, tas[trigger]);
    00996
    00997   uint32 empty_mask = 0;
    00998   if (trigger == SRT_CARGO_TAKEN) {
    00999     /* Create a bitmask of completely empty cargo types to be matched */
    01000     for (CargoID i = 0; i < NUM_CARGO; i++) {
    01001       if (st->goods[i].cargo.Empty()) {
    01002         SetBit(empty_mask, i);
    01003       }
    01004     }
    01005   }
    01006
    01007   /* Convert trigger to bit */
    01008   uint8 trigger_bit = 1 << trigger;
    01009
    01010   /* Check all tiles over the station to check if the specindex is still in use */
    01011   TILE_AREA_LOOP(tile, area) {
    01012     if (st->TileBelongsToRailStation(tile)) {
    01013       const StationSpec *ss = GetStationSpec(tile);
    01014       if (ss == NULL) continue;
    01015
    01016       /* Cargo taken "will only be triggered if all of those
    01017        * cargo types have no more cargo waiting." */
    01018       if (trigger == SRT_CARGO_TAKEN) {
    01019         if ((ss->cargo_triggers & ~empty_mask) != 0) continue;
    01020       }
    01021
    01022       if (cargo_type == CT_INVALID || HasBit(ss->cargo_triggers, cargo_type)) {
    01023         StationResolverObject object(ss, st, tile, CBID_RANDOM_TRIGGER, 0);
    01024         object.trigger = trigger_bit;
    01025
    01026         const SpriteGroup *group = ResolveStation(&object);
    01027         if (group == NULL) continue;
    01028
    01029         uint32 reseed = object.GetReseedSum();
    01030         if (reseed != 0) {
    01031           whole_reseed |= reseed;
    01032           reseed >>= 16;
    01033
    01034           /* Set individual tile random bits */
    01035           uint8 random_bits = GetStationTileRandomBits(tile);
    01036           random_bits &= ~reseed;
    01037           random_bits |= Random() & reseed;
    01038           SetStationTileRandomBits(tile, random_bits);
    01039
    01040           MarkTileDirtyByTile(tile);
    01041         }
    01042       }
    01043     }
    01044   }
    01045
    01046   /* Update whole station random bits */
    01047   if ((whole_reseed & 0xFFFF) != 0) {
    01048     st->random_bits &= ~whole_reseed;
    01049     st->random_bits |= Random() & whole_reseed;
    01050   }
    01051 }
    01052
    01057 void StationUpdateCachedTriggers(BaseStation *st)
    01058 {
    01059   st->cached_anim_triggers = 0;
    01060   st->cached_cargo_triggers = 0;
    01061
    01062   /* Combine animation trigger bitmask for all station specs
    01063    * of this station. */
    01064   for (uint i = 0; i < st->num_specs; i++) {
    01065     const StationSpec *ss = st->speclist[i].spec;
    01066     if (ss != NULL) {
    01067       st->cached_anim_triggers |= ss->animation.triggers;
    01068       st->cached_cargo_triggers |= ss->cargo_triggers;
    01069     }
    01070   }
    01071 }
    01072