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