OpenTTD Source  12.0-beta2
train_cmd.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #include "stdafx.h"
11 #include "error.h"
12 #include "articulated_vehicles.h"
13 #include "command_func.h"
15 #include "pathfinder/yapf/yapf.hpp"
16 #include "news_func.h"
17 #include "company_func.h"
18 #include "newgrf_sound.h"
19 #include "newgrf_text.h"
20 #include "strings_func.h"
21 #include "viewport_func.h"
22 #include "vehicle_func.h"
23 #include "sound_func.h"
24 #include "ai/ai.hpp"
25 #include "game/game.hpp"
26 #include "newgrf_station.h"
27 #include "effectvehicle_func.h"
28 #include "network/network.h"
29 #include "spritecache.h"
30 #include "core/random_func.hpp"
31 #include "company_base.h"
32 #include "newgrf.h"
33 #include "order_backup.h"
34 #include "zoom_func.h"
35 #include "newgrf_debug.h"
36 #include "framerate_type.h"
37 
38 #include "table/strings.h"
39 #include "table/train_cmd.h"
40 
41 #include "safeguards.h"
42 
43 static Track ChooseTrainTrack(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool force_res, bool *got_reservation, bool mark_stuck);
44 static bool TrainCheckIfLineEnds(Train *v, bool reverse = true);
45 bool TrainController(Train *v, Vehicle *nomove, bool reverse = true); // Also used in vehicle_sl.cpp.
47 static void CheckIfTrainNeedsService(Train *v);
48 static void CheckNextTrainTile(Train *v);
49 
50 static const byte _vehicle_initial_x_fract[4] = {10, 8, 4, 8};
51 static const byte _vehicle_initial_y_fract[4] = { 8, 4, 8, 10};
52 
53 template <>
54 bool IsValidImageIndex<VEH_TRAIN>(uint8 image_index)
55 {
56  return image_index < lengthof(_engine_sprite_base);
57 }
58 
59 
66 {
67  if (!CargoSpec::Get(cargo)->is_freight) return 1;
69 }
70 
73 {
74  bool first = true;
75 
76  for (const Train *v : Train::Iterate()) {
77  if (v->First() == v && !(v->vehstatus & VS_CRASHED)) {
78  for (const Train *u = v, *w = v->Next(); w != nullptr; u = w, w = w->Next()) {
79  if (u->track != TRACK_BIT_DEPOT) {
80  if ((w->track != TRACK_BIT_DEPOT &&
81  std::max(abs(u->x_pos - w->x_pos), abs(u->y_pos - w->y_pos)) != u->CalcNextVehicleOffset()) ||
82  (w->track == TRACK_BIT_DEPOT && TicksToLeaveDepot(u) <= 0)) {
83  SetDParam(0, v->index);
84  SetDParam(1, v->owner);
85  ShowErrorMessage(STR_BROKEN_VEHICLE_LENGTH, INVALID_STRING_ID, WL_CRITICAL);
86 
87  if (!_networking && first) {
88  first = false;
90  }
91  /* Break so we warn only once for each train. */
92  break;
93  }
94  }
95  }
96  }
97  }
98 }
99 
107 {
108  uint16 max_speed = UINT16_MAX;
109 
110  assert(this->IsFrontEngine() || this->IsFreeWagon());
111 
112  const RailVehicleInfo *rvi_v = RailVehInfo(this->engine_type);
113  EngineID first_engine = this->IsFrontEngine() ? this->engine_type : INVALID_ENGINE;
114  this->gcache.cached_total_length = 0;
115  this->compatible_railtypes = RAILTYPES_NONE;
116 
117  bool train_can_tilt = true;
118  int min_curve_speed_mod = INT_MAX;
119 
120  for (Train *u = this; u != nullptr; u = u->Next()) {
121  const RailVehicleInfo *rvi_u = RailVehInfo(u->engine_type);
122 
123  /* Check the this->first cache. */
124  assert(u->First() == this);
125 
126  /* update the 'first engine' */
127  u->gcache.first_engine = this == u ? INVALID_ENGINE : first_engine;
128  u->railtype = rvi_u->railtype;
129 
130  if (u->IsEngine()) first_engine = u->engine_type;
131 
132  /* Set user defined data to its default value */
133  u->tcache.user_def_data = rvi_u->user_def_data;
134  this->InvalidateNewGRFCache();
135  u->InvalidateNewGRFCache();
136  }
137 
138  for (Train *u = this; u != nullptr; u = u->Next()) {
139  /* Update user defined data (must be done before other properties) */
140  u->tcache.user_def_data = GetVehicleProperty(u, PROP_TRAIN_USER_DATA, u->tcache.user_def_data);
141  this->InvalidateNewGRFCache();
142  u->InvalidateNewGRFCache();
143  }
144 
145  for (Train *u = this; u != nullptr; u = u->Next()) {
146  const Engine *e_u = u->GetEngine();
147  const RailVehicleInfo *rvi_u = &e_u->u.rail;
148 
149  if (!HasBit(e_u->info.misc_flags, EF_RAIL_TILTS)) train_can_tilt = false;
150  min_curve_speed_mod = std::min(min_curve_speed_mod, u->GetCurveSpeedModifier());
151 
152  /* Cache wagon override sprite group. nullptr is returned if there is none */
153  u->tcache.cached_override = GetWagonOverrideSpriteSet(u->engine_type, u->cargo_type, u->gcache.first_engine);
154 
155  /* Reset colour map */
156  u->colourmap = PAL_NONE;
157 
158  /* Update powered-wagon-status and visual effect */
159  u->UpdateVisualEffect(true);
160 
161  if (rvi_v->pow_wag_power != 0 && rvi_u->railveh_type == RAILVEH_WAGON &&
162  UsesWagonOverride(u) && !HasBit(u->vcache.cached_vis_effect, VE_DISABLE_WAGON_POWER)) {
163  /* wagon is powered */
164  SetBit(u->flags, VRF_POWEREDWAGON); // cache 'powered' status
165  } else {
166  ClrBit(u->flags, VRF_POWEREDWAGON);
167  }
168 
169  if (!u->IsArticulatedPart()) {
170  /* Do not count powered wagons for the compatible railtypes, as wagons always
171  have railtype normal */
172  if (rvi_u->power > 0) {
173  this->compatible_railtypes |= GetRailTypeInfo(u->railtype)->powered_railtypes;
174  }
175 
176  /* Some electric engines can be allowed to run on normal rail. It happens to all
177  * existing electric engines when elrails are disabled and then re-enabled */
178  if (HasBit(u->flags, VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL)) {
179  u->railtype = RAILTYPE_RAIL;
180  u->compatible_railtypes |= RAILTYPES_RAIL;
181  }
182 
183  /* max speed is the minimum of the speed limits of all vehicles in the consist */
184  if ((rvi_u->railveh_type != RAILVEH_WAGON || _settings_game.vehicle.wagon_speed_limits) && !UsesWagonOverride(u)) {
185  uint16 speed = GetVehicleProperty(u, PROP_TRAIN_SPEED, rvi_u->max_speed);
186  if (speed != 0) max_speed = std::min(speed, max_speed);
187  }
188  }
189 
190  uint16 new_cap = e_u->DetermineCapacity(u);
191  if (allowed_changes & CCF_CAPACITY) {
192  /* Update vehicle capacity. */
193  if (u->cargo_cap > new_cap) u->cargo.Truncate(new_cap);
194  u->refit_cap = std::min(new_cap, u->refit_cap);
195  u->cargo_cap = new_cap;
196  } else {
197  /* Verify capacity hasn't changed. */
198  if (new_cap != u->cargo_cap) ShowNewGrfVehicleError(u->engine_type, STR_NEWGRF_BROKEN, STR_NEWGRF_BROKEN_CAPACITY, GBUG_VEH_CAPACITY, true);
199  }
200  u->vcache.cached_cargo_age_period = GetVehicleProperty(u, PROP_TRAIN_CARGO_AGE_PERIOD, e_u->info.cargo_age_period);
201 
202  /* check the vehicle length (callback) */
203  uint16 veh_len = CALLBACK_FAILED;
204  if (e_u->GetGRF() != nullptr && e_u->GetGRF()->grf_version >= 8) {
205  /* Use callback 36 */
206  veh_len = GetVehicleProperty(u, PROP_TRAIN_SHORTEN_FACTOR, CALLBACK_FAILED);
207 
208  if (veh_len != CALLBACK_FAILED && veh_len >= VEHICLE_LENGTH) {
210  }
211  } else if (HasBit(e_u->info.callback_mask, CBM_VEHICLE_LENGTH)) {
212  /* Use callback 11 */
213  veh_len = GetVehicleCallback(CBID_VEHICLE_LENGTH, 0, 0, u->engine_type, u);
214  }
215  if (veh_len == CALLBACK_FAILED) veh_len = rvi_u->shorten_factor;
216  veh_len = VEHICLE_LENGTH - Clamp(veh_len, 0, VEHICLE_LENGTH - 1);
217 
218  if (allowed_changes & CCF_LENGTH) {
219  /* Update vehicle length. */
220  u->gcache.cached_veh_length = veh_len;
221  } else {
222  /* Verify length hasn't changed. */
223  if (veh_len != u->gcache.cached_veh_length) VehicleLengthChanged(u);
224  }
225 
226  this->gcache.cached_total_length += u->gcache.cached_veh_length;
227  this->InvalidateNewGRFCache();
228  u->InvalidateNewGRFCache();
229  }
230 
231  /* store consist weight/max speed in cache */
232  this->vcache.cached_max_speed = max_speed;
233  this->tcache.cached_tilt = train_can_tilt;
234  this->tcache.cached_curve_speed_mod = min_curve_speed_mod;
235  this->tcache.cached_max_curve_speed = this->GetCurveSpeedLimit();
236 
237  /* recalculate cached weights and power too (we do this *after* the rest, so it is known which wagons are powered and need extra weight added) */
238  this->CargoChanged();
239 
240  if (this->IsFrontEngine()) {
241  this->UpdateAcceleration();
245  InvalidateNewGRFInspectWindow(GSF_TRAINS, this->index);
246  }
247 }
248 
259 int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length)
260 {
261  const Station *st = Station::Get(station_id);
262  *station_ahead = st->GetPlatformLength(tile, DirToDiagDir(v->direction)) * TILE_SIZE;
263  *station_length = st->GetPlatformLength(tile) * TILE_SIZE;
264 
265  /* Default to the middle of the station for stations stops that are not in
266  * the order list like intermediate stations when non-stop is disabled */
268  if (v->gcache.cached_total_length >= *station_length) {
269  /* The train is longer than the station, make it stop at the far end of the platform */
270  osl = OSL_PLATFORM_FAR_END;
271  } else if (v->current_order.IsType(OT_GOTO_STATION) && v->current_order.GetDestination() == station_id) {
272  osl = v->current_order.GetStopLocation();
273  }
274 
275  /* The stop location of the FRONT! of the train */
276  int stop;
277  switch (osl) {
278  default: NOT_REACHED();
279 
281  stop = v->gcache.cached_total_length;
282  break;
283 
284  case OSL_PLATFORM_MIDDLE:
285  stop = *station_length - (*station_length - v->gcache.cached_total_length) / 2;
286  break;
287 
289  stop = *station_length;
290  break;
291  }
292 
293  /* Subtract half the front vehicle length of the train so we get the real
294  * stop location of the train. */
295  return stop - (v->gcache.cached_veh_length + 1) / 2;
296 }
297 
298 
304 {
305  assert(this->First() == this);
306 
307  static const int absolute_max_speed = UINT16_MAX;
308  int max_speed = absolute_max_speed;
309 
310  if (_settings_game.vehicle.train_acceleration_model == AM_ORIGINAL) return max_speed;
311 
312  int curvecount[2] = {0, 0};
313 
314  /* first find the curve speed limit */
315  int numcurve = 0;
316  int sum = 0;
317  int pos = 0;
318  int lastpos = -1;
319  for (const Vehicle *u = this; u->Next() != nullptr; u = u->Next(), pos++) {
320  Direction this_dir = u->direction;
321  Direction next_dir = u->Next()->direction;
322 
323  DirDiff dirdiff = DirDifference(this_dir, next_dir);
324  if (dirdiff == DIRDIFF_SAME) continue;
325 
326  if (dirdiff == DIRDIFF_45LEFT) curvecount[0]++;
327  if (dirdiff == DIRDIFF_45RIGHT) curvecount[1]++;
328  if (dirdiff == DIRDIFF_45LEFT || dirdiff == DIRDIFF_45RIGHT) {
329  if (lastpos != -1) {
330  numcurve++;
331  sum += pos - lastpos;
332  if (pos - lastpos == 1 && max_speed > 88) {
333  max_speed = 88;
334  }
335  }
336  lastpos = pos;
337  }
338 
339  /* if we have a 90 degree turn, fix the speed limit to 60 */
340  if (dirdiff == DIRDIFF_90LEFT || dirdiff == DIRDIFF_90RIGHT) {
341  max_speed = 61;
342  }
343  }
344 
345  if (numcurve > 0 && max_speed > 88) {
346  if (curvecount[0] == 1 && curvecount[1] == 1) {
347  max_speed = absolute_max_speed;
348  } else {
349  sum /= numcurve;
350  max_speed = 232 - (13 - Clamp(sum, 1, 12)) * (13 - Clamp(sum, 1, 12));
351  }
352  }
353 
354  if (max_speed != absolute_max_speed) {
355  /* Apply the current railtype's curve speed advantage */
356  const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(this->tile));
357  max_speed += (max_speed / 2) * rti->curve_speed;
358 
359  if (this->tcache.cached_tilt) {
360  /* Apply max_speed bonus of 20% for a tilting train */
361  max_speed += max_speed / 5;
362  }
363 
364  /* Apply max_speed modifier (cached value is fixed-point binary with 8 fractional bits)
365  * and clamp the result to an acceptable range. */
366  max_speed += (max_speed * this->tcache.cached_curve_speed_mod) / 256;
367  max_speed = Clamp(max_speed, 2, absolute_max_speed);
368  }
369 
370  return max_speed;
371 }
372 
378 {
379  int max_speed = _settings_game.vehicle.train_acceleration_model == AM_ORIGINAL ?
381  this->tcache.cached_max_curve_speed;
382 
383  if (_settings_game.vehicle.train_acceleration_model == AM_REALISTIC && IsRailStationTile(this->tile)) {
384  StationID sid = GetStationIndex(this->tile);
385  if (this->current_order.ShouldStopAtStation(this, sid)) {
386  int station_ahead;
387  int station_length;
388  int stop_at = GetTrainStopLocation(sid, this->tile, this, &station_ahead, &station_length);
389 
390  /* The distance to go is whatever is still ahead of the train minus the
391  * distance from the train's stop location to the end of the platform */
392  int distance_to_go = station_ahead / TILE_SIZE - (station_length - stop_at) / TILE_SIZE;
393 
394  if (distance_to_go > 0) {
395  int st_max_speed = 120;
396 
397  int delta_v = this->cur_speed / (distance_to_go + 1);
398  if (max_speed > (this->cur_speed - delta_v)) {
399  st_max_speed = this->cur_speed - (delta_v / 10);
400  }
401 
402  st_max_speed = std::max(st_max_speed, 25 * distance_to_go);
403  max_speed = std::min(max_speed, st_max_speed);
404  }
405  }
406  }
407 
408  for (const Train *u = this; u != nullptr; u = u->Next()) {
409  if (_settings_game.vehicle.train_acceleration_model == AM_REALISTIC && u->track == TRACK_BIT_DEPOT) {
410  max_speed = std::min(max_speed, 61);
411  break;
412  }
413 
414  /* Vehicle is on the middle part of a bridge. */
415  if (u->track == TRACK_BIT_WORMHOLE && !(u->vehstatus & VS_HIDDEN)) {
416  max_speed = std::min<int>(max_speed, GetBridgeSpec(GetBridgeType(u->tile))->speed);
417  }
418  }
419 
420  max_speed = std::min<int>(max_speed, this->current_order.GetMaxSpeed());
421  return std::min<int>(max_speed, this->gcache.cached_max_track_speed);
422 }
423 
426 {
427  assert(this->IsFrontEngine() || this->IsFreeWagon());
428 
429  uint power = this->gcache.cached_power;
430  uint weight = this->gcache.cached_weight;
431  assert(weight != 0);
432  this->acceleration = Clamp(power / weight * 4, 1, 255);
433 }
434 
441 {
442  int reference_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
443  int vehicle_pitch = 0;
444 
445  const Engine *e = this->GetEngine();
446  if (e->GetGRF() != nullptr && is_custom_sprite(e->u.rail.image_index)) {
447  reference_width = e->GetGRF()->traininfo_vehicle_width;
448  vehicle_pitch = e->GetGRF()->traininfo_vehicle_pitch;
449  }
450 
451  if (offset != nullptr) {
452  offset->x = ScaleGUITrad(reference_width) / 2;
453  offset->y = ScaleGUITrad(vehicle_pitch);
454  }
455  return ScaleGUITrad(this->gcache.cached_veh_length * reference_width / VEHICLE_LENGTH);
456 }
457 
458 static SpriteID GetDefaultTrainSprite(uint8 spritenum, Direction direction)
459 {
460  assert(IsValidImageIndex<VEH_TRAIN>(spritenum));
461  return ((direction + _engine_sprite_add[spritenum]) & _engine_sprite_and[spritenum]) + _engine_sprite_base[spritenum];
462 }
463 
471 {
472  uint8 spritenum = this->spritenum;
473 
475 
476  if (is_custom_sprite(spritenum)) {
477  GetCustomVehicleSprite(this, (Direction)(direction + 4 * IS_CUSTOM_SECONDHEAD_SPRITE(spritenum)), image_type, result);
478  if (result->IsValid()) return;
479 
481  }
482 
483  assert(IsValidImageIndex<VEH_TRAIN>(spritenum));
484  SpriteID sprite = GetDefaultTrainSprite(spritenum, direction);
485 
486  if (this->cargo.StoredCount() >= this->cargo_cap / 2U) sprite += _wagon_full_adder[spritenum];
487 
488  result->Set(sprite);
489 }
490 
491 static void GetRailIcon(EngineID engine, bool rear_head, int &y, EngineImageType image_type, VehicleSpriteSeq *result)
492 {
493  const Engine *e = Engine::Get(engine);
494  Direction dir = rear_head ? DIR_E : DIR_W;
495  uint8 spritenum = e->u.rail.image_index;
496 
497  if (is_custom_sprite(spritenum)) {
498  GetCustomVehicleIcon(engine, dir, image_type, result);
499  if (result->IsValid()) {
500  if (e->GetGRF() != nullptr) {
502  }
503  return;
504  }
505 
506  spritenum = Engine::Get(engine)->original_image_index;
507  }
508 
509  if (rear_head) spritenum++;
510 
511  result->Set(GetDefaultTrainSprite(spritenum, DIR_W));
512 }
513 
514 void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
515 {
516  if (RailVehInfo(engine)->railveh_type == RAILVEH_MULTIHEAD) {
517  int yf = y;
518  int yr = y;
519 
520  VehicleSpriteSeq seqf, seqr;
521  GetRailIcon(engine, false, yf, image_type, &seqf);
522  GetRailIcon(engine, true, yr, image_type, &seqr);
523 
524  Rect rectf, rectr;
525  seqf.GetBounds(&rectf);
526  seqr.GetBounds(&rectr);
527 
528  preferred_x = Clamp(preferred_x,
529  left - UnScaleGUI(rectf.left) + ScaleGUITrad(14),
530  right - UnScaleGUI(rectr.right) - ScaleGUITrad(15));
531 
532  seqf.Draw(preferred_x - ScaleGUITrad(14), yf, pal, pal == PALETTE_CRASH);
533  seqr.Draw(preferred_x + ScaleGUITrad(15), yr, pal, pal == PALETTE_CRASH);
534  } else {
535  VehicleSpriteSeq seq;
536  GetRailIcon(engine, false, y, image_type, &seq);
537 
538  Rect rect;
539  seq.GetBounds(&rect);
540  preferred_x = Clamp(preferred_x,
541  left - UnScaleGUI(rect.left),
542  right - UnScaleGUI(rect.right));
543 
544  seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
545  }
546 }
547 
557 void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
558 {
559  int y = 0;
560 
561  VehicleSpriteSeq seq;
562  GetRailIcon(engine, false, y, image_type, &seq);
563 
564  Rect rect;
565  seq.GetBounds(&rect);
566 
567  width = UnScaleGUI(rect.right - rect.left + 1);
568  height = UnScaleGUI(rect.bottom - rect.top + 1);
569  xoffs = UnScaleGUI(rect.left);
570  yoffs = UnScaleGUI(rect.top);
571 
572  if (RailVehInfo(engine)->railveh_type == RAILVEH_MULTIHEAD) {
573  GetRailIcon(engine, true, y, image_type, &seq);
574  seq.GetBounds(&rect);
575 
576  /* Calculate values relative to an imaginary center between the two sprites. */
577  width = ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) + UnScaleGUI(rect.right) - xoffs;
578  height = std::max<uint>(height, UnScaleGUI(rect.bottom - rect.top + 1));
579  xoffs = xoffs - ScaleGUITrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) / 2;
580  yoffs = std::min(yoffs, UnScaleGUI(rect.top));
581  }
582 }
583 
593 {
594  const RailVehicleInfo *rvi = &e->u.rail;
595 
596  /* Check that the wagon can drive on the track in question */
597  if (!IsCompatibleRail(rvi->railtype, GetRailType(tile))) return CMD_ERROR;
598 
599  if (flags & DC_EXEC) {
600  Train *v = new Train();
601  *ret = v;
602  v->spritenum = rvi->image_index;
603 
604  v->engine_type = e->index;
605  v->gcache.first_engine = INVALID_ENGINE; // needs to be set before first callback
606 
608 
609  v->direction = DiagDirToDir(dir);
610  v->tile = tile;
611 
612  int x = TileX(tile) * TILE_SIZE | _vehicle_initial_x_fract[dir];
613  int y = TileY(tile) * TILE_SIZE | _vehicle_initial_y_fract[dir];
614 
615  v->x_pos = x;
616  v->y_pos = y;
617  v->z_pos = GetSlopePixelZ(x, y);
618  v->owner = _current_company;
619  v->track = TRACK_BIT_DEPOT;
621 
622  v->SetWagon();
623 
624  v->SetFreeWagon();
626 
628  v->cargo_cap = rvi->capacity;
629  v->refit_cap = 0;
630 
631  v->railtype = rvi->railtype;
632 
634  v->build_year = _cur_year;
635  v->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
637 
638  v->group_id = DEFAULT_GROUP;
639 
641 
642  _new_vehicle_id = v->index;
643 
644  v->UpdatePosition();
647 
649 
650  /* Try to connect the vehicle to one of free chains of wagons. */
651  for (Train *w : Train::Iterate()) {
652  if (w->tile == tile &&
653  w->IsFreeWagon() &&
654  w->engine_type == e->index &&
655  w->First() != v &&
656  !(w->vehstatus & VS_CRASHED)) {
657  if (DoCommand(0, v->index | 1 << 20, w->Last()->index, DC_EXEC, CMD_MOVE_RAIL_VEHICLE).Succeeded()) {
658  break;
659  }
660  }
661  }
662  }
663 
664  return CommandCost();
665 }
666 
668 static void NormalizeTrainVehInDepot(const Train *u)
669 {
670  for (const Train *v : Train::Iterate()) {
671  if (v->IsFreeWagon() && v->tile == u->tile &&
672  v->track == TRACK_BIT_DEPOT) {
673  if (DoCommand(0, v->index | 1 << 20, u->index, DC_EXEC,
675  break;
676  }
677  }
678 }
679 
680 static void AddRearEngineToMultiheadedTrain(Train *v)
681 {
682  Train *u = new Train();
683  v->value >>= 1;
684  u->value = v->value;
685  u->direction = v->direction;
686  u->owner = v->owner;
687  u->tile = v->tile;
688  u->x_pos = v->x_pos;
689  u->y_pos = v->y_pos;
690  u->z_pos = v->z_pos;
691  u->track = TRACK_BIT_DEPOT;
692  u->vehstatus = v->vehstatus & ~VS_STOPPED;
693  u->spritenum = v->spritenum + 1;
694  u->cargo_type = v->cargo_type;
696  u->cargo_cap = v->cargo_cap;
697  u->refit_cap = v->refit_cap;
698  u->railtype = v->railtype;
699  u->engine_type = v->engine_type;
701  u->build_year = v->build_year;
702  u->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
704  v->SetMultiheaded();
705  u->SetMultiheaded();
706  v->SetNext(u);
707  u->UpdatePosition();
708 
709  /* Now we need to link the front and rear engines together */
710  v->other_multiheaded_part = u;
711  u->other_multiheaded_part = v;
712 }
713 
724 {
725  const RailVehicleInfo *rvi = &e->u.rail;
726 
727  if (rvi->railveh_type == RAILVEH_WAGON) return CmdBuildRailWagon(tile, flags, e, ret);
728 
729  /* Check if depot and new engine uses the same kind of tracks *
730  * We need to see if the engine got power on the tile to avoid electric engines in non-electric depots */
731  if (!HasPowerOnRail(rvi->railtype, GetRailType(tile))) return CMD_ERROR;
732 
733  if (flags & DC_EXEC) {
735  int x = TileX(tile) * TILE_SIZE + _vehicle_initial_x_fract[dir];
736  int y = TileY(tile) * TILE_SIZE + _vehicle_initial_y_fract[dir];
737 
738  Train *v = new Train();
739  *ret = v;
740  v->direction = DiagDirToDir(dir);
741  v->tile = tile;
742  v->owner = _current_company;
743  v->x_pos = x;
744  v->y_pos = y;
745  v->z_pos = GetSlopePixelZ(x, y);
746  v->track = TRACK_BIT_DEPOT;
748  v->spritenum = rvi->image_index;
750  v->cargo_cap = rvi->capacity;
751  v->refit_cap = 0;
752  v->last_station_visited = INVALID_STATION;
753  v->last_loading_station = INVALID_STATION;
754 
755  v->engine_type = e->index;
756  v->gcache.first_engine = INVALID_ENGINE; // needs to be set before first callback
757 
758  v->reliability = e->reliability;
760  v->max_age = e->GetLifeLengthInDays();
761 
762  v->railtype = rvi->railtype;
763  _new_vehicle_id = v->index;
764 
765  v->SetServiceInterval(Company::Get(_current_company)->settings.vehicle.servint_trains);
767  v->build_year = _cur_year;
768  v->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
770 
772  v->SetServiceIntervalIsPercent(Company::Get(_current_company)->settings.vehicle.servint_ispercent);
773 
774  v->group_id = DEFAULT_GROUP;
775 
776  v->SetFrontEngine();
777  v->SetEngine();
778 
779  v->UpdatePosition();
780 
781  if (rvi->railveh_type == RAILVEH_MULTIHEAD) {
782  AddRearEngineToMultiheadedTrain(v);
783  } else {
785  }
786 
789 
790  if (!HasBit(data, 0) && !(flags & DC_AUTOREPLACE)) { // check if the cars should be added to the new vehicle
792  }
793 
795  }
796 
797  return CommandCost();
798 }
799 
800 static Train *FindGoodVehiclePos(const Train *src)
801 {
802  EngineID eng = src->engine_type;
803  TileIndex tile = src->tile;
804 
805  for (Train *dst : Train::Iterate()) {
806  if (dst->IsFreeWagon() && dst->tile == tile && !(dst->vehstatus & VS_CRASHED)) {
807  /* check so all vehicles in the line have the same engine. */
808  Train *t = dst;
809  while (t->engine_type == eng) {
810  t = t->Next();
811  if (t == nullptr) return dst;
812  }
813  }
814  }
815 
816  return nullptr;
817 }
818 
820 typedef std::vector<Train *> TrainList;
821 
828 {
829  for (; t != nullptr; t = t->Next()) list.push_back(t);
830 }
831 
837 {
838  /* No train, nothing to do. */
839  if (list.size() == 0) return;
840 
841  Train *prev = nullptr;
842  /* Iterate over the list and rebuild it. */
843  for (Train *t : list) {
844  if (prev != nullptr) {
845  prev->SetNext(t);
846  } else if (t->Previous() != nullptr) {
847  /* Make sure the head of the train is always the first in the chain. */
848  t->Previous()->SetNext(nullptr);
849  }
850  prev = t;
851  }
852 }
853 
859 static void RemoveFromConsist(Train *part, bool chain = false)
860 {
861  Train *tail = chain ? part->Last() : part->GetLastEnginePart();
862 
863  /* Unlink at the front, but make it point to the next
864  * vehicle after the to be remove part. */
865  if (part->Previous() != nullptr) part->Previous()->SetNext(tail->Next());
866 
867  /* Unlink at the back */
868  tail->SetNext(nullptr);
869 }
870 
876 static void InsertInConsist(Train *dst, Train *chain)
877 {
878  /* We do not want to add something in the middle of an articulated part. */
879  assert(dst != nullptr && (dst->Next() == nullptr || !dst->Next()->IsArticulatedPart()));
880 
881  chain->Last()->SetNext(dst->Next());
882  dst->SetNext(chain);
883 }
884 
890 static void NormaliseDualHeads(Train *t)
891 {
892  for (; t != nullptr; t = t->GetNextVehicle()) {
893  if (!t->IsMultiheaded() || !t->IsEngine()) continue;
894 
895  /* Make sure that there are no free cars before next engine */
896  Train *u;
897  for (u = t; u->Next() != nullptr && !u->Next()->IsEngine(); u = u->Next()) {}
898 
899  if (u == t->other_multiheaded_part) continue;
900 
901  /* Remove the part from the 'wrong' train */
902  RemoveFromConsist(t->other_multiheaded_part);
903  /* And add it to the 'right' train */
904  InsertInConsist(u, t->other_multiheaded_part);
905  }
906 }
907 
912 static void NormaliseSubtypes(Train *chain)
913 {
914  /* Nothing to do */
915  if (chain == nullptr) return;
916 
917  /* We must be the first in the chain. */
918  assert(chain->Previous() == nullptr);
919 
920  /* Set the appropriate bits for the first in the chain. */
921  if (chain->IsWagon()) {
922  chain->SetFreeWagon();
923  } else {
924  assert(chain->IsEngine());
925  chain->SetFrontEngine();
926  }
927 
928  /* Now clear the bits for the rest of the chain */
929  for (Train *t = chain->Next(); t != nullptr; t = t->Next()) {
930  t->ClearFreeWagon();
931  t->ClearFrontEngine();
932  }
933 }
934 
944 static CommandCost CheckNewTrain(Train *original_dst, Train *dst, Train *original_src, Train *src)
945 {
946  /* Just add 'new' engines and subtract the original ones.
947  * If that's less than or equal to 0 we can be sure we did
948  * not add any engines (read: trains) along the way. */
949  if ((src != nullptr && src->IsEngine() ? 1 : 0) +
950  (dst != nullptr && dst->IsEngine() ? 1 : 0) -
951  (original_src != nullptr && original_src->IsEngine() ? 1 : 0) -
952  (original_dst != nullptr && original_dst->IsEngine() ? 1 : 0) <= 0) {
953  return CommandCost();
954  }
955 
956  /* Get a free unit number and check whether it's within the bounds.
957  * There will always be a maximum of one new train. */
959 
960  return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
961 }
962 
969 {
970  /* No multi-part train, no need to check. */
971  if (t == nullptr || t->Next() == nullptr) return CommandCost();
972 
973  /* The maximum length for a train. For each part we decrease this by one
974  * and if the result is negative the train is simply too long. */
976 
977  /* For free-wagon chains, check if they are within the max_train_length limit. */
978  if (!t->IsEngine()) {
979  t = t->Next();
980  while (t != nullptr) {
981  allowed_len -= t->gcache.cached_veh_length;
982 
983  t = t->Next();
984  }
985 
986  if (allowed_len < 0) return_cmd_error(STR_ERROR_TRAIN_TOO_LONG);
987  return CommandCost();
988  }
989 
990  Train *head = t;
991  Train *prev = t;
992 
993  /* Break the prev -> t link so it always holds within the loop. */
994  t = t->Next();
995  prev->SetNext(nullptr);
996 
997  /* Make sure the cache is cleared. */
998  head->InvalidateNewGRFCache();
999 
1000  while (t != nullptr) {
1001  allowed_len -= t->gcache.cached_veh_length;
1002 
1003  Train *next = t->Next();
1004 
1005  /* Unlink the to-be-added piece; it is already unlinked from the previous
1006  * part due to the fact that the prev -> t link is broken. */
1007  t->SetNext(nullptr);
1008 
1009  /* Don't check callback for articulated or rear dual headed parts */
1010  if (!t->IsArticulatedPart() && !t->IsRearDualheaded()) {
1011  /* Back up and clear the first_engine data to avoid using wagon override group */
1012  EngineID first_engine = t->gcache.first_engine;
1014 
1015  /* We don't want the cache to interfere. head's cache is cleared before
1016  * the loop and after each callback does not need to be cleared here. */
1017  t->InvalidateNewGRFCache();
1018 
1019  uint16 callback = GetVehicleCallbackParent(CBID_TRAIN_ALLOW_WAGON_ATTACH, 0, 0, head->engine_type, t, head);
1020 
1021  /* Restore original first_engine data */
1022  t->gcache.first_engine = first_engine;
1023 
1024  /* We do not want to remember any cached variables from the test run */
1025  t->InvalidateNewGRFCache();
1026  head->InvalidateNewGRFCache();
1027 
1028  if (callback != CALLBACK_FAILED) {
1029  /* A failing callback means everything is okay */
1030  StringID error = STR_NULL;
1031 
1032  if (head->GetGRF()->grf_version < 8) {
1033  if (callback == 0xFD) error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
1034  if (callback < 0xFD) error = GetGRFStringID(head->GetGRFID(), 0xD000 + callback);
1035  if (callback >= 0x100) ErrorUnknownCallbackResult(head->GetGRFID(), CBID_TRAIN_ALLOW_WAGON_ATTACH, callback);
1036  } else {
1037  if (callback < 0x400) {
1038  error = GetGRFStringID(head->GetGRFID(), 0xD000 + callback);
1039  } else {
1040  switch (callback) {
1041  case 0x400: // allow if railtypes match (always the case for OpenTTD)
1042  case 0x401: // allow
1043  break;
1044 
1045  default: // unknown reason -> disallow
1046  case 0x402: // disallow attaching
1047  error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
1048  break;
1049  }
1050  }
1051  }
1052 
1053  if (error != STR_NULL) return_cmd_error(error);
1054  }
1055  }
1056 
1057  /* And link it to the new part. */
1058  prev->SetNext(t);
1059  prev = t;
1060  t = next;
1061  }
1062 
1063  if (allowed_len < 0) return_cmd_error(STR_ERROR_TRAIN_TOO_LONG);
1064  return CommandCost();
1065 }
1066 
1077 static CommandCost ValidateTrains(Train *original_dst, Train *dst, Train *original_src, Train *src, bool check_limit)
1078 {
1079  /* Check whether we may actually construct the trains. */
1080  CommandCost ret = CheckTrainAttachment(src);
1081  if (ret.Failed()) return ret;
1082  ret = CheckTrainAttachment(dst);
1083  if (ret.Failed()) return ret;
1084 
1085  /* Check whether we need to build a new train. */
1086  return check_limit ? CheckNewTrain(original_dst, dst, original_src, src) : CommandCost();
1087 }
1088 
1097 static void ArrangeTrains(Train **dst_head, Train *dst, Train **src_head, Train *src, bool move_chain)
1098 {
1099  /* First determine the front of the two resulting trains */
1100  if (*src_head == *dst_head) {
1101  /* If we aren't moving part(s) to a new train, we are just moving the
1102  * front back and there is not destination head. */
1103  *dst_head = nullptr;
1104  } else if (*dst_head == nullptr) {
1105  /* If we are moving to a new train the head of the move train would become
1106  * the head of the new vehicle. */
1107  *dst_head = src;
1108  }
1109 
1110  if (src == *src_head) {
1111  /* If we are moving the front of a train then we are, in effect, creating
1112  * a new head for the train. Point to that. Unless we are moving the whole
1113  * train in which case there is not 'source' train anymore.
1114  * In case we are a multiheaded part we want the complete thing to come
1115  * with us, so src->GetNextUnit(), however... when we are e.g. a wagon
1116  * that is followed by a rear multihead we do not want to include that. */
1117  *src_head = move_chain ? nullptr :
1118  (src->IsMultiheaded() ? src->GetNextUnit() : src->GetNextVehicle());
1119  }
1120 
1121  /* Now it's just simply removing the part that we are going to move from the
1122  * source train and *if* the destination is a not a new train add the chain
1123  * at the destination location. */
1124  RemoveFromConsist(src, move_chain);
1125  if (*dst_head != src) InsertInConsist(dst, src);
1126 
1127  /* Now normalise the dual heads, that is move the dual heads around in such
1128  * a way that the head and rear of a dual head are in the same train */
1129  NormaliseDualHeads(*src_head);
1130  NormaliseDualHeads(*dst_head);
1131 }
1132 
1138 static void NormaliseTrainHead(Train *head)
1139 {
1140  /* Not much to do! */
1141  if (head == nullptr) return;
1142 
1143  /* Tell the 'world' the train changed. */
1144  head->ConsistChanged(CCF_ARRANGE);
1145  UpdateTrainGroupID(head);
1146 
1147  /* Not a front engine, i.e. a free wagon chain. No need to do more. */
1148  if (!head->IsFrontEngine()) return;
1149 
1150  /* Update the refit button and window */
1153 
1154  /* If we don't have a unit number yet, set one. */
1155  if (head->unitnumber != 0) return;
1157 }
1158 
1171 CommandCost CmdMoveRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
1172 {
1173  VehicleID s = GB(p1, 0, 20);
1174  VehicleID d = GB(p2, 0, 20);
1175  bool move_chain = HasBit(p1, 20);
1176 
1177  Train *src = Train::GetIfValid(s);
1178  if (src == nullptr) return CMD_ERROR;
1179 
1180  CommandCost ret = CheckOwnership(src->owner);
1181  if (ret.Failed()) return ret;
1182 
1183  /* Do not allow moving crashed vehicles inside the depot, it is likely to cause asserts later */
1184  if (src->vehstatus & VS_CRASHED) return CMD_ERROR;
1185 
1186  /* if nothing is selected as destination, try and find a matching vehicle to drag to. */
1187  Train *dst;
1188  if (d == INVALID_VEHICLE) {
1189  dst = (src->IsEngine() || (flags & DC_AUTOREPLACE)) ? nullptr : FindGoodVehiclePos(src);
1190  } else {
1191  dst = Train::GetIfValid(d);
1192  if (dst == nullptr) return CMD_ERROR;
1193 
1194  CommandCost ret = CheckOwnership(dst->owner);
1195  if (ret.Failed()) return ret;
1196 
1197  /* Do not allow appending to crashed vehicles, too */
1198  if (dst->vehstatus & VS_CRASHED) return CMD_ERROR;
1199  }
1200 
1201  /* if an articulated part is being handled, deal with its parent vehicle */
1202  src = src->GetFirstEnginePart();
1203  if (dst != nullptr) {
1204  dst = dst->GetFirstEnginePart();
1205  }
1206 
1207  /* don't move the same vehicle.. */
1208  if (src == dst) return CommandCost();
1209 
1210  /* locate the head of the two chains */
1211  Train *src_head = src->First();
1212  Train *dst_head;
1213  if (dst != nullptr) {
1214  dst_head = dst->First();
1215  if (dst_head->tile != src_head->tile) return CMD_ERROR;
1216  /* Now deal with articulated part of destination wagon */
1217  dst = dst->GetLastEnginePart();
1218  } else {
1219  dst_head = nullptr;
1220  }
1221 
1222  if (src->IsRearDualheaded()) return_cmd_error(STR_ERROR_REAR_ENGINE_FOLLOW_FRONT);
1223 
1224  /* When moving all wagons, we can't have the same src_head and dst_head */
1225  if (move_chain && src_head == dst_head) return CommandCost();
1226 
1227  /* When moving a multiheaded part to be place after itself, bail out. */
1228  if (!move_chain && dst != nullptr && dst->IsRearDualheaded() && src == dst->other_multiheaded_part) return CommandCost();
1229 
1230  /* Check if all vehicles in the source train are stopped inside a depot. */
1231  if (!src_head->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT);
1232 
1233  /* Check if all vehicles in the destination train are stopped inside a depot. */
1234  if (dst_head != nullptr && !dst_head->IsStoppedInDepot()) return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT);
1235 
1236  /* First make a backup of the order of the trains. That way we can do
1237  * whatever we want with the order and later on easily revert. */
1238  TrainList original_src;
1239  TrainList original_dst;
1240 
1241  MakeTrainBackup(original_src, src_head);
1242  MakeTrainBackup(original_dst, dst_head);
1243 
1244  /* Also make backup of the original heads as ArrangeTrains can change them.
1245  * For the destination head we do not care if it is the same as the source
1246  * head because in that case it's just a copy. */
1247  Train *original_src_head = src_head;
1248  Train *original_dst_head = (dst_head == src_head ? nullptr : dst_head);
1249 
1250  /* We want this information from before the rearrangement, but execute this after the validation.
1251  * original_src_head can't be nullptr; src is by definition != nullptr, so src_head can't be nullptr as
1252  * src->GetFirst() always yields non-nullptr, so eventually original_src_head != nullptr as well. */
1253  bool original_src_head_front_engine = original_src_head->IsFrontEngine();
1254  bool original_dst_head_front_engine = original_dst_head != nullptr && original_dst_head->IsFrontEngine();
1255 
1256  /* (Re)arrange the trains in the wanted arrangement. */
1257  ArrangeTrains(&dst_head, dst, &src_head, src, move_chain);
1258 
1259  if ((flags & DC_AUTOREPLACE) == 0) {
1260  /* If the autoreplace flag is set we do not need to test for the validity
1261  * because we are going to revert the train to its original state. As we
1262  * assume the original state was correct autoreplace can skip this. */
1263  CommandCost ret = ValidateTrains(original_dst_head, dst_head, original_src_head, src_head, true);
1264  if (ret.Failed()) {
1265  /* Restore the train we had. */
1266  RestoreTrainBackup(original_src);
1267  RestoreTrainBackup(original_dst);
1268  return ret;
1269  }
1270  }
1271 
1272  /* do it? */
1273  if (flags & DC_EXEC) {
1274  /* Remove old heads from the statistics */
1275  if (original_src_head_front_engine) GroupStatistics::CountVehicle(original_src_head, -1);
1276  if (original_dst_head_front_engine) GroupStatistics::CountVehicle(original_dst_head, -1);
1277 
1278  /* First normalise the sub types of the chains. */
1279  NormaliseSubtypes(src_head);
1280  NormaliseSubtypes(dst_head);
1281 
1282  /* There are 14 different cases:
1283  * 1) front engine gets moved to a new train, it stays a front engine.
1284  * a) the 'next' part is a wagon that becomes a free wagon chain.
1285  * b) the 'next' part is an engine that becomes a front engine.
1286  * c) there is no 'next' part, nothing else happens
1287  * 2) front engine gets moved to another train, it is not a front engine anymore
1288  * a) the 'next' part is a wagon that becomes a free wagon chain.
1289  * b) the 'next' part is an engine that becomes a front engine.
1290  * c) there is no 'next' part, nothing else happens
1291  * 3) front engine gets moved to later in the current train, it is not a front engine anymore.
1292  * a) the 'next' part is a wagon that becomes a free wagon chain.
1293  * b) the 'next' part is an engine that becomes a front engine.
1294  * 4) free wagon gets moved
1295  * a) the 'next' part is a wagon that becomes a free wagon chain.
1296  * b) the 'next' part is an engine that becomes a front engine.
1297  * c) there is no 'next' part, nothing else happens
1298  * 5) non front engine gets moved and becomes a new train, nothing else happens
1299  * 6) non front engine gets moved within a train / to another train, nothing happens
1300  * 7) wagon gets moved, nothing happens
1301  */
1302  if (src == original_src_head && src->IsEngine() && !src->IsFrontEngine()) {
1303  /* Cases #2 and #3: the front engine gets trashed. */
1309  DeleteNewGRFInspectWindow(GSF_TRAINS, src->index);
1311 
1312  /* Delete orders, group stuff and the unit number as we're not the
1313  * front of any vehicle anymore. */
1314  DeleteVehicleOrders(src);
1316  src->unitnumber = 0;
1317  }
1318 
1319  /* We weren't a front engine but are becoming one. So
1320  * we should be put in the default group. */
1321  if (original_src_head != src && dst_head == src) {
1324  }
1325 
1326  /* Add new heads to statistics */
1327  if (src_head != nullptr && src_head->IsFrontEngine()) GroupStatistics::CountVehicle(src_head, 1);
1328  if (dst_head != nullptr && dst_head->IsFrontEngine()) GroupStatistics::CountVehicle(dst_head, 1);
1329 
1330  /* Handle 'new engine' part of cases #1b, #2b, #3b, #4b and #5 in NormaliseTrainHead. */
1331  NormaliseTrainHead(src_head);
1332  NormaliseTrainHead(dst_head);
1333 
1334  if ((flags & DC_NO_CARGO_CAP_CHECK) == 0) {
1335  CheckCargoCapacity(src_head);
1336  CheckCargoCapacity(dst_head);
1337  }
1338 
1339  if (src_head != nullptr) src_head->First()->MarkDirty();
1340  if (dst_head != nullptr) dst_head->First()->MarkDirty();
1341 
1342  /* We are undoubtedly changing something in the depot and train list. */
1345  } else {
1346  /* We don't want to execute what we're just tried. */
1347  RestoreTrainBackup(original_src);
1348  RestoreTrainBackup(original_dst);
1349  }
1350 
1351  return CommandCost();
1352 }
1353 
1365 CommandCost CmdSellRailWagon(DoCommandFlag flags, Vehicle *t, uint16 data, uint32 user)
1366 {
1367  /* Sell a chain of vehicles or not? */
1368  bool sell_chain = HasBit(data, 0);
1369 
1371  Train *first = v->First();
1372 
1373  if (v->IsRearDualheaded()) return_cmd_error(STR_ERROR_REAR_ENGINE_FOLLOW_FRONT);
1374 
1375  /* First make a backup of the order of the train. That way we can do
1376  * whatever we want with the order and later on easily revert. */
1377  TrainList original;
1378  MakeTrainBackup(original, first);
1379 
1380  /* We need to keep track of the new head and the head of what we're going to sell. */
1381  Train *new_head = first;
1382  Train *sell_head = nullptr;
1383 
1384  /* Split the train in the wanted way. */
1385  ArrangeTrains(&sell_head, nullptr, &new_head, v, sell_chain);
1386 
1387  /* We don't need to validate the second train; it's going to be sold. */
1388  CommandCost ret = ValidateTrains(nullptr, nullptr, first, new_head, (flags & DC_AUTOREPLACE) == 0);
1389  if (ret.Failed()) {
1390  /* Restore the train we had. */
1391  RestoreTrainBackup(original);
1392  return ret;
1393  }
1394 
1395  if (first->orders.list == nullptr && !OrderList::CanAllocateItem()) {
1396  /* Restore the train we had. */
1397  RestoreTrainBackup(original);
1398  return_cmd_error(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
1399  }
1400 
1402  for (Train *part = sell_head; part != nullptr; part = part->Next()) cost.AddCost(-part->value);
1403 
1404  /* do it? */
1405  if (flags & DC_EXEC) {
1406  /* First normalise the sub types of the chain. */
1407  NormaliseSubtypes(new_head);
1408 
1409  if (v == first && v->IsEngine() && !sell_chain && new_head != nullptr && new_head->IsFrontEngine()) {
1410  /* We are selling the front engine. In this case we want to
1411  * 'give' the order, unit number and such to the new head. */
1412  new_head->orders.list = first->orders.list;
1413  new_head->AddToShared(first);
1415 
1416  /* Copy other important data from the front engine */
1418  GroupStatistics::CountVehicle(new_head, 1); // after copying over the profit
1419  } else if (v->IsPrimaryVehicle() && data & (MAKE_ORDER_BACKUP_FLAG >> 20)) {
1420  OrderBackup::Backup(v, user);
1421  }
1422 
1423  /* We need to update the information about the train. */
1424  NormaliseTrainHead(new_head);
1425 
1426  /* We are undoubtedly changing something in the depot and train list. */
1429 
1430  /* Actually delete the sold 'goods' */
1431  delete sell_head;
1432  } else {
1433  /* We don't want to execute what we're just tried. */
1434  RestoreTrainBackup(original);
1435  }
1436 
1437  return cost;
1438 }
1439 
1441 {
1442  /* Set common defaults. */
1443  this->x_offs = -1;
1444  this->y_offs = -1;
1445  this->x_extent = 3;
1446  this->y_extent = 3;
1447  this->z_extent = 6;
1448  this->x_bb_offs = 0;
1449  this->y_bb_offs = 0;
1450 
1451  if (!IsDiagonalDirection(this->direction)) {
1452  static const int _sign_table[] =
1453  {
1454  /* x, y */
1455  -1, -1, // DIR_N
1456  -1, 1, // DIR_E
1457  1, 1, // DIR_S
1458  1, -1, // DIR_W
1459  };
1460 
1461  int half_shorten = (VEHICLE_LENGTH - this->gcache.cached_veh_length) / 2;
1462 
1463  /* For all straight directions, move the bound box to the centre of the vehicle, but keep the size. */
1464  this->x_offs -= half_shorten * _sign_table[this->direction];
1465  this->y_offs -= half_shorten * _sign_table[this->direction + 1];
1466  this->x_extent += this->x_bb_offs = half_shorten * _sign_table[direction];
1467  this->y_extent += this->y_bb_offs = half_shorten * _sign_table[direction + 1];
1468  } else {
1469  switch (this->direction) {
1470  /* Shorten southern corner of the bounding box according the vehicle length
1471  * and center the bounding box on the vehicle. */
1472  case DIR_NE:
1473  this->x_offs = 1 - (this->gcache.cached_veh_length + 1) / 2;
1474  this->x_extent = this->gcache.cached_veh_length - 1;
1475  this->x_bb_offs = -1;
1476  break;
1477 
1478  case DIR_NW:
1479  this->y_offs = 1 - (this->gcache.cached_veh_length + 1) / 2;
1480  this->y_extent = this->gcache.cached_veh_length - 1;
1481  this->y_bb_offs = -1;
1482  break;
1483 
1484  /* Move northern corner of the bounding box down according to vehicle length
1485  * and center the bounding box on the vehicle. */
1486  case DIR_SW:
1487  this->x_offs = 1 + (this->gcache.cached_veh_length + 1) / 2 - VEHICLE_LENGTH;
1488  this->x_extent = VEHICLE_LENGTH - 1;
1489  this->x_bb_offs = VEHICLE_LENGTH - this->gcache.cached_veh_length - 1;
1490  break;
1491 
1492  case DIR_SE:
1493  this->y_offs = 1 + (this->gcache.cached_veh_length + 1) / 2 - VEHICLE_LENGTH;
1494  this->y_extent = VEHICLE_LENGTH - 1;
1495  this->y_bb_offs = VEHICLE_LENGTH - this->gcache.cached_veh_length - 1;
1496  break;
1497 
1498  default:
1499  NOT_REACHED();
1500  }
1501  }
1502 }
1503 
1508 static void MarkTrainAsStuck(Train *v)
1509 {
1510  if (!HasBit(v->flags, VRF_TRAIN_STUCK)) {
1511  /* It is the first time the problem occurred, set the "train stuck" flag. */
1512  SetBit(v->flags, VRF_TRAIN_STUCK);
1513 
1514  v->wait_counter = 0;
1515 
1516  /* Stop train */
1517  v->cur_speed = 0;
1518  v->subspeed = 0;
1519  v->SetLastSpeed();
1520 
1522  }
1523 }
1524 
1532 static void SwapTrainFlags(uint16 *swap_flag1, uint16 *swap_flag2)
1533 {
1534  uint16 flag1 = *swap_flag1;
1535  uint16 flag2 = *swap_flag2;
1536 
1537  /* Clear the flags */
1538  ClrBit(*swap_flag1, GVF_GOINGUP_BIT);
1539  ClrBit(*swap_flag1, GVF_GOINGDOWN_BIT);
1540  ClrBit(*swap_flag2, GVF_GOINGUP_BIT);
1541  ClrBit(*swap_flag2, GVF_GOINGDOWN_BIT);
1542 
1543  /* Reverse the rail-flags (if needed) */
1544  if (HasBit(flag1, GVF_GOINGUP_BIT)) {
1545  SetBit(*swap_flag2, GVF_GOINGDOWN_BIT);
1546  } else if (HasBit(flag1, GVF_GOINGDOWN_BIT)) {
1547  SetBit(*swap_flag2, GVF_GOINGUP_BIT);
1548  }
1549  if (HasBit(flag2, GVF_GOINGUP_BIT)) {
1550  SetBit(*swap_flag1, GVF_GOINGDOWN_BIT);
1551  } else if (HasBit(flag2, GVF_GOINGDOWN_BIT)) {
1552  SetBit(*swap_flag1, GVF_GOINGUP_BIT);
1553  }
1554 }
1555 
1561 {
1562  /* Reverse the direction. */
1563  if (v->track != TRACK_BIT_DEPOT) v->direction = ReverseDir(v->direction);
1564 
1565  /* Call the proper EnterTile function unless we are in a wormhole. */
1566  if (v->track != TRACK_BIT_WORMHOLE) {
1567  VehicleEnterTile(v, v->tile, v->x_pos, v->y_pos);
1568  } else {
1569  /* VehicleEnter_TunnelBridge() sets TRACK_BIT_WORMHOLE when the vehicle
1570  * is on the last bit of the bridge head (frame == TILE_SIZE - 1).
1571  * If we were swapped with such a vehicle, we have set TRACK_BIT_WORMHOLE,
1572  * when we shouldn't have. Check if this is the case. */
1573  TileIndex vt = TileVirtXY(v->x_pos, v->y_pos);
1574  if (IsTileType(vt, MP_TUNNELBRIDGE)) {
1575  VehicleEnterTile(v, vt, v->x_pos, v->y_pos);
1576  if (v->track != TRACK_BIT_WORMHOLE && IsBridgeTile(v->tile)) {
1577  /* We have just left the wormhole, possibly set the
1578  * "goingdown" bit. UpdateInclination() can be used
1579  * because we are at the border of the tile. */
1580  v->UpdatePosition();
1581  v->UpdateInclination(true, true);
1582  return;
1583  }
1584  }
1585  }
1586 
1587  v->UpdatePosition();
1588  v->UpdateViewport(true, true);
1589 }
1590 
1597 void ReverseTrainSwapVeh(Train *v, int l, int r)
1598 {
1599  Train *a, *b;
1600 
1601  /* locate vehicles to swap */
1602  for (a = v; l != 0; l--) a = a->Next();
1603  for (b = v; r != 0; r--) b = b->Next();
1604 
1605  if (a != b) {
1606  /* swap the hidden bits */
1607  {
1608  uint16 tmp = (a->vehstatus & ~VS_HIDDEN) | (b->vehstatus & VS_HIDDEN);
1609  b->vehstatus = (b->vehstatus & ~VS_HIDDEN) | (a->vehstatus & VS_HIDDEN);
1610  a->vehstatus = tmp;
1611  }
1612 
1613  Swap(a->track, b->track);
1614  Swap(a->direction, b->direction);
1615  Swap(a->x_pos, b->x_pos);
1616  Swap(a->y_pos, b->y_pos);
1617  Swap(a->tile, b->tile);
1618  Swap(a->z_pos, b->z_pos);
1619 
1620  SwapTrainFlags(&a->gv_flags, &b->gv_flags);
1621 
1624  } else {
1625  /* Swap GVF_GOINGUP_BIT/GVF_GOINGDOWN_BIT.
1626  * This is a little bit redundant way, a->gv_flags will
1627  * be (re)set twice, but it reduces code duplication */
1628  SwapTrainFlags(&a->gv_flags, &a->gv_flags);
1630  }
1631 }
1632 
1633 
1639 static Vehicle *TrainOnTileEnum(Vehicle *v, void *)
1640 {
1641  return (v->type == VEH_TRAIN) ? v : nullptr;
1642 }
1643 
1644 
1652 {
1653  if (v->type != VEH_TRAIN || (v->vehstatus & VS_CRASHED)) return nullptr;
1654 
1655  Train *t = Train::From(v);
1656  if (!t->IsFrontEngine()) return nullptr;
1657 
1658  TileIndex tile = *(TileIndex *)data;
1659 
1660  if (TrainApproachingCrossingTile(t) != tile) return nullptr;
1661 
1662  return t;
1663 }
1664 
1665 
1673 {
1674  assert(IsLevelCrossingTile(tile));
1675 
1677  TileIndex tile_from = tile + TileOffsByDiagDir(dir);
1678 
1679  if (HasVehicleOnPos(tile_from, &tile, &TrainApproachingCrossingEnum)) return true;
1680 
1681  dir = ReverseDiagDir(dir);
1682  tile_from = tile + TileOffsByDiagDir(dir);
1683 
1684  return HasVehicleOnPos(tile_from, &tile, &TrainApproachingCrossingEnum);
1685 }
1686 
1687 
1695 {
1696  assert(IsLevelCrossingTile(tile));
1697 
1698  /* reserved || train on crossing || train approaching crossing */
1700 
1701  if (new_state != IsCrossingBarred(tile)) {
1702  if (new_state && sound) {
1704  }
1705  SetCrossingBarred(tile, new_state);
1707  }
1708 }
1709 
1710 
1717 {
1718  if (!IsCrossingBarred(tile)) {
1719  BarCrossing(tile);
1722  }
1723 }
1724 
1725 
1732 {
1733  Train *base = v;
1734  Train *first = base; // first vehicle to move
1735  Train *last = v->Last(); // last vehicle to move
1736  uint length = CountVehiclesInChain(v);
1737 
1738  while (length > 2) {
1739  last = last->Previous();
1740  first = first->Next();
1741 
1742  int differential = base->CalcNextVehicleOffset() - last->CalcNextVehicleOffset();
1743 
1744  /* do not update images now
1745  * negative differential will be handled in AdvanceWagonsAfterSwap() */
1746  for (int i = 0; i < differential; i++) TrainController(first, last->Next());
1747 
1748  base = first; // == base->Next()
1749  length -= 2;
1750  }
1751 }
1752 
1753 
1760 {
1761  /* first of all, fix the situation when the train was entering a depot */
1762  Train *dep = v; // last vehicle in front of just left depot
1763  while (dep->Next() != nullptr && (dep->track == TRACK_BIT_DEPOT || dep->Next()->track != TRACK_BIT_DEPOT)) {
1764  dep = dep->Next(); // find first vehicle outside of a depot, with next vehicle inside a depot
1765  }
1766 
1767  Train *leave = dep->Next(); // first vehicle in a depot we are leaving now
1768 
1769  if (leave != nullptr) {
1770  /* 'pull' next wagon out of the depot, so we won't miss it (it could stay in depot forever) */
1771  int d = TicksToLeaveDepot(dep);
1772 
1773  if (d <= 0) {
1774  leave->vehstatus &= ~VS_HIDDEN; // move it out of the depot
1775  leave->track = TrackToTrackBits(GetRailDepotTrack(leave->tile));
1776  for (int i = 0; i >= d; i--) TrainController(leave, nullptr); // maybe move it, and maybe let another wagon leave
1777  }
1778  } else {
1779  dep = nullptr; // no vehicle in a depot, so no vehicle leaving a depot
1780  }
1781 
1782  Train *base = v;
1783  Train *first = base; // first vehicle to move
1784  Train *last = v->Last(); // last vehicle to move
1785  uint length = CountVehiclesInChain(v);
1786 
1787  /* We have to make sure all wagons that leave a depot because of train reversing are moved correctly
1788  * they have already correct spacing, so we have to make sure they are moved how they should */
1789  bool nomove = (dep == nullptr); // If there is no vehicle leaving a depot, limit the number of wagons moved immediately.
1790 
1791  while (length > 2) {
1792  /* we reached vehicle (originally) in front of a depot, stop now
1793  * (we would move wagons that are already moved with new wagon length). */
1794  if (base == dep) break;
1795 
1796  /* the last wagon was that one leaving a depot, so do not move it anymore */
1797  if (last == dep) nomove = true;
1798 
1799  last = last->Previous();
1800  first = first->Next();
1801 
1802  int differential = last->CalcNextVehicleOffset() - base->CalcNextVehicleOffset();
1803 
1804  /* do not update images now */
1805  for (int i = 0; i < differential; i++) TrainController(first, (nomove ? last->Next() : nullptr));
1806 
1807  base = first; // == base->Next()
1808  length -= 2;
1809  }
1810 }
1811 
1817 {
1818  if (IsRailDepotTile(v->tile)) {
1820  }
1821 
1822  /* Clear path reservation in front if train is not stuck. */
1823  if (!HasBit(v->flags, VRF_TRAIN_STUCK)) FreeTrainTrackReservation(v);
1824 
1825  /* Check if we were approaching a rail/road-crossing */
1827 
1828  /* count number of vehicles */
1829  int r = CountVehiclesInChain(v) - 1; // number of vehicles - 1
1830 
1832 
1833  /* swap start<>end, start+1<>end-1, ... */
1834  int l = 0;
1835  do {
1836  ReverseTrainSwapVeh(v, l++, r--);
1837  } while (l <= r);
1838 
1840 
1841  if (IsRailDepotTile(v->tile)) {
1843  }
1844 
1845  ToggleBit(v->flags, VRF_TOGGLE_REVERSE);
1846 
1847  ClrBit(v->flags, VRF_REVERSING);
1848 
1849  /* recalculate cached data */
1851 
1852  /* update all images */
1853  for (Train *u = v; u != nullptr; u = u->Next()) u->UpdateViewport(false, false);
1854 
1855  /* update crossing we were approaching */
1856  if (crossing != INVALID_TILE) UpdateLevelCrossing(crossing);
1857 
1858  /* maybe we are approaching crossing now, after reversal */
1859  crossing = TrainApproachingCrossingTile(v);
1860  if (crossing != INVALID_TILE) MaybeBarCrossingWithSound(crossing);
1861 
1862  /* If we are inside a depot after reversing, don't bother with path reserving. */
1863  if (v->track == TRACK_BIT_DEPOT) {
1864  /* Can't be stuck here as inside a depot is always a safe tile. */
1866  ClrBit(v->flags, VRF_TRAIN_STUCK);
1867  return;
1868  }
1869 
1870  /* VehicleExitDir does not always produce the desired dir for depots and
1871  * tunnels/bridges that is needed for UpdateSignalsOnSegment. */
1872  DiagDirection dir = VehicleExitDir(v->direction, v->track);
1874 
1876  /* If we are currently on a tile with conventional signals, we can't treat the
1877  * current tile as a safe tile or we would enter a PBS block without a reservation. */
1878  bool first_tile_okay = !(IsTileType(v->tile, MP_RAILWAY) &&
1880  !IsPbsSignal(GetSignalType(v->tile, FindFirstTrack(v->track))));
1881 
1882  /* If we are on a depot tile facing outwards, do not treat the current tile as safe. */
1883  if (IsRailDepotTile(v->tile) && TrackdirToExitdir(v->GetVehicleTrackdir()) == GetRailDepotDirection(v->tile)) first_tile_okay = false;
1884 
1886  if (TryPathReserve(v, false, first_tile_okay)) {
1887  /* Do a look-ahead now in case our current tile was already a safe tile. */
1888  CheckNextTrainTile(v);
1889  } else if (v->current_order.GetType() != OT_LOADING) {
1890  /* Do not wait for a way out when we're still loading */
1891  MarkTrainAsStuck(v);
1892  }
1893  } else if (HasBit(v->flags, VRF_TRAIN_STUCK)) {
1894  /* A train not inside a PBS block can't be stuck. */
1895  ClrBit(v->flags, VRF_TRAIN_STUCK);
1896  v->wait_counter = 0;
1897  }
1898 }
1899 
1909 CommandCost CmdReverseTrainDirection(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
1910 {
1911  Train *v = Train::GetIfValid(p1);
1912  if (v == nullptr) return CMD_ERROR;
1913 
1914  CommandCost ret = CheckOwnership(v->owner);
1915  if (ret.Failed()) return ret;
1916 
1917  if (p2 != 0) {
1918  /* turn a single unit around */
1919 
1920  if (v->IsMultiheaded() || HasBit(EngInfo(v->engine_type)->callback_mask, CBM_VEHICLE_ARTIC_ENGINE)) {
1921  return_cmd_error(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE_MULTIPLE_UNITS);
1922  }
1923  if (!HasBit(EngInfo(v->engine_type)->misc_flags, EF_RAIL_FLIPS)) return CMD_ERROR;
1924 
1925  Train *front = v->First();
1926  /* make sure the vehicle is stopped in the depot */
1927  if (!front->IsStoppedInDepot()) {
1928  return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT);
1929  }
1930 
1931  if (flags & DC_EXEC) {
1932  ToggleBit(v->flags, VRF_REVERSE_DIRECTION);
1933 
1934  front->ConsistChanged(CCF_ARRANGE);
1939  }
1940  } else {
1941  /* turn the whole train around */
1942  if ((v->vehstatus & VS_CRASHED) || v->breakdown_ctr != 0) return CMD_ERROR;
1943 
1944  if (flags & DC_EXEC) {
1945  /* Properly leave the station if we are loading and won't be loading anymore */
1946  if (v->current_order.IsType(OT_LOADING)) {
1947  const Vehicle *last = v;
1948  while (last->Next() != nullptr) last = last->Next();
1949 
1950  /* not a station || different station --> leave the station */
1951  if (!IsTileType(last->tile, MP_STATION) || GetStationIndex(last->tile) != GetStationIndex(v->tile)) {
1952  v->LeaveStation();
1953  }
1954  }
1955 
1956  /* We cancel any 'skip signal at dangers' here */
1957  v->force_proceed = TFP_NONE;
1959 
1960  if (_settings_game.vehicle.train_acceleration_model != AM_ORIGINAL && v->cur_speed != 0) {
1961  ToggleBit(v->flags, VRF_REVERSING);
1962  } else {
1963  v->cur_speed = 0;
1964  v->SetLastSpeed();
1967  }
1968  }
1969  }
1970  return CommandCost();
1971 }
1972 
1982 CommandCost CmdForceTrainProceed(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
1983 {
1984  Train *t = Train::GetIfValid(p1);
1985  if (t == nullptr) return CMD_ERROR;
1986 
1987  if (!t->IsPrimaryVehicle()) return CMD_ERROR;
1988 
1989  CommandCost ret = CheckOwnership(t->owner);
1990  if (ret.Failed()) return ret;
1991 
1992 
1993  if (flags & DC_EXEC) {
1994  /* If we are forced to proceed, cancel that order.
1995  * If we are marked stuck we would want to force the train
1996  * to proceed to the next signal. In the other cases we
1997  * would like to pass the signal at danger and run till the
1998  * next signal we encounter. */
1999  t->force_proceed = t->force_proceed == TFP_SIGNAL ? TFP_NONE : HasBit(t->flags, VRF_TRAIN_STUCK) || t->IsChainInDepot() ? TFP_STUCK : TFP_SIGNAL;
2001  }
2002 
2003  return CommandCost();
2004 }
2005 
2013 static FindDepotData FindClosestTrainDepot(Train *v, int max_distance)
2014 {
2015  assert(!(v->vehstatus & VS_CRASHED));
2016 
2017  if (IsRailDepotTile(v->tile)) return FindDepotData(v->tile, 0);
2018 
2019  PBSTileInfo origin = FollowTrainReservation(v);
2020  if (IsRailDepotTile(origin.tile)) return FindDepotData(origin.tile, 0);
2021 
2023  case VPF_NPF: return NPFTrainFindNearestDepot(v, max_distance);
2024  case VPF_YAPF: return YapfTrainFindNearestDepot(v, max_distance);
2025 
2026  default: NOT_REACHED();
2027  }
2028 }
2029 
2037 bool Train::FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
2038 {
2039  FindDepotData tfdd = FindClosestTrainDepot(this, 0);
2040  if (tfdd.best_length == UINT_MAX) return false;
2041 
2042  if (location != nullptr) *location = tfdd.tile;
2043  if (destination != nullptr) *destination = GetDepotIndex(tfdd.tile);
2044  if (reverse != nullptr) *reverse = tfdd.reverse;
2045 
2046  return true;
2047 }
2048 
2051 {
2052  static const SoundFx sfx[] = {
2058  };
2059 
2060  if (PlayVehicleSound(this, VSE_START)) return;
2061 
2062  EngineID engtype = this->engine_type;
2063  SndPlayVehicleFx(sfx[RailVehInfo(engtype)->engclass], this);
2064 }
2065 
2070 static void CheckNextTrainTile(Train *v)
2071 {
2072  /* Don't do any look-ahead if path_backoff_interval is 255. */
2073  if (_settings_game.pf.path_backoff_interval == 255) return;
2074 
2075  /* Exit if we are inside a depot. */
2076  if (v->track == TRACK_BIT_DEPOT) return;
2077 
2078  switch (v->current_order.GetType()) {
2079  /* Exit if we reached our destination depot. */
2080  case OT_GOTO_DEPOT:
2081  if (v->tile == v->dest_tile) return;
2082  break;
2083 
2084  case OT_GOTO_WAYPOINT:
2085  /* If we reached our waypoint, make sure we see that. */
2087  break;
2088 
2089  case OT_NOTHING:
2090  case OT_LEAVESTATION:
2091  case OT_LOADING:
2092  /* Exit if the current order doesn't have a destination, but the train has orders. */
2093  if (v->GetNumOrders() > 0) return;
2094  break;
2095 
2096  default:
2097  break;
2098  }
2099  /* Exit if we are on a station tile and are going to stop. */
2101 
2102  Trackdir td = v->GetVehicleTrackdir();
2103 
2104  /* On a tile with a red non-pbs signal, don't look ahead. */
2105  if (IsTileType(v->tile, MP_RAILWAY) && HasSignalOnTrackdir(v->tile, td) &&
2106  !IsPbsSignal(GetSignalType(v->tile, TrackdirToTrack(td))) &&
2107  GetSignalStateByTrackdir(v->tile, td) == SIGNAL_STATE_RED) return;
2108 
2109  CFollowTrackRail ft(v);
2110  if (!ft.Follow(v->tile, td)) return;
2111 
2113  /* Next tile is not reserved. */
2116  /* If the next tile is a PBS signal, try to make a reservation. */
2120  }
2121  ChooseTrainTrack(v, ft.m_new_tile, ft.m_exitdir, tracks, false, nullptr, false);
2122  }
2123  }
2124  }
2125 }
2126 
2133 {
2134  /* bail out if not all wagons are in the same depot or not in a depot at all */
2135  for (const Train *u = v; u != nullptr; u = u->Next()) {
2136  if (u->track != TRACK_BIT_DEPOT || u->tile != v->tile) return false;
2137  }
2138 
2139  /* if the train got no power, then keep it in the depot */
2140  if (v->gcache.cached_power == 0) {
2141  v->vehstatus |= VS_STOPPED;
2143  return true;
2144  }
2145 
2146  SigSegState seg_state;
2147 
2148  if (v->force_proceed == TFP_NONE) {
2149  /* force proceed was not pressed */
2150  if (++v->wait_counter < 37) {
2152  return true;
2153  }
2154 
2155  v->wait_counter = 0;
2156 
2158  if (seg_state == SIGSEG_FULL || HasDepotReservation(v->tile)) {
2159  /* Full and no PBS signal in block or depot reserved, can't exit. */
2161  return true;
2162  }
2163  } else {
2165  }
2166 
2167  /* We are leaving a depot, but have to go to the exact same one; re-enter. */
2168  if (v->current_order.IsType(OT_GOTO_DEPOT) && v->tile == v->dest_tile) {
2169  /* Service when depot has no reservation. */
2171  return true;
2172  }
2173 
2174  /* Only leave when we can reserve a path to our destination. */
2175  if (seg_state == SIGSEG_PBS && !TryPathReserve(v) && v->force_proceed == TFP_NONE) {
2176  /* No path and no force proceed. */
2178  MarkTrainAsStuck(v);
2179  return true;
2180  }
2181 
2182  SetDepotReservation(v->tile, true);
2184 
2187  v->PlayLeaveStationSound();
2188 
2189  v->track = TRACK_BIT_X;
2190  if (v->direction & 2) v->track = TRACK_BIT_Y;
2191 
2192  v->vehstatus &= ~VS_HIDDEN;
2193  v->cur_speed = 0;
2194 
2195  v->UpdateViewport(true, true);
2196  v->UpdatePosition();
2198  v->UpdateAcceleration();
2200 
2201  return false;
2202 }
2203 
2210 static void ClearPathReservation(const Train *v, TileIndex tile, Trackdir track_dir)
2211 {
2212  DiagDirection dir = TrackdirToExitdir(track_dir);
2213 
2215  /* Are we just leaving a tunnel/bridge? */
2218 
2219  if (TunnelBridgeIsFree(tile, end, v).Succeeded()) {
2220  /* Free the reservation only if no other train is on the tiles. */
2222  SetTunnelBridgeReservation(end, false);
2223 
2225  if (IsBridge(tile)) {
2227  } else {
2229  MarkTileDirtyByTile(end);
2230  }
2231  }
2232  }
2233  }
2234  } else if (IsRailStationTile(tile)) {
2235  TileIndex new_tile = TileAddByDiagDir(tile, dir);
2236  /* If the new tile is not a further tile of the same station, we
2237  * clear the reservation for the whole platform. */
2238  if (!IsCompatibleTrainStationTile(new_tile, tile)) {
2240  }
2241  } else {
2242  /* Any other tile */
2244  }
2245 }
2246 
2252 {
2253  assert(v->IsFrontEngine());
2254 
2255  TileIndex tile = v->tile;
2256  Trackdir td = v->GetVehicleTrackdir();
2257  bool free_tile = !(IsRailStationTile(v->tile) || IsTileType(v->tile, MP_TUNNELBRIDGE));
2258  StationID station_id = IsRailStationTile(v->tile) ? GetStationIndex(v->tile) : INVALID_STATION;
2259 
2260  /* Can't be holding a reservation if we enter a depot. */
2262  if (v->track == TRACK_BIT_DEPOT) {
2263  /* Front engine is in a depot. We enter if some part is not in the depot. */
2264  for (const Train *u = v; u != nullptr; u = u->Next()) {
2265  if (u->track != TRACK_BIT_DEPOT || u->tile != v->tile) return;
2266  }
2267  }
2268  /* Don't free reservation if it's not ours. */
2270 
2272  while (ft.Follow(tile, td)) {
2273  tile = ft.m_new_tile;
2275  td = RemoveFirstTrackdir(&bits);
2276  assert(bits == TRACKDIR_BIT_NONE);
2277 
2278  if (!IsValidTrackdir(td)) break;
2279 
2280  if (IsTileType(tile, MP_RAILWAY)) {
2281  if (HasSignalOnTrackdir(tile, td) && !IsPbsSignal(GetSignalType(tile, TrackdirToTrack(td)))) {
2282  /* Conventional signal along trackdir: remove reservation and stop. */
2284  break;
2285  }
2286  if (HasPbsSignalOnTrackdir(tile, td)) {
2288  /* Red PBS signal? Can't be our reservation, would be green then. */
2289  break;
2290  } else {
2291  /* Turn the signal back to red. */
2294  }
2296  break;
2297  }
2298  }
2299 
2300  /* Don't free first station/bridge/tunnel if we are on it. */
2301  if (free_tile || (!(ft.m_is_station && GetStationIndex(ft.m_new_tile) == station_id) && !ft.m_is_tunnel && !ft.m_is_bridge)) ClearPathReservation(v, tile, td);
2302 
2303  free_tile = true;
2304  }
2305 }
2306 
2307 static const byte _initial_tile_subcoord[6][4][3] = {
2308 {{ 15, 8, 1 }, { 0, 0, 0 }, { 0, 8, 5 }, { 0, 0, 0 }},
2309 {{ 0, 0, 0 }, { 8, 0, 3 }, { 0, 0, 0 }, { 8, 15, 7 }},
2310 {{ 0, 0, 0 }, { 7, 0, 2 }, { 0, 7, 6 }, { 0, 0, 0 }},
2311 {{ 15, 8, 2 }, { 0, 0, 0 }, { 0, 0, 0 }, { 8, 15, 6 }},
2312 {{ 15, 7, 0 }, { 8, 0, 4 }, { 0, 0, 0 }, { 0, 0, 0 }},
2313 {{ 0, 0, 0 }, { 0, 0, 0 }, { 0, 8, 4 }, { 7, 15, 0 }},
2314 };
2315 
2328 static Track DoTrainPathfind(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool do_track_reservation, PBSTileInfo *dest)
2329 {
2331  case VPF_NPF: return NPFTrainChooseTrack(v, path_found, do_track_reservation, dest);
2332  case VPF_YAPF: return YapfTrainChooseTrack(v, tile, enterdir, tracks, path_found, do_track_reservation, dest);
2333 
2334  default: NOT_REACHED();
2335  }
2336 }
2337 
2343 static PBSTileInfo ExtendTrainReservation(const Train *v, TrackBits *new_tracks, DiagDirection *enterdir)
2344 {
2345  PBSTileInfo origin = FollowTrainReservation(v);
2346 
2347  CFollowTrackRail ft(v);
2348 
2349  TileIndex tile = origin.tile;
2350  Trackdir cur_td = origin.trackdir;
2351  while (ft.Follow(tile, cur_td)) {
2353  /* Possible signal tile. */
2355  }
2356 
2359  if (ft.m_new_td_bits == TRACKDIR_BIT_NONE) break;
2360  }
2361 
2362  /* Station, depot or waypoint are a possible target. */
2363  bool target_seen = ft.m_is_station || (IsTileType(ft.m_new_tile, MP_RAILWAY) && !IsPlainRail(ft.m_new_tile));
2364  if (target_seen || KillFirstBit(ft.m_new_td_bits) != TRACKDIR_BIT_NONE) {
2365  /* Choice found or possible target encountered.
2366  * On finding a possible target, we need to stop and let the pathfinder handle the
2367  * remaining path. This is because we don't know if this target is in one of our
2368  * orders, so we might cause pathfinding to fail later on if we find a choice.
2369  * This failure would cause a bogous call to TryReserveSafePath which might reserve
2370  * a wrong path not leading to our next destination. */
2372 
2373  /* If we did skip some tiles, backtrack to the first skipped tile so the pathfinder
2374  * actually starts its search at the first unreserved tile. */
2376 
2377  /* Choice found, path valid but not okay. Save info about the choice tile as well. */
2378  if (new_tracks != nullptr) *new_tracks = TrackdirBitsToTrackBits(ft.m_new_td_bits);
2379  if (enterdir != nullptr) *enterdir = ft.m_exitdir;
2380  return PBSTileInfo(ft.m_new_tile, ft.m_old_td, false);
2381  }
2382 
2383  tile = ft.m_new_tile;
2384  cur_td = FindFirstTrackdir(ft.m_new_td_bits);
2385 
2386  if (IsSafeWaitingPosition(v, tile, cur_td, true, _settings_game.pf.forbid_90_deg)) {
2387  bool wp_free = IsWaitingPositionFree(v, tile, cur_td, _settings_game.pf.forbid_90_deg);
2388  if (!(wp_free && TryReserveRailTrack(tile, TrackdirToTrack(cur_td)))) break;
2389  /* Safe position is all good, path valid and okay. */
2390  return PBSTileInfo(tile, cur_td, true);
2391  }
2392 
2393  if (!TryReserveRailTrack(tile, TrackdirToTrack(cur_td))) break;
2394  }
2395 
2396  if (ft.m_err == CFollowTrackRail::EC_OWNER || ft.m_err == CFollowTrackRail::EC_NO_WAY) {
2397  /* End of line, path valid and okay. */
2398  return PBSTileInfo(ft.m_old_tile, ft.m_old_td, true);
2399  }
2400 
2401  /* Sorry, can't reserve path, back out. */
2402  tile = origin.tile;
2403  cur_td = origin.trackdir;
2404  TileIndex stopped = ft.m_old_tile;
2405  Trackdir stopped_td = ft.m_old_td;
2406  while (tile != stopped || cur_td != stopped_td) {
2407  if (!ft.Follow(tile, cur_td)) break;
2408 
2411  assert(ft.m_new_td_bits != TRACKDIR_BIT_NONE);
2412  }
2414 
2415  tile = ft.m_new_tile;
2416  cur_td = FindFirstTrackdir(ft.m_new_td_bits);
2417 
2419  }
2420 
2421  /* Path invalid. */
2422  return PBSTileInfo();
2423 }
2424 
2435 static bool TryReserveSafeTrack(const Train *v, TileIndex tile, Trackdir td, bool override_railtype)
2436 {
2438  case VPF_NPF: return NPFTrainFindNearestSafeTile(v, tile, td, override_railtype);
2439  case VPF_YAPF: return YapfTrainFindNearestSafeTile(v, tile, td, override_railtype);
2440 
2441  default: NOT_REACHED();
2442  }
2443 }
2444 
2447 private:
2448  Train *v;
2449  Order old_order;
2450  TileIndex old_dest_tile;
2451  StationID old_last_station_visited;
2452  VehicleOrderID index;
2453  bool suppress_implicit_orders;
2454 
2455 public:
2456  VehicleOrderSaver(Train *_v) :
2457  v(_v),
2458  old_order(_v->current_order),
2459  old_dest_tile(_v->dest_tile),
2460  old_last_station_visited(_v->last_station_visited),
2461  index(_v->cur_real_order_index),
2462  suppress_implicit_orders(HasBit(_v->gv_flags, GVF_SUPPRESS_IMPLICIT_ORDERS))
2463  {
2464  }
2465 
2467  {
2468  this->v->current_order = this->old_order;
2469  this->v->dest_tile = this->old_dest_tile;
2470  this->v->last_station_visited = this->old_last_station_visited;
2471  SB(this->v->gv_flags, GVF_SUPPRESS_IMPLICIT_ORDERS, 1, suppress_implicit_orders ? 1: 0);
2472  }
2473 
2479  bool SwitchToNextOrder(bool skip_first)
2480  {
2481  if (this->v->GetNumOrders() == 0) return false;
2482 
2483  if (skip_first) ++this->index;
2484 
2485  int depth = 0;
2486 
2487  do {
2488  /* Wrap around. */
2489  if (this->index >= this->v->GetNumOrders()) this->index = 0;
2490 
2491  Order *order = this->v->GetOrder(this->index);
2492  assert(order != nullptr);
2493 
2494  switch (order->GetType()) {
2495  case OT_GOTO_DEPOT:
2496  /* Skip service in depot orders when the train doesn't need service. */
2497  if ((order->GetDepotOrderType() & ODTFB_SERVICE) && !this->v->NeedsServicing()) break;
2498  FALLTHROUGH;
2499  case OT_GOTO_STATION:
2500  case OT_GOTO_WAYPOINT:
2501  this->v->current_order = *order;
2502  return UpdateOrderDest(this->v, order, 0, true);
2503  case OT_CONDITIONAL: {
2504  VehicleOrderID next = ProcessConditionalOrder(order, this->v);
2505  if (next != INVALID_VEH_ORDER_ID) {
2506  depth++;
2507  this->index = next;
2508  /* Don't increment next, so no break here. */
2509  continue;
2510  }
2511  break;
2512  }
2513  default:
2514  break;
2515  }
2516  /* Don't increment inside the while because otherwise conditional
2517  * orders can lead to an infinite loop. */
2518  ++this->index;
2519  depth++;
2520  } while (this->index != this->v->cur_real_order_index && depth < this->v->GetNumOrders());
2521 
2522  return false;
2523  }
2524 };
2525 
2526 /* choose a track */
2527 static Track ChooseTrainTrack(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool force_res, bool *got_reservation, bool mark_stuck)
2528 {
2529  Track best_track = INVALID_TRACK;
2530  bool do_track_reservation = _settings_game.pf.reserve_paths || force_res;
2531  bool changed_signal = false;
2532 
2533  assert((tracks & ~TRACK_BIT_MASK) == 0);
2534 
2535  if (got_reservation != nullptr) *got_reservation = false;
2536 
2537  /* Don't use tracks here as the setting to forbid 90 deg turns might have been switched between reservation and now. */
2538  TrackBits res_tracks = (TrackBits)(GetReservedTrackbits(tile) & DiagdirReachesTracks(enterdir));
2539  /* Do we have a suitable reserved track? */
2540  if (res_tracks != TRACK_BIT_NONE) return FindFirstTrack(res_tracks);
2541 
2542  /* Quick return in case only one possible track is available */
2543  if (KillFirstBit(tracks) == TRACK_BIT_NONE) {
2544  Track track = FindFirstTrack(tracks);
2545  /* We need to check for signals only here, as a junction tile can't have signals. */
2546  if (track != INVALID_TRACK && HasPbsSignalOnTrackdir(tile, TrackEnterdirToTrackdir(track, enterdir))) {
2547  do_track_reservation = true;
2548  changed_signal = true;
2550  } else if (!do_track_reservation) {
2551  return track;
2552  }
2553  best_track = track;
2554  }
2555 
2556  PBSTileInfo res_dest(tile, INVALID_TRACKDIR, false);
2557  DiagDirection dest_enterdir = enterdir;
2558  if (do_track_reservation) {
2559  res_dest = ExtendTrainReservation(v, &tracks, &dest_enterdir);
2560  if (res_dest.tile == INVALID_TILE) {
2561  /* Reservation failed? */
2562  if (mark_stuck) MarkTrainAsStuck(v);
2563  if (changed_signal) SetSignalStateByTrackdir(tile, TrackEnterdirToTrackdir(best_track, enterdir), SIGNAL_STATE_RED);
2564  return FindFirstTrack(tracks);
2565  }
2566  if (res_dest.okay) {
2567  /* Got a valid reservation that ends at a safe target, quick exit. */
2568  if (got_reservation != nullptr) *got_reservation = true;
2569  if (changed_signal) MarkTileDirtyByTile(tile);
2571  return best_track;
2572  }
2573 
2574  /* Check if the train needs service here, so it has a chance to always find a depot.
2575  * Also check if the current order is a service order so we don't reserve a path to
2576  * the destination but instead to the next one if service isn't needed. */
2578  if (v->current_order.IsType(OT_DUMMY) || v->current_order.IsType(OT_CONDITIONAL) || v->current_order.IsType(OT_GOTO_DEPOT)) ProcessOrders(v);
2579  }
2580 
2581  /* Save the current train order. The destructor will restore the old order on function exit. */
2582  VehicleOrderSaver orders(v);
2583 
2584  /* If the current tile is the destination of the current order and
2585  * a reservation was requested, advance to the next order.
2586  * Don't advance on a depot order as depots are always safe end points
2587  * for a path and no look-ahead is necessary. This also avoids a
2588  * problem with depot orders not part of the order list when the
2589  * order list itself is empty. */
2590  if (v->current_order.IsType(OT_LEAVESTATION)) {
2591  orders.SwitchToNextOrder(false);
2592  } else if (v->current_order.IsType(OT_LOADING) || (!v->current_order.IsType(OT_GOTO_DEPOT) && (
2593  v->current_order.IsType(OT_GOTO_STATION) ?
2595  v->tile == v->dest_tile))) {
2596  orders.SwitchToNextOrder(true);
2597  }
2598 
2599  if (res_dest.tile != INVALID_TILE && !res_dest.okay) {
2600  /* Pathfinders are able to tell that route was only 'guessed'. */
2601  bool path_found = true;
2602  TileIndex new_tile = res_dest.tile;
2603 
2604  Track next_track = DoTrainPathfind(v, new_tile, dest_enterdir, tracks, path_found, do_track_reservation, &res_dest);
2605  if (new_tile == tile) best_track = next_track;
2606  v->HandlePathfindingResult(path_found);
2607  }
2608 
2609  /* No track reservation requested -> finished. */
2610  if (!do_track_reservation) return best_track;
2611 
2612  /* A path was found, but could not be reserved. */
2613  if (res_dest.tile != INVALID_TILE && !res_dest.okay) {
2614  if (mark_stuck) MarkTrainAsStuck(v);
2616  return best_track;
2617  }
2618 
2619  /* No possible reservation target found, we are probably lost. */
2620  if (res_dest.tile == INVALID_TILE) {
2621  /* Try to find any safe destination. */
2622  PBSTileInfo origin = FollowTrainReservation(v);
2623  if (TryReserveSafeTrack(v, origin.tile, origin.trackdir, false)) {
2624  TrackBits res = GetReservedTrackbits(tile) & DiagdirReachesTracks(enterdir);
2625  best_track = FindFirstTrack(res);
2627  if (got_reservation != nullptr) *got_reservation = true;
2628  if (changed_signal) MarkTileDirtyByTile(tile);
2629  } else {
2631  if (mark_stuck) MarkTrainAsStuck(v);
2632  }
2633  return best_track;
2634  }
2635 
2636  if (got_reservation != nullptr) *got_reservation = true;
2637 
2638  /* Reservation target found and free, check if it is safe. */
2639  while (!IsSafeWaitingPosition(v, res_dest.tile, res_dest.trackdir, true, _settings_game.pf.forbid_90_deg)) {
2640  /* Extend reservation until we have found a safe position. */
2641  DiagDirection exitdir = TrackdirToExitdir(res_dest.trackdir);
2642  TileIndex next_tile = TileAddByDiagDir(res_dest.tile, exitdir);
2644  if (Rail90DegTurnDisallowed(GetTileRailType(res_dest.tile), GetTileRailType(next_tile))) {
2645  reachable &= ~TrackCrossesTracks(TrackdirToTrack(res_dest.trackdir));
2646  }
2647 
2648  /* Get next order with destination. */
2649  if (orders.SwitchToNextOrder(true)) {
2650  PBSTileInfo cur_dest;
2651  bool path_found;
2652  DoTrainPathfind(v, next_tile, exitdir, reachable, path_found, true, &cur_dest);
2653  if (cur_dest.tile != INVALID_TILE) {
2654  res_dest = cur_dest;
2655  if (res_dest.okay) continue;
2656  /* Path found, but could not be reserved. */
2658  if (mark_stuck) MarkTrainAsStuck(v);
2659  if (got_reservation != nullptr) *got_reservation = false;
2660  changed_signal = false;
2661  break;
2662  }
2663  }
2664  /* No order or no safe position found, try any position. */
2665  if (!TryReserveSafeTrack(v, res_dest.tile, res_dest.trackdir, true)) {
2667  if (mark_stuck) MarkTrainAsStuck(v);
2668  if (got_reservation != nullptr) *got_reservation = false;
2669  changed_signal = false;
2670  }
2671  break;
2672  }
2673 
2675 
2676  if (changed_signal) MarkTileDirtyByTile(tile);
2677 
2678  return best_track;
2679 }
2680 
2689 bool TryPathReserve(Train *v, bool mark_as_stuck, bool first_tile_okay)
2690 {
2691  assert(v->IsFrontEngine());
2692 
2693  /* We have to handle depots specially as the track follower won't look
2694  * at the depot tile itself but starts from the next tile. If we are still
2695  * inside the depot, a depot reservation can never be ours. */
2696  if (v->track == TRACK_BIT_DEPOT) {
2697  if (HasDepotReservation(v->tile)) {
2698  if (mark_as_stuck) MarkTrainAsStuck(v);
2699  return false;
2700  } else {
2701  /* Depot not reserved, but the next tile might be. */
2703  if (HasReservedTracks(next_tile, DiagdirReachesTracks(GetRailDepotDirection(v->tile)))) return false;
2704  }
2705  }
2706 
2707  Vehicle *other_train = nullptr;
2708  PBSTileInfo origin = FollowTrainReservation(v, &other_train);
2709  /* The path we are driving on is already blocked by some other train.
2710  * This can only happen in certain situations when mixing path and
2711  * block signals or when changing tracks and/or signals.
2712  * Exit here as doing any further reservations will probably just
2713  * make matters worse. */
2714  if (other_train != nullptr && other_train->index != v->index) {
2715  if (mark_as_stuck) MarkTrainAsStuck(v);
2716  return false;
2717  }
2718  /* If we have a reserved path and the path ends at a safe tile, we are finished already. */
2719  if (origin.okay && (v->tile != origin.tile || first_tile_okay)) {
2720  /* Can't be stuck then. */
2722  ClrBit(v->flags, VRF_TRAIN_STUCK);
2723  return true;
2724  }
2725 
2726  /* If we are in a depot, tentatively reserve the depot. */
2727  if (v->track == TRACK_BIT_DEPOT) {
2728  SetDepotReservation(v->tile, true);
2730  }
2731 
2732  DiagDirection exitdir = TrackdirToExitdir(origin.trackdir);
2733  TileIndex new_tile = TileAddByDiagDir(origin.tile, exitdir);
2735 
2737 
2738  bool res_made = false;
2739  ChooseTrainTrack(v, new_tile, exitdir, reachable, true, &res_made, mark_as_stuck);
2740 
2741  if (!res_made) {
2742  /* Free the depot reservation as well. */
2743  if (v->track == TRACK_BIT_DEPOT) SetDepotReservation(v->tile, false);
2744  return false;
2745  }
2746 
2747  if (HasBit(v->flags, VRF_TRAIN_STUCK)) {
2748  v->wait_counter = 0;
2750  }
2751  ClrBit(v->flags, VRF_TRAIN_STUCK);
2752  return true;
2753 }
2754 
2755 
2756 static bool CheckReverseTrain(const Train *v)
2757 {
2759  v->track == TRACK_BIT_DEPOT || v->track == TRACK_BIT_WORMHOLE ||
2760  !(v->direction & 1)) {
2761  return false;
2762  }
2763 
2764  assert(v->track != TRACK_BIT_NONE);
2765 
2767  case VPF_NPF: return NPFTrainCheckReverse(v);
2768  case VPF_YAPF: return YapfTrainCheckReverse(v);
2769 
2770  default: NOT_REACHED();
2771  }
2772 }
2773 
2780 {
2781  if (station == this->last_station_visited) this->last_station_visited = INVALID_STATION;
2782 
2783  const Station *st = Station::Get(station);
2784  if (!(st->facilities & FACIL_TRAIN)) {
2785  /* The destination station has no trainstation tiles. */
2786  this->IncrementRealOrderIndex();
2787  return 0;
2788  }
2789 
2790  return st->xy;
2791 }
2792 
2795 {
2796  Train *v = this;
2797  do {
2798  v->colourmap = PAL_NONE;
2799  v->UpdateViewport(true, false);
2800  } while ((v = v->Next()) != nullptr);
2801 
2802  /* need to update acceleration and cached values since the goods on the train changed. */
2803  this->CargoChanged();
2804  this->UpdateAcceleration();
2805 }
2806 
2815 {
2817  default: NOT_REACHED();
2818  case AM_ORIGINAL:
2819  return this->DoUpdateSpeed(this->acceleration * (this->GetAccelerationStatus() == AS_BRAKE ? -4 : 2), 0, this->GetCurrentMaxSpeed());
2820 
2821  case AM_REALISTIC:
2822  return this->DoUpdateSpeed(this->GetAcceleration(), this->GetAccelerationStatus() == AS_BRAKE ? 0 : 2, this->GetCurrentMaxSpeed());
2823  }
2824 }
2825 
2831 static void TrainEnterStation(Train *v, StationID station)
2832 {
2833  v->last_station_visited = station;
2834 
2835  /* check if a train ever visited this station before */
2836  Station *st = Station::Get(station);
2837  if (!(st->had_vehicle_of_type & HVOT_TRAIN)) {
2838  st->had_vehicle_of_type |= HVOT_TRAIN;
2839  SetDParam(0, st->index);
2841  STR_NEWS_FIRST_TRAIN_ARRIVAL,
2843  v->index,
2844  st->index
2845  );
2846  AI::NewEvent(v->owner, new ScriptEventStationFirstVehicle(st->index, v->index));
2847  Game::NewEvent(new ScriptEventStationFirstVehicle(st->index, v->index));
2848  }
2849 
2850  v->force_proceed = TFP_NONE;
2852 
2853  v->BeginLoading();
2854 
2856  TriggerStationAnimation(st, v->tile, SAT_TRAIN_ARRIVES);
2857 }
2858 
2859 /* Check if the vehicle is compatible with the specified tile */
2860 static inline bool CheckCompatibleRail(const Train *v, TileIndex tile)
2861 {
2862  return IsTileOwner(tile, v->owner) &&
2863  (!v->IsFrontEngine() || HasBit(v->compatible_railtypes, GetRailType(tile)));
2864 }
2865 
2868  byte small_turn;
2869  byte large_turn;
2870  byte z_up;
2871  byte z_down;
2872 };
2873 
2876  /* normal accel */
2877  {256 / 4, 256 / 2, 256 / 4, 2},
2878  {256 / 4, 256 / 2, 256 / 4, 2},
2879  {0, 256 / 2, 256 / 4, 2},
2880 };
2881 
2887 static inline void AffectSpeedByZChange(Train *v, int old_z)
2888 {
2889  if (old_z == v->z_pos || _settings_game.vehicle.train_acceleration_model != AM_ORIGINAL) return;
2890 
2892 
2893  if (old_z < v->z_pos) {
2894  v->cur_speed -= (v->cur_speed * asp->z_up >> 8);
2895  } else {
2896  uint16 spd = v->cur_speed + asp->z_down;
2897  if (spd <= v->gcache.cached_max_track_speed) v->cur_speed = spd;
2898  }
2899 }
2900 
2901 static bool TrainMovedChangeSignals(TileIndex tile, DiagDirection dir)
2902 {
2903  if (IsTileType(tile, MP_RAILWAY) &&
2906  Trackdir trackdir = FindFirstTrackdir(tracks);
2907  if (UpdateSignalsOnSegment(tile, TrackdirToExitdir(trackdir), GetTileOwner(tile)) == SIGSEG_PBS && HasSignalOnTrackdir(tile, trackdir)) {
2908  /* A PBS block with a non-PBS signal facing us? */
2909  if (!IsPbsSignal(GetSignalType(tile, TrackdirToTrack(trackdir)))) return true;
2910  }
2911  }
2912  return false;
2913 }
2914 
2917 {
2918  for (const Train *u = this; u != nullptr; u = u->Next()) {
2919  switch (u->track) {
2920  case TRACK_BIT_WORMHOLE:
2922  break;
2923  case TRACK_BIT_DEPOT:
2924  break;
2925  default:
2926  TryReserveRailTrack(u->tile, TrackBitsToTrack(u->track));
2927  break;
2928  }
2929  }
2930 }
2931 
2938 uint Train::Crash(bool flooded)
2939 {
2940  uint pass = 0;
2941  if (this->IsFrontEngine()) {
2942  pass += 2; // driver
2943 
2944  /* Remove the reserved path in front of the train if it is not stuck.
2945  * Also clear all reserved tracks the train is currently on. */
2946  if (!HasBit(this->flags, VRF_TRAIN_STUCK)) FreeTrainTrackReservation(this);
2947  for (const Train *v = this; v != nullptr; v = v->Next()) {
2949  if (IsTileType(v->tile, MP_TUNNELBRIDGE)) {
2950  /* ClearPathReservation will not free the wormhole exit
2951  * if the train has just entered the wormhole. */
2953  }
2954  }
2955 
2956  /* we may need to update crossing we were approaching,
2957  * but must be updated after the train has been marked crashed */
2958  TileIndex crossing = TrainApproachingCrossingTile(this);
2959  if (crossing != INVALID_TILE) UpdateLevelCrossing(crossing);
2960 
2961  /* Remove the loading indicators (if any) */
2963  }
2964 
2965  pass += this->GroundVehicleBase::Crash(flooded);
2966 
2967  this->crash_anim_pos = flooded ? 4000 : 1; // max 4440, disappear pretty fast when flooded
2968  return pass;
2969 }
2970 
2977 static uint TrainCrashed(Train *v)
2978 {
2979  uint num = 0;
2980 
2981  /* do not crash train twice */
2982  if (!(v->vehstatus & VS_CRASHED)) {
2983  num = v->Crash();
2984  AI::NewEvent(v->owner, new ScriptEventVehicleCrashed(v->index, v->tile, ScriptEventVehicleCrashed::CRASH_TRAIN));
2985  Game::NewEvent(new ScriptEventVehicleCrashed(v->index, v->tile, ScriptEventVehicleCrashed::CRASH_TRAIN));
2986  }
2987 
2988  /* Try to re-reserve track under already crashed train too.
2989  * Crash() clears the reservation! */
2991 
2992  return num;
2993 }
2994 
2998  uint num;
2999 };
3000 
3007 static Vehicle *FindTrainCollideEnum(Vehicle *v, void *data)
3008 {
3010 
3011  /* not a train or in depot */
3012  if (v->type != VEH_TRAIN || Train::From(v)->track == TRACK_BIT_DEPOT) return nullptr;
3013 
3014  /* do not crash into trains of another company. */
3015  if (v->owner != tcc->v->owner) return nullptr;
3016 
3017  /* get first vehicle now to make most usual checks faster */
3018  Train *coll = Train::From(v)->First();
3019 
3020  /* can't collide with own wagons */
3021  if (coll == tcc->v) return nullptr;
3022 
3023  int x_diff = v->x_pos - tcc->v->x_pos;
3024  int y_diff = v->y_pos - tcc->v->y_pos;
3025 
3026  /* Do fast calculation to check whether trains are not in close vicinity
3027  * and quickly reject trains distant enough for any collision.
3028  * Differences are shifted by 7, mapping range [-7 .. 8] into [0 .. 15]
3029  * Differences are then ORed and then we check for any higher bits */
3030  uint hash = (y_diff + 7) | (x_diff + 7);
3031  if (hash & ~15) return nullptr;
3032 
3033  /* Slower check using multiplication */
3034  int min_diff = (Train::From(v)->gcache.cached_veh_length + 1) / 2 + (tcc->v->gcache.cached_veh_length + 1) / 2 - 1;
3035  if (x_diff * x_diff + y_diff * y_diff > min_diff * min_diff) return nullptr;
3036 
3037  /* Happens when there is a train under bridge next to bridge head */
3038  if (abs(v->z_pos - tcc->v->z_pos) > 5) return nullptr;
3039 
3040  /* crash both trains */
3041  tcc->num += TrainCrashed(tcc->v);
3042  tcc->num += TrainCrashed(coll);
3043 
3044  return nullptr; // continue searching
3045 }
3046 
3055 {
3056  /* can't collide in depot */
3057  if (v->track == TRACK_BIT_DEPOT) return false;
3058 
3059  assert(v->track == TRACK_BIT_WORMHOLE || TileVirtXY(v->x_pos, v->y_pos) == v->tile);
3060 
3061  TrainCollideChecker tcc;
3062  tcc.v = v;
3063  tcc.num = 0;
3064 
3065  /* find colliding vehicles */
3066  if (v->track == TRACK_BIT_WORMHOLE) {
3069  } else {
3071  }
3072 
3073  /* any dead -> no crash */
3074  if (tcc.num == 0) return false;
3075 
3076  SetDParam(0, tcc.num);
3077  AddTileNewsItem(STR_NEWS_TRAIN_CRASH, NT_ACCIDENT, v->tile);
3078 
3079  ModifyStationRatingAround(v->tile, v->owner, -160, 30);
3080  if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_13_TRAIN_COLLISION, v);
3081  return true;
3082 }
3083 
3084 static Vehicle *CheckTrainAtSignal(Vehicle *v, void *data)
3085 {
3086  if (v->type != VEH_TRAIN || (v->vehstatus & VS_CRASHED)) return nullptr;
3087 
3088  Train *t = Train::From(v);
3089  DiagDirection exitdir = *(DiagDirection *)data;
3090 
3091  /* not front engine of a train, inside wormhole or depot, crashed */
3092  if (!t->IsFrontEngine() || !(t->track & TRACK_BIT_MASK)) return nullptr;
3093 
3094  if (t->cur_speed > 5 || VehicleExitDir(t->direction, t->track) != exitdir) return nullptr;
3095 
3096  return t;
3097 }
3098 
3106 bool TrainController(Train *v, Vehicle *nomove, bool reverse)
3107 {
3108  Train *first = v->First();
3109  Train *prev;
3110  bool direction_changed = false; // has direction of any part changed?
3111 
3112  /* For every vehicle after and including the given vehicle */
3113  for (prev = v->Previous(); v != nomove; prev = v, v = v->Next()) {
3114  DiagDirection enterdir = DIAGDIR_BEGIN;
3115  bool update_signals_crossing = false; // will we update signals or crossing state?
3116 
3118  if (v->track != TRACK_BIT_WORMHOLE) {
3119  /* Not inside tunnel */
3120  if (gp.old_tile == gp.new_tile) {
3121  /* Staying in the old tile */
3122  if (v->track == TRACK_BIT_DEPOT) {
3123  /* Inside depot */
3124  gp.x = v->x_pos;
3125  gp.y = v->y_pos;
3126  } else {
3127  /* Not inside depot */
3128 
3129  /* Reverse when we are at the end of the track already, do not move to the new position */
3130  if (v->IsFrontEngine() && !TrainCheckIfLineEnds(v, reverse)) return false;
3131 
3132  uint32 r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
3133  if (HasBit(r, VETS_CANNOT_ENTER)) {
3134  goto invalid_rail;
3135  }
3136  if (HasBit(r, VETS_ENTERED_STATION)) {
3137  /* The new position is the end of the platform */
3139  }
3140  }
3141  } else {
3142  /* A new tile is about to be entered. */
3143 
3144  /* Determine what direction we're entering the new tile from */
3145  enterdir = DiagdirBetweenTiles(gp.old_tile, gp.new_tile);
3146  assert(IsValidDiagDirection(enterdir));
3147 
3148  /* Get the status of the tracks in the new tile and mask
3149  * away the bits that aren't reachable. */
3150  TrackStatus ts = GetTileTrackStatus(gp.new_tile, TRANSPORT_RAIL, 0, ReverseDiagDir(enterdir));
3151  TrackdirBits reachable_trackdirs = DiagdirReachesTrackdirs(enterdir);
3152 
3153  TrackdirBits trackdirbits = TrackStatusToTrackdirBits(ts) & reachable_trackdirs;
3154  TrackBits red_signals = TrackdirBitsToTrackBits(TrackStatusToRedSignals(ts) & reachable_trackdirs);
3155 
3156  TrackBits bits = TrackdirBitsToTrackBits(trackdirbits);
3157  if (Rail90DegTurnDisallowed(GetTileRailType(gp.old_tile), GetTileRailType(gp.new_tile)) && prev == nullptr) {
3158  /* We allow wagons to make 90 deg turns, because forbid_90_deg
3159  * can be switched on halfway a turn */
3160  bits &= ~TrackCrossesTracks(FindFirstTrack(v->track));
3161  }
3162 
3163  if (bits == TRACK_BIT_NONE) goto invalid_rail;
3164 
3165  /* Check if the new tile constrains tracks that are compatible
3166  * with the current train, if not, bail out. */
3167  if (!CheckCompatibleRail(v, gp.new_tile)) goto invalid_rail;
3168 
3169  TrackBits chosen_track;
3170  if (prev == nullptr) {
3171  /* Currently the locomotive is active. Determine which one of the
3172  * available tracks to choose */
3173  chosen_track = TrackToTrackBits(ChooseTrainTrack(v, gp.new_tile, enterdir, bits, false, nullptr, true));
3174  assert(chosen_track & (bits | GetReservedTrackbits(gp.new_tile)));
3175 
3176  if (v->force_proceed != TFP_NONE && IsPlainRailTile(gp.new_tile) && HasSignals(gp.new_tile)) {
3177  /* For each signal we find decrease the counter by one.
3178  * We start at two, so the first signal we pass decreases
3179  * this to one, then if we reach the next signal it is
3180  * decreased to zero and we won't pass that new signal. */
3181  Trackdir dir = FindFirstTrackdir(trackdirbits);
3182  if (HasSignalOnTrackdir(gp.new_tile, dir) ||
3184  GetSignalType(gp.new_tile, TrackdirToTrack(dir)) != SIGTYPE_PBS)) {
3185  /* However, we do not want to be stopped by PBS signals
3186  * entered via the back. */
3187  v->force_proceed = (v->force_proceed == TFP_SIGNAL) ? TFP_STUCK : TFP_NONE;
3189  }
3190  }
3191 
3192  /* Check if it's a red signal and that force proceed is not clicked. */
3193  if ((red_signals & chosen_track) && v->force_proceed == TFP_NONE) {
3194  /* In front of a red signal */
3195  Trackdir i = FindFirstTrackdir(trackdirbits);
3196 
3197  /* Don't handle stuck trains here. */
3198  if (HasBit(v->flags, VRF_TRAIN_STUCK)) return false;
3199 
3201  v->cur_speed = 0;
3202  v->subspeed = 0;
3203  v->progress = 255; // make sure that every bit of acceleration will hit the signal again, so speed stays 0.
3205  } else if (HasSignalOnTrackdir(gp.new_tile, i)) {
3206  v->cur_speed = 0;
3207  v->subspeed = 0;
3208  v->progress = 255; // make sure that every bit of acceleration will hit the signal again, so speed stays 0.
3210  DiagDirection exitdir = TrackdirToExitdir(i);
3211  TileIndex o_tile = TileAddByDiagDir(gp.new_tile, exitdir);
3212 
3213  exitdir = ReverseDiagDir(exitdir);
3214 
3215  /* check if a train is waiting on the other side */
3216  if (!HasVehicleOnPos(o_tile, &exitdir, &CheckTrainAtSignal)) return false;
3217  }
3218  }
3219 
3220  /* If we would reverse but are currently in a PBS block and
3221  * reversing of stuck trains is disabled, don't reverse.
3222  * This does not apply if the reason for reversing is a one-way
3223  * signal blocking us, because a train would then be stuck forever. */
3225  UpdateSignalsOnSegment(v->tile, enterdir, v->owner) == SIGSEG_PBS) {
3226  v->wait_counter = 0;
3227  return false;
3228  }
3229  goto reverse_train_direction;
3230  } else {
3231  TryReserveRailTrack(gp.new_tile, TrackBitsToTrack(chosen_track), false);
3232  }
3233  } else {
3234  /* The wagon is active, simply follow the prev vehicle. */
3235  if (prev->tile == gp.new_tile) {
3236  /* Choose the same track as prev */
3237  if (prev->track == TRACK_BIT_WORMHOLE) {
3238  /* Vehicles entering tunnels enter the wormhole earlier than for bridges.
3239  * However, just choose the track into the wormhole. */
3240  assert(IsTunnel(prev->tile));
3241  chosen_track = bits;
3242  } else {
3243  chosen_track = prev->track;
3244  }
3245  } else {
3246  /* Choose the track that leads to the tile where prev is.
3247  * This case is active if 'prev' is already on the second next tile, when 'v' just enters the next tile.
3248  * I.e. when the tile between them has only space for a single vehicle like
3249  * 1) horizontal/vertical track tiles and
3250  * 2) some orientations of tunnel entries, where the vehicle is already inside the wormhole at 8/16 from the tile edge.
3251  * Is also the train just reversing, the wagon inside the tunnel is 'on' the tile of the opposite tunnel entry.
3252  */
3253  static const TrackBits _connecting_track[DIAGDIR_END][DIAGDIR_END] = {
3258  };
3259  DiagDirection exitdir = DiagdirBetweenTiles(gp.new_tile, prev->tile);
3260  assert(IsValidDiagDirection(exitdir));
3261  chosen_track = _connecting_track[enterdir][exitdir];
3262  }
3263  chosen_track &= bits;
3264  }
3265 
3266  /* Make sure chosen track is a valid track */
3267  assert(
3268  chosen_track == TRACK_BIT_X || chosen_track == TRACK_BIT_Y ||
3269  chosen_track == TRACK_BIT_UPPER || chosen_track == TRACK_BIT_LOWER ||
3270  chosen_track == TRACK_BIT_LEFT || chosen_track == TRACK_BIT_RIGHT);
3271 
3272  /* Update XY to reflect the entrance to the new tile, and select the direction to use */
3273  const byte *b = _initial_tile_subcoord[FIND_FIRST_BIT(chosen_track)][enterdir];
3274  gp.x = (gp.x & ~0xF) | b[0];
3275  gp.y = (gp.y & ~0xF) | b[1];
3276  Direction chosen_dir = (Direction)b[2];
3277 
3278  /* Call the landscape function and tell it that the vehicle entered the tile */
3279  uint32 r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
3280  if (HasBit(r, VETS_CANNOT_ENTER)) {
3281  goto invalid_rail;
3282  }
3283 
3284  if (!HasBit(r, VETS_ENTERED_WORMHOLE)) {
3285  Track track = FindFirstTrack(chosen_track);
3286  Trackdir tdir = TrackDirectionToTrackdir(track, chosen_dir);
3287  if (v->IsFrontEngine() && HasPbsSignalOnTrackdir(gp.new_tile, tdir)) {
3290  }
3291 
3292  /* Clear any track reservation when the last vehicle leaves the tile */
3293  if (v->Next() == nullptr) ClearPathReservation(v, v->tile, v->GetVehicleTrackdir());
3294 
3295  v->tile = gp.new_tile;
3296 
3299  }
3300 
3301  v->track = chosen_track;
3302  assert(v->track);
3303  }
3304 
3305  /* We need to update signal status, but after the vehicle position hash
3306  * has been updated by UpdateInclination() */
3307  update_signals_crossing = true;
3308 
3309  if (chosen_dir != v->direction) {
3310  if (prev == nullptr && _settings_game.vehicle.train_acceleration_model == AM_ORIGINAL) {
3312  DirDiff diff = DirDifference(v->direction, chosen_dir);
3313  v->cur_speed -= (diff == DIRDIFF_45RIGHT || diff == DIRDIFF_45LEFT ? asp->small_turn : asp->large_turn) * v->cur_speed >> 8;
3314  }
3315  direction_changed = true;
3316  v->direction = chosen_dir;
3317  }
3318 
3319  if (v->IsFrontEngine()) {
3320  v->wait_counter = 0;
3321 
3322  /* If we are approaching a crossing that is reserved, play the sound now. */
3324  if (crossing != INVALID_TILE && HasCrossingReservation(crossing) && _settings_client.sound.ambient) SndPlayTileFx(SND_0E_LEVEL_CROSSING, crossing);
3325 
3326  /* Always try to extend the reservation when entering a tile. */
3327  CheckNextTrainTile(v);
3328  }
3329 
3330  if (HasBit(r, VETS_ENTERED_STATION)) {
3331  /* The new position is the location where we want to stop */
3333  }
3334  }
3335  } else {
3337  /* Perform look-ahead on tunnel exit. */
3338  if (v->IsFrontEngine()) {
3340  CheckNextTrainTile(v);
3341  }
3342  /* Prevent v->UpdateInclination() being called with wrong parameters.
3343  * This could happen if the train was reversed inside the tunnel/bridge. */
3344  if (gp.old_tile == gp.new_tile) {
3346  }
3347  } else {
3348  v->x_pos = gp.x;
3349  v->y_pos = gp.y;
3350  v->UpdatePosition();
3351  if ((v->vehstatus & VS_HIDDEN) == 0) v->Vehicle::UpdateViewport(true);
3352  continue;
3353  }
3354  }
3355 
3356  /* update image of train, as well as delta XY */
3357  v->UpdateDeltaXY();
3358 
3359  v->x_pos = gp.x;
3360  v->y_pos = gp.y;
3361  v->UpdatePosition();
3362 
3363  /* update the Z position of the vehicle */
3364  int old_z = v->UpdateInclination(gp.new_tile != gp.old_tile, false);
3365 
3366  if (prev == nullptr) {
3367  /* This is the first vehicle in the train */
3368  AffectSpeedByZChange(v, old_z);
3369  }
3370 
3371  if (update_signals_crossing) {
3372  if (v->IsFrontEngine()) {
3373  if (TrainMovedChangeSignals(gp.new_tile, enterdir)) {
3374  /* We are entering a block with PBS signals right now, but
3375  * not through a PBS signal. This means we don't have a
3376  * reservation right now. As a conventional signal will only
3377  * ever be green if no other train is in the block, getting
3378  * a path should always be possible. If the player built
3379  * such a strange network that it is not possible, the train
3380  * will be marked as stuck and the player has to deal with
3381  * the problem. */
3382  if ((!HasReservedTracks(gp.new_tile, v->track) &&
3383  !TryReserveRailTrack(gp.new_tile, FindFirstTrack(v->track))) ||
3384  !TryPathReserve(v)) {
3385  MarkTrainAsStuck(v);
3386  }
3387  }
3388  }
3389 
3390  /* Signals can only change when the first
3391  * (above) or the last vehicle moves. */
3392  if (v->Next() == nullptr) {
3393  TrainMovedChangeSignals(gp.old_tile, ReverseDiagDir(enterdir));
3395  }
3396  }
3397 
3398  /* Do not check on every tick to save some computing time. */
3400  }
3401 
3402  if (direction_changed) first->tcache.cached_max_curve_speed = first->GetCurveSpeedLimit();
3403 
3404  return true;
3405 
3406 invalid_rail:
3407  /* We've reached end of line?? */
3408  if (prev != nullptr) error("Disconnecting train");
3409 
3410 reverse_train_direction:
3411  if (reverse) {
3412  v->wait_counter = 0;
3413  v->cur_speed = 0;
3414  v->subspeed = 0;
3416  }
3417 
3418  return false;
3419 }
3420 
3428 {
3429  TrackBits *trackbits = (TrackBits *)data;
3430 
3431  if (v->type == VEH_TRAIN && (v->vehstatus & VS_CRASHED) != 0) {
3432  TrackBits train_tbits = Train::From(v)->track;
3433  if (train_tbits == TRACK_BIT_WORMHOLE) {
3434  /* Vehicle is inside a wormhole, v->track contains no useful value then. */
3436  } else if (train_tbits != TRACK_BIT_DEPOT) {
3437  *trackbits |= train_tbits;
3438  }
3439  }
3440 
3441  return nullptr;
3442 }
3443 
3451 static void DeleteLastWagon(Train *v)
3452 {
3453  Train *first = v->First();
3454 
3455  /* Go to the last wagon and delete the link pointing there
3456  * *u is then the one-before-last wagon, and *v the last
3457  * one which will physically be removed */
3458  Train *u = v;
3459  for (; v->Next() != nullptr; v = v->Next()) u = v;
3460  u->SetNext(nullptr);
3461 
3462  if (first != v) {
3463  /* Recalculate cached train properties */
3464  first->ConsistChanged(CCF_ARRANGE);
3465  /* Update the depot window if the first vehicle is in depot -
3466  * if v == first, then it is updated in PreDestructor() */
3467  if (first->track == TRACK_BIT_DEPOT) {
3469  }
3470  v->last_station_visited = first->last_station_visited; // for PreDestructor
3471  }
3472 
3473  /* 'v' shouldn't be accessed after it has been deleted */
3474  TrackBits trackbits = v->track;
3475  TileIndex tile = v->tile;
3476  Owner owner = v->owner;
3477 
3478  delete v;
3479  v = nullptr; // make sure nobody will try to read 'v' anymore
3480 
3481  if (trackbits == TRACK_BIT_WORMHOLE) {
3482  /* Vehicle is inside a wormhole, v->track contains no useful value then. */
3484  }
3485 
3486  Track track = TrackBitsToTrack(trackbits);
3487  if (HasReservedTracks(tile, trackbits)) {
3488  UnreserveRailTrack(tile, track);
3489 
3490  /* If there are still crashed vehicles on the tile, give the track reservation to them */
3491  TrackBits remaining_trackbits = TRACK_BIT_NONE;
3492  FindVehicleOnPos(tile, &remaining_trackbits, CollectTrackbitsFromCrashedVehiclesEnum);
3493 
3494  /* It is important that these two are the first in the loop, as reservation cannot deal with every trackbit combination */
3495  assert(TRACK_BEGIN == TRACK_X && TRACK_Y == TRACK_BEGIN + 1);
3496  for (Track t : SetTrackBitIterator(remaining_trackbits)) TryReserveRailTrack(tile, t);
3497  }
3498 
3499  /* check if the wagon was on a road/rail-crossing */
3500  if (IsLevelCrossingTile(tile)) UpdateLevelCrossing(tile);
3501 
3502  /* Update signals */
3503  if (IsTileType(tile, MP_TUNNELBRIDGE) || IsRailDepotTile(tile)) {
3505  } else {
3506  SetSignalsOnBothDir(tile, track, owner);
3507  }
3508 }
3509 
3515 {
3516  static const DirDiff delta[] = {
3518  };
3519 
3520  do {
3521  /* We don't need to twist around vehicles if they're not visible */
3522  if (!(v->vehstatus & VS_HIDDEN)) {
3523  v->direction = ChangeDir(v->direction, delta[GB(Random(), 0, 2)]);
3524  /* Refrain from updating the z position of the vehicle when on
3525  * a bridge, because UpdateInclination() will put the vehicle under
3526  * the bridge in that case */
3527  if (v->track != TRACK_BIT_WORMHOLE) {
3528  v->UpdatePosition();
3529  v->UpdateInclination(false, true);
3530  } else {
3531  v->UpdateViewport(false, true);
3532  }
3533  }
3534  } while ((v = v->Next()) != nullptr);
3535 }
3536 
3542 static bool HandleCrashedTrain(Train *v)
3543 {
3544  int state = ++v->crash_anim_pos;
3545 
3546  if (state == 4 && !(v->vehstatus & VS_HIDDEN)) {
3548  }
3549 
3550  uint32 r;
3551  if (state <= 200 && Chance16R(1, 7, r)) {
3552  int index = (r * 10 >> 16);
3553 
3554  Vehicle *u = v;
3555  do {
3556  if (--index < 0) {
3557  r = Random();
3558 
3560  GB(r, 8, 3) + 2,
3561  GB(r, 16, 3) + 2,
3562  GB(r, 0, 3) + 5,
3564  break;
3565  }
3566  } while ((u = u->Next()) != nullptr);
3567  }
3568 
3569  if (state <= 240 && !(v->tick_counter & 3)) ChangeTrainDirRandomly(v);
3570 
3571  if (state >= 4440 && !(v->tick_counter & 0x1F)) {
3572  bool ret = v->Next() != nullptr;
3573  DeleteLastWagon(v);
3574  return ret;
3575  }
3576 
3577  return true;
3578 }
3579 
3581 static const uint16 _breakdown_speeds[16] = {
3582  225, 210, 195, 180, 165, 150, 135, 120, 105, 90, 75, 60, 45, 30, 15, 15
3583 };
3584 
3585 
3594 static bool TrainApproachingLineEnd(Train *v, bool signal, bool reverse)
3595 {
3596  /* Calc position within the current tile */
3597  uint x = v->x_pos & 0xF;
3598  uint y = v->y_pos & 0xF;
3599 
3600  /* for diagonal directions, 'x' will be 0..15 -
3601  * for other directions, it will be 1, 3, 5, ..., 15 */
3602  switch (v->direction) {
3603  case DIR_N : x = ~x + ~y + 25; break;
3604  case DIR_NW: x = y; FALLTHROUGH;
3605  case DIR_NE: x = ~x + 16; break;
3606  case DIR_E : x = ~x + y + 9; break;
3607  case DIR_SE: x = y; break;
3608  case DIR_S : x = x + y - 7; break;
3609  case DIR_W : x = ~y + x + 9; break;
3610  default: break;
3611  }
3612 
3613  /* Do not reverse when approaching red signal. Make sure the vehicle's front
3614  * does not cross the tile boundary when we do reverse, but as the vehicle's
3615  * location is based on their center, use half a vehicle's length as offset.
3616  * Multiply the half-length by two for straight directions to compensate that
3617  * we only get odd x offsets there. */
3618  if (!signal && x + (v->gcache.cached_veh_length + 1) / 2 * (IsDiagonalDirection(v->direction) ? 1 : 2) >= TILE_SIZE) {
3619  /* we are too near the tile end, reverse now */
3620  v->cur_speed = 0;
3621  if (reverse) ReverseTrainDirection(v);
3622  return false;
3623  }
3624 
3625  /* slow down */
3627  uint16 break_speed = _breakdown_speeds[x & 0xF];
3628  if (break_speed < v->cur_speed) v->cur_speed = break_speed;
3629 
3630  return true;
3631 }
3632 
3633 
3639 static bool TrainCanLeaveTile(const Train *v)
3640 {
3641  /* Exit if inside a tunnel/bridge or a depot */
3642  if (v->track == TRACK_BIT_WORMHOLE || v->track == TRACK_BIT_DEPOT) return false;
3643 
3644  TileIndex tile = v->tile;
3645 
3646  /* entering a tunnel/bridge? */
3647  if (IsTileType(tile, MP_TUNNELBRIDGE)) {
3649  if (DiagDirToDir(dir) == v->direction) return false;
3650  }
3651 
3652  /* entering a depot? */
3653  if (IsRailDepotTile(tile)) {
3655  if (DiagDirToDir(dir) == v->direction) return false;
3656  }
3657 
3658  return true;
3659 }
3660 
3661 
3670 {
3671  assert(v->IsFrontEngine());
3672  assert(!(v->vehstatus & VS_CRASHED));
3673 
3674  if (!TrainCanLeaveTile(v)) return INVALID_TILE;
3675 
3676  DiagDirection dir = VehicleExitDir(v->direction, v->track);
3677  TileIndex tile = v->tile + TileOffsByDiagDir(dir);
3678 
3679  /* not a crossing || wrong axis || unusable rail (wrong type or owner) */
3680  if (!IsLevelCrossingTile(tile) || DiagDirToAxis(dir) == GetCrossingRoadAxis(tile) ||
3681  !CheckCompatibleRail(v, tile)) {
3682  return INVALID_TILE;
3683  }
3684 
3685  return tile;
3686 }
3687 
3688 
3696 static bool TrainCheckIfLineEnds(Train *v, bool reverse)
3697 {
3698  /* First, handle broken down train */
3699 
3700  int t = v->breakdown_ctr;
3701  if (t > 1) {
3703 
3704  uint16 break_speed = _breakdown_speeds[GB(~t, 4, 4)];
3705  if (break_speed < v->cur_speed) v->cur_speed = break_speed;
3706  } else {
3707  v->vehstatus &= ~VS_TRAIN_SLOWING;
3708  }
3709 
3710  if (!TrainCanLeaveTile(v)) return true;
3711 
3712  /* Determine the non-diagonal direction in which we will exit this tile */
3713  DiagDirection dir = VehicleExitDir(v->direction, v->track);
3714  /* Calculate next tile */
3715  TileIndex tile = v->tile + TileOffsByDiagDir(dir);
3716 
3717  /* Determine the track status on the next tile */
3718  TrackStatus ts = GetTileTrackStatus(tile, TRANSPORT_RAIL, 0, ReverseDiagDir(dir));
3719  TrackdirBits reachable_trackdirs = DiagdirReachesTrackdirs(dir);
3720 
3721  TrackdirBits trackdirbits = TrackStatusToTrackdirBits(ts) & reachable_trackdirs;
3722  TrackdirBits red_signals = TrackStatusToRedSignals(ts) & reachable_trackdirs;
3723 
3724  /* We are sure the train is not entering a depot, it is detected above */
3725 
3726  /* mask unreachable track bits if we are forbidden to do 90deg turns */
3727  TrackBits bits = TrackdirBitsToTrackBits(trackdirbits);
3729  bits &= ~TrackCrossesTracks(FindFirstTrack(v->track));
3730  }
3731 
3732  /* no suitable trackbits at all || unusable rail (wrong type or owner) */
3733  if (bits == TRACK_BIT_NONE || !CheckCompatibleRail(v, tile)) {
3734  return TrainApproachingLineEnd(v, false, reverse);
3735  }
3736 
3737  /* approaching red signal */
3738  if ((trackdirbits & red_signals) != 0) return TrainApproachingLineEnd(v, true, reverse);
3739 
3740  /* approaching a rail/road crossing? then make it red */
3742 
3743  return true;
3744 }
3745 
3746 
3747 static bool TrainLocoHandler(Train *v, bool mode)
3748 {
3749  /* train has crashed? */
3750  if (v->vehstatus & VS_CRASHED) {
3751  return mode ? true : HandleCrashedTrain(v); // 'this' can be deleted here
3752  }
3753 
3754  if (v->force_proceed != TFP_NONE) {
3755  ClrBit(v->flags, VRF_TRAIN_STUCK);
3757  }
3758 
3759  /* train is broken down? */
3760  if (v->HandleBreakdown()) return true;
3761 
3762  if (HasBit(v->flags, VRF_REVERSING) && v->cur_speed == 0) {
3764  }
3765 
3766  /* exit if train is stopped */
3767  if ((v->vehstatus & VS_STOPPED) && v->cur_speed == 0) return true;
3768 
3769  bool valid_order = !v->current_order.IsType(OT_NOTHING) && v->current_order.GetType() != OT_CONDITIONAL;
3770  if (ProcessOrders(v) && CheckReverseTrain(v)) {
3771  v->wait_counter = 0;
3772  v->cur_speed = 0;
3773  v->subspeed = 0;
3774  ClrBit(v->flags, VRF_LEAVING_STATION);
3776  return true;
3777  } else if (HasBit(v->flags, VRF_LEAVING_STATION)) {
3778  /* Try to reserve a path when leaving the station as we
3779  * might not be marked as wanting a reservation, e.g.
3780  * when an overlength train gets turned around in a station. */
3781  DiagDirection dir = VehicleExitDir(v->direction, v->track);
3783 
3785  TryPathReserve(v, true, true);
3786  }
3787  ClrBit(v->flags, VRF_LEAVING_STATION);
3788  }
3789 
3790  v->HandleLoading(mode);
3791 
3792  if (v->current_order.IsType(OT_LOADING)) return true;
3793 
3794  if (CheckTrainStayInDepot(v)) return true;
3795 
3796  if (!mode) v->ShowVisualEffect();
3797 
3798  /* We had no order but have an order now, do look ahead. */
3799  if (!valid_order && !v->current_order.IsType(OT_NOTHING)) {
3800  CheckNextTrainTile(v);
3801  }
3802 
3803  /* Handle stuck trains. */
3804  if (!mode && HasBit(v->flags, VRF_TRAIN_STUCK)) {
3805  ++v->wait_counter;
3806 
3807  /* Should we try reversing this tick if still stuck? */
3809 
3810  if (!turn_around && v->wait_counter % _settings_game.pf.path_backoff_interval != 0 && v->force_proceed == TFP_NONE) return true;
3811  if (!TryPathReserve(v)) {
3812  /* Still stuck. */
3813  if (turn_around) ReverseTrainDirection(v);
3814 
3816  /* Show message to player. */
3818  SetDParam(0, v->index);
3819  AddVehicleAdviceNewsItem(STR_NEWS_TRAIN_IS_STUCK, v->index);
3820  }
3821  v->wait_counter = 0;
3822  }
3823  /* Exit if force proceed not pressed, else reset stuck flag anyway. */
3824  if (v->force_proceed == TFP_NONE) return true;
3825  ClrBit(v->flags, VRF_TRAIN_STUCK);
3826  v->wait_counter = 0;
3828  }
3829  }
3830 
3831  if (v->current_order.IsType(OT_LEAVESTATION)) {
3832  v->current_order.Free();
3834  return true;
3835  }
3836 
3837  int j = v->UpdateSpeed();
3838 
3839  /* we need to invalidate the widget if we are stopping from 'Stopping 0 km/h' to 'Stopped' */
3840  if (v->cur_speed == 0 && (v->vehstatus & VS_STOPPED)) {
3841  /* If we manually stopped, we're not force-proceeding anymore. */
3842  v->force_proceed = TFP_NONE;
3844  }
3845 
3846  int adv_spd = v->GetAdvanceDistance();
3847  if (j < adv_spd) {
3848  /* if the vehicle has speed 0, update the last_speed field. */
3849  if (v->cur_speed == 0) v->SetLastSpeed();
3850  } else {
3852  /* Loop until the train has finished moving. */
3853  for (;;) {
3854  j -= adv_spd;
3855  TrainController(v, nullptr);
3856  /* Don't continue to move if the train crashed. */
3857  if (CheckTrainCollision(v)) break;
3858  /* Determine distance to next map position */
3859  adv_spd = v->GetAdvanceDistance();
3860 
3861  /* No more moving this tick */
3862  if (j < adv_spd || v->cur_speed == 0) break;
3863 
3864  OrderType order_type = v->current_order.GetType();
3865  /* Do not skip waypoints (incl. 'via' stations) when passing through at full speed. */
3866  if ((order_type == OT_GOTO_WAYPOINT || order_type == OT_GOTO_STATION) &&
3868  IsTileType(v->tile, MP_STATION) &&
3870  ProcessOrders(v);
3871  }
3872  }
3873  v->SetLastSpeed();
3874  }
3875 
3876  for (Train *u = v; u != nullptr; u = u->Next()) {
3877  if ((u->vehstatus & VS_HIDDEN) != 0) continue;
3878 
3879  u->UpdateViewport(false, false);
3880  }
3881 
3882  if (v->progress == 0) v->progress = j; // Save unused spd for next time, if TrainController didn't set progress
3883 
3884  return true;
3885 }
3886 
3892 {
3893  Money cost = 0;
3894  const Train *v = this;
3895 
3896  do {
3897  const Engine *e = v->GetEngine();
3898  if (e->u.rail.running_cost_class == INVALID_PRICE) continue;
3899 
3900  uint cost_factor = GetVehicleProperty(v, PROP_TRAIN_RUNNING_COST_FACTOR, e->u.rail.running_cost);
3901  if (cost_factor == 0) continue;
3902 
3903  /* Halve running cost for multiheaded parts */
3904  if (v->IsMultiheaded()) cost_factor /= 2;
3905 
3906  cost += GetPrice(e->u.rail.running_cost_class, cost_factor, e->GetGRF());
3907  } while ((v = v->GetNextVehicle()) != nullptr);
3908 
3909  return cost;
3910 }
3911 
3917 {
3919 
3920  this->tick_counter++;
3921 
3922  if (this->IsFrontEngine()) {
3923  if (!(this->vehstatus & VS_STOPPED) || this->cur_speed > 0) this->running_ticks++;
3924 
3925  this->current_order_time++;
3926 
3927  if (!TrainLocoHandler(this, false)) return false;
3928 
3929  return TrainLocoHandler(this, true);
3930  } else if (this->IsFreeWagon() && (this->vehstatus & VS_CRASHED)) {
3931  /* Delete flooded standalone wagon chain */
3932  if (++this->crash_anim_pos >= 4400) {
3933  delete this;
3934  return false;
3935  }
3936  }
3937 
3938  return true;
3939 }
3940 
3946 {
3947  if (Company::Get(v->owner)->settings.vehicle.servint_trains == 0 || !v->NeedsAutomaticServicing()) return;
3948  if (v->IsChainInDepot()) {
3950  return;
3951  }
3952 
3953  uint max_penalty;
3955  case VPF_NPF: max_penalty = _settings_game.pf.npf.maximum_go_to_depot_penalty; break;
3956  case VPF_YAPF: max_penalty = _settings_game.pf.yapf.maximum_go_to_depot_penalty; break;
3957  default: NOT_REACHED();
3958  }
3959 
3960  FindDepotData tfdd = FindClosestTrainDepot(v, max_penalty);
3961  /* Only go to the depot if it is not too far out of our way. */
3962  if (tfdd.best_length == UINT_MAX || tfdd.best_length > max_penalty) {
3963  if (v->current_order.IsType(OT_GOTO_DEPOT)) {
3964  /* If we were already heading for a depot but it has
3965  * suddenly moved farther away, we continue our normal
3966  * schedule? */
3967  v->current_order.MakeDummy();
3969  }
3970  return;
3971  }
3972 
3973  DepotID depot = GetDepotIndex(tfdd.tile);
3974 
3975  if (v->current_order.IsType(OT_GOTO_DEPOT) &&
3976  v->current_order.GetDestination() != depot &&
3977  !Chance16(3, 16)) {
3978  return;
3979  }
3980 
3983  v->dest_tile = tfdd.tile;
3985 }
3986 
3989 {
3990  AgeVehicle(this);
3991 
3992  if ((++this->day_counter & 7) == 0) DecreaseVehicleValue(this);
3993 
3994  if (this->IsFrontEngine()) {
3995  CheckVehicleBreakdown(this);
3996 
3998 
3999  CheckOrders(this);
4000 
4001  /* update destination */
4002  if (this->current_order.IsType(OT_GOTO_STATION)) {
4004  if (tile != INVALID_TILE) this->dest_tile = tile;
4005  }
4006 
4007  if (this->running_ticks != 0) {
4008  /* running costs */
4010 
4011  this->profit_this_year -= cost.GetCost();
4012  this->running_ticks = 0;
4013 
4014  SubtractMoneyFromCompanyFract(this->owner, cost);
4015 
4018  }
4019  }
4020 }
4021 
4027 {
4028  if (this->vehstatus & VS_CRASHED) return INVALID_TRACKDIR;
4029 
4030  if (this->track == TRACK_BIT_DEPOT) {
4031  /* We'll assume the train is facing outwards */
4032  return DiagDirToDiagTrackdir(GetRailDepotDirection(this->tile)); // Train in depot
4033  }
4034 
4035  if (this->track == TRACK_BIT_WORMHOLE) {
4036  /* train in tunnel or on bridge, so just use its direction and assume a diagonal track */
4037  return DiagDirToDiagTrackdir(DirToDiagDir(this->direction));
4038  }
4039 
4040  return TrackDirectionToTrackdir(FindFirstTrack(this->track), this->direction);
4041 }
Train::GetDisplayImageWidth
int GetDisplayImageWidth(Point *offset=nullptr) const
Get the width of a train vehicle image in the GUI.
Definition: train_cmd.cpp:440
VSE_START
@ VSE_START
Vehicle starting, i.e. leaving, the station.
Definition: newgrf_sound.h:19
VehicleOrderSaver
This class will save the current order of a vehicle and restore it on destruction.
Definition: train_cmd.cpp:2446
GUISettings::lost_vehicle_warn
bool lost_vehicle_warn
if a vehicle can't find its destination, show a warning
Definition: settings_type.h:105
SpecializedVehicle::GetNextVehicle
T * GetNextVehicle() const
Get the next real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:1123
VETS_STATION_ID_OFFSET
@ VETS_STATION_ID_OFFSET
Shift the VehicleEnterTileStatus this many bits to the right to get the station ID when VETS_ENTERED_...
Definition: tile_cmd.h:30
game.hpp
Train::GetImage
void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
Get the sprite to display the train.
Definition: train_cmd.cpp:470
VehicleExitDir
static DiagDirection VehicleExitDir(Direction direction, TrackBits track)
Determine the side in which the vehicle will leave the tile.
Definition: track_func.h:713
SetTrainGroupID
void SetTrainGroupID(Train *v, GroupID grp)
Affect the groupID of a train to new_g.
Definition: group_cmd.cpp:739
CFollowTrackT::m_is_station
bool m_is_station
last turn passed station
Definition: follow_track.hpp:48
EF_RAIL_TILTS
@ EF_RAIL_TILTS
Rail vehicle tilts in curves.
Definition: engine_type.h:154
TRACK_BIT_MASK
@ TRACK_BIT_MASK
Bitmask for the first 6 bits.
Definition: track_type.h:54
DeleteNewGRFInspectWindow
void DeleteNewGRFInspectWindow(GrfSpecFeature feature, uint index)
Delete inspect window for a given feature and index.
Definition: newgrf_debug_gui.cpp:734
FindFirstTrackdir
static Trackdir FindFirstTrackdir(TrackdirBits trackdirs)
Returns first Trackdir from TrackdirBits or INVALID_TRACKDIR.
Definition: track_func.h:210
PBSTileInfo::okay
bool okay
True if tile is a safe waiting position, false otherwise.
Definition: pbs.h:29
VRF_TOGGLE_REVERSE
@ VRF_TOGGLE_REVERSE
Used for vehicle var 0xFE bit 8 (toggled each time the train is reversed, accurate for first vehicle ...
Definition: train.h:31
BaseStation::facilities
StationFacility facilities
The facilities that this station has.
Definition: base_station_base.h:63
TRACK_BIT_WORMHOLE
@ TRACK_BIT_WORMHOLE
Bitflag for a wormhole (used for tunnels)
Definition: track_type.h:55
INVALID_ENGINE
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
Definition: engine_type.h:175
PlayVehicleSound
bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event)
Checks whether a NewGRF wants to play a different vehicle sound effect.
Definition: newgrf_sound.cpp:186
VehicleOrderID
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
NPFTrainFindNearestDepot
FindDepotData NPFTrainFindNearestDepot(const Train *v, int max_penalty)
Used when user sends train to the nearest depot or if train needs servicing using NPF.
Definition: npf.cpp:1234
Engine::GetGRFID
uint32 GetGRFID() const
Retrieve the GRF ID of the NewGRF the engine is tied to.
Definition: engine.cpp:147
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
VehicleCargoList::StoredCount
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Definition: cargopacket.h:352
PathfinderSettings::npf
NPFSettings npf
pathfinder settings for the new pathfinder
Definition: settings_type.h:461
HasReservedTracks
static bool HasReservedTracks(TileIndex tile, TrackBits tracks)
Check whether some of tracks is reserved on a tile.
Definition: pbs.h:58
DIR_SW
@ DIR_SW
Southwest.
Definition: direction_type.h:31
InvalidateWindowData
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3218
Order::MakeDummy
void MakeDummy()
Makes this order a Dummy order.
Definition: order_cmd.cpp:132
sound_func.h
PROP_TRAIN_SPEED
@ PROP_TRAIN_SPEED
Max. speed: 1 unit = 1/1.6 mph = 1 km-ish/h.
Definition: newgrf_properties.h:21
TRACK_BIT_NONE
@ TRACK_BIT_NONE
No track.
Definition: track_type.h:39
PathfinderSettings::wait_for_pbs_path
byte wait_for_pbs_path
how long to wait for a path reservation.
Definition: settings_type.h:458
ArrangeTrains
static void ArrangeTrains(Train **dst_head, Train *dst, Train **src_head, Train *src, bool move_chain)
Arrange the trains in the wanted way.
Definition: train_cmd.cpp:1097
newgrf_station.h
Chance16
static bool Chance16(const uint a, const uint b)
Flips a coin with given probability.
Definition: random_func.hpp:131
CheckNewTrain
static CommandCost CheckNewTrain(Train *original_dst, Train *dst, Train *original_src, Train *src)
Check/validate whether we may actually build a new train.
Definition: train_cmd.cpp:944
DoCommand
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:450
CCF_CAPACITY
@ CCF_CAPACITY
Allow vehicles to change capacity.
Definition: train.h:46
Order::IsType
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:64
Pool::PoolItem<&_engine_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
TileOffsByDiagDir
static TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition: map_func.h:341
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
Vehicle::y_pos
int32 y_pos
y coordinate.
Definition: vehicle_base.h:281
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3120
MutableSpriteCache::sprite_seq
VehicleSpriteSeq sprite_seq
Vehicle appearance.
Definition: vehicle_base.h:194
Station::GetPlatformLength
uint GetPlatformLength(TileIndex tile, DiagDirection dir) const override
Determines the REMAINING length of a platform, starting at (and including) the given tile.
Definition: station.cpp:266
GetPrice
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition: economy.cpp:953
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
NT_ARRIVAL_OTHER
@ NT_ARRIVAL_OTHER
First vehicle arrived for competitor.
Definition: news_type.h:23
Vehicle::value
Money value
Value of the vehicle.
Definition: vehicle_base.h:253
YapfTrainFindNearestSafeTile
bool YapfTrainFindNearestSafeTile(const Train *v, TileIndex tile, Trackdir td, bool override_railtype)
Try to extend the reserved path of a train to the nearest safe tile using YAPF.
Definition: yapf_rail.cpp:624
CMD_MOVE_RAIL_VEHICLE
@ CMD_MOVE_RAIL_VEHICLE
move a rail vehicle (in the depot)
Definition: command_type.h:220
VehicleSettings::train_acceleration_model
uint8 train_acceleration_model
realistic acceleration for trains
Definition: settings_type.h:478
Vehicle::x_pos
int32 x_pos
x coordinate.
Definition: vehicle_base.h:280
DIRDIFF_45LEFT
@ DIRDIFF_45LEFT
Angle of 45 degrees left.
Definition: direction_type.h:68
ChangeDir
static Direction ChangeDir(Direction d, DirDiff delta)
Change a direction by a given difference.
Definition: direction_func.h:104
GetBridgeType
static BridgeType GetBridgeType(TileIndex t)
Determines the type of bridge on a tile.
Definition: bridge_map.h:56
GroundVehicle< Train, VEH_TRAIN >::GetAcceleration
int GetAcceleration() const
Calculates the acceleration of the vehicle under its current conditions.
Definition: ground_vehicle.cpp:105
FindDepotData
Helper container to find a depot.
Definition: pathfinder_type.h:53
RemoveFirstTrackdir
static Trackdir RemoveFirstTrackdir(TrackdirBits *trackdirs)
Removes first Trackdir from TrackdirBits and returns it.
Definition: track_func.h:155
command_func.h
TrackdirBits
TrackdirBits
Enumeration of bitmasks for the TrackDirs.
Definition: track_type.h:101
DIR_SE
@ DIR_SE
Southeast.
Definition: direction_type.h:29
IsRailWaypointTile
static bool IsRailWaypointTile(TileIndex t)
Is this tile a station tile and a rail waypoint?
Definition: station_map.h:123
CFollowTrackT::m_old_tile
TileIndex m_old_tile
the origin (vehicle moved from) before move
Definition: follow_track.hpp:41
PathfinderSettings::forbid_90_deg
bool forbid_90_deg
forbid trains to make 90 deg turns
Definition: settings_type.h:451
ODTFB_SERVICE
@ ODTFB_SERVICE
This depot order is because of the servicing limit.
Definition: order_type.h:95
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:23
MaybeBarCrossingWithSound
static void MaybeBarCrossingWithSound(TileIndex tile)
Bars crossing and plays ding-ding sound if not barred already.
Definition: train_cmd.cpp:1716
TrainCache::cached_tilt
bool cached_tilt
train can tilt; feature provides a bonus in curves
Definition: train.h:74
PROP_TRAIN_RUNNING_COST_FACTOR
@ PROP_TRAIN_RUNNING_COST_FACTOR
Yearly runningcost (if dualheaded: sum of both vehicles)
Definition: newgrf_properties.h:23
AccelerationSlowdownParams::small_turn
byte small_turn
Speed change due to a small turn.
Definition: train_cmd.cpp:2868
HasVehicleOnPos
bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
Checks whether a vehicle is on a specific location.
Definition: vehicle.cpp:513
CheckOrders
void CheckOrders(const Vehicle *v)
Check the orders of a vehicle, to see if there are invalid orders and stuff.
Definition: order_cmd.cpp:1729
GVF_SUPPRESS_IMPLICIT_ORDERS
@ GVF_SUPPRESS_IMPLICIT_ORDERS
Disable insertion and removal of automatic orders until the vehicle completes the real order.
Definition: ground_vehicle.hpp:54
Engine::reliability_spd_dec
uint16 reliability_spd_dec
Speed of reliability decay between services (per day).
Definition: engine_base.h:32
GroundVehicleCache::first_engine
EngineID first_engine
Cached EngineID of the front vehicle. INVALID_ENGINE for the front vehicle itself.
Definition: ground_vehicle.hpp:43
Vehicle::LeaveStation
void LeaveStation()
Perform all actions when leaving a station.
Definition: vehicle.cpp:2247
company_base.h
GroundVehicle::ClearFreeWagon
void ClearFreeWagon()
Clear a vehicle from being a free wagon.
Definition: ground_vehicle.hpp:294
FindClosestTrainDepot
static FindDepotData FindClosestTrainDepot(Train *v, int max_distance)
Try to find a depot nearby.
Definition: train_cmd.cpp:2013
Vehicle::Next
Vehicle * Next() const
Get the next vehicle of this vehicle.
Definition: vehicle_base.h:594
_cur_year
Year _cur_year
Current year, starting at 0.
Definition: date.cpp:26
SpecializedVehicle::Next
T * Next() const
Get next vehicle in the chain.
Definition: vehicle_base.h:1079
TRANSPORT_RAIL
@ TRANSPORT_RAIL
Transport by train.
Definition: transport_type.h:27
CheckConsistencyOfArticulatedVehicle
void CheckConsistencyOfArticulatedVehicle(const Vehicle *v)
Checks whether the specs of freshly build articulated vehicles are consistent with the information sp...
Definition: articulated_vehicles.cpp:311
SetRailStationPlatformReservation
void SetRailStationPlatformReservation(TileIndex start, DiagDirection dir, bool b)
Set the reservation for a complete station platform.
Definition: pbs.cpp:57
GetReservedTrackbits
TrackBits GetReservedTrackbits(TileIndex t)
Get the reserved trackbits for any tile, regardless of type.
Definition: pbs.cpp:24
DIRDIFF_SAME
@ DIRDIFF_SAME
Both directions faces to the same direction.
Definition: direction_type.h:63
Vehicle::y_extent
byte y_extent
y-extent of vehicle bounding box
Definition: vehicle_base.h:293
Station
Station data structure.
Definition: station_base.h:447
Order::GetDestination
DestinationID GetDestination() const
Gets the destination of this order.
Definition: order_base.h:97
Vehicle::NeedsAutomaticServicing
bool NeedsAutomaticServicing() const
Checks if the current order should be interrupted for a service-in-depot order.
Definition: vehicle.cpp:252
Vehicle::z_pos
int32 z_pos
z coordinate.
Definition: vehicle_base.h:282
TrainCache::cached_curve_speed_mod
int cached_curve_speed_mod
curve speed modifier of the entire train
Definition: train.h:75
ProcessConditionalOrder
VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v)
Process a conditional order and determine the next order.
Definition: order_cmd.cpp:1972
UpdateStatusAfterSwap
static void UpdateStatusAfterSwap(Train *v)
Updates some variables after swapping the vehicle.
Definition: train_cmd.cpp:1560
VehicleSpriteSeq::Set
void Set(SpriteID sprite)
Assign a single sprite to the sequence.
Definition: vehicle_base.h:162
DIR_NW
@ DIR_NW
Northwest.
Definition: direction_type.h:33
yapf.hpp
DiagDirToAxis
static Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
Definition: direction_func.h:214
IsDiagonalDirection
static bool IsDiagonalDirection(Direction dir)
Checks if a given Direction is diagonal.
Definition: direction_func.h:273
FindDepotData::reverse
bool reverse
True if reversing is necessary for the train to get to this depot.
Definition: pathfinder_type.h:56
CheckTrainAttachment
static CommandCost CheckTrainAttachment(Train *t)
Check whether the train parts can be attached.
Definition: train_cmd.cpp:968
RAIL_TILE_SIGNALS
@ RAIL_TILE_SIGNALS
Normal rail tile with signals.
Definition: rail_map.h:25
SAT_TRAIN_ARRIVES
@ SAT_TRAIN_ARRIVES
Trigger platform when train arrives.
Definition: newgrf_animation_type.h:30
Vehicle::random_bits
byte random_bits
Bits used for determining which randomized variational spritegroups to use when drawing.
Definition: vehicle_base.h:310
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:328
NormaliseTrainHead
static void NormaliseTrainHead(Train *head)
Normalise the head of the train again, i.e.
Definition: train_cmd.cpp:1138
DIAGDIR_END
@ DIAGDIR_END
Used for iterations.
Definition: direction_type.h:83
GroundVehicle::ClearFrontEngine
void ClearFrontEngine()
Remove the front engine state.
Definition: ground_vehicle.hpp:254
VPF_YAPF
@ VPF_YAPF
Yet Another PathFinder.
Definition: vehicle_type.h:61
TRACK_BEGIN
@ TRACK_BEGIN
Used for iterations.
Definition: track_type.h:20
VehicleOrderSaver::SwitchToNextOrder
bool SwitchToNextOrder(bool skip_first)
Set the current vehicle order to the next order in the order list.
Definition: train_cmd.cpp:2479
VS_DEFPAL
@ VS_DEFPAL
Use default vehicle palette.
Definition: vehicle_base.h:34
DepotID
uint16 DepotID
Type for the unique identifier of depots.
Definition: depot_type.h:13
YapfTrainCheckReverse
bool YapfTrainCheckReverse(const Train *v)
Returns true if it is better to reverse the train before leaving station using YAPF.
Definition: yapf_rail.cpp:546
Pool::PoolItem<&_vehicle_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
Vehicle::SetNext
void SetNext(Vehicle *next)
Set the next vehicle of this vehicle.
Definition: vehicle.cpp:2726
VRF_POWEREDWAGON
@ VRF_POWEREDWAGON
Wagon is powered.
Definition: train.h:27
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:119
Train::crash_anim_pos
uint16 crash_anim_pos
Crash animation counter.
Definition: train.h:92
Vehicle::acceleration
byte acceleration
used by train & aircraft
Definition: vehicle_base.h:306
MakeTrainBackup
static void MakeTrainBackup(TrainList &list, Train *t)
Make a backup of a train into a train list.
Definition: train_cmd.cpp:827
AddArticulatedParts
void AddArticulatedParts(Vehicle *first)
Add the remaining articulated parts to the given vehicle.
Definition: articulated_vehicles.cpp:353
HasPowerOnRail
static bool HasPowerOnRail(RailType enginetype, RailType tiletype)
Checks if an engine of the given RailType got power on a tile with a given RailType.
Definition: rail.h:332
TRACK_X
@ TRACK_X
Track along the x-axis (north-east to south-west)
Definition: track_type.h:21
FollowTrainReservation
PBSTileInfo FollowTrainReservation(const Train *v, Vehicle **train_on_res)
Follow a train reservation to the last tile.
Definition: pbs.cpp:289
OSL_PLATFORM_MIDDLE
@ OSL_PLATFORM_MIDDLE
Stop at the middle of the platform.
Definition: order_type.h:85
Vehicle::group_id
GroupID group_id
Index of group Pool array.
Definition: vehicle_base.h:337
Order::Free
void Free()
'Free' the order
Definition: order_cmd.cpp:62
InsertInConsist
static void InsertInConsist(Train *dst, Train *chain)
Inserts a chain into the train at dst.
Definition: train_cmd.cpp:876
Train::UpdateSpeed
int UpdateSpeed()
This function looks at the vehicle and updates its speed (cur_speed and subspeed) variables.
Definition: train_cmd.cpp:2814
Train::GetAccelerationStatus
AccelStatus GetAccelerationStatus() const
Checks the current acceleration status of this vehicle.
Definition: train.h:263
KillFirstBit
static T KillFirstBit(T value)
Clear the first bit in an integer.
Definition: bitmath_func.hpp:239
GameSettings::difficulty
DifficultySettings difficulty
settings related to the difficulty
Definition: settings_type.h:575
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
GroupStatistics::CountVehicle
static void CountVehicle(const Vehicle *v, int delta)
Update num_vehicle when adding or removing a vehicle.
Definition: group_cmd.cpp:133
UnScaleGUI
static int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition: zoom_func.h:66
SIGNAL_STATE_GREEN
@ SIGNAL_STATE_GREEN
The signal is green.
Definition: signal_type.h:46
RailtypeInfo
This struct contains all the info that is needed to draw and construct tracks.
Definition: rail.h:124
DiagDirToDiagTrackdir
static Trackdir DiagDirToDiagTrackdir(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal trackdir that runs in that direction.
Definition: track_func.h:536
ClrBit
static T ClrBit(T &x, const uint8 y)
Clears a bit in a variable.
Definition: bitmath_func.hpp:151
IsCompatibleTrainStationTile
static bool IsCompatibleTrainStationTile(TileIndex test_tile, TileIndex station_tile)
Check if a tile is a valid continuation to a railstation tile.
Definition: station_map.h:378
VehicleSettings::wagon_speed_limits
bool wagon_speed_limits
enable wagon speed limits
Definition: settings_type.h:482
HideFillingPercent
void HideFillingPercent(TextEffectID *te_id)
Hide vehicle loading indicators.
Definition: misc_gui.cpp:648
TracksOverlap
static bool TracksOverlap(TrackBits bits)
Checks if the given tracks overlap, ie form a crossing.
Definition: track_func.h:644
MP_RAILWAY
@ MP_RAILWAY
A railway.
Definition: tile_type.h:47
Vehicle::next
Vehicle * next
pointer to the next vehicle in the chain
Definition: vehicle_base.h:226
Vehicle::GetGRF
const GRFFile * GetGRF() const
Retrieve the NewGRF the vehicle is tied to.
Definition: vehicle.cpp:751
Train::FindClosestDepot
bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
Locate the closest depot for this consist, and return the information to the caller.
Definition: train_cmd.cpp:2037
IsValidDiagDirection
static bool IsValidDiagDirection(DiagDirection d)
Checks if an integer value is a valid DiagDirection.
Definition: direction_func.h:21
RestoreTrainBackup
static void RestoreTrainBackup(TrainList &list)
Restore the train from the backup list.
Definition: train_cmd.cpp:836
zoom_func.h
InvalidateNewGRFInspectWindow
void InvalidateNewGRFInspectWindow(GrfSpecFeature feature, uint index)
Invalidate the inspect window for a given feature and index.
Definition: newgrf_debug_gui.cpp:718
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL
@ VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL
Electric train engine is allowed to run on normal rail. *‍/.
Definition: train.h:30
ClearPathReservation
static void ClearPathReservation(const Train *v, TileIndex tile, Trackdir track_dir)
Clear the reservation of tile that was just left by a wagon on track_dir.
Definition: train_cmd.cpp:2210
AddVehicleNewsItem
static void AddVehicleNewsItem(StringID string, NewsType type, VehicleID vehicle, StationID station=INVALID_STATION)
Adds a newsitem referencing a vehicle.
Definition: news_func.h:30
Vehicle::running_ticks
byte running_ticks
Number of ticks this vehicle was not stopped this day.
Definition: vehicle_base.h:326
GetTrackBits
static TrackBits GetTrackBits(TileIndex tile)
Gets the track bits of the given tile.
Definition: rail_map.h:136
CmdBuildRailVehicle
CommandCost CmdBuildRailVehicle(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **ret)
Build a railroad vehicle.
Definition: train_cmd.cpp:723
UpdateSignalsOnSegment
SigSegState UpdateSignalsOnSegment(TileIndex tile, DiagDirection side, Owner owner)
Update signals, starting at one side of a tile Will check tile next to this at opposite side too.
Definition: signal.cpp:636
SpecializedStation< Station, false >::Get
static Station * Get(size_t index)
Gets station with given index.
Definition: base_station_base.h:219
DirDifference
static DirDiff DirDifference(Direction d0, Direction d1)
Calculate the difference between two directions.
Definition: direction_func.h:68
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
HasSignals
static bool HasSignals(TileIndex t)
Checks if a rail tile has signals.
Definition: rail_map.h:72
VehicleEnterDepot
void VehicleEnterDepot(Vehicle *v)
Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it,...
Definition: vehicle.cpp:1473
VehicleLengthChanged
void VehicleLengthChanged(const Vehicle *u)
Logs a bug in GRF and shows a warning message if this is for the first time this happened.
Definition: vehicle.cpp:330
WC_VEHICLE_TIMETABLE
@ WC_VEHICLE_TIMETABLE
Vehicle timetable; Window numbers:
Definition: window_type.h:216
newgrf_debug.h
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
RailVehicleInfo::power
uint16 power
Power of engine (hp); For multiheaded engines the sum of both engine powers.
Definition: engine_type.h:48
Engine::GetLifeLengthInDays
Date GetLifeLengthInDays() const
Returns the vehicle's (not model's!) life length in days.
Definition: engine.cpp:431
NPFTrainCheckReverse
bool NPFTrainCheckReverse(const Train *v)
Returns true if it is better to reverse the train before leaving station using NPF.
Definition: npf.cpp:1277
Rail90DegTurnDisallowed
static bool Rail90DegTurnDisallowed(RailType rt1, RailType rt2, bool def=_settings_game.pf.forbid_90_deg)
Test if 90 degree turns are disallowed between two railtypes.
Definition: rail.h:354
GroundVehicle::IsRearDualheaded
bool IsRearDualheaded() const
Tell if we are dealing with the rear end of a multiheaded engine.
Definition: ground_vehicle.hpp:334
VS_TRAIN_SLOWING
@ VS_TRAIN_SLOWING
Train is slowing down.
Definition: vehicle_base.h:35
WC_COMPANY
@ WC_COMPANY
Company view; Window numbers:
Definition: window_type.h:361
DIR_W
@ DIR_W
West.
Definition: direction_type.h:32
EV_EXPLOSION_SMALL
@ EV_EXPLOSION_SMALL
Various explosions.
Definition: effectvehicle_func.h:24
NormaliseDualHeads
static void NormaliseDualHeads(Train *t)
Normalise the dual heads in the train, i.e.
Definition: train_cmd.cpp:890
Vehicle::orders
union Vehicle::@49 orders
The orders currently assigned to the vehicle.
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
Engine
Definition: engine_base.h:27
GetTrainStopLocation
int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length)
Get the stop location of (the center) of the front vehicle of a train at a platform of a station.
Definition: train_cmd.cpp:259
Vehicle::cur_speed
uint16 cur_speed
current speed
Definition: vehicle_base.h:304
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:221
RAILTYPES_NONE
@ RAILTYPES_NONE
No rail types.
Definition: rail_type.h:47
VETS_ENTERED_STATION
@ VETS_ENTERED_STATION
The vehicle entered a station.
Definition: tile_cmd.h:21
Engine::GetDefaultCargoType
CargoID GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition: engine_base.h:83
VehicleSpriteSeq::Draw
void Draw(int x, int y, PaletteID default_pal, bool force_pal) const
Draw the sprite sequence.
Definition: vehicle.cpp:126
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:285
TryPathReserve
bool TryPathReserve(Train *v, bool mark_as_stuck, bool first_tile_okay)
Try to reserve a path to a safe position.
Definition: train_cmd.cpp:2689
Train::GetVehicleTrackdir
Trackdir GetVehicleTrackdir() const
Get the tracks of the train vehicle.
Definition: train_cmd.cpp:4026
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
BridgeSpec::speed
uint16 speed
maximum travel speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition: bridge.h:46
EV_EXPLOSION_LARGE
@ EV_EXPLOSION_LARGE
Various explosions.
Definition: effectvehicle_func.h:22
GetVehicleCallback
uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v)
Evaluate a newgrf callback for vehicles.
Definition: newgrf_engine.cpp:1155
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:348
FindTrainCollideEnum
static Vehicle * FindTrainCollideEnum(Vehicle *v, void *data)
Collision test function.
Definition: train_cmd.cpp:3007
DIR_N
@ DIR_N
North.
Definition: direction_type.h:26
CBM_VEHICLE_ARTIC_ENGINE
@ CBM_VEHICLE_ARTIC_ENGINE
Add articulated engines (trains and road vehicles)
Definition: newgrf_callbacks.h:293
_accel_slowdown
static const AccelerationSlowdownParams _accel_slowdown[]
Speed update fractions for each acceleration type.
Definition: train_cmd.cpp:2875
DeleteVehicleOrders
void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist, bool reset_order_indices)
Delete all orders from a vehicle.
Definition: order_cmd.cpp:1890
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
OrderStopLocation
OrderStopLocation
Where to stop the trains.
Definition: order_type.h:83
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
VehicleServiceInDepot
void VehicleServiceInDepot(Vehicle *v)
Service a vehicle and all subsequent vehicles in the consist.
Definition: vehicle.cpp:162
GroundVehicle::SetWagon
void SetWagon()
Set a vehicle to be a wagon.
Definition: ground_vehicle.hpp:269
GetRailDepotDirection
static DiagDirection GetRailDepotDirection(TileIndex t)
Returns the direction the depot is facing to.
Definition: rail_map.h:171
HasPbsSignalOnTrackdir
static bool HasPbsSignalOnTrackdir(TileIndex tile, Trackdir td)
Is a pbs signal present along the trackdir?
Definition: rail_map.h:463
ExtendTrainReservation
static PBSTileInfo ExtendTrainReservation(const Train *v, TrackBits *new_tracks, DiagDirection *enterdir)
Extend a train path as far as possible.
Definition: train_cmd.cpp:2343
TRACK_BIT_UPPER
@ TRACK_BIT_UPPER
Upper track.
Definition: track_type.h:42
CommandCost::Succeeded
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:150
CFollowTrackT::m_is_bridge
bool m_is_bridge
last turn passed bridge ramp
Definition: follow_track.hpp:47
TrackToTrackBits
static TrackBits TrackToTrackBits(Track track)
Maps a Track to the corresponding TrackBits value.
Definition: track_func.h:76
TryReserveRailTrack
bool TryReserveRailTrack(TileIndex tile, Track t, bool trigger_stations)
Try to reserve a specific track on a tile.
Definition: pbs.cpp:80
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
train_cmd.h
SwapTrainFlags
static void SwapTrainFlags(uint16 *swap_flag1, uint16 *swap_flag2)
Swap the two up/down flags in two ways:
Definition: train_cmd.cpp:1532
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:383
GetTileTrackStatus
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
Definition: landscape.cpp:590
Vehicle::IsArticulatedPart
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
Definition: vehicle_base.h:906
effectvehicle_func.h
TRACK_BIT_RIGHT
@ TRACK_BIT_RIGHT
Right track.
Definition: track_type.h:45
CheckTrainCollision
static bool CheckTrainCollision(Train *v)
Checks whether the specified train has a collision with another vehicle.
Definition: train_cmd.cpp:3054
ai.hpp
Order::MakeGoToDepot
void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type=ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action=ODATF_SERVICE_ONLY, CargoID cargo=CT_NO_REFIT)
Makes this order a Go To Depot order.
Definition: order_cmd.cpp:89
PFE_GL_TRAINS
@ PFE_GL_TRAINS
Time spent processing trains.
Definition: framerate_type.h:51
Order::GetType
OrderType GetType() const
Get the type of order of this order.
Definition: order_base.h:70
TrainOnTileEnum
static Vehicle * TrainOnTileEnum(Vehicle *v, void *)
Check if the vehicle is a train.
Definition: train_cmd.cpp:1639
Order::GetMaxSpeed
uint16 GetMaxSpeed() const
Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination.
Definition: order_base.h:195
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
GVF_GOINGDOWN_BIT
@ GVF_GOINGDOWN_BIT
Vehicle is currently going downhill. (Cached track information for acceleration)
Definition: ground_vehicle.hpp:53
Order::GetStopLocation
OrderStopLocation GetStopLocation() const
Where must we stop at the platform?
Definition: order_base.h:136
RemoveVehicleFromGroup
void RemoveVehicleFromGroup(const Vehicle *v)
Decrease the num_vehicle variable before delete an front engine from a group.
Definition: group_cmd.cpp:725
CBM_VEHICLE_LENGTH
@ CBM_VEHICLE_LENGTH
Vehicle length (trains and road vehicles)
Definition: newgrf_callbacks.h:290
GBUG_VEH_CAPACITY
@ GBUG_VEH_CAPACITY
Capacity of vehicle changes when not refitting or arranging.
Definition: newgrf_config.h:48
PathfinderSettings::wait_oneway_signal
byte wait_oneway_signal
waitingtime in days before a oneway signal
Definition: settings_type.h:454
SetSignalsOnBothDir
void SetSignalsOnBothDir(TileIndex tile, Track track, Owner owner)
Update signals at segments that are at both ends of given (existent or non-existent) track.
Definition: signal.cpp:654
SoundSettings::ambient
bool ambient
Play ambient, industry and town sounds.
Definition: settings_type.h:212
Engine::GetGRF
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition: engine_base.h:142
GRFFile::traininfo_vehicle_pitch
int traininfo_vehicle_pitch
Vertical offset for drawing train images in depot GUI and vehicle details.
Definition: newgrf.h:142
GetRailTypeInfo
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:304
SetWindowWidgetDirty
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
Definition: window.cpp:3133
NormaliseSubtypes
static void NormaliseSubtypes(Train *chain)
Normalise the sub types of the parts in this chain.
Definition: train_cmd.cpp:912
ENGINE_EXCLUSIVE_PREVIEW
@ ENGINE_EXCLUSIVE_PREVIEW
This vehicle is in the exclusive preview stage, either being used or being offered to a company.
Definition: engine_type.h:170
Train::GetCurrentMaxSpeed
int GetCurrentMaxSpeed() const
Calculates the maximum speed of the vehicle under its current conditions.
Definition: train_cmd.cpp:377
VRF_LEAVING_STATION
@ VRF_LEAVING_STATION
Train is just leaving a station.
Definition: train.h:33
GetBridgeSpec
static const BridgeSpec * GetBridgeSpec(BridgeType i)
Get the specification of a bridge type.
Definition: bridge.h:65
Order::GetNonStopType
OrderNonStopFlags GetNonStopType() const
At which stations must we stop?
Definition: order_base.h:134
UpdateOrderDest
bool UpdateOrderDest(Vehicle *v, const Order *order, int conditional_depth, bool pbs_look_ahead)
Update the vehicle's destination tile from an order.
Definition: order_cmd.cpp:2002
Vehicle::BeginLoading
void BeginLoading()
Prepare everything to begin the loading when arriving at a station.
Definition: vehicle.cpp:2099
GameSettings::pf
PathfinderSettings pf
settings for all pathfinders
Definition: settings_type.h:582
TrackdirReachesTrackdirs
static TrackdirBits TrackdirReachesTrackdirs(Trackdir trackdir)
Maps a trackdir to the trackdirs that can be reached from it (ie, when entering the next tile.
Definition: track_func.h:583
Vehicle::breakdown_ctr
byte breakdown_ctr
Counter for managing breakdown events.
Definition: vehicle_base.h:275
VS_HIDDEN
@ VS_HIDDEN
Vehicle is not visible.
Definition: vehicle_base.h:31
SIGTYPE_PBS
@ SIGTYPE_PBS
normal pbs signal
Definition: signal_type.h:28
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
UnreserveRailTrack
void UnreserveRailTrack(TileIndex tile, Track t)
Lift the reservation of a specific track on a tile.
Definition: pbs.cpp:141
FindDepotData::best_length
uint best_length
The distance towards the depot in penalty, or UINT_MAX if not found.
Definition: pathfinder_type.h:55
TrainList
std::vector< Train * > TrainList
Helper type for lists/vectors of trains.
Definition: rail_cmd.cpp:42
PathfinderSettings::wait_twoway_signal
byte wait_twoway_signal
waitingtime in days before a twoway signal
Definition: settings_type.h:455
RailVehicleInfo
Information about a rail vehicle.
Definition: engine_type.h:42
CheckOwnership
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
Definition: company_cmd.cpp:311
VehicleSpriteSeq::IsValid
bool IsValid() const
Check whether the sequence contains any sprites.
Definition: vehicle_base.h:146
GroundVehicleCache::cached_total_length
uint16 cached_total_length
Length of the whole vehicle (valid only for the first engine).
Definition: ground_vehicle.hpp:42
Vehicle::dest_tile
TileIndex dest_tile
Heading for this tile.
Definition: vehicle_base.h:249
DirToDiagDir
static DiagDirection DirToDiagDir(Direction dir)
Convert a Direction to a DiagDirection.
Definition: direction_func.h:166
Vehicle::HandlePathfindingResult
void HandlePathfindingResult(bool path_found)
Handle the pathfinding result, especially the lost status.
Definition: vehicle.cpp:773
_breakdown_speeds
static const uint16 _breakdown_speeds[16]
Maximum speeds for train that is broken down or approaching line end.
Definition: train_cmd.cpp:3581
TrackBitsToTrack
static Track TrackBitsToTrack(TrackBits tracks)
Converts TrackBits to Track.
Definition: track_func.h:192
return_cmd_error
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:33
IsWaitingPositionFree
bool IsWaitingPositionFree(const Train *v, TileIndex tile, Trackdir trackdir, bool forbid_90deg)
Check if a safe position is free.
Definition: pbs.cpp:427
AI::NewEvent
static void NewEvent(CompanyID company, ScriptEvent *event)
Queue a new event for an AI.
Definition: ai_core.cpp:234
DoTrainPathfind
static Track DoTrainPathfind(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool do_track_reservation, PBSTileInfo *dest)
Perform pathfinding for a train.
Definition: train_cmd.cpp:2328
IsBridgeTile
static bool IsBridgeTile(TileIndex t)
checks if there is a bridge on this tile
Definition: bridge_map.h:35
CommandCost
Common return value for all commands.
Definition: command_type.h:23
TRACK_Y
@ TRACK_Y
Track along the y-axis (north-west to south-east)
Definition: track_type.h:22
SetBitIterator
Iterable ensemble of each set bit in a value.
Definition: bitmath_func.hpp:329
CheckTrainStayInDepot
static bool CheckTrainStayInDepot(Train *v)
Will the train stay in the depot the next tick?
Definition: train_cmd.cpp:2132
VRF_TRAIN_STUCK
@ VRF_TRAIN_STUCK
Train can't get a path reservation.
Definition: train.h:32
_date
Date _date
Current date in days (day counter)
Definition: date.cpp:28
UpdateTrainGroupID
void UpdateTrainGroupID(Train *v)
Recalculates the groupID of a train.
Definition: group_cmd.cpp:767
WC_VEHICLE_VIEW
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
Definition: window_type.h:331
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:596
Vehicle::AddToShared
void AddToShared(Vehicle *shared_chain)
Adds this vehicle to a shared vehicle chain.
Definition: vehicle.cpp:2755
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:541
YapfTrainFindNearestDepot
FindDepotData YapfTrainFindNearestDepot(const Train *v, int max_distance)
Used when user sends train to the nearest depot or if train needs servicing using YAPF.
Definition: yapf_rail.cpp:605
GroundVehicle::SetMultiheaded
void SetMultiheaded()
Set a vehicle as a multiheaded engine.
Definition: ground_vehicle.hpp:299
BaseStation::train_station
TileArea train_station
Tile area the train 'station' part covers.
Definition: base_station_base.h:75
NPFTrainChooseTrack
Track NPFTrainChooseTrack(const Train *v, bool &path_found, bool reserve_track, struct PBSTileInfo *target)
Finds the best path for given train using NPF.
Definition: npf.cpp:1296
INVALID_VEH_ORDER_ID
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel)
Definition: order_type.h:21
CMD_PAUSE
@ CMD_PAUSE
pause the game
Definition: command_type.h:256
DIRDIFF_90LEFT
@ DIRDIFF_90LEFT
Angle of 90 degrees left.
Definition: direction_type.h:67
EngineInfo::callback_mask
byte callback_mask
Bitmask of vehicle callbacks that have to be called.
Definition: engine_type.h:144
DIR_E
@ DIR_E
East.
Definition: direction_type.h:28
Train::Crash
uint Crash(bool flooded=false)
The train vehicle crashed! Update its status and other parts around it.
Definition: train_cmd.cpp:2938
TrackBitsToTrackdirBits
static TrackdirBits TrackBitsToTrackdirBits(TrackBits bits)
Converts TrackBits to TrackdirBits while allowing both directions.
Definition: track_func.h:318
GVF_GOINGUP_BIT
@ GVF_GOINGUP_BIT
Vehicle is currently going uphill. (Cached track information for acceleration)
Definition: ground_vehicle.hpp:52
GetRailTileType
static RailTileType GetRailTileType(TileIndex t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition: rail_map.h:36
SubtractMoneyFromCompanyFract
void SubtractMoneyFromCompanyFract(CompanyID company, const CommandCost &cst)
Subtract money from a company, including the money fraction.
Definition: company_cmd.cpp:254
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:242
DeleteLastWagon
static void DeleteLastWagon(Train *v)
Deletes/Clears the last wagon of a crashed train.
Definition: train_cmd.cpp:3451
SIGNAL_STATE_RED
@ SIGNAL_STATE_RED
The signal is red.
Definition: signal_type.h:45
INVALID_VEHICLE
static const VehicleID INVALID_VEHICLE
Constant representing a non-existing vehicle.
Definition: vehicle_type.h:55
npf_func.h
TrackdirToExitdir
static DiagDirection TrackdirToExitdir(Trackdir trackdir)
Maps a trackdir to the (4-way) direction the tile is exited when following that trackdir.
Definition: track_func.h:438
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:299
PBSTileInfo
This struct contains information about the end of a reserved path.
Definition: pbs.h:26
PathfinderSettings::path_backoff_interval
byte path_backoff_interval
ticks between checks for a free path.
Definition: settings_type.h:459
GroundVehicleCache::cached_veh_length
uint8 cached_veh_length
Length of this vehicle in units of 1/VEHICLE_LENGTH of normal length. It is cached because this can b...
Definition: ground_vehicle.hpp:44
VS_CRASHED
@ VS_CRASHED
Vehicle is crashed.
Definition: vehicle_base.h:38
VETS_CANNOT_ENTER
@ VETS_CANNOT_ENTER
The vehicle cannot enter the tile.
Definition: tile_cmd.h:23
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:129
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
SND_41_DEPARTURE_MAGLEV
@ SND_41_DEPARTURE_MAGLEV
65 == 0x41 Station departure: maglev engine
Definition: sound_type.h:104
GetTrainSpriteSize
void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a train sprite heading west, or both heads (used for lists).
Definition: train_cmd.cpp:557
Vehicle::last_station_visited
StationID last_station_visited
The last station we stopped at.
Definition: vehicle_base.h:313
GetFreeUnitNumber
UnitID GetFreeUnitNumber(VehicleType type)
Get an unused unit number for a vehicle (if allowed).
Definition: vehicle.cpp:1792
NPFSettings::maximum_go_to_depot_penalty
uint32 maximum_go_to_depot_penalty
What is the maximum penalty that may be endured for going to a depot.
Definition: settings_type.h:381
Vehicle::cargo
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition: vehicle_base.h:320
CheckTrainsLengths
void CheckTrainsLengths()
Checks if lengths of all rail vehicles are valid.
Definition: train_cmd.cpp:72
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:159
CmdMoveRailVehicle
CommandCost CmdMoveRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Move a rail vehicle around inside the depot.
Definition: train_cmd.cpp:1171
CmdSellRailWagon
CommandCost CmdSellRailWagon(DoCommandFlag flags, Vehicle *t, uint16 data, uint32 user)
Sell a (single) train wagon/engine.
Definition: train_cmd.cpp:1365
CCF_ARRANGE
@ CCF_ARRANGE
Valid changes for arranging the consist in a depot.
Definition: train.h:52
Vehicle::current_order
Order current_order
The current order (+ status, like: loading)
Definition: vehicle_base.h:329
GroundVehicleCache::cached_max_track_speed
uint16 cached_max_track_speed
Maximum consist speed (in internal units) limited by track type (valid only for the first engine).
Definition: ground_vehicle.hpp:37
GroundVehicle::IsChainInDepot
bool IsChainInDepot() const override
Check whether the whole vehicle chain is in the depot.
Definition: ground_vehicle.cpp:190
PBSTileInfo::trackdir
Trackdir trackdir
The reserved trackdir on the tile.
Definition: pbs.h:28
HasSignalOnTrackdir
static bool HasSignalOnTrackdir(TileIndex tile, Trackdir trackdir)
Checks for the presence of signals along the given trackdir on the given rail tile.
Definition: rail_map.h:426
Vehicle::max_age
Date max_age
Maximum age.
Definition: vehicle_base.h:271
GroundVehicle< Train, VEH_TRAIN >::gcache
GroundVehicleCache gcache
Cache of often calculated values.
Definition: ground_vehicle.hpp:80
DIR_NE
@ DIR_NE
Northeast.
Definition: direction_type.h:27
RAILTYPES_RAIL
@ RAILTYPES_RAIL
Non-electrified rails.
Definition: rail_type.h:48
GroundVehicle::SetFrontEngine
void SetFrontEngine()
Set front engine state.
Definition: ground_vehicle.hpp:249
HVOT_TRAIN
@ HVOT_TRAIN
Station has seen a train.
Definition: station_type.h:64
Vehicle::IsFrontEngine
bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition: vehicle_base.h:897
HasDepotReservation
static bool HasDepotReservation(TileIndex t)
Get the reservation state of the depot.
Definition: rail_map.h:258
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:53
CheckIfTrainNeedsService
static void CheckIfTrainNeedsService(Train *v)
Check whether a train needs service, and if so, find a depot or service it.
Definition: train_cmd.cpp:3945
DiagDirToDiagTrack
static Track DiagDirToDiagTrack(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track incidating with that diagdir.
Definition: track_func.h:511
DC_AUTOREPLACE
@ DC_AUTOREPLACE
autoreplace/autorenew is in progress, this shall disable vehicle limits when building,...
Definition: command_type.h:355
WC_VEHICLE_DETAILS
@ WC_VEHICLE_DETAILS
Vehicle details; Window numbers:
Definition: window_type.h:192
Game::NewEvent
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:141
HandleCrashedTrain
static bool HandleCrashedTrain(Train *v)
Handle a crashed train.
Definition: train_cmd.cpp:3542
TrackdirCrossesTrackdirs
static TrackdirBits TrackdirCrossesTrackdirs(Trackdir trackdir)
Maps a trackdir to all trackdirs that make 90 deg turns with it.
Definition: track_func.h:605
IsCrossingBarred
static bool IsCrossingBarred(TileIndex t)
Check if the level crossing is barred.
Definition: road_map.h:416
VS_STOPPED
@ VS_STOPPED
Vehicle is stopped by the player.
Definition: vehicle_base.h:32
Vehicle::GetGRFID
uint32 GetGRFID() const
Retrieve the GRF ID of the NewGRF the vehicle is tied to.
Definition: vehicle.cpp:761
Vehicle::ShowVisualEffect
void ShowVisualEffect() const
Draw visual effects (smoke and/or sparks) for a vehicle chain.
Definition: vehicle.cpp:2576
SetSignalStateByTrackdir
static void SetSignalStateByTrackdir(TileIndex tile, Trackdir trackdir, SignalState state)
Sets the state of the signal along the given trackdir.
Definition: rail_map.h:449
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
Vehicle::GetEngine
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition: vehicle.cpp:741
TRACK_BIT_X
@ TRACK_BIT_X
X-axis track.
Definition: track_type.h:40
VehicleEnterTile
VehicleEnterTileStatus VehicleEnterTile(Vehicle *v, TileIndex tile, int x, int y)
Call the tile callback function for a vehicle entering a tile.
Definition: vehicle.cpp:1741
TrainApproachingLineEnd
static bool TrainApproachingLineEnd(Train *v, bool signal, bool reverse)
Train is approaching line end, slow down and possibly reverse.
Definition: train_cmd.cpp:3594
DiagdirReachesTracks
static TrackBits DiagdirReachesTracks(DiagDirection diagdir)
Returns all tracks that can be reached when entering a tile from a given (diagonal) direction.
Definition: track_func.h:572
safeguards.h
IsRailDepotTile
static bool IsRailDepotTile(TileIndex t)
Is this tile rail tile and a rail depot?
Definition: rail_map.h:105
Vehicle::CopyVehicleConfigAndStatistics
void CopyVehicleConfigAndStatistics(const Vehicle *src)
Copy certain configurations and statistics of a vehicle after successful autoreplace/renew The functi...
Definition: vehicle_base.h:725
GroundVehicle::SetLastSpeed
void SetLastSpeed()
Update the GUI variant of the current speed of the vehicle.
Definition: ground_vehicle.hpp:341
SIGSEG_PBS
@ SIGSEG_PBS
Segment is a PBS segment.
Definition: signal_func.h:52
GetNewVehiclePosResult::new_tile
TileIndex new_tile
Tile of the vehicle after moving.
Definition: vehicle_func.h:78
Vehicle::reliability_spd_dec
uint16 reliability_spd_dec
Reliability decrease speed.
Definition: vehicle_base.h:274
Vehicle::last_loading_station
StationID last_loading_station
Last station the vehicle has stopped at and could possibly leave from with any cargo loaded.
Definition: vehicle_base.h:314
Train
'Train' is either a loco or a wagon.
Definition: train.h:86
DiagDirToDir
static Direction DiagDirToDir(DiagDirection dir)
Convert a DiagDirection to a Direction.
Definition: direction_func.h:182
MAKE_ORDER_BACKUP_FLAG
static const uint32 MAKE_ORDER_BACKUP_FLAG
Flag to pass to the vehicle construction command when an order should be preserved.
Definition: order_backup.h:30
CommandCost::GetCost
Money GetCost() const
The costs as made up to this moment.
Definition: command_type.h:82
Train::GetOrderStationLocation
TileIndex GetOrderStationLocation(StationID station)
Get the location of the next station to visit.
Definition: train_cmd.cpp:2779
DEFAULT_GROUP
static const GroupID DEFAULT_GROUP
Ungrouped vehicles are in this group.
Definition: group_type.h:17
YapfTrainChooseTrack
Track YapfTrainChooseTrack(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool reserve_track, struct PBSTileInfo *target)
Finds the best path for given train using YAPF.
Definition: yapf_rail.cpp:531
FreightWagonMult
byte FreightWagonMult(CargoID cargo)
Return the cargo weight multiplier to use for a rail vehicle.
Definition: train_cmd.cpp:65
TileAddByDiagDir
static TileIndex TileAddByDiagDir(TileIndex tile, DiagDirection dir)
Adds a DiagDir to a tile.
Definition: map_func.h:382
ReverseDiagDir
static DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
Definition: direction_func.h:118
HasOnewaySignalBlockingTrackdir
static bool HasOnewaySignalBlockingTrackdir(TileIndex tile, Trackdir td)
Is a one-way signal blocking the trackdir? A one-way signal on the trackdir against will block,...
Definition: rail_map.h:475
DIR_S
@ DIR_S
South.
Definition: direction_type.h:30
IsBridge
static bool IsBridge(TileIndex t)
Checks if this is a bridge, instead of a tunnel.
Definition: bridge_map.h:24
Vehicle::profit_this_year
Money profit_this_year
Profit this year << 8, low 8 bits are fract.
Definition: vehicle_base.h:251
GetGRFStringID
StringID GetGRFStringID(uint32 grfid, StringID stringid)
Returns the index for this stringid associated with its grfID.
Definition: newgrf_text.cpp:601
IsTileOwner
static bool IsTileOwner(TileIndex tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition: tile_map.h:214
settings
fluid_settings_t * settings
FluidSynth settings handle.
Definition: fluidsynth.cpp:21
IsSafeWaitingPosition
bool IsSafeWaitingPosition(const Train *v, TileIndex tile, Trackdir trackdir, bool include_line_end, bool forbid_90deg)
Determine whether a certain track on a tile is a safe position to end a path.
Definition: pbs.cpp:381
GetVehicleCallbackParent
uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent)
Evaluate a newgrf callback for vehicles with a different vehicle for parent scope.
Definition: newgrf_engine.cpp:1171
_networking
bool _networking
are we in networking mode?
Definition: network.cpp:56
INVALID_DIAGDIR
@ INVALID_DIAGDIR
Flag for an invalid DiagDirection.
Definition: direction_type.h:84
VRF_REVERSE_DIRECTION
@ VRF_REVERSE_DIRECTION
Reverse the visible direction of the vehicle.
Definition: train.h:28
Train::MarkDirty
void MarkDirty()
Goods at the consist have changed, update the graphics, cargo, and acceleration.
Definition: train_cmd.cpp:2794
MP_TUNNELBRIDGE
@ MP_TUNNELBRIDGE
Tunnel entry/exit and bridge heads.
Definition: tile_type.h:55
CheckNextTrainTile
static void CheckNextTrainTile(Train *v)
Check if the train is on the last reserved tile and try to extend the path then.
Definition: train_cmd.cpp:2070
newgrf_text.h
INVALID_TRACKDIR
@ INVALID_TRACKDIR
Flag for an invalid trackdir.
Definition: track_type.h:89
SoundSettings::disaster
bool disaster
Play disaster and accident sounds.
Definition: settings_type.h:210
ValidateTrains
static CommandCost ValidateTrains(Train *original_dst, Train *dst, Train *original_src, Train *src, bool check_limit)
Validate whether we are going to create valid trains.
Definition: train_cmd.cpp:1077
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
HasCrossingReservation
static bool HasCrossingReservation(TileIndex t)
Get the reservation state of the rail crossing.
Definition: road_map.h:380
error.h
DirDiff
DirDiff
Enumeration for the difference between two directions.
Definition: direction_type.h:62
CheckCargoCapacity
void CheckCargoCapacity(Vehicle *v)
Check the capacity of all vehicles in a chain and spread cargo if needed.
Definition: autoreplace_cmd.cpp:104
MarkBridgeDirty
void MarkBridgeDirty(TileIndex begin, TileIndex end, DiagDirection direction, uint bridge_height)
Mark bridge tiles dirty.
Definition: tunnelbridge_cmd.cpp:64
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:77
WC_TRAINS_LIST
@ WC_TRAINS_LIST
Trains list; Window numbers:
Definition: window_type.h:300
ConsistChangeFlags
ConsistChangeFlags
Flags for Train::ConsistChanged.
Definition: train.h:44
Vehicle::HandleLoading
void HandleLoading(bool mode=false)
Handle the loading of the vehicle; when not it skips through dummy orders and does nothing in all oth...
Definition: vehicle.cpp:2309
SigSegState
SigSegState
State of the signal segment.
Definition: signal_func.h:49
CreateEffectVehicleRel
EffectVehicle * CreateEffectVehicleRel(const Vehicle *v, int x, int y, int z, EffectVehicleType type)
Create an effect vehicle above a particular vehicle.
Definition: effectvehicle.cpp:638
SND_0E_LEVEL_CROSSING
@ SND_0E_LEVEL_CROSSING
12 == 0x0C Train passes through level crossing
Definition: sound_type.h:51
GRFFile::traininfo_vehicle_width
uint traininfo_vehicle_width
Width (in pixels) of a 8/8 train vehicle in depot GUI and vehicle details.
Definition: newgrf.h:143
AccelerationSlowdownParams
Data structure for storing engine speed changes of an acceleration type.
Definition: train_cmd.cpp:2867
IsRailStationTile
static bool IsRailStationTile(TileIndex t)
Is this tile a station tile and a rail station?
Definition: station_map.h:102
CommandCost::AddCost
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Definition: command_type.h:62
TRACK_BIT_LOWER
@ TRACK_BIT_LOWER
Lower track.
Definition: track_type.h:43
GUISettings::show_track_reservation
bool show_track_reservation
highlight reserved tracks.
Definition: settings_type.h:155
AffectSpeedByZChange
static void AffectSpeedByZChange(Train *v, int old_z)
Modify the speed of the vehicle due to a change in altitude.
Definition: train_cmd.cpp:2887
stdafx.h
ShowNewGrfVehicleError
void ShowNewGrfVehicleError(EngineID engine, StringID part1, StringID part2, GRFBugs bug_type, bool critical)
Displays a "NewGrf Bug" error message for a engine, and pauses the game if not networking.
Definition: vehicle.cpp:297
BaseConsist::vehicle_flags
uint16 vehicle_flags
Used for gradual loading and other miscellaneous things (.
Definition: base_consist.h:31
WID_VV_START_STOP
@ WID_VV_START_STOP
Start or stop this vehicle, and show information about the current state.
Definition: vehicle_widget.h:17
IsOnewaySignal
static bool IsOnewaySignal(TileIndex t, Track track)
One-way signals can't be passed the 'wrong' way.
Definition: rail_map.h:319
Vehicle::sprite_cache
MutableSpriteCache sprite_cache
Cache of sprites and values related to recalculating them, see MutableSpriteCache.
Definition: vehicle_base.h:343
RailVehicleInfo::pow_wag_power
uint16 pow_wag_power
Extra power applied to consist if wagon should be powered.
Definition: engine_type.h:55
SoundFx
SoundFx
Sound effects from baseset.
Definition: sound_type.h:37
VPF_NPF
@ VPF_NPF
New PathFinder.
Definition: vehicle_type.h:60
EngineInfo::misc_flags
byte misc_flags
Miscellaneous flags.
Definition: engine_type.h:143
Vehicle::y_offs
int8 y_offs
y offset for vehicle sprite
Definition: vehicle_base.h:298
viewport_func.h
Vehicle::colourmap
SpriteID colourmap
NOSAVE: cached colour mapping.
Definition: vehicle_base.h:266
AxisToDiagDir
static DiagDirection AxisToDiagDir(Axis a)
Converts an Axis to a DiagDirection.
Definition: direction_func.h:232
RemoveFromConsist
static void RemoveFromConsist(Train *part, bool chain=false)
Remove the given wagon from its consist.
Definition: train_cmd.cpp:859
OSL_PLATFORM_NEAR_END
@ OSL_PLATFORM_NEAR_END
Stop at the near end of the platform.
Definition: order_type.h:84
RailtypeInfo::powered_railtypes
RailTypes powered_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype generates power
Definition: rail.h:185
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
RAILVEH_WAGON
@ RAILVEH_WAGON
simple wagon, not motorized
Definition: engine_type.h:29
SetDepotReservation
static void SetDepotReservation(TileIndex t, bool b)
Set the reservation state of the depot.
Definition: rail_map.h:270
WC_VEHICLE_REFIT
@ WC_VEHICLE_REFIT
Vehicle refit; Window numbers:
Definition: window_type.h:198
GetTunnelBridgeDirection
static DiagDirection GetTunnelBridgeDirection(TileIndex t)
Get the direction pointing to the other end.
Definition: tunnelbridge_map.h:26
Train::ReserveTrackUnderConsist
void ReserveTrackUnderConsist() const
Tries to reserve track under whole train consist.
Definition: train_cmd.cpp:2916
Vehicle::IncrementRealOrderIndex
void IncrementRealOrderIndex()
Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates t...
Definition: vehicle_base.h:838
GetTileOwner
static Owner GetTileOwner(TileIndex tile)
Returns the owner of a tile.
Definition: tile_map.h:178
VF_BUILT_AS_PROTOTYPE
@ VF_BUILT_AS_PROTOTYPE
Vehicle is a prototype (accepted as exclusive preview).
Definition: vehicle_base.h:45
CFollowTrackT::m_old_td
Trackdir m_old_td
the trackdir (the vehicle was on) before move
Definition: follow_track.hpp:42
VIWD_CONSIST_CHANGED
@ VIWD_CONSIST_CHANGED
Vehicle composition was changed.
Definition: vehicle_gui.h:34
Vehicle::direction
Direction direction
facing
Definition: vehicle_base.h:283
Train::GetCurveSpeedLimit
int GetCurveSpeedLimit() const
Computes train speed limit caused by curves.
Definition: train_cmd.cpp:303
TrainCollideChecker
Temporary data storage for testing collisions.
Definition: train_cmd.cpp:2996
DiagdirReachesTrackdirs
static TrackdirBits DiagdirReachesTrackdirs(DiagDirection diagdir)
Returns all trackdirs that can be reached when entering a tile from a given (diagonal) direction.
Definition: track_func.h:554
TRACK_BIT_DEPOT
@ TRACK_BIT_DEPOT
Bitflag for a depot.
Definition: track_type.h:56
PathfinderSettings::pathfinder_for_trains
uint8 pathfinder_for_trains
the pathfinder to use for trains
Definition: settings_type.h:445
RAILTYPE_RAIL
@ RAILTYPE_RAIL
Standard non-electric rails.
Definition: rail_type.h:29
Vehicle::list
OrderList * list
Pointer to the order list for this vehicle.
Definition: vehicle_base.h:332
BaseConsist::cur_real_order_index
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
Definition: base_consist.h:28
ONSF_NO_STOP_AT_DESTINATION_STATION
@ ONSF_NO_STOP_AT_DESTINATION_STATION
The vehicle will stop at any station it passes except the destination.
Definition: order_type.h:75
TrainCanLeaveTile
static bool TrainCanLeaveTile(const Train *v)
Determines whether train would like to leave the tile.
Definition: train_cmd.cpp:3639
PerformanceAccumulator
RAII class for measuring multi-step elements of performance.
Definition: framerate_type.h:114
PBSTileInfo::tile
TileIndex tile
Tile the path ends, INVALID_TILE if no valid path was found.
Definition: pbs.h:27
ProcessOrders
bool ProcessOrders(Vehicle *v)
Handle the orders of a vehicle and determine the next place to go to if needed.
Definition: order_cmd.cpp:2130
spritecache.h
ReverseDir
static Direction ReverseDir(Direction d)
Return the reverse of a direction.
Definition: direction_func.h:54
Vehicle::x_extent
byte x_extent
x-extent of vehicle bounding box
Definition: vehicle_base.h:292
Train::wait_counter
uint16 wait_counter
Ticks waiting in front of a signal, ticks being stuck or a counter for forced proceeding through sign...
Definition: train.h:101
RailtypeInfo::acceleration_type
uint8 acceleration_type
Acceleration type of this rail type.
Definition: rail.h:223
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition: newgrf_callbacks.h:404
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
TRACKDIR_BIT_NONE
@ TRACKDIR_BIT_NONE
No track build.
Definition: track_type.h:102
IsCompatibleRail
static bool IsCompatibleRail(RailType enginetype, RailType tiletype)
Checks if an engine of the given RailType can drive on a tile with a given RailType.
Definition: rail.h:319
Vehicle::vcache
VehicleCache vcache
Cache of often used vehicle values.
Definition: vehicle_base.h:341
Train::PlayLeaveStationSound
void PlayLeaveStationSound() const
Play a sound for a train leaving the station.
Definition: train_cmd.cpp:2050
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
GroundVehicle::UpdateInclination
int UpdateInclination(bool new_tile, bool update_delta)
Checks if the vehicle is in a slope and sets the required flags in that case.
Definition: ground_vehicle.hpp:232
TrainList
std::vector< Train * > TrainList
Helper type for lists/vectors of trains.
Definition: train_cmd.cpp:820
vehicle_func.h
AdvanceWagonsBeforeSwap
static void AdvanceWagonsBeforeSwap(Train *v)
Advances wagons for train reversing, needed for variable length wagons.
Definition: train_cmd.cpp:1731
newgrf_sound.h
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
VEHICLE_LENGTH
static const uint VEHICLE_LENGTH
The length of a vehicle in tile units.
Definition: vehicle_type.h:76
PALETTE_CRASH
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1600
strings_func.h
Train::OnNewDay
void OnNewDay()
Update day counters of the train vehicle.
Definition: train_cmd.cpp:3988
PROP_TRAIN_SHORTEN_FACTOR
@ PROP_TRAIN_SHORTEN_FACTOR
Shorter vehicles.
Definition: newgrf_properties.h:28
RailVehicleInfo::max_speed
uint16 max_speed
Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition: engine_type.h:47
Vehicle::tick_counter
byte tick_counter
Increased by one for each tick.
Definition: vehicle_base.h:325
OSL_PLATFORM_FAR_END
@ OSL_PLATFORM_FAR_END
Stop at the far end of the platform.
Definition: order_type.h:86
SND_0A_DEPARTURE_TRAIN
@ SND_0A_DEPARTURE_TRAIN
8 == 0x08 Station departure: diesel and electric engine
Definition: sound_type.h:47
Vehicle::cargo_cap
uint16 cargo_cap
total capacity
Definition: vehicle_base.h:318
TRACK_BIT_LEFT
@ TRACK_BIT_LEFT
Left track.
Definition: track_type.h:44
Train::UpdateDeltaXY
void UpdateDeltaXY()
Updates the x and y offsets and the size of the sprite used for this vehicle.
Definition: train_cmd.cpp:1440
GroundVehicleCache::cached_power
uint32 cached_power
Total power of the consist (valid only for the first engine).
Definition: ground_vehicle.hpp:38
VehicleSettings::max_trains
UnitID max_trains
max trains in game per company
Definition: settings_type.h:484
IsPlainRail
static bool IsPlainRail(TileIndex t)
Returns whether this is plain rails, with or without signals.
Definition: rail_map.h:49
Vehicle::x_offs
int8 x_offs
x offset for vehicle sprite
Definition: vehicle_base.h:297
Vehicle::subspeed
byte subspeed
fractional speed
Definition: vehicle_base.h:305
DiagdirBetweenTiles
static DiagDirection DiagdirBetweenTiles(TileIndex tile_from, TileIndex tile_to)
Determines the DiagDirection to get from one tile to another.
Definition: map_func.h:394
FACIL_TRAIN
@ FACIL_TRAIN
Station with train station.
Definition: station_type.h:52
SpecializedVehicle< Train, Type >::From
static Train * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1164
DIRDIFF_45RIGHT
@ DIRDIFF_45RIGHT
Angle of 45 degrees right.
Definition: direction_type.h:64
Train::ConsistChanged
void ConsistChanged(ConsistChangeFlags allowed_changes)
Recalculates the cached stuff of a train.
Definition: train_cmd.cpp:106
Vehicle::z_extent
byte z_extent
z-extent of vehicle bounding box
Definition: vehicle_base.h:294
GroundVehicle::SetEngine
void SetEngine()
Set engine status.
Definition: ground_vehicle.hpp:279
VehicleRandomBits
byte VehicleRandomBits()
Get a value for a vehicle's random_bits.
Definition: vehicle.cpp:363
ScaleGUITrad
static int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:76
AccelerationSlowdownParams::z_up
byte z_up
Fraction to remove when moving up.
Definition: train_cmd.cpp:2870
AdvanceWagonsAfterSwap
static void AdvanceWagonsAfterSwap(Train *v)
Advances wagons for train reversing, needed for variable length wagons.
Definition: train_cmd.cpp:1759
Train::UpdateAcceleration
void UpdateAcceleration()
Update acceleration of the train from the cached power and weight.
Definition: train_cmd.cpp:425
IsTunnel
static bool IsTunnel(TileIndex t)
Is this a tunnel (entrance)?
Definition: tunnel_map.h:23
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
TryReserveSafeTrack
static bool TryReserveSafeTrack(const Train *v, TileIndex tile, Trackdir td, bool override_railtype)
Try to reserve any path to a safe tile, ignoring the vehicle's destination.
Definition: train_cmd.cpp:2435
DC_NO_CARGO_CAP_CHECK
@ DC_NO_CARGO_CAP_CHECK
when autoreplace/autorenew is in progress, this shall prevent truncating the amount of cargo in the v...
Definition: command_type.h:356
framerate_type.h
InvalidateWindowClassesData
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3235
NPFTrainFindNearestSafeTile
bool NPFTrainFindNearestSafeTile(const Train *v, TileIndex tile, Trackdir trackdir, bool override_railtype)
Try to extend the reserved path of a train to the nearest safe tile using NPF.
Definition: npf.cpp:1256
FreeTrainTrackReservation
void FreeTrainTrackReservation(const Train *v)
Free the reserved path in front of a vehicle.
Definition: train_cmd.cpp:2251
GroundVehicle::IsEngine
bool IsEngine() const
Check if a vehicle is an engine (can be first in a consist).
Definition: ground_vehicle.hpp:316
SetTunnelBridgeReservation
static void SetTunnelBridgeReservation(TileIndex t, bool b)
Set the reservation state of the rail tunnel/bridge.
Definition: tunnelbridge_map.h:104
GetSignalStateByTrackdir
static SignalState GetSignalStateByTrackdir(TileIndex tile, Trackdir trackdir)
Gets the state of the signal along the given trackdir.
Definition: rail_map.h:438
GroundVehicle::SetFreeWagon
void SetFreeWagon()
Set a vehicle as a free wagon.
Definition: ground_vehicle.hpp:289
RAILVEH_MULTIHEAD
@ RAILVEH_MULTIHEAD
indicates a combination of two locomotives
Definition: engine_type.h:28
BaseConsist::current_order_time
uint32 current_order_time
How many ticks have passed since this order started.
Definition: base_consist.h:22
MarkTileDirtyByTile
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
Definition: viewport.cpp:1987
SND_13_TRAIN_COLLISION
@ SND_13_TRAIN_COLLISION
15 == 0x11 Train+train crash
Definition: sound_type.h:56
SND_47_DEPARTURE_MONORAIL
@ SND_47_DEPARTURE_MONORAIL
71 == 0x47 Station departure: monorail engine
Definition: sound_type.h:110
RailVehicleInfo::user_def_data
byte user_def_data
Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles.
Definition: engine_type.h:61
GetRailType
static RailType GetRailType(TileIndex t)
Gets the rail type of the given tile.
Definition: rail_map.h:115
GetNewVehiclePosResult
Position information of a vehicle after it moved.
Definition: vehicle_func.h:75
WC_VEHICLE_DEPOT
@ WC_VEHICLE_DEPOT
Depot view; Window numbers:
Definition: window_type.h:343
TrackStatusToRedSignals
static TrackdirBits TrackStatusToRedSignals(TrackStatus ts)
Returns the red-signal-information of a TrackStatus.
Definition: track_func.h:375
newgrf.h
VE_DISABLE_WAGON_POWER
@ VE_DISABLE_WAGON_POWER
Flag to disable wagon power.
Definition: vehicle_base.h:91
MP_STATION
@ MP_STATION
A tile of a station.
Definition: tile_type.h:51
SND_04_DEPARTURE_STEAM
@ SND_04_DEPARTURE_STEAM
2 == 0x02 Station departure: steam engine
Definition: sound_type.h:41
GetStationIndex
static StationID GetStationIndex(TileIndex t)
Get StationID from a tile.
Definition: station_map.h:28
GetCrossingRailAxis
static Axis GetCrossingRailAxis(TileIndex t)
Get the rail axis of a level crossing.
Definition: road_map.h:337
Vehicle::build_year
Year build_year
Year the vehicle has been built.
Definition: vehicle_base.h:269
FindVehicleOnPos
void FindVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
Find a vehicle from a specific location.
Definition: vehicle.cpp:498
Pool::PoolItem<&_orderlist_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:307
UsesWagonOverride
bool UsesWagonOverride(const Vehicle *v)
Check if a wagon is currently using a wagon override.
Definition: newgrf_engine.cpp:1140
NT_ACCIDENT
@ NT_ACCIDENT
An accident or disaster has occurred.
Definition: news_type.h:24
DIAGDIR_BEGIN
@ DIAGDIR_BEGIN
Used for iterations.
Definition: direction_type.h:78
DAYS_IN_YEAR
static const int DAYS_IN_YEAR
days per year
Definition: date_type.h:29
TrackDirectionToTrackdir
static Trackdir TrackDirectionToTrackdir(Track track, Direction dir)
Maps a track and a full (8-way) direction to the trackdir that represents the track running in the gi...
Definition: track_func.h:497
TrackStatusToTrackdirBits
static TrackdirBits TrackStatusToTrackdirBits(TrackStatus ts)
Returns the present-trackdir-information of a TrackStatus.
Definition: track_func.h:351
GroundVehicle::gv_flags
uint16 gv_flags
Definition: ground_vehicle.hpp:81
TrainApproachingCrossingEnum
static Vehicle * TrainApproachingCrossingEnum(Vehicle *v, void *data)
Checks if a train is approaching a rail-road crossing.
Definition: train_cmd.cpp:1651
FindDepotData::tile
TileIndex tile
The tile of the depot.
Definition: pathfinder_type.h:54
PathfinderSettings::reverse_at_signals
bool reverse_at_signals
whether to reverse at signals at all
Definition: settings_type.h:453
DIRDIFF_90RIGHT
@ DIRDIFF_90RIGHT
Angle of 90 degrees right.
Definition: direction_type.h:65
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition: base_station_base.h:53
TrainCollideChecker::num
uint num
Total number of victims if train collided.
Definition: train_cmd.cpp:2998
Vehicle::unitnumber
UnitID unitnumber
unit number, for display purposes only
Definition: vehicle_base.h:302
DifficultySettings::line_reverse_mode
bool line_reverse_mode
reversing at stations or not
Definition: settings_type.h:88
SIGSEG_FULL
@ SIGSEG_FULL
Occupied by a train.
Definition: signal_func.h:51
SpecializedVehicle< Train, Type >::GetIfValid
static Train * GetIfValid(size_t index)
Returns vehicle if the index is a valid index for this vehicle type.
Definition: vehicle_base.h:1154
TrackEnterdirToTrackdir
static Trackdir TrackEnterdirToTrackdir(Track track, DiagDirection diagdir)
Maps a track and an (4-way) dir to the trackdir that represents the track with the entry in the given...
Definition: track_func.h:485
TrainCollideChecker::v
Train * v
Vehicle we are testing for collision.
Definition: train_cmd.cpp:2997
VehicleCache::cached_max_speed
uint16 cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Definition: vehicle_base.h:122
company_func.h
BarCrossing
static void BarCrossing(TileIndex t)
Bar a level crossing.
Definition: road_map.h:447
GetRailDepotTrack
static Track GetRailDepotTrack(TileIndex t)
Returns the track of a depot, ignoring direction.
Definition: rail_map.h:182
FindFirstTrack
static Track FindFirstTrack(TrackBits tracks)
Returns first Track from TrackBits or INVALID_TRACK.
Definition: track_func.h:176
SpecializedVehicle< Train, Type >::Iterate
static Pool::IterateWrapper< Train > Iterate(size_t from=0)
Returns an iterable ensemble of all valid vehicles of type T.
Definition: vehicle_base.h:1233
IsLevelCrossingTile
static bool IsLevelCrossingTile(TileIndex t)
Return whether a tile is a level crossing tile.
Definition: road_map.h:94
TrainCache::cached_max_curve_speed
int cached_max_curve_speed
max consist speed limited by curves
Definition: train.h:80
NT_ARRIVAL_COMPANY
@ NT_ARRIVAL_COMPANY
First vehicle arrived for company.
Definition: news_type.h:22
Engine::original_image_index
uint8 original_image_index
Original vehicle image index, thus the image index of the overridden vehicle.
Definition: engine_base.h:45
GetNewVehiclePosResult::old_tile
TileIndex old_tile
Current tile of the vehicle.
Definition: vehicle_func.h:77
Vehicle::x_bb_offs
int8 x_bb_offs
x offset of vehicle bounding box
Definition: vehicle_base.h:295
EXPENSES_NEW_VEHICLES
@ EXPENSES_NEW_VEHICLES
New vehicles.
Definition: economy_type.h:159
CFollowTrackT::m_new_tile
TileIndex m_new_tile
the new tile (the vehicle has entered)
Definition: follow_track.hpp:43
AccelerationSlowdownParams::large_turn
byte large_turn
Speed change due to a large turn.
Definition: train_cmd.cpp:2869
CmdForceTrainProceed
CommandCost CmdForceTrainProceed(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Force a train through a red signal.
Definition: train_cmd.cpp:1982
abs
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:21
Order::ShouldStopAtStation
bool ShouldStopAtStation(const Vehicle *v, StationID station) const
Check whether the given vehicle should stop at the given station based on this order and the non-stop...
Definition: order_cmd.cpp:2229
TriggerStationRandomisation
void TriggerStationRandomisation(Station *st, TileIndex trigger_tile, StationRandomTrigger trigger, CargoID cargo_type)
Trigger station randomisation.
Definition: newgrf_station.cpp:964
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
OrderType
OrderType
Order types.
Definition: order_type.h:35
error
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Definition: openttd.cpp:132
Order::GetDepotOrderType
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
Definition: order_base.h:138
Vehicle::InvalidateNewGRFCache
void InvalidateNewGRFCache()
Invalidates cached NewGRF variables.
Definition: vehicle_base.h:464
network.h
RailVehicleInfo::shorten_factor
byte shorten_factor
length on main map for this type is 8 - shorten_factor
Definition: engine_type.h:58
AddVehicleAdviceNewsItem
static void AddVehicleAdviceNewsItem(StringID string, VehicleID vehicle)
Adds a vehicle-advice news item.
Definition: news_func.h:40
TrackBits
TrackBits
Bitfield corresponding to Track.
Definition: track_type.h:38
Vehicle::day_counter
byte day_counter
Increased by one for each day.
Definition: vehicle_base.h:324
FindVehicleOnPosXY
void FindVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc)
Find a vehicle from a specific location.
Definition: vehicle.cpp:438
TicksToLeaveDepot
int TicksToLeaveDepot(const Train *v)
Compute number of ticks when next wagon will leave a depot.
Definition: rail_cmd.cpp:2943
ToggleBit
static T ToggleBit(T &x, const uint8 y)
Toggles a bit in a variable.
Definition: bitmath_func.hpp:181
Train::IsPrimaryVehicle
bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: train.h:114
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
Train::Tick
bool Tick()
Update train vehicle data for a tick.
Definition: train_cmd.cpp:3916
CFollowTrackT::Follow
bool Follow(TileIndex old_tile, Trackdir old_td)
main follower routine.
Definition: follow_track.hpp:119
DiagDirToDiagTrackBits
static TrackBits DiagDirToDiagTrackBits(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track bits incidating with that diagdir.
Definition: track_func.h:523
OrderBackup::Backup
static void Backup(const Vehicle *v, uint32 user)
Create an order backup for the given vehicle.
Definition: order_backup.cpp:100
Train::GetRunningCost
Money GetRunningCost() const
Get running cost for the train consist.
Definition: train_cmd.cpp:3891
PathfinderSettings::yapf
YAPFSettings yapf
pathfinder settings for the yet another pathfinder
Definition: settings_type.h:462
random_func.hpp
EXPENSES_TRAIN_RUN
@ EXPENSES_TRAIN_RUN
Running costs trains.
Definition: economy_type.h:160
AgeVehicle
void AgeVehicle(Vehicle *v)
Update age of a vehicle.
Definition: vehicle.cpp:1364
Vehicle::progress
byte progress
The percentage (if divided by 256) this vehicle already crossed the tile unit.
Definition: vehicle_base.h:308
RailtypeInfo::compatible_railtypes
RailTypes compatible_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel
Definition: rail.h:188
Engine::DetermineCapacity
uint DetermineCapacity(const Vehicle *v, uint16 *mail_capacity=nullptr) const
Determines capacity of a given vehicle from scratch.
Definition: engine.cpp:191
OverflowSafeInt< int64 >
CFollowTrackT::m_exitdir
DiagDirection m_exitdir
exit direction (leaving the old tile)
Definition: follow_track.hpp:45
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
Vehicle::IsStoppedInDepot
bool IsStoppedInDepot() const
Check whether the vehicle is in the depot and stopped.
Definition: vehicle_base.h:529
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
IsPlainRailTile
static bool IsPlainRailTile(TileIndex t)
Checks whether the tile is a rail tile or rail tile with signals.
Definition: rail_map.h:60
TrainCrashed
static uint TrainCrashed(Train *v)
Marks train as crashed and creates an AI event.
Definition: train_cmd.cpp:2977
CFollowTrackT::m_new_td_bits
TrackdirBits m_new_td_bits
the new set of available trackdirs
Definition: follow_track.hpp:44
TFP_SIGNAL
@ TFP_SIGNAL
Ignore next signal, after the signal ignore being stuck.
Definition: train.h:40
CmdBuildRailWagon
static CommandCost CmdBuildRailWagon(TileIndex tile, DoCommandFlag flags, const Engine *e, Vehicle **ret)
Build a railroad wagon.
Definition: train_cmd.cpp:592
CCF_LENGTH
@ CCF_LENGTH
Allow vehicles to change length.
Definition: train.h:45
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:88
EF_RAIL_FLIPS
@ EF_RAIL_FLIPS
Rail vehicle can be flipped in the depot.
Definition: engine_type.h:158
GroundVehicle< Train, VEH_TRAIN >::CargoChanged
void CargoChanged()
Recalculates the cached weight of a vehicle and its parts.
Definition: ground_vehicle.cpp:79
Chance16R
static bool Chance16R(const uint a, const uint b, uint32 &r)
Flips a coin with a given probability and saves the randomize-number in a variable.
Definition: random_func.hpp:155
UpdateLevelCrossing
void UpdateLevelCrossing(TileIndex tile, bool sound)
Sets correct crossing state.
Definition: train_cmd.cpp:1694
GetTileRailType
RailType GetTileRailType(TileIndex tile)
Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
Definition: rail.cpp:155
Vehicle::cargo_type
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:316
TrainCheckIfLineEnds
static bool TrainCheckIfLineEnds(Train *v, bool reverse=true)
Checks for line end.
Definition: train_cmd.cpp:3696
VehicleSettings::max_train_length
uint8 max_train_length
maximum length for trains
Definition: settings_type.h:476
Vehicle::spritenum
byte spritenum
currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == res...
Definition: vehicle_base.h:291
Train::GetNextUnit
Train * GetNextUnit() const
Get the next real (non-articulated part and non rear part of dualheaded engine) vehicle in the consis...
Definition: train.h:144
GetCrossingRoadAxis
static Axis GetCrossingRoadAxis(TileIndex t)
Get the road axis of a level crossing.
Definition: road_map.h:325
GetOtherTunnelBridgeEnd
static TileIndex GetOtherTunnelBridgeEnd(TileIndex t)
Determines type of the wormhole and returns its other end.
Definition: tunnelbridge_map.h:78
ReverseTrackdir
static Trackdir ReverseTrackdir(Trackdir trackdir)
Maps a trackdir to the reverse trackdir.
Definition: track_func.h:246
NormalizeTrainVehInDepot
static void NormalizeTrainVehInDepot(const Train *u)
Move all free vehicles in the depot to the train.
Definition: train_cmd.cpp:668
SpecializedVehicle::GetLastEnginePart
T * GetLastEnginePart()
Get the last part of an articulated engine.
Definition: vehicle_base.h:1117
GroundVehicle::IsWagon
bool IsWagon() const
Check if a vehicle is a wagon.
Definition: ground_vehicle.hpp:322
RailVehicleInfo::running_cost
byte running_cost
Running cost of engine; For multiheaded engines the sum of both running costs.
Definition: engine_type.h:50
TRACK_BIT_Y
@ TRACK_BIT_Y
Y-axis track.
Definition: track_type.h:41
CBID_VEHICLE_LENGTH
@ CBID_VEHICLE_LENGTH
Vehicle length, returns the amount of 1/8's the vehicle is shorter for trains and RVs.
Definition: newgrf_callbacks.h:33
Train::CalcNextVehicleOffset
int CalcNextVehicleOffset() const
Calculate the offset from this vehicle's center to the following center taking the vehicle lengths in...
Definition: train.h:168
articulated_vehicles.h
CCF_TRACK
@ CCF_TRACK
Valid changes while vehicle is driving, and possibly changing tracks.
Definition: train.h:48
GameSettings::vehicle
VehicleSettings vehicle
options for vehicles
Definition: settings_type.h:584
ErrorUnknownCallbackResult
void ErrorUnknownCallbackResult(uint32 grfid, uint16 cbid, uint16 cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Definition: newgrf_commons.cpp:516
SpecializedVehicle::Previous
T * Previous() const
Get previous vehicle in the chain.
Definition: vehicle_base.h:1085
Trackdir
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:70
TrainApproachingCrossing
static bool TrainApproachingCrossing(TileIndex tile)
Finds a vehicle approaching rail-road crossing.
Definition: train_cmd.cpp:1672
Vehicle::cargo_subtype
byte cargo_subtype
Used for livery refits (NewGRF variations)
Definition: vehicle_base.h:317
TFP_NONE
@ TFP_NONE
Normal operation.
Definition: train.h:38
GroundVehicle< Train, VEH_TRAIN >::IsFreeWagon
bool IsFreeWagon() const
Check if the vehicle is a free wagon (got no engine in front of it).
Definition: ground_vehicle.hpp:310
TFP_STUCK
@ TFP_STUCK
Proceed till next signal, but ignore being stuck till then. This includes force leaving depots.
Definition: train.h:39
TrackCrossesTracks
static TrackBits TrackCrossesTracks(Track track)
Maps a track to all tracks that make 90 deg turns with it.
Definition: track_func.h:419
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
CollectTrackbitsFromCrashedVehiclesEnum
static Vehicle * CollectTrackbitsFromCrashedVehiclesEnum(Vehicle *v, void *data)
Collect trackbits of all crashed train vehicles on a tile.
Definition: train_cmd.cpp:3427
YAPFSettings::maximum_go_to_depot_penalty
uint32 maximum_go_to_depot_penalty
What is the maximum penalty that may be endured for going to a depot.
Definition: settings_type.h:405
Vehicle::GetAdvanceDistance
uint GetAdvanceDistance()
Determines the vehicle "progress" needed for moving a step.
Definition: vehicle_base.h:427
RailVehicleInfo::capacity
byte capacity
Cargo capacity of vehicle; For multiheaded engines the capacity of each single engine.
Definition: engine_type.h:53
Vehicle::GetOrder
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
Definition: vehicle_base.h:874
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:52
Vehicle::reliability
uint16 reliability
Reliability.
Definition: vehicle_base.h:273
SpecializedVehicle< Train, Type >::First
Train * First() const
Get the first vehicle in the chain.
Definition: vehicle_base.h:1061
SetCrossingBarred
static void SetCrossingBarred(TileIndex t, bool barred)
Set the bar state of a level crossing.
Definition: road_map.h:428
Vehicle::UpdatePosition
void UpdatePosition()
Update the position of the vehicle.
Definition: vehicle.cpp:1596
Swap
static void Swap(T &a, T &b)
Type safe swap operation.
Definition: math_func.hpp:215
Engine::flags
byte flags
Flags of the engine.
Definition: engine_base.h:39
AS_BRAKE
@ AS_BRAKE
We want to stop.
Definition: ground_vehicle.hpp:22
Track
Track
These are used to specify a single track.
Definition: track_type.h:19
Vehicle::HandleBreakdown
bool HandleBreakdown()
Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds,...
Definition: vehicle.cpp:1298
DecreaseVehicleValue
void DecreaseVehicleValue(Vehicle *v)
Decrease the value of a vehicle.
Definition: vehicle.cpp:1236
Vehicle::y_bb_offs
int8 y_bb_offs
y offset of vehicle bounding box
Definition: vehicle_base.h:296
GetNewVehiclePosResult::y
int y
x and y position of the vehicle after moving
Definition: vehicle_func.h:76
order_backup.h
ChangeTrainDirRandomly
static void ChangeTrainDirRandomly(Train *v)
Rotate all vehicles of a (crashed) train chain randomly to animate the crash.
Definition: train_cmd.cpp:3514
TrackdirBitsToTrackBits
static TrackBits TrackdirBitsToTrackBits(TrackdirBits bits)
Discards all directional information from a TrackdirBits value.
Definition: track_func.h:307
PROP_TRAIN_CARGO_AGE_PERIOD
@ PROP_TRAIN_CARGO_AGE_PERIOD
Number of ticks before carried cargo is aged.
Definition: newgrf_properties.h:30
VehicleSettings::freight_trains
uint8 freight_trains
value to multiply the weight of cargo by
Definition: settings_type.h:489
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
GroundVehicle::Crash
uint Crash(bool flooded) override
Common code executed for crashed ground vehicles.
Definition: ground_vehicle.hpp:100
PM_PAUSED_ERROR
@ PM_PAUSED_ERROR
A game paused because a (critical) error.
Definition: openttd.h:65
TrainEnterStation
static void TrainEnterStation(Train *v, StationID station)
Trains enters a station, send out a news item if it is the first train, and start loading.
Definition: train_cmd.cpp:2831
FIND_FIRST_BIT
#define FIND_FIRST_BIT(x)
Returns the first non-zero bit in a 6-bit value (from right).
Definition: bitmath_func.hpp:200
Vehicle::GetNumOrders
VehicleOrderID GetNumOrders() const
Get the number of orders this vehicle has.
Definition: vehicle_base.h:700
SpecializedVehicle::Last
T * Last()
Get the last vehicle in the chain.
Definition: vehicle_base.h:1067
GroundVehicle< Train, VEH_TRAIN >::DoUpdateSpeed
uint DoUpdateSpeed(uint accel, int min_speed, int max_speed)
Update the speed of the vehicle.
Definition: ground_vehicle.hpp:363
SetWindowClassesDirty
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3146
VehicleSpriteSeq::GetBounds
void GetBounds(Rect *bounds) const
Determine shared bounds of all sprites.
Definition: vehicle.cpp:98
PathfinderSettings::reserve_paths
bool reserve_paths
always reserve paths regardless of signal type.
Definition: settings_type.h:457
TrainController
bool TrainController(Train *v, Vehicle *nomove, bool reverse=true)
Move a vehicle chain one movement stop forwards.
Definition: train_cmd.cpp:3106
Vehicle::first
Vehicle * first
NOSAVE: pointer to the first vehicle in the chain.
Definition: vehicle_base.h:228
IsValidTrackdir
static bool IsValidTrackdir(Trackdir trackdir)
Checks if a Trackdir is valid for non-road vehicles.
Definition: track_func.h:51
SpecializedVehicle::UpdateViewport
void UpdateViewport(bool force_update, bool update_delta)
Update vehicle sprite- and position caches.
Definition: vehicle_base.h:1186
Vehicle::fill_percent_te_id
TextEffectID fill_percent_te_id
a text-effect id to a loading indicator object
Definition: vehicle_base.h:301
SRT_TRAIN_ARRIVES
@ SRT_TRAIN_ARRIVES
Trigger platform when train arrives.
Definition: newgrf_station.h:106
EngineInfo::cargo_age_period
uint16 cargo_age_period
Number of ticks before carried cargo is aged.
Definition: engine_type.h:147
Order
Definition: order_base.h:33
WID_VV_REFIT
@ WID_VV_REFIT
Open the refit window.
Definition: vehicle_widget.h:22
GroundVehicleCache::cached_weight
uint32 cached_weight
Total weight of the consist (valid only for the first engine).
Definition: ground_vehicle.hpp:31
RailtypeInfo::curve_speed
byte curve_speed
Multiplier for curve maximum speed advantage.
Definition: rail.h:203
MarkTrainAsStuck
static void MarkTrainAsStuck(Train *v)
Mark a train as stuck and stop it if it isn't stopped right now.
Definition: train_cmd.cpp:1508
DAY_TICKS
static const int DAY_TICKS
1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885.
Definition: date_type.h:28
ReverseTrainSwapVeh
void ReverseTrainSwapVeh(Train *v, int l, int r)
Swap vehicles l and r in consist v, and reverse their direction.
Definition: train_cmd.cpp:1597
CmdReverseTrainDirection
CommandCost CmdReverseTrainDirection(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Reverse train.
Definition: train_cmd.cpp:1909
CFollowTrackT
Track follower helper template class (can serve pathfinders and vehicle controllers).
Definition: follow_track.hpp:28
CFollowTrackT::m_tiles_skipped
int m_tiles_skipped
number of skipped tunnel or station tiles
Definition: follow_track.hpp:49
GetDepotIndex
static DepotID GetDepotIndex(TileIndex t)
Get the index of which depot is attached to the tile.
Definition: depot_map.h:52
SpecializedVehicle::GetFirstEnginePart
T * GetFirstEnginePart()
Get the first part of an articulated engine.
Definition: vehicle_base.h:1105
CFollowTrackT::m_is_tunnel
bool m_is_tunnel
last turn passed tunnel
Definition: follow_track.hpp:46
TunnelBridgeIsFree
CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore)
Finds vehicle in tunnel / bridge.
Definition: vehicle.cpp:568
TrackdirToTrack
static Track TrackdirToTrack(Trackdir trackdir)
Returns the Track that a given Trackdir represents.
Definition: track_func.h:261
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
WC_VEHICLE_ORDERS
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
Definition: window_type.h:204
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:593
PROP_TRAIN_USER_DATA
@ PROP_TRAIN_USER_DATA
User defined data for vehicle variable 0x42.
Definition: newgrf_properties.h:29
Engine::reliability
uint16 reliability
Current reliability of the engine.
Definition: engine_base.h:31
WL_CRITICAL
@ WL_CRITICAL
Critical errors, the MessageBox is shown in all cases.
Definition: error.h:25
Vehicle::refit_cap
uint16 refit_cap
Capacity left over from before last refit.
Definition: vehicle_base.h:319
GroundVehicle::IsMultiheaded
bool IsMultiheaded() const
Check if the vehicle is a multiheaded engine.
Definition: ground_vehicle.hpp:328
Vehicle::date_of_last_service
Date date_of_last_service
Last date the vehicle had a service at a depot.
Definition: vehicle_base.h:272
GetNewVehiclePos
GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v)
Get position information of a vehicle when moving one pixel in the direction it is facing.
Definition: vehicle.cpp:1687
CBID_TRAIN_ALLOW_WAGON_ATTACH
@ CBID_TRAIN_ALLOW_WAGON_ATTACH
Determine whether a wagon can be attached to an already existing train.
Definition: newgrf_callbacks.h:72
TileVirtXY
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:194
TrainApproachingCrossingTile
static TileIndex TrainApproachingCrossingTile(const Train *v)
Determines whether train is approaching a rail-road crossing (thus making it barred)
Definition: train_cmd.cpp:3669
news_func.h
ReverseTrainDirection
void ReverseTrainDirection(Train *v)
Turn a train around.
Definition: train_cmd.cpp:1816
AccelerationSlowdownParams::z_down
byte z_down
Fraction to add when moving down.
Definition: train_cmd.cpp:2871
VETS_ENTERED_WORMHOLE
@ VETS_ENTERED_WORMHOLE
The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/...
Definition: tile_cmd.h:22
INVALID_TRACK
@ INVALID_TRACK
Flag for an invalid track.
Definition: track_type.h:28