OpenTTD Source: src/train_cmd.cpp Source File

OpenTTD Source 15.0-RC2

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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "stdafx.h"
11#include "error.h"
12#include "articulated_vehicles.h"
13#include "command_func.h"
14#include "error_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 "core/random_func.hpp"
30#include "company_base.h"
31#include "newgrf.h"
32#include "order_backup.h"
33#include "zoom_func.h"
34#include "newgrf_debug.h"
35#include "framerate_type.h"
36#include "train_cmd.h"
37#include "misc_cmd.h"
38#include "timer/timer_game_calendar.h"
39#include "timer/timer_game_economy.h"
40
41#include "table/strings.h"
42#include "table/train_sprites.h"
43
44#include "safeguards.h"
45
46static Track ChooseTrainTrack(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool force_res, bool *got_reservation, bool mark_stuck);
47static bool TrainCheckIfLineEnds(Train *v, bool reverse = true);
48bool TrainController(Train *v, Vehicle *nomove, bool reverse = true); // Also used in vehicle_sl.cpp.
49static TileIndex TrainApproachingCrossingTile(const Train *v);
50static void CheckIfTrainNeedsService(Train *v);
51static void CheckNextTrainTile(Train *v);
52
53static const uint8_t _vehicle_initial_x_fract[4] = {10, 8, 4, 8};
54static const uint8_t _vehicle_initial_y_fract[4] = { 8, 4, 8, 10};
55
56template <>
57bool IsValidImageIndex<VEH_TRAIN>(uint8_t image_index)
58{
59 return image_index < lengthof(_engine_sprite_base);
60}
61
62
68uint8_t FreightWagonMult(CargoType cargo)
69{
70 if (!CargoSpec::Get(cargo)->is_freight) return 1;
71 return _settings_game.vehicle.freight_trains;
72}
73
75 void CheckTrainsLengths()
76{
77 bool first = true;
78
79 for (const Train *v : Train::Iterate()) {
80 if (v->First() == v && !v->vehstatus.Test(VehState::Crashed)) {
81 for (const Train *u = v, *w = v->Next(); w != nullptr; u = w, w = w->Next()) {
82 if (u->track != TRACK_BIT_DEPOT) {
83 if ((w->track != TRACK_BIT_DEPOT &&
84 std::max(abs(u->x_pos - w->x_pos), abs(u->y_pos - w->y_pos)) != u->CalcNextVehicleOffset()) ||
85 (w->track == TRACK_BIT_DEPOT && TicksToLeaveDepot(u) <= 0)) {
86 ShowErrorMessage(GetEncodedString(STR_BROKEN_VEHICLE_LENGTH, v->index, v->owner), {}, WL_CRITICAL);
87
88 if (!_networking && first) {
89 first = false;
90 Command<CMD_PAUSE>::Post(PauseMode::Error, true);
91 }
92 /* Break so we warn only once for each train. */
93 break;
94 }
95 }
96 }
97 }
98 }
99}
100
107 void Train::ConsistChanged(ConsistChangeFlags allowed_changes)
108{
109 uint16_t max_speed = UINT16_MAX;
110
111 assert(this->IsFrontEngine() || this->IsFreeWagon());
112
113 const RailVehicleInfo *rvi_v = RailVehInfo(this->engine_type);
114 EngineID first_engine = this->IsFrontEngine() ? this->engine_type : EngineID::Invalid();
115 this->gcache.cached_total_length = 0;
116 this->compatible_railtypes = {};
117
118 bool train_can_tilt = true;
119 int16_t min_curve_speed_mod = INT16_MAX;
120
121 for (Train *u = this; u != nullptr; u = u->Next()) {
122 const RailVehicleInfo *rvi_u = RailVehInfo(u->engine_type);
123
124 /* Check the this->first cache. */
125 assert(u->First() == this);
126
127 /* update the 'first engine' */
128 u->gcache.first_engine = this == u ? EngineID::Invalid() : first_engine;
129 u->railtypes = rvi_u->railtypes;
130
131 if (u->IsEngine()) first_engine = u->engine_type;
132
133 /* Set user defined data to its default value */
134 u->tcache.user_def_data = rvi_u->user_def_data;
135 this->InvalidateNewGRFCache();
136 u->InvalidateNewGRFCache();
137 }
138
139 for (Train *u = this; u != nullptr; u = u->Next()) {
140 /* Update user defined data (must be done before other properties) */
141 u->tcache.user_def_data = GetVehicleProperty(u, PROP_TRAIN_USER_DATA, u->tcache.user_def_data);
142 this->InvalidateNewGRFCache();
143 u->InvalidateNewGRFCache();
144 }
145
146 for (Train *u = this; u != nullptr; u = u->Next()) {
147 const Engine *e_u = u->GetEngine();
148 const RailVehicleInfo *rvi_u = &e_u->VehInfo<RailVehicleInfo>();
149
150 if (!e_u->info.misc_flags.Test(EngineMiscFlag::RailTilts)) train_can_tilt = false;
151 min_curve_speed_mod = std::min(min_curve_speed_mod, u->GetCurveSpeedModifier());
152
153 /* Cache wagon override sprite group. nullptr is returned if there is none */
154 u->tcache.cached_override = GetWagonOverrideSpriteSet(u->engine_type, u->cargo_type, u->gcache.first_engine);
155
156 /* Reset colour map */
157 u->colourmap = PAL_NONE;
158
159 /* Update powered-wagon-status and visual effect */
160 u->UpdateVisualEffect(true);
161
162 if (rvi_v->pow_wag_power != 0 && rvi_u->railveh_type == RAILVEH_WAGON &&
163 UsesWagonOverride(u) && !HasBit(u->vcache.cached_vis_effect, VE_DISABLE_WAGON_POWER)) {
164 /* wagon is powered */
165 u->flags.Set(VehicleRailFlag::PoweredWagon); // cache 'powered' status
166 } else {
167 u->flags.Reset(VehicleRailFlag::PoweredWagon);
168 }
169
170 if (!u->IsArticulatedPart()) {
171 /* Do not count powered wagons for the compatible railtypes, as wagons always
172 have railtype normal */
173 if (rvi_u->power > 0) {
174 this->compatible_railtypes.Set(GetAllPoweredRailTypes(u->railtypes));
175 }
176
177 /* Some electric engines can be allowed to run on normal rail. It happens to all
178 * existing electric engines when elrails are disabled and then re-enabled */
179 if (u->flags.Test(VehicleRailFlag::AllowedOnNormalRail)) {
180 u->railtypes.Set(RAILTYPE_RAIL);
181 u->compatible_railtypes.Set(RAILTYPE_RAIL);
182 }
183
184 /* max speed is the minimum of the speed limits of all vehicles in the consist */
185 if ((rvi_u->railveh_type != RAILVEH_WAGON || _settings_game.vehicle.wagon_speed_limits) && !UsesWagonOverride(u)) {
186 uint16_t speed = GetVehicleProperty(u, PROP_TRAIN_SPEED, rvi_u->max_speed);
187 if (speed != 0) max_speed = std::min(speed, max_speed);
188 }
189 }
190
191 uint16_t new_cap = e_u->DetermineCapacity(u);
192 if (allowed_changes.Test(ConsistChangeFlag::Capacity)) {
193 /* Update vehicle capacity. */
194 if (u->cargo_cap > new_cap) u->cargo.Truncate(new_cap);
195 u->refit_cap = std::min(new_cap, u->refit_cap);
196 u->cargo_cap = new_cap;
197 } else {
198 /* Verify capacity hasn't changed. */
199 if (new_cap != u->cargo_cap) ShowNewGrfVehicleError(u->engine_type, STR_NEWGRF_BROKEN, STR_NEWGRF_BROKEN_CAPACITY, GRFBug::VehCapacity, true);
200 }
201 u->vcache.cached_cargo_age_period = GetVehicleProperty(u, PROP_TRAIN_CARGO_AGE_PERIOD, e_u->info.cargo_age_period);
202
203 /* check the vehicle length (callback) */
204 uint16_t veh_len = CALLBACK_FAILED;
205 if (e_u->GetGRF() != nullptr && e_u->GetGRF()->grf_version >= 8) {
206 /* Use callback 36 */
207 veh_len = GetVehicleProperty(u, PROP_TRAIN_SHORTEN_FACTOR, CALLBACK_FAILED);
208
209 if (veh_len != CALLBACK_FAILED && veh_len >= VEHICLE_LENGTH) {
210 ErrorUnknownCallbackResult(e_u->GetGRFID(), CBID_VEHICLE_LENGTH, veh_len);
211 }
212 } else if (e_u->info.callback_mask.Test(VehicleCallbackMask::Length)) {
213 /* Use callback 11 */
214 veh_len = GetVehicleCallback(CBID_VEHICLE_LENGTH, 0, 0, u->engine_type, u);
215 }
216 if (veh_len == CALLBACK_FAILED) veh_len = rvi_u->shorten_factor;
217 veh_len = VEHICLE_LENGTH - Clamp(veh_len, 0, VEHICLE_LENGTH - 1);
218
219 if (allowed_changes.Test(ConsistChangeFlag::Length)) {
220 /* Update vehicle length. */
221 u->gcache.cached_veh_length = veh_len;
222 } else {
223 /* Verify length hasn't changed. */
224 if (veh_len != u->gcache.cached_veh_length) VehicleLengthChanged(u);
225 }
226
227 this->gcache.cached_total_length += u->gcache.cached_veh_length;
228 this->InvalidateNewGRFCache();
229 u->InvalidateNewGRFCache();
230 }
231
232 /* store consist weight/max speed in cache */
233 this->vcache.cached_max_speed = max_speed;
234 this->tcache.cached_tilt = train_can_tilt;
235 this->tcache.cached_curve_speed_mod = min_curve_speed_mod;
236 this->tcache.cached_max_curve_speed = this->GetCurveSpeedLimit();
237
238 /* 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) */
239 this->CargoChanged();
240
241 if (this->IsFrontEngine()) {
242 this->UpdateAcceleration();
243 SetWindowDirty(WC_VEHICLE_DETAILS, this->index);
244 InvalidateWindowData(WC_VEHICLE_REFIT, this->index, VIWD_CONSIST_CHANGED);
245 InvalidateWindowData(WC_VEHICLE_ORDERS, this->index, VIWD_CONSIST_CHANGED);
246 InvalidateNewGRFInspectWindow(GSF_TRAINS, this->index);
247 }
248}
249
260 int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length)
261{
262 const Station *st = Station::Get(station_id);
263 *station_ahead = st->GetPlatformLength(tile, DirToDiagDir(v->direction)) * TILE_SIZE;
264 *station_length = st->GetPlatformLength(tile) * TILE_SIZE;
265
266 /* Default to the middle of the station for stations stops that are not in
267 * the order list like intermediate stations when non-stop is disabled */
268 OrderStopLocation osl = OrderStopLocation::Middle;
269 if (v->gcache.cached_total_length >= *station_length) {
270 /* The train is longer than the station, make it stop at the far end of the platform */
271 osl = OrderStopLocation::FarEnd;
272 } else if (v->current_order.IsType(OT_GOTO_STATION) && v->current_order.GetDestination() == station_id) {
273 osl = v->current_order.GetStopLocation();
274 }
275
276 /* The stop location of the FRONT! of the train */
277 int stop;
278 switch (osl) {
279 default: NOT_REACHED();
280
281 case OrderStopLocation::NearEnd:
282 stop = v->gcache.cached_total_length;
283 break;
284
285 case OrderStopLocation::Middle:
286 stop = *station_length - (*station_length - v->gcache.cached_total_length) / 2;
287 break;
288
289 case OrderStopLocation::FarEnd:
290 stop = *station_length;
291 break;
292 }
293
294 /* Subtract half the front vehicle length of the train so we get the real
295 * stop location of the train. */
296 return stop - (v->gcache.cached_veh_length + 1) / 2;
297}
298
299
304uint16_t Train::GetCurveSpeedLimit() const
305{
306 assert(this->First() == this);
307
308 static const int absolute_max_speed = UINT16_MAX;
309 int max_speed = absolute_max_speed;
310
311 if (_settings_game.vehicle.train_acceleration_model == AM_ORIGINAL) return max_speed;
312
313 int curvecount[2] = {0, 0};
314
315 /* first find the curve speed limit */
316 int numcurve = 0;
317 int sum = 0;
318 int pos = 0;
319 int lastpos = -1;
320 for (const Train *u = this; u->Next() != nullptr; u = u->Next(), pos += u->gcache.cached_veh_length) {
321 Direction this_dir = u->direction;
322 Direction next_dir = u->Next()->direction;
323
324 DirDiff dirdiff = DirDifference(this_dir, next_dir);
325 if (dirdiff == DIRDIFF_SAME) continue;
326
327 if (dirdiff == DIRDIFF_45LEFT) curvecount[0]++;
328 if (dirdiff == DIRDIFF_45RIGHT) curvecount[1]++;
329 if (dirdiff == DIRDIFF_45LEFT || dirdiff == DIRDIFF_45RIGHT) {
330 if (lastpos != -1) {
331 numcurve++;
332 sum += pos - lastpos;
333 if (pos - lastpos <= static_cast<int>(VEHICLE_LENGTH) && max_speed > 88) {
334 max_speed = 88;
335 }
336 }
337 lastpos = pos;
338 }
339
340 /* if we have a 90 degree turn, fix the speed limit to 60 */
341 if (dirdiff == DIRDIFF_90LEFT || dirdiff == DIRDIFF_90RIGHT) {
342 max_speed = 61;
343 }
344 }
345
346 if (numcurve > 0 && max_speed > 88) {
347 if (curvecount[0] == 1 && curvecount[1] == 1) {
348 max_speed = absolute_max_speed;
349 } else {
350 sum = CeilDiv(sum, VEHICLE_LENGTH);
351 sum /= numcurve;
352 max_speed = 232 - (13 - Clamp(sum, 1, 12)) * (13 - Clamp(sum, 1, 12));
353 }
354 }
355
356 if (max_speed != absolute_max_speed) {
357 /* Apply the current railtype's curve speed advantage */
358 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(this->tile));
359 max_speed += (max_speed / 2) * rti->curve_speed;
360
361 if (this->tcache.cached_tilt) {
362 /* Apply max_speed bonus of 20% for a tilting train */
363 max_speed += max_speed / 5;
364 }
365
366 /* Apply max_speed modifier (cached value is fixed-point binary with 8 fractional bits)
367 * and clamp the result to an acceptable range. */
368 max_speed += (max_speed * this->tcache.cached_curve_speed_mod) / 256;
369 max_speed = Clamp(max_speed, 2, absolute_max_speed);
370 }
371
372 return static_cast<uint16_t>(max_speed);
373}
374
379 int Train::GetCurrentMaxSpeed() const
380{
381 int max_speed = _settings_game.vehicle.train_acceleration_model == AM_ORIGINAL ?
382 this->gcache.cached_max_track_speed :
383 this->tcache.cached_max_curve_speed;
384
385 if (_settings_game.vehicle.train_acceleration_model == AM_REALISTIC && IsRailStationTile(this->tile)) {
386 StationID sid = GetStationIndex(this->tile);
387 if (this->current_order.ShouldStopAtStation(this, sid)) {
388 int station_ahead;
389 int station_length;
390 int stop_at = GetTrainStopLocation(sid, this->tile, this, &station_ahead, &station_length);
391
392 /* The distance to go is whatever is still ahead of the train minus the
393 * distance from the train's stop location to the end of the platform */
394 int distance_to_go = station_ahead / TILE_SIZE - (station_length - stop_at) / TILE_SIZE;
395
396 if (distance_to_go > 0) {
397 int st_max_speed = 120;
398
399 int delta_v = this->cur_speed / (distance_to_go + 1);
400 if (max_speed > (this->cur_speed - delta_v)) {
401 st_max_speed = this->cur_speed - (delta_v / 10);
402 }
403
404 st_max_speed = std::max(st_max_speed, 25 * distance_to_go);
405 max_speed = std::min(max_speed, st_max_speed);
406 }
407 }
408 }
409
410 for (const Train *u = this; u != nullptr; u = u->Next()) {
411 if (_settings_game.vehicle.train_acceleration_model == AM_REALISTIC && u->track == TRACK_BIT_DEPOT) {
412 max_speed = std::min(max_speed, 61);
413 break;
414 }
415
416 /* Vehicle is on the middle part of a bridge. */
417 if (u->track == TRACK_BIT_WORMHOLE && !u->vehstatus.Test(VehState::Hidden)) {
418 max_speed = std::min<int>(max_speed, GetBridgeSpec(GetBridgeType(u->tile))->speed);
419 }
420 }
421
422 max_speed = std::min<int>(max_speed, this->current_order.GetMaxSpeed());
423 return std::min<int>(max_speed, this->gcache.cached_max_track_speed);
424}
425
427 void Train::UpdateAcceleration()
428{
429 assert(this->IsFrontEngine() || this->IsFreeWagon());
430
431 uint power = this->gcache.cached_power;
432 uint weight = this->gcache.cached_weight;
433 assert(weight != 0);
434 this->acceleration = Clamp(power / weight * 4, 1, 255);
435}
436
437int Train::GetCursorImageOffset() const
438{
439 if (this->gcache.cached_veh_length != 8 && this->flags.Test(VehicleRailFlag::Flipped) && !EngInfo(this->engine_type)->misc_flags.Test(EngineMiscFlag::RailFlips)) {
440 int reference_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
441
442 const Engine *e = this->GetEngine();
443 if (e->GetGRF() != nullptr && IsCustomVehicleSpriteNum(e->VehInfo<RailVehicleInfo>().image_index)) {
444 reference_width = e->GetGRF()->traininfo_vehicle_width;
445 }
446
447 return ScaleSpriteTrad((this->gcache.cached_veh_length - (int)VEHICLE_LENGTH) * reference_width / (int)VEHICLE_LENGTH);
448 }
449 return 0;
450}
451
457 int Train::GetDisplayImageWidth(Point *offset) const
458{
459 int reference_width = TRAININFO_DEFAULT_VEHICLE_WIDTH;
460 int vehicle_pitch = 0;
461
462 const Engine *e = this->GetEngine();
463 if (e->GetGRF() != nullptr && IsCustomVehicleSpriteNum(e->VehInfo<RailVehicleInfo>().image_index)) {
464 reference_width = e->GetGRF()->traininfo_vehicle_width;
465 vehicle_pitch = e->GetGRF()->traininfo_vehicle_pitch;
466 }
467
468 if (offset != nullptr) {
469 if (this->flags.Test(VehicleRailFlag::Flipped) && !EngInfo(this->engine_type)->misc_flags.Test(EngineMiscFlag::RailFlips)) {
470 offset->x = ScaleSpriteTrad(((int)this->gcache.cached_veh_length - (int)VEHICLE_LENGTH / 2) * reference_width / (int)VEHICLE_LENGTH);
471 } else {
472 offset->x = ScaleSpriteTrad(reference_width) / 2;
473 }
474 offset->y = ScaleSpriteTrad(vehicle_pitch);
475 }
476 return ScaleSpriteTrad(this->gcache.cached_veh_length * reference_width / VEHICLE_LENGTH);
477}
478
479static SpriteID GetDefaultTrainSprite(uint8_t spritenum, Direction direction)
480{
481 assert(IsValidImageIndex<VEH_TRAIN>(spritenum));
482 return ((direction + _engine_sprite_add[spritenum]) & _engine_sprite_and[spritenum]) + _engine_sprite_base[spritenum];
483}
484
491 void Train::GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
492{
493 uint8_t spritenum = this->spritenum;
494
495 if (this->flags.Test(VehicleRailFlag::Flipped)) direction = ReverseDir(direction);
496
497 if (IsCustomVehicleSpriteNum(spritenum)) {
498 if (spritenum == CUSTOM_VEHICLE_SPRITENUM_REVERSED) direction = ReverseDir(direction);
499 GetCustomVehicleSprite(this, direction, image_type, result);
500 if (result->IsValid()) return;
501
502 spritenum = this->GetEngine()->original_image_index;
503 }
504
505 assert(IsValidImageIndex<VEH_TRAIN>(spritenum));
506 SpriteID sprite = GetDefaultTrainSprite(spritenum, direction);
507
508 if (this->cargo.StoredCount() >= this->cargo_cap / 2U) sprite += _wagon_full_adder[spritenum];
509
510 result->Set(sprite);
511}
512
513static void GetRailIcon(EngineID engine, bool rear_head, int &y, EngineImageType image_type, VehicleSpriteSeq *result)
514{
515 const Engine *e = Engine::Get(engine);
516 Direction dir = rear_head ? DIR_E : DIR_W;
517 uint8_t spritenum = e->VehInfo<RailVehicleInfo>().image_index;
518
519 if (IsCustomVehicleSpriteNum(spritenum)) {
520 GetCustomVehicleIcon(engine, dir, image_type, result);
521 if (result->IsValid()) {
522 if (e->GetGRF() != nullptr) {
523 y += ScaleSpriteTrad(e->GetGRF()->traininfo_vehicle_pitch);
524 }
525 return;
526 }
527
528 spritenum = Engine::Get(engine)->original_image_index;
529 }
530
531 if (rear_head) spritenum++;
532
533 result->Set(GetDefaultTrainSprite(spritenum, DIR_W));
534}
535
536void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
537{
538 if (RailVehInfo(engine)->railveh_type == RAILVEH_MULTIHEAD) {
539 int yf = y;
540 int yr = y;
541
542 VehicleSpriteSeq seqf, seqr;
543 GetRailIcon(engine, false, yf, image_type, &seqf);
544 GetRailIcon(engine, true, yr, image_type, &seqr);
545
546 Rect rectf, rectr;
547 seqf.GetBounds(&rectf);
548 seqr.GetBounds(&rectr);
549
550 preferred_x = Clamp(preferred_x,
551 left - UnScaleGUI(rectf.left) + ScaleSpriteTrad(14),
552 right - UnScaleGUI(rectr.right) - ScaleSpriteTrad(15));
553
554 seqf.Draw(preferred_x - ScaleSpriteTrad(14), yf, pal, pal == PALETTE_CRASH);
555 seqr.Draw(preferred_x + ScaleSpriteTrad(15), yr, pal, pal == PALETTE_CRASH);
556 } else {
557 VehicleSpriteSeq seq;
558 GetRailIcon(engine, false, y, image_type, &seq);
559
560 Rect rect;
561 seq.GetBounds(&rect);
562 preferred_x = Clamp(preferred_x,
563 left - UnScaleGUI(rect.left),
564 right - UnScaleGUI(rect.right));
565
566 seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
567 }
568}
569
579 void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
580{
581 int y = 0;
582
583 VehicleSpriteSeq seq;
584 GetRailIcon(engine, false, y, image_type, &seq);
585
586 Rect rect;
587 seq.GetBounds(&rect);
588
589 width = UnScaleGUI(rect.Width());
590 height = UnScaleGUI(rect.Height());
591 xoffs = UnScaleGUI(rect.left);
592 yoffs = UnScaleGUI(rect.top);
593
594 if (RailVehInfo(engine)->railveh_type == RAILVEH_MULTIHEAD) {
595 GetRailIcon(engine, true, y, image_type, &seq);
596 seq.GetBounds(&rect);
597
598 /* Calculate values relative to an imaginary center between the two sprites. */
599 width = ScaleSpriteTrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) + UnScaleGUI(rect.right) - xoffs;
600 height = std::max<uint>(height, UnScaleGUI(rect.Height()));
601 xoffs = xoffs - ScaleSpriteTrad(TRAININFO_DEFAULT_VEHICLE_WIDTH) / 2;
602 yoffs = std::min(yoffs, UnScaleGUI(rect.top));
603 }
604}
605
611 static std::vector<VehicleID> GetFreeWagonsInDepot(TileIndex tile)
612{
613 std::vector<VehicleID> free_wagons;
614
615 for (Vehicle *v : VehiclesOnTile(tile)) {
616 if (v->type != VEH_TRAIN) continue;
617 if (v->vehstatus.Test(VehState::Crashed)) continue;
618 if (!Train::From(v)->IsFreeWagon()) continue;
619
620 free_wagons.push_back(v->index);
621 }
622
623 /* Sort by vehicle index for consistency across clients. */
624 std::ranges::sort(free_wagons);
625 return free_wagons;
626}
627
636 static CommandCost CmdBuildRailWagon(DoCommandFlags flags, TileIndex tile, const Engine *e, Vehicle **ret)
637{
638 const RailVehicleInfo *rvi = &e->VehInfo<RailVehicleInfo>();
639
640 /* Check that the wagon can drive on the track in question */
641 if (!IsCompatibleRail(rvi->railtypes, GetRailType(tile))) return CMD_ERROR;
642
643 if (flags.Test(DoCommandFlag::Execute)) {
644 Train *v = new Train();
645 *ret = v;
646 v->spritenum = rvi->image_index;
647
648 v->engine_type = e->index;
649 v->gcache.first_engine = EngineID::Invalid(); // needs to be set before first callback
650
651 DiagDirection dir = GetRailDepotDirection(tile);
652
653 v->direction = DiagDirToDir(dir);
654 v->tile = tile;
655
656 int x = TileX(tile) * TILE_SIZE | _vehicle_initial_x_fract[dir];
657 int y = TileY(tile) * TILE_SIZE | _vehicle_initial_y_fract[dir];
658
659 v->x_pos = x;
660 v->y_pos = y;
661 v->z_pos = GetSlopePixelZ(x, y, true);
662 v->owner = _current_company;
663 v->track = TRACK_BIT_DEPOT;
664 v->vehstatus = {VehState::Hidden, VehState::DefaultPalette};
665
666 v->SetWagon();
667
668 v->SetFreeWagon();
669 InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
670
671 v->cargo_type = e->GetDefaultCargoType();
672 assert(IsValidCargoType(v->cargo_type));
673 v->cargo_cap = rvi->capacity;
674 v->refit_cap = 0;
675
676 v->railtypes = rvi->railtypes;
677
678 v->date_of_last_service = TimerGameEconomy::date;
679 v->date_of_last_service_newgrf = TimerGameCalendar::date;
680 v->build_year = TimerGameCalendar::year;
681 v->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
682 v->random_bits = Random();
683
684 v->group_id = DEFAULT_GROUP;
685
686 auto prob = TestVehicleBuildProbability(v, v->engine_type, BuildProbabilityType::Reversed);
687 if (prob.has_value()) v->flags.Set(VehicleRailFlag::Flipped, prob.value());
688 AddArticulatedParts(v);
689
690 v->UpdatePosition();
691 v->First()->ConsistChanged(CCF_ARRANGE);
692 UpdateTrainGroupID(v->First());
693
694 CheckConsistencyOfArticulatedVehicle(v);
695
696 /* Try to connect the vehicle to one of free chains of wagons. */
697 for (VehicleID vehicle : GetFreeWagonsInDepot(tile)) {
698 if (vehicle == v->index) continue;
699
700 const Train *w = Train::Get(vehicle);
701 if (w->engine_type != v->engine_type) continue;
702 if (w->First() == v) continue;
703
704 if (Command<CMD_MOVE_RAIL_VEHICLE>::Do(DoCommandFlag::Execute, v->index, w->Last()->index, true).Succeeded()) {
705 break;
706 }
707 }
708 }
709
710 return CommandCost();
711}
712
714 void NormalizeTrainVehInDepot(const Train *u)
715{
716 assert(u->IsEngine());
717 for (VehicleID vehicle : GetFreeWagonsInDepot(u->tile)) {
718 if (Command<CMD_MOVE_RAIL_VEHICLE>::Do(DoCommandFlag::Execute, vehicle, u->index, true).Failed()) {
719 break;
720 }
721 }
722}
723
724static void AddRearEngineToMultiheadedTrain(Train *v)
725{
726 Train *u = new Train();
727 v->value >>= 1;
728 u->value = v->value;
729 u->direction = v->direction;
730 u->owner = v->owner;
731 u->tile = v->tile;
732 u->x_pos = v->x_pos;
733 u->y_pos = v->y_pos;
734 u->z_pos = v->z_pos;
735 u->track = TRACK_BIT_DEPOT;
736 u->vehstatus = v->vehstatus;
737 u->vehstatus.Reset(VehState::Stopped);
738 u->spritenum = v->spritenum + 1;
739 u->cargo_type = v->cargo_type;
740 u->cargo_subtype = v->cargo_subtype;
741 u->cargo_cap = v->cargo_cap;
742 u->refit_cap = v->refit_cap;
743 u->railtypes = v->railtypes;
744 u->engine_type = v->engine_type;
745 u->date_of_last_service = v->date_of_last_service;
746 u->date_of_last_service_newgrf = v->date_of_last_service_newgrf;
747 u->build_year = v->build_year;
748 u->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
749 u->random_bits = Random();
750 v->SetMultiheaded();
751 u->SetMultiheaded();
752 v->SetNext(u);
753 auto prob = TestVehicleBuildProbability(u, u->engine_type, BuildProbabilityType::Reversed);
754 if (prob.has_value()) u->flags.Set(VehicleRailFlag::Flipped, prob.value());
755 u->UpdatePosition();
756
757 /* Now we need to link the front and rear engines together */
758 v->other_multiheaded_part = u;
759 u->other_multiheaded_part = v;
760}
761
770 CommandCost CmdBuildRailVehicle(DoCommandFlags flags, TileIndex tile, const Engine *e, Vehicle **ret)
771{
772 const RailVehicleInfo *rvi = &e->VehInfo<RailVehicleInfo>();
773
774 if (rvi->railveh_type == RAILVEH_WAGON) return CmdBuildRailWagon(flags, tile, e, ret);
775
776 /* Check if depot and new engine uses the same kind of tracks *
777 * We need to see if the engine got power on the tile to avoid electric engines in non-electric depots */
778 if (!HasPowerOnRail(rvi->railtypes, GetRailType(tile))) return CMD_ERROR;
779
780 if (flags.Test(DoCommandFlag::Execute)) {
781 DiagDirection dir = GetRailDepotDirection(tile);
782 int x = TileX(tile) * TILE_SIZE + _vehicle_initial_x_fract[dir];
783 int y = TileY(tile) * TILE_SIZE + _vehicle_initial_y_fract[dir];
784
785 Train *v = new Train();
786 *ret = v;
787 v->direction = DiagDirToDir(dir);
788 v->tile = tile;
789 v->owner = _current_company;
790 v->x_pos = x;
791 v->y_pos = y;
792 v->z_pos = GetSlopePixelZ(x, y, true);
793 v->track = TRACK_BIT_DEPOT;
794 v->vehstatus = {VehState::Hidden, VehState::Stopped, VehState::DefaultPalette};
795 v->spritenum = rvi->image_index;
796 v->cargo_type = e->GetDefaultCargoType();
797 assert(IsValidCargoType(v->cargo_type));
798 v->cargo_cap = rvi->capacity;
799 v->refit_cap = 0;
800 v->last_station_visited = StationID::Invalid();
801 v->last_loading_station = StationID::Invalid();
802
803 v->engine_type = e->index;
804 v->gcache.first_engine = EngineID::Invalid(); // needs to be set before first callback
805
806 v->reliability = e->reliability;
807 v->reliability_spd_dec = e->reliability_spd_dec;
808 v->max_age = e->GetLifeLengthInDays();
809
810 v->railtypes = rvi->railtypes;
811
812 v->SetServiceInterval(Company::Get(_current_company)->settings.vehicle.servint_trains);
813 v->date_of_last_service = TimerGameEconomy::date;
814 v->date_of_last_service_newgrf = TimerGameCalendar::date;
815 v->build_year = TimerGameCalendar::year;
816 v->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
817 v->random_bits = Random();
818
819 if (e->flags.Test(EngineFlag::ExclusivePreview)) v->vehicle_flags.Set(VehicleFlag::BuiltAsPrototype);
820 v->SetServiceIntervalIsPercent(Company::Get(_current_company)->settings.vehicle.servint_ispercent);
821
822 v->group_id = DEFAULT_GROUP;
823
824 v->SetFrontEngine();
825 v->SetEngine();
826
827 auto prob = TestVehicleBuildProbability(v, v->engine_type, BuildProbabilityType::Reversed);
828 if (prob.has_value()) v->flags.Set(VehicleRailFlag::Flipped, prob.value());
829 v->UpdatePosition();
830
831 if (rvi->railveh_type == RAILVEH_MULTIHEAD) {
832 AddRearEngineToMultiheadedTrain(v);
833 } else {
834 AddArticulatedParts(v);
835 }
836
837 v->ConsistChanged(CCF_ARRANGE);
838 UpdateTrainGroupID(v);
839
840 CheckConsistencyOfArticulatedVehicle(v);
841 }
842
843 return CommandCost();
844}
845
846static Train *FindGoodVehiclePos(const Train *src)
847{
848 EngineID eng = src->engine_type;
849
850 for (VehicleID vehicle : GetFreeWagonsInDepot(src->tile)) {
851 Train *dst = Train::Get(vehicle);
852
853 /* check so all vehicles in the line have the same engine. */
854 Train *t = dst;
855 while (t->engine_type == eng) {
856 t = t->Next();
857 if (t == nullptr) return dst;
858 }
859 }
860
861 return nullptr;
862}
863
865 typedef std::vector<Train *> TrainList;
866
872 static void MakeTrainBackup(TrainList &list, Train *t)
873{
874 for (; t != nullptr; t = t->Next()) list.push_back(t);
875}
876
881 static void RestoreTrainBackup(TrainList &list)
882{
883 /* No train, nothing to do. */
884 if (list.empty()) return;
885
886 Train *prev = nullptr;
887 /* Iterate over the list and rebuild it. */
888 for (Train *t : list) {
889 if (prev != nullptr) {
890 prev->SetNext(t);
891 } else if (t->Previous() != nullptr) {
892 /* Make sure the head of the train is always the first in the chain. */
893 t->Previous()->SetNext(nullptr);
894 }
895 prev = t;
896 }
897}
898
904 static void RemoveFromConsist(Train *part, bool chain = false)
905{
906 Train *tail = chain ? part->Last() : part->GetLastEnginePart();
907
908 /* Unlink at the front, but make it point to the next
909 * vehicle after the to be remove part. */
910 if (part->Previous() != nullptr) part->Previous()->SetNext(tail->Next());
911
912 /* Unlink at the back */
913 tail->SetNext(nullptr);
914}
915
921 static void InsertInConsist(Train *dst, Train *chain)
922{
923 /* We do not want to add something in the middle of an articulated part. */
924 assert(dst != nullptr && (dst->Next() == nullptr || !dst->Next()->IsArticulatedPart()));
925
926 chain->Last()->SetNext(dst->Next());
927 dst->SetNext(chain);
928}
929
935 static void NormaliseDualHeads(Train *t)
936{
937 for (; t != nullptr; t = t->GetNextVehicle()) {
938 if (!t->IsMultiheaded() || !t->IsEngine()) continue;
939
940 /* Make sure that there are no free cars before next engine */
941 Train *u;
942 for (u = t; u->Next() != nullptr && !u->Next()->IsEngine(); u = u->Next()) {}
943
944 if (u == t->other_multiheaded_part) continue;
945
946 /* Remove the part from the 'wrong' train */
947 RemoveFromConsist(t->other_multiheaded_part);
948 /* And add it to the 'right' train */
949 InsertInConsist(u, t->other_multiheaded_part);
950 }
951}
952
957 static void NormaliseSubtypes(Train *chain)
958{
959 /* Nothing to do */
960 if (chain == nullptr) return;
961
962 /* We must be the first in the chain. */
963 assert(chain->Previous() == nullptr);
964
965 /* Set the appropriate bits for the first in the chain. */
966 if (chain->IsWagon()) {
967 chain->SetFreeWagon();
968 } else {
969 assert(chain->IsEngine());
970 chain->SetFrontEngine();
971 }
972
973 /* Now clear the bits for the rest of the chain */
974 for (Train *t = chain->Next(); t != nullptr; t = t->Next()) {
975 t->ClearFreeWagon();
976 t->ClearFrontEngine();
977 }
978}
979
989 static CommandCost CheckNewTrain(Train *original_dst, Train *dst, Train *original_src, Train *src)
990{
991 /* Just add 'new' engines and subtract the original ones.
992 * If that's less than or equal to 0 we can be sure we did
993 * not add any engines (read: trains) along the way. */
994 if ((src != nullptr && src->IsEngine() ? 1 : 0) +
995 (dst != nullptr && dst->IsEngine() ? 1 : 0) -
996 (original_src != nullptr && original_src->IsEngine() ? 1 : 0) -
997 (original_dst != nullptr && original_dst->IsEngine() ? 1 : 0) <= 0) {
998 return CommandCost();
999 }
1000
1001 /* Get a free unit number and check whether it's within the bounds.
1002 * There will always be a maximum of one new train. */
1003 if (GetFreeUnitNumber(VEH_TRAIN) <= _settings_game.vehicle.max_trains) return CommandCost();
1004
1005 return CommandCost(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
1006}
1007
1013 static CommandCost CheckTrainAttachment(Train *t)
1014{
1015 /* No multi-part train, no need to check. */
1016 if (t == nullptr || t->Next() == nullptr) return CommandCost();
1017
1018 /* The maximum length for a train. For each part we decrease this by one
1019 * and if the result is negative the train is simply too long. */
1020 int allowed_len = _settings_game.vehicle.max_train_length * TILE_SIZE - t->gcache.cached_veh_length;
1021
1022 /* For free-wagon chains, check if they are within the max_train_length limit. */
1023 if (!t->IsEngine()) {
1024 t = t->Next();
1025 while (t != nullptr) {
1026 allowed_len -= t->gcache.cached_veh_length;
1027
1028 t = t->Next();
1029 }
1030
1031 if (allowed_len < 0) return CommandCost(STR_ERROR_TRAIN_TOO_LONG);
1032 return CommandCost();
1033 }
1034
1035 Train *head = t;
1036 Train *prev = t;
1037
1038 /* Break the prev -> t link so it always holds within the loop. */
1039 t = t->Next();
1040 prev->SetNext(nullptr);
1041
1042 /* Make sure the cache is cleared. */
1043 head->InvalidateNewGRFCache();
1044
1045 while (t != nullptr) {
1046 allowed_len -= t->gcache.cached_veh_length;
1047
1048 Train *next = t->Next();
1049
1050 /* Unlink the to-be-added piece; it is already unlinked from the previous
1051 * part due to the fact that the prev -> t link is broken. */
1052 t->SetNext(nullptr);
1053
1054 /* Don't check callback for articulated or rear dual headed parts */
1055 if (!t->IsArticulatedPart() && !t->IsRearDualheaded()) {
1056 /* Back up and clear the first_engine data to avoid using wagon override group */
1057 EngineID first_engine = t->gcache.first_engine;
1058 t->gcache.first_engine = EngineID::Invalid();
1059
1060 /* We don't want the cache to interfere. head's cache is cleared before
1061 * the loop and after each callback does not need to be cleared here. */
1062 t->InvalidateNewGRFCache();
1063
1064 std::array<int32_t, 1> regs100;
1065 uint16_t callback = GetVehicleCallbackParent(CBID_TRAIN_ALLOW_WAGON_ATTACH, 0, 0, head->engine_type, t, head, regs100);
1066
1067 /* Restore original first_engine data */
1068 t->gcache.first_engine = first_engine;
1069
1070 /* We do not want to remember any cached variables from the test run */
1071 t->InvalidateNewGRFCache();
1072 head->InvalidateNewGRFCache();
1073
1074 if (callback != CALLBACK_FAILED) {
1075 /* A failing callback means everything is okay */
1076 StringID error = STR_NULL;
1077
1078 if (head->GetGRF()->grf_version < 8) {
1079 if (callback == 0xFD) error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
1080 if (callback < 0xFD) error = GetGRFStringID(head->GetGRFID(), GRFSTR_MISC_GRF_TEXT + callback);
1081 if (callback >= 0x100) ErrorUnknownCallbackResult(head->GetGRFID(), CBID_TRAIN_ALLOW_WAGON_ATTACH, callback);
1082 } else {
1083 if (callback < 0x400) {
1084 error = GetGRFStringID(head->GetGRFID(), GRFSTR_MISC_GRF_TEXT + callback);
1085 } else {
1086 switch (callback) {
1087 case 0x400: // allow if railtypes match (always the case for OpenTTD)
1088 case 0x401: // allow
1089 break;
1090
1091 case 0x40F:
1092 error = GetGRFStringID(head->GetGRFID(), static_cast<GRFStringID>(regs100[0]));
1093 break;
1094
1095 default: // unknown reason -> disallow
1096 case 0x402: // disallow attaching
1097 error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
1098 break;
1099 }
1100 }
1101 }
1102
1103 if (error != STR_NULL) return CommandCost(error);
1104 }
1105 }
1106
1107 /* And link it to the new part. */
1108 prev->SetNext(t);
1109 prev = t;
1110 t = next;
1111 }
1112
1113 if (allowed_len < 0) return CommandCost(STR_ERROR_TRAIN_TOO_LONG);
1114 return CommandCost();
1115}
1116
1127 static CommandCost ValidateTrains(Train *original_dst, Train *dst, Train *original_src, Train *src, bool check_limit)
1128{
1129 /* Check whether we may actually construct the trains. */
1130 CommandCost ret = CheckTrainAttachment(src);
1131 if (ret.Failed()) return ret;
1132 ret = CheckTrainAttachment(dst);
1133 if (ret.Failed()) return ret;
1134
1135 /* Check whether we need to build a new train. */
1136 return check_limit ? CheckNewTrain(original_dst, dst, original_src, src) : CommandCost();
1137}
1138
1147 static void ArrangeTrains(Train **dst_head, Train *dst, Train **src_head, Train *src, bool move_chain)
1148{
1149 /* First determine the front of the two resulting trains */
1150 if (*src_head == *dst_head) {
1151 /* If we aren't moving part(s) to a new train, we are just moving the
1152 * front back and there is not destination head. */
1153 *dst_head = nullptr;
1154 } else if (*dst_head == nullptr) {
1155 /* If we are moving to a new train the head of the move train would become
1156 * the head of the new vehicle. */
1157 *dst_head = src;
1158 }
1159
1160 if (src == *src_head) {
1161 /* If we are moving the front of a train then we are, in effect, creating
1162 * a new head for the train. Point to that. Unless we are moving the whole
1163 * train in which case there is not 'source' train anymore.
1164 * In case we are a multiheaded part we want the complete thing to come
1165 * with us, so src->GetNextUnit(), however... when we are e.g. a wagon
1166 * that is followed by a rear multihead we do not want to include that. */
1167 *src_head = move_chain ? nullptr :
1168 (src->IsMultiheaded() ? src->GetNextUnit() : src->GetNextVehicle());
1169 }
1170
1171 /* Now it's just simply removing the part that we are going to move from the
1172 * source train and *if* the destination is a not a new train add the chain
1173 * at the destination location. */
1174 RemoveFromConsist(src, move_chain);
1175 if (*dst_head != src) InsertInConsist(dst, src);
1176
1177 /* Now normalise the dual heads, that is move the dual heads around in such
1178 * a way that the head and rear of a dual head are in the same train */
1179 NormaliseDualHeads(*src_head);
1180 NormaliseDualHeads(*dst_head);
1181}
1182
1188 static void NormaliseTrainHead(Train *head)
1189{
1190 /* Not much to do! */
1191 if (head == nullptr) return;
1192
1193 /* Tell the 'world' the train changed. */
1194 head->ConsistChanged(CCF_ARRANGE);
1195 UpdateTrainGroupID(head);
1196
1197 /* Not a front engine, i.e. a free wagon chain. No need to do more. */
1198 if (!head->IsFrontEngine()) return;
1199
1200 /* Update the refit button and window */
1201 InvalidateWindowData(WC_VEHICLE_REFIT, head->index, VIWD_CONSIST_CHANGED);
1202 SetWindowWidgetDirty(WC_VEHICLE_VIEW, head->index, WID_VV_REFIT);
1203
1204 /* If we don't have a unit number yet, set one. */
1205 if (head->unitnumber != 0) return;
1206 head->unitnumber = Company::Get(head->owner)->freeunits[head->type].UseID(GetFreeUnitNumber(VEH_TRAIN));
1207}
1208
1218 CommandCost CmdMoveRailVehicle(DoCommandFlags flags, VehicleID src_veh, VehicleID dest_veh, bool move_chain)
1219{
1220 Train *src = Train::GetIfValid(src_veh);
1221 if (src == nullptr) return CMD_ERROR;
1222
1223 CommandCost ret = CheckOwnership(src->owner);
1224 if (ret.Failed()) return ret;
1225
1226 /* Do not allow moving crashed vehicles inside the depot, it is likely to cause asserts later */
1227 if (src->vehstatus.Test(VehState::Crashed)) return CMD_ERROR;
1228
1229 /* if nothing is selected as destination, try and find a matching vehicle to drag to. */
1230 Train *dst;
1231 if (dest_veh == VehicleID::Invalid()) {
1232 dst = (src->IsEngine() || flags.Test(DoCommandFlag::AutoReplace)) ? nullptr : FindGoodVehiclePos(src);
1233 } else {
1234 dst = Train::GetIfValid(dest_veh);
1235 if (dst == nullptr) return CMD_ERROR;
1236
1237 ret = CheckOwnership(dst->owner);
1238 if (ret.Failed()) return ret;
1239
1240 /* Do not allow appending to crashed vehicles, too */
1241 if (dst->vehstatus.Test(VehState::Crashed)) return CMD_ERROR;
1242 }
1243
1244 /* if an articulated part is being handled, deal with its parent vehicle */
1245 src = src->GetFirstEnginePart();
1246 if (dst != nullptr) {
1247 dst = dst->GetFirstEnginePart();
1248 }
1249
1250 /* don't move the same vehicle.. */
1251 if (src == dst) return CommandCost();
1252
1253 /* locate the head of the two chains */
1254 Train *src_head = src->First();
1255 Train *dst_head;
1256 if (dst != nullptr) {
1257 dst_head = dst->First();
1258 if (dst_head->tile != src_head->tile) return CMD_ERROR;
1259 /* Now deal with articulated part of destination wagon */
1260 dst = dst->GetLastEnginePart();
1261 } else {
1262 dst_head = nullptr;
1263 }
1264
1265 if (src->IsRearDualheaded()) return CommandCost(STR_ERROR_REAR_ENGINE_FOLLOW_FRONT);
1266
1267 /* When moving all wagons, we can't have the same src_head and dst_head */
1268 if (move_chain && src_head == dst_head) return CommandCost();
1269
1270 /* When moving a multiheaded part to be place after itself, bail out. */
1271 if (!move_chain && dst != nullptr && dst->IsRearDualheaded() && src == dst->other_multiheaded_part) return CommandCost();
1272
1273 /* Check if all vehicles in the source train are stopped inside a depot. */
1274 if (!src_head->IsStoppedInDepot()) return CommandCost(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT);
1275
1276 /* Check if all vehicles in the destination train are stopped inside a depot. */
1277 if (dst_head != nullptr && !dst_head->IsStoppedInDepot()) return CommandCost(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT);
1278
1279 /* First make a backup of the order of the trains. That way we can do
1280 * whatever we want with the order and later on easily revert. */
1281 TrainList original_src;
1282 TrainList original_dst;
1283
1284 MakeTrainBackup(original_src, src_head);
1285 MakeTrainBackup(original_dst, dst_head);
1286
1287 /* Also make backup of the original heads as ArrangeTrains can change them.
1288 * For the destination head we do not care if it is the same as the source
1289 * head because in that case it's just a copy. */
1290 Train *original_src_head = src_head;
1291 Train *original_dst_head = (dst_head == src_head ? nullptr : dst_head);
1292
1293 /* We want this information from before the rearrangement, but execute this after the validation.
1294 * original_src_head can't be nullptr; src is by definition != nullptr, so src_head can't be nullptr as
1295 * src->GetFirst() always yields non-nullptr, so eventually original_src_head != nullptr as well. */
1296 bool original_src_head_front_engine = original_src_head->IsFrontEngine();
1297 bool original_dst_head_front_engine = original_dst_head != nullptr && original_dst_head->IsFrontEngine();
1298
1299 /* (Re)arrange the trains in the wanted arrangement. */
1300 ArrangeTrains(&dst_head, dst, &src_head, src, move_chain);
1301
1302 if (!flags.Test(DoCommandFlag::AutoReplace)) {
1303 /* If the autoreplace flag is set we do not need to test for the validity
1304 * because we are going to revert the train to its original state. As we
1305 * assume the original state was correct autoreplace can skip this. */
1306 ret = ValidateTrains(original_dst_head, dst_head, original_src_head, src_head, true);
1307 if (ret.Failed()) {
1308 /* Restore the train we had. */
1309 RestoreTrainBackup(original_src);
1310 RestoreTrainBackup(original_dst);
1311 return ret;
1312 }
1313 }
1314
1315 /* do it? */
1316 if (flags.Test(DoCommandFlag::Execute)) {
1317 /* Remove old heads from the statistics */
1318 if (original_src_head_front_engine) GroupStatistics::CountVehicle(original_src_head, -1);
1319 if (original_dst_head_front_engine) GroupStatistics::CountVehicle(original_dst_head, -1);
1320
1321 /* First normalise the sub types of the chains. */
1322 NormaliseSubtypes(src_head);
1323 NormaliseSubtypes(dst_head);
1324
1325 /* There are 14 different cases:
1326 * 1) front engine gets moved to a new train, it stays a front engine.
1327 * a) the 'next' part is a wagon that becomes a free wagon chain.
1328 * b) the 'next' part is an engine that becomes a front engine.
1329 * c) there is no 'next' part, nothing else happens
1330 * 2) front engine gets moved to another train, it is not a front engine anymore
1331 * a) the 'next' part is a wagon that becomes a free wagon chain.
1332 * b) the 'next' part is an engine that becomes a front engine.
1333 * c) there is no 'next' part, nothing else happens
1334 * 3) front engine gets moved to later in the current train, it is not a front engine anymore.
1335 * a) the 'next' part is a wagon that becomes a free wagon chain.
1336 * b) the 'next' part is an engine that becomes a front engine.
1337 * 4) free wagon gets moved
1338 * a) the 'next' part is a wagon that becomes a free wagon chain.
1339 * b) the 'next' part is an engine that becomes a front engine.
1340 * c) there is no 'next' part, nothing else happens
1341 * 5) non front engine gets moved and becomes a new train, nothing else happens
1342 * 6) non front engine gets moved within a train / to another train, nothing happens
1343 * 7) wagon gets moved, nothing happens
1344 */
1345 if (src == original_src_head && src->IsEngine() && !src->IsFrontEngine()) {
1346 /* Cases #2 and #3: the front engine gets trashed. */
1347 CloseWindowById(WC_VEHICLE_VIEW, src->index);
1348 CloseWindowById(WC_VEHICLE_ORDERS, src->index);
1349 CloseWindowById(WC_VEHICLE_REFIT, src->index);
1350 CloseWindowById(WC_VEHICLE_DETAILS, src->index);
1351 CloseWindowById(WC_VEHICLE_TIMETABLE, src->index);
1352 DeleteNewGRFInspectWindow(GSF_TRAINS, src->index);
1353 SetWindowDirty(WC_COMPANY, _current_company);
1354
1355 if (src_head != nullptr && src_head->IsFrontEngine()) {
1356 /* Cases #?b: Transfer order, unit number and other stuff
1357 * to the new front engine. */
1358 src_head->orders = src->orders;
1359 if (src_head->orders != nullptr) src_head->AddToShared(src);
1360 src_head->CopyVehicleConfigAndStatistics(src);
1361 }
1362 /* Remove stuff not valid anymore for non-front engines. */
1363 DeleteVehicleOrders(src);
1364 src->ReleaseUnitNumber();
1365 src->name.clear();
1366 }
1367
1368 /* We weren't a front engine but are becoming one. So
1369 * we should be put in the default group. */
1370 if (original_src_head != src && dst_head == src) {
1371 SetTrainGroupID(src, DEFAULT_GROUP);
1372 SetWindowDirty(WC_COMPANY, _current_company);
1373 }
1374
1375 /* Handle 'new engine' part of cases #1b, #2b, #3b, #4b and #5 in NormaliseTrainHead. */
1376 NormaliseTrainHead(src_head);
1377 NormaliseTrainHead(dst_head);
1378
1379 /* Add new heads to statistics.
1380 * This should be done after NormaliseTrainHead due to engine total limit checks in GetFreeUnitNumber. */
1381 if (src_head != nullptr && src_head->IsFrontEngine()) GroupStatistics::CountVehicle(src_head, 1);
1382 if (dst_head != nullptr && dst_head->IsFrontEngine()) GroupStatistics::CountVehicle(dst_head, 1);
1383
1384 if (!flags.Test(DoCommandFlag::NoCargoCapacityCheck)) {
1385 CheckCargoCapacity(src_head);
1386 CheckCargoCapacity(dst_head);
1387 }
1388
1389 if (src_head != nullptr) src_head->First()->MarkDirty();
1390 if (dst_head != nullptr) dst_head->First()->MarkDirty();
1391
1392 /* We are undoubtedly changing something in the depot and train list. */
1393 InvalidateWindowData(WC_VEHICLE_DEPOT, src->tile);
1394 InvalidateWindowClassesData(WC_TRAINS_LIST, 0);
1395 } else {
1396 /* We don't want to execute what we're just tried. */
1397 RestoreTrainBackup(original_src);
1398 RestoreTrainBackup(original_dst);
1399 }
1400
1401 return CommandCost();
1402}
1403
1416 CommandCost CmdSellRailWagon(DoCommandFlags flags, Vehicle *t, bool sell_chain, bool backup_order, ClientID user)
1417{
1418 Train *v = Train::From(t)->GetFirstEnginePart();
1419 Train *first = v->First();
1420
1421 if (v->IsRearDualheaded()) return CommandCost(STR_ERROR_REAR_ENGINE_FOLLOW_FRONT);
1422
1423 /* First make a backup of the order of the train. That way we can do
1424 * whatever we want with the order and later on easily revert. */
1425 TrainList original;
1426 MakeTrainBackup(original, first);
1427
1428 /* We need to keep track of the new head and the head of what we're going to sell. */
1429 Train *new_head = first;
1430 Train *sell_head = nullptr;
1431
1432 /* Split the train in the wanted way. */
1433 ArrangeTrains(&sell_head, nullptr, &new_head, v, sell_chain);
1434
1435 /* We don't need to validate the second train; it's going to be sold. */
1436 CommandCost ret = ValidateTrains(nullptr, nullptr, first, new_head, !flags.Test(DoCommandFlag::AutoReplace));
1437 if (ret.Failed()) {
1438 /* Restore the train we had. */
1439 RestoreTrainBackup(original);
1440 return ret;
1441 }
1442
1443 if (first->orders == nullptr && !OrderList::CanAllocateItem()) {
1444 /* Restore the train we had. */
1445 RestoreTrainBackup(original);
1446 return CommandCost(STR_ERROR_NO_MORE_SPACE_FOR_ORDERS);
1447 }
1448
1449 CommandCost cost(EXPENSES_NEW_VEHICLES);
1450 for (Train *part = sell_head; part != nullptr; part = part->Next()) cost.AddCost(-part->value);
1451
1452 /* do it? */
1453 if (flags.Test(DoCommandFlag::Execute)) {
1454 /* First normalise the sub types of the chain. */
1455 NormaliseSubtypes(new_head);
1456
1457 if (v == first && !sell_chain && new_head != nullptr && new_head->IsFrontEngine()) {
1458 if (v->IsEngine()) {
1459 /* We are selling the front engine. In this case we want to
1460 * 'give' the order, unit number and such to the new head. */
1461 new_head->orders = first->orders;
1462 new_head->AddToShared(first);
1463 DeleteVehicleOrders(first);
1464
1465 /* Copy other important data from the front engine */
1466 new_head->CopyVehicleConfigAndStatistics(first);
1467 }
1468 GroupStatistics::CountVehicle(new_head, 1); // after copying over the profit, if required
1469 } else if (v->IsPrimaryVehicle() && backup_order) {
1470 OrderBackup::Backup(v, user);
1471 }
1472
1473 /* We need to update the information about the train. */
1474 NormaliseTrainHead(new_head);
1475
1476 /* We are undoubtedly changing something in the depot and train list. */
1477 InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
1478 InvalidateWindowClassesData(WC_TRAINS_LIST, 0);
1479
1480 /* Actually delete the sold 'goods' */
1481 delete sell_head;
1482 } else {
1483 /* We don't want to execute what we're just tried. */
1484 RestoreTrainBackup(original);
1485 }
1486
1487 return cost;
1488}
1489
1490 void Train::UpdateDeltaXY()
1491{
1492 /* Set common defaults. */
1493 this->bounds = {{-1, -1, 0}, {3, 3, 6}, {}};
1494
1495 /* Set if flipped and engine is NOT flagged with custom flip handling. */
1496 int flipped = this->flags.Test(VehicleRailFlag::Flipped) && !EngInfo(this->engine_type)->misc_flags.Test(EngineMiscFlag::RailFlips);
1497 /* If flipped and vehicle length is odd, we need to adjust the bounding box offset slightly. */
1498 int flip_offs = flipped && (this->gcache.cached_veh_length & 1);
1499
1500 Direction dir = this->direction;
1501 if (flipped) dir = ReverseDir(dir);
1502
1503 if (!IsDiagonalDirection(dir)) {
1504 static const Point _sign_table[] = {
1505 /* x, y */
1506 {-1, -1}, // DIR_N
1507 {-1, 1}, // DIR_E
1508 { 1, 1}, // DIR_S
1509 { 1, -1}, // DIR_W
1510 };
1511
1512 int half_shorten = (VEHICLE_LENGTH - this->gcache.cached_veh_length + flipped) / 2;
1513
1514 /* For all straight directions, move the bound box to the centre of the vehicle, but keep the size. */
1515 this->bounds.offset.x -= half_shorten * _sign_table[DirToDiagDir(dir)].x;
1516 this->bounds.offset.y -= half_shorten * _sign_table[DirToDiagDir(dir)].y;
1517 } else {
1518 switch (dir) {
1519 /* Shorten southern corner of the bounding box according the vehicle length
1520 * and center the bounding box on the vehicle. */
1521 case DIR_NE:
1522 this->bounds.origin.x = -(this->gcache.cached_veh_length + 1) / 2 + flip_offs;
1523 this->bounds.extent.x = this->gcache.cached_veh_length;
1524 this->bounds.offset.x = 1;
1525 break;
1526
1527 case DIR_NW:
1528 this->bounds.origin.y = -(this->gcache.cached_veh_length + 1) / 2 + flip_offs;
1529 this->bounds.extent.y = this->gcache.cached_veh_length;
1530 this->bounds.offset.y = 1;
1531 break;
1532
1533 /* Move northern corner of the bounding box down according to vehicle length
1534 * and center the bounding box on the vehicle. */
1535 case DIR_SW:
1536 this->bounds.origin.x = -(this->gcache.cached_veh_length) / 2 - flip_offs;
1537 this->bounds.extent.x = this->gcache.cached_veh_length;
1538 this->bounds.offset.x = 1 - (VEHICLE_LENGTH - this->gcache.cached_veh_length);
1539 break;
1540
1541 case DIR_SE:
1542 this->bounds.origin.y = -(this->gcache.cached_veh_length) / 2 - flip_offs;
1543 this->bounds.extent.y = this->gcache.cached_veh_length;
1544 this->bounds.offset.y = 1 - (VEHICLE_LENGTH - this->gcache.cached_veh_length);
1545 break;
1546
1547 default:
1548 NOT_REACHED();
1549 }
1550 }
1551}
1552
1557 static void MarkTrainAsStuck(Train *v)
1558{
1559 if (!v->flags.Test(VehicleRailFlag::Stuck)) {
1560 /* It is the first time the problem occurred, set the "train stuck" flag. */
1561 v->flags.Set(VehicleRailFlag::Stuck);
1562
1563 v->wait_counter = 0;
1564
1565 /* Stop train */
1566 v->cur_speed = 0;
1567 v->subspeed = 0;
1568 v->SetLastSpeed();
1569
1570 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
1571 }
1572}
1573
1581 static void SwapTrainFlags(uint16_t *swap_flag1, uint16_t *swap_flag2)
1582{
1583 uint16_t flag1 = *swap_flag1;
1584 uint16_t flag2 = *swap_flag2;
1585
1586 /* Clear the flags */
1587 ClrBit(*swap_flag1, GVF_GOINGUP_BIT);
1588 ClrBit(*swap_flag1, GVF_GOINGDOWN_BIT);
1589 ClrBit(*swap_flag2, GVF_GOINGUP_BIT);
1590 ClrBit(*swap_flag2, GVF_GOINGDOWN_BIT);
1591
1592 /* Reverse the rail-flags (if needed) */
1593 if (HasBit(flag1, GVF_GOINGUP_BIT)) {
1594 SetBit(*swap_flag2, GVF_GOINGDOWN_BIT);
1595 } else if (HasBit(flag1, GVF_GOINGDOWN_BIT)) {
1596 SetBit(*swap_flag2, GVF_GOINGUP_BIT);
1597 }
1598 if (HasBit(flag2, GVF_GOINGUP_BIT)) {
1599 SetBit(*swap_flag1, GVF_GOINGDOWN_BIT);
1600 } else if (HasBit(flag2, GVF_GOINGDOWN_BIT)) {
1601 SetBit(*swap_flag1, GVF_GOINGUP_BIT);
1602 }
1603}
1604
1609 static void UpdateStatusAfterSwap(Train *v)
1610{
1611 /* Reverse the direction. */
1612 if (v->track != TRACK_BIT_DEPOT) v->direction = ReverseDir(v->direction);
1613
1614 /* Call the proper EnterTile function unless we are in a wormhole. */
1615 if (v->track != TRACK_BIT_WORMHOLE) {
1616 VehicleEnterTile(v, v->tile, v->x_pos, v->y_pos);
1617 } else {
1618 /* VehicleEnter_TunnelBridge() sets TRACK_BIT_WORMHOLE when the vehicle
1619 * is on the last bit of the bridge head (frame == TILE_SIZE - 1).
1620 * If we were swapped with such a vehicle, we have set TRACK_BIT_WORMHOLE,
1621 * when we shouldn't have. Check if this is the case. */
1622 TileIndex vt = TileVirtXY(v->x_pos, v->y_pos);
1623 if (IsTileType(vt, MP_TUNNELBRIDGE)) {
1624 VehicleEnterTile(v, vt, v->x_pos, v->y_pos);
1625 if (v->track != TRACK_BIT_WORMHOLE && IsBridgeTile(v->tile)) {
1626 /* We have just left the wormhole, possibly set the
1627 * "goingdown" bit. UpdateInclination() can be used
1628 * because we are at the border of the tile. */
1629 v->UpdatePosition();
1630 v->UpdateInclination(true, true);
1631 return;
1632 }
1633 }
1634 }
1635
1636 v->UpdatePosition();
1637 v->UpdateViewport(true, true);
1638}
1639
1646 void ReverseTrainSwapVeh(Train *v, int l, int r)
1647{
1648 Train *a, *b;
1649
1650 /* locate vehicles to swap */
1651 for (a = v; l != 0; l--) a = a->Next();
1652 for (b = v; r != 0; r--) b = b->Next();
1653
1654 if (a != b) {
1655 /* swap the hidden bits */
1656 {
1657 bool a_hidden = a->vehstatus.Test(VehState::Hidden);
1658 bool b_hidden = b->vehstatus.Test(VehState::Hidden);
1659 b->vehstatus.Set(VehState::Hidden, a_hidden);
1660 a->vehstatus.Set(VehState::Hidden, b_hidden);
1661 }
1662
1663 std::swap(a->track, b->track);
1664 std::swap(a->direction, b->direction);
1665 std::swap(a->x_pos, b->x_pos);
1666 std::swap(a->y_pos, b->y_pos);
1667 std::swap(a->tile, b->tile);
1668 std::swap(a->z_pos, b->z_pos);
1669
1670 SwapTrainFlags(&a->gv_flags, &b->gv_flags);
1671
1672 UpdateStatusAfterSwap(a);
1673 UpdateStatusAfterSwap(b);
1674 } else {
1675 /* Swap GVF_GOINGUP_BIT/GVF_GOINGDOWN_BIT.
1676 * This is a little bit redundant way, a->gv_flags will
1677 * be (re)set twice, but it reduces code duplication */
1678 SwapTrainFlags(&a->gv_flags, &a->gv_flags);
1679 UpdateStatusAfterSwap(a);
1680 }
1681}
1682
1688 static bool IsTrain(const Vehicle *v)
1689{
1690 return v->type == VEH_TRAIN;
1691}
1692
1699 bool TrainOnCrossing(TileIndex tile)
1700{
1701 assert(IsLevelCrossingTile(tile));
1702
1703 return HasVehicleOnTile(tile, IsTrain);
1704}
1705
1712 static bool TrainApproachingCrossingEnum(const Vehicle *v, TileIndex tile)
1713{
1714 if (v->type != VEH_TRAIN || v->vehstatus.Test(VehState::Crashed)) return false;
1715
1716 const Train *t = Train::From(v);
1717 if (!t->IsFrontEngine()) return false;
1718
1719 return TrainApproachingCrossingTile(t) == tile;
1720}
1721
1722
1729 static bool TrainApproachingCrossing(TileIndex tile)
1730{
1731 assert(IsLevelCrossingTile(tile));
1732
1733 DiagDirection dir = AxisToDiagDir(GetCrossingRailAxis(tile));
1734 TileIndex tile_from = tile + TileOffsByDiagDir(dir);
1735
1736 if (HasVehicleOnTile(tile_from, [&](const Vehicle *v) {
1737 return TrainApproachingCrossingEnum(v, tile);
1738 })) return true;
1739
1740 dir = ReverseDiagDir(dir);
1741 tile_from = tile + TileOffsByDiagDir(dir);
1742
1743 return HasVehicleOnTile(tile_from, [&](const Vehicle *v) {
1744 return TrainApproachingCrossingEnum(v, tile);
1745 });
1746}
1747
1753 static inline bool CheckLevelCrossing(TileIndex tile)
1754{
1755 /* reserved || train on crossing || train approaching crossing */
1756 return HasCrossingReservation(tile) || TrainOnCrossing(tile) || TrainApproachingCrossing(tile);
1757}
1758
1766 static void UpdateLevelCrossingTile(TileIndex tile, bool sound, bool force_barred)
1767{
1768 assert(IsLevelCrossingTile(tile));
1769 bool set_barred;
1770
1771 /* We force the crossing to be barred when an adjacent crossing is barred, otherwise let it decide for itself. */
1772 set_barred = force_barred || CheckLevelCrossing(tile);
1773
1774 /* The state has changed */
1775 if (set_barred != IsCrossingBarred(tile)) {
1776 if (set_barred && sound && _settings_client.sound.ambient) SndPlayTileFx(SND_0E_LEVEL_CROSSING, tile);
1777 SetCrossingBarred(tile, set_barred);
1778 MarkTileDirtyByTile(tile);
1779 }
1780}
1781
1788 void UpdateLevelCrossing(TileIndex tile, bool sound, bool force_bar)
1789{
1790 if (!IsLevelCrossingTile(tile)) return;
1791
1792 bool forced_state = force_bar;
1793
1794 const Axis axis = GetCrossingRoadAxis(tile);
1795 const DiagDirection dir1 = AxisToDiagDir(axis);
1796 const DiagDirection dir2 = ReverseDiagDir(dir1);
1797
1798 /* Check if an adjacent crossing is barred. */
1799 for (DiagDirection dir : { dir1, dir2 }) {
1800 for (TileIndex t = tile; !forced_state && t < Map::Size() && IsLevelCrossingTile(t) && GetCrossingRoadAxis(t) == axis; t = TileAddByDiagDir(t, dir)) {
1801 forced_state |= CheckLevelCrossing(t);
1802 }
1803 }
1804
1805 /* Now that we know whether all tiles in this crossing should be barred or open,
1806 * we need to update those tiles. We start with the tile itself, then look along the road axis. */
1807 UpdateLevelCrossingTile(tile, sound, forced_state);
1808 for (DiagDirection dir : { dir1, dir2 }) {
1809 for (TileIndex t = TileAddByDiagDir(tile, dir); t < Map::Size() && IsLevelCrossingTile(t) && GetCrossingRoadAxis(t) == axis; t = TileAddByDiagDir(t, dir)) {
1810 UpdateLevelCrossingTile(t, sound, forced_state);
1811 }
1812 }
1813}
1814
1820 void MarkDirtyAdjacentLevelCrossingTiles(TileIndex tile, Axis road_axis)
1821{
1822 const DiagDirection dir1 = AxisToDiagDir(road_axis);
1823 const DiagDirection dir2 = ReverseDiagDir(dir1);
1824 for (DiagDirection dir : { dir1, dir2 }) {
1825 const TileIndex t = TileAddByDiagDir(tile, dir);
1826 if (t < Map::Size() && IsLevelCrossingTile(t) && GetCrossingRoadAxis(t) == road_axis) {
1827 MarkTileDirtyByTile(t);
1828 }
1829 }
1830}
1831
1837 void UpdateAdjacentLevelCrossingTilesOnLevelCrossingRemoval(TileIndex tile, Axis road_axis)
1838{
1839 const DiagDirection dir1 = AxisToDiagDir(road_axis);
1840 const DiagDirection dir2 = ReverseDiagDir(dir1);
1841 for (DiagDirection dir : { dir1, dir2 }) {
1842 const TileIndexDiff diff = TileOffsByDiagDir(dir);
1843 bool occupied = false;
1844 for (TileIndex t = tile + diff; t < Map::Size() && IsLevelCrossingTile(t) && GetCrossingRoadAxis(t) == road_axis; t += diff) {
1845 occupied |= CheckLevelCrossing(t);
1846 }
1847 if (occupied) {
1848 /* Mark the immediately adjacent tile dirty */
1849 const TileIndex t = tile + diff;
1850 if (t < Map::Size() && IsLevelCrossingTile(t) && GetCrossingRoadAxis(t) == road_axis) {
1851 MarkTileDirtyByTile(t);
1852 }
1853 } else {
1854 /* Unbar the crossing tiles in this direction as necessary */
1855 for (TileIndex t = tile + diff; t < Map::Size() && IsLevelCrossingTile(t) && GetCrossingRoadAxis(t) == road_axis; t += diff) {
1856 if (IsCrossingBarred(t)) {
1857 /* The crossing tile is barred, unbar it and continue to check the next tile */
1858 SetCrossingBarred(t, false);
1859 MarkTileDirtyByTile(t);
1860 } else {
1861 /* The crossing tile is already unbarred, mark the tile dirty and stop checking */
1862 MarkTileDirtyByTile(t);
1863 break;
1864 }
1865 }
1866 }
1867 }
1868}
1869
1875 static inline void MaybeBarCrossingWithSound(TileIndex tile)
1876{
1877 if (!IsCrossingBarred(tile)) {
1878 SetCrossingReservation(tile, true);
1879 UpdateLevelCrossing(tile, true);
1880 }
1881}
1882
1883
1889 static void AdvanceWagonsBeforeSwap(Train *v)
1890{
1891 Train *base = v;
1892 Train *first = base; // first vehicle to move
1893 Train *last = v->Last(); // last vehicle to move
1894 uint length = CountVehiclesInChain(v);
1895
1896 while (length > 2) {
1897 last = last->Previous();
1898 first = first->Next();
1899
1900 int differential = base->CalcNextVehicleOffset() - last->CalcNextVehicleOffset();
1901
1902 /* do not update images now
1903 * negative differential will be handled in AdvanceWagonsAfterSwap() */
1904 for (int i = 0; i < differential; i++) TrainController(first, last->Next());
1905
1906 base = first; // == base->Next()
1907 length -= 2;
1908 }
1909}
1910
1911
1917 static void AdvanceWagonsAfterSwap(Train *v)
1918{
1919 /* first of all, fix the situation when the train was entering a depot */
1920 Train *dep = v; // last vehicle in front of just left depot
1921 while (dep->Next() != nullptr && (dep->track == TRACK_BIT_DEPOT || dep->Next()->track != TRACK_BIT_DEPOT)) {
1922 dep = dep->Next(); // find first vehicle outside of a depot, with next vehicle inside a depot
1923 }
1924
1925 Train *leave = dep->Next(); // first vehicle in a depot we are leaving now
1926
1927 if (leave != nullptr) {
1928 /* 'pull' next wagon out of the depot, so we won't miss it (it could stay in depot forever) */
1929 int d = TicksToLeaveDepot(dep);
1930
1931 if (d <= 0) {
1932 leave->vehstatus.Reset(VehState::Hidden); // move it out of the depot
1933 leave->track = TrackToTrackBits(GetRailDepotTrack(leave->tile));
1934 for (int i = 0; i >= d; i--) TrainController(leave, nullptr); // maybe move it, and maybe let another wagon leave
1935 }
1936 } else {
1937 dep = nullptr; // no vehicle in a depot, so no vehicle leaving a depot
1938 }
1939
1940 Train *base = v;
1941 Train *first = base; // first vehicle to move
1942 Train *last = v->Last(); // last vehicle to move
1943 uint length = CountVehiclesInChain(v);
1944
1945 /* We have to make sure all wagons that leave a depot because of train reversing are moved correctly
1946 * they have already correct spacing, so we have to make sure they are moved how they should */
1947 bool nomove = (dep == nullptr); // If there is no vehicle leaving a depot, limit the number of wagons moved immediately.
1948
1949 while (length > 2) {
1950 /* we reached vehicle (originally) in front of a depot, stop now
1951 * (we would move wagons that are already moved with new wagon length). */
1952 if (base == dep) break;
1953
1954 /* the last wagon was that one leaving a depot, so do not move it anymore */
1955 if (last == dep) nomove = true;
1956
1957 last = last->Previous();
1958 first = first->Next();
1959
1960 int differential = last->CalcNextVehicleOffset() - base->CalcNextVehicleOffset();
1961
1962 /* do not update images now */
1963 for (int i = 0; i < differential; i++) TrainController(first, (nomove ? last->Next() : nullptr));
1964
1965 base = first; // == base->Next()
1966 length -= 2;
1967 }
1968}
1969
1970static bool IsWholeTrainInsideDepot(const Train *v)
1971{
1972 for (const Train *u = v; u != nullptr; u = u->Next()) {
1973 if (u->track != TRACK_BIT_DEPOT || u->tile != v->tile) return false;
1974 }
1975 return true;
1976}
1977
1982 void ReverseTrainDirection(Train *v)
1983{
1984 if (IsRailDepotTile(v->tile)) {
1985 if (IsWholeTrainInsideDepot(v)) return;
1986 InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
1987 }
1988
1989 /* Clear path reservation in front if train is not stuck. */
1990 if (!v->flags.Test(VehicleRailFlag::Stuck)) FreeTrainTrackReservation(v);
1991
1992 /* Check if we were approaching a rail/road-crossing */
1993 TileIndex crossing = TrainApproachingCrossingTile(v);
1994
1995 /* count number of vehicles */
1996 int r = CountVehiclesInChain(v) - 1; // number of vehicles - 1
1997
1998 AdvanceWagonsBeforeSwap(v);
1999
2000 /* swap start<>end, start+1<>end-1, ... */
2001 int l = 0;
2002 do {
2003 ReverseTrainSwapVeh(v, l++, r--);
2004 } while (l <= r);
2005
2006 AdvanceWagonsAfterSwap(v);
2007
2008 if (IsRailDepotTile(v->tile)) {
2009 InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
2010 }
2011
2012 v->flags.Flip(VehicleRailFlag::Reversed);
2013 v->flags.Reset(VehicleRailFlag::Reversing);
2014
2015 /* recalculate cached data */
2016 v->ConsistChanged(CCF_TRACK);
2017
2018 /* update all images */
2019 for (Train *u = v; u != nullptr; u = u->Next()) u->UpdateViewport(false, false);
2020
2021 /* update crossing we were approaching */
2022 if (crossing != INVALID_TILE) UpdateLevelCrossing(crossing);
2023
2024 /* maybe we are approaching crossing now, after reversal */
2025 crossing = TrainApproachingCrossingTile(v);
2026 if (crossing != INVALID_TILE) MaybeBarCrossingWithSound(crossing);
2027
2028 /* If we are inside a depot after reversing, don't bother with path reserving. */
2029 if (v->track == TRACK_BIT_DEPOT) {
2030 /* Can't be stuck here as inside a depot is always a safe tile. */
2031 if (v->flags.Test(VehicleRailFlag::Stuck)) SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
2032 v->flags.Reset(VehicleRailFlag::Stuck);
2033 return;
2034 }
2035
2036 /* VehicleExitDir does not always produce the desired dir for depots and
2037 * tunnels/bridges that is needed for UpdateSignalsOnSegment. */
2038 DiagDirection dir = VehicleExitDir(v->direction, v->track);
2039 if (IsRailDepotTile(v->tile) || IsTileType(v->tile, MP_TUNNELBRIDGE)) dir = INVALID_DIAGDIR;
2040
2041 if (UpdateSignalsOnSegment(v->tile, dir, v->owner) == SIGSEG_PBS || _settings_game.pf.reserve_paths) {
2042 /* If we are currently on a tile with conventional signals, we can't treat the
2043 * current tile as a safe tile or we would enter a PBS block without a reservation. */
2044 bool first_tile_okay = !(IsTileType(v->tile, MP_RAILWAY) &&
2045 HasSignalOnTrackdir(v->tile, v->GetVehicleTrackdir()) &&
2046 !IsPbsSignal(GetSignalType(v->tile, FindFirstTrack(v->track))));
2047
2048 /* If we are on a depot tile facing outwards, do not treat the current tile as safe. */
2049 if (IsRailDepotTile(v->tile) && TrackdirToExitdir(v->GetVehicleTrackdir()) == GetRailDepotDirection(v->tile)) first_tile_okay = false;
2050
2051 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), true);
2052 if (TryPathReserve(v, false, first_tile_okay)) {
2053 /* Do a look-ahead now in case our current tile was already a safe tile. */
2054 CheckNextTrainTile(v);
2055 } else if (v->current_order.GetType() != OT_LOADING) {
2056 /* Do not wait for a way out when we're still loading */
2057 MarkTrainAsStuck(v);
2058 }
2059 } else if (v->flags.Test(VehicleRailFlag::Stuck)) {
2060 /* A train not inside a PBS block can't be stuck. */
2061 v->flags.Reset(VehicleRailFlag::Stuck);
2062 v->wait_counter = 0;
2063 }
2064}
2065
2073 CommandCost CmdReverseTrainDirection(DoCommandFlags flags, VehicleID veh_id, bool reverse_single_veh)
2074{
2075 Train *v = Train::GetIfValid(veh_id);
2076 if (v == nullptr) return CMD_ERROR;
2077
2078 CommandCost ret = CheckOwnership(v->owner);
2079 if (ret.Failed()) return ret;
2080
2081 if (reverse_single_veh) {
2082 /* turn a single unit around */
2083
2084 if (v->IsMultiheaded() || EngInfo(v->engine_type)->callback_mask.Test(VehicleCallbackMask::ArticEngine)) {
2085 return CommandCost(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE_MULTIPLE_UNITS);
2086 }
2087
2088 Train *front = v->First();
2089 /* make sure the vehicle is stopped in the depot */
2090 if (!front->IsStoppedInDepot()) {
2091 return CommandCost(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT);
2092 }
2093
2094 if (flags.Test(DoCommandFlag::Execute)) {
2095 v->flags.Flip(VehicleRailFlag::Flipped);
2096
2097 front->ConsistChanged(CCF_ARRANGE);
2098 SetWindowDirty(WC_VEHICLE_DEPOT, front->tile);
2099 SetWindowDirty(WC_VEHICLE_DETAILS, front->index);
2100 SetWindowDirty(WC_VEHICLE_VIEW, front->index);
2101 SetWindowClassesDirty(WC_TRAINS_LIST);
2102 }
2103 } else {
2104 /* turn the whole train around */
2105 if (!v->IsPrimaryVehicle()) return CMD_ERROR;
2106 if (v->vehstatus.Test(VehState::Crashed) || v->breakdown_ctr != 0) return CMD_ERROR;
2107
2108 if (flags.Test(DoCommandFlag::Execute)) {
2109 /* Properly leave the station if we are loading and won't be loading anymore */
2110 if (v->current_order.IsType(OT_LOADING)) {
2111 const Vehicle *last = v;
2112 while (last->Next() != nullptr) last = last->Next();
2113
2114 /* not a station || different station --> leave the station */
2115 if (!IsTileType(last->tile, MP_STATION) || GetStationIndex(last->tile) != GetStationIndex(v->tile)) {
2116 v->LeaveStation();
2117 }
2118 }
2119
2120 /* We cancel any 'skip signal at dangers' here */
2121 v->force_proceed = TFP_NONE;
2122 SetWindowDirty(WC_VEHICLE_VIEW, v->index);
2123
2124 if (_settings_game.vehicle.train_acceleration_model != AM_ORIGINAL && v->cur_speed != 0) {
2125 v->flags.Flip(VehicleRailFlag::Reversing);
2126 } else {
2127 v->cur_speed = 0;
2128 v->SetLastSpeed();
2129 HideFillingPercent(&v->fill_percent_te_id);
2130 ReverseTrainDirection(v);
2131 }
2132
2133 /* Unbunching data is no longer valid. */
2134 v->ResetDepotUnbunching();
2135 }
2136 }
2137 return CommandCost();
2138}
2139
2150 static TrainForceProceeding DetermineNextTrainForceProceeding(const Train *t)
2151{
2152 if (t->vehstatus.Test(VehState::Crashed) || t->force_proceed == TFP_SIGNAL) return TFP_NONE;
2153 if (!t->flags.Test(VehicleRailFlag::Stuck)) return t->IsChainInDepot() ? TFP_STUCK : TFP_SIGNAL;
2154
2155 TileIndex next_tile = TileAddByDiagDir(t->tile, TrackdirToExitdir(t->GetVehicleTrackdir()));
2156 if (next_tile == INVALID_TILE || !IsTileType(next_tile, MP_RAILWAY) || !HasSignals(next_tile)) return TFP_STUCK;
2157 TrackBits new_tracks = DiagdirReachesTracks(TrackdirToExitdir(t->GetVehicleTrackdir())) & GetTrackBits(next_tile);
2158 return new_tracks != TRACK_BIT_NONE && HasSignalOnTrack(next_tile, FindFirstTrack(new_tracks)) ? TFP_SIGNAL : TFP_STUCK;
2159}
2160
2167 CommandCost CmdForceTrainProceed(DoCommandFlags flags, VehicleID veh_id)
2168{
2169 Train *t = Train::GetIfValid(veh_id);
2170 if (t == nullptr) return CMD_ERROR;
2171
2172 if (!t->IsPrimaryVehicle()) return CMD_ERROR;
2173
2174 CommandCost ret = CheckOwnership(t->owner);
2175 if (ret.Failed()) return ret;
2176
2177
2178 if (flags.Test(DoCommandFlag::Execute)) {
2179 t->force_proceed = DetermineNextTrainForceProceeding(t);
2180 SetWindowDirty(WC_VEHICLE_VIEW, t->index);
2181
2182 /* Unbunching data is no longer valid. */
2183 t->ResetDepotUnbunching();
2184 }
2185
2186 return CommandCost();
2187}
2188
2196 static FindDepotData FindClosestTrainDepot(Train *v, int max_distance)
2197{
2198 assert(!v->vehstatus.Test(VehState::Crashed));
2199
2200 return YapfTrainFindNearestDepot(v, max_distance);
2201}
2202
2203 ClosestDepot Train::FindClosestDepot()
2204{
2205 FindDepotData tfdd = FindClosestTrainDepot(this, 0);
2206 if (tfdd.best_length == UINT_MAX) return ClosestDepot();
2207
2208 return ClosestDepot(tfdd.tile, GetDepotIndex(tfdd.tile), tfdd.reverse);
2209}
2210
2212 void Train::PlayLeaveStationSound(bool force) const
2213{
2214 static const SoundFx sfx[] = {
2215 SND_04_DEPARTURE_STEAM,
2216 SND_0A_DEPARTURE_TRAIN,
2217 SND_0A_DEPARTURE_TRAIN,
2218 SND_47_DEPARTURE_MONORAIL,
2219 SND_41_DEPARTURE_MAGLEV
2220 };
2221
2222 if (PlayVehicleSound(this, VSE_START, force)) return;
2223
2224 SndPlayVehicleFx(sfx[RailVehInfo(this->engine_type)->engclass], this);
2225}
2226
2231 static void CheckNextTrainTile(Train *v)
2232{
2233 /* Don't do any look-ahead if path_backoff_interval is 255. */
2234 if (_settings_game.pf.path_backoff_interval == 255) return;
2235
2236 /* Exit if we are inside a depot. */
2237 if (v->track == TRACK_BIT_DEPOT) return;
2238
2239 switch (v->current_order.GetType()) {
2240 /* Exit if we reached our destination depot. */
2241 case OT_GOTO_DEPOT:
2242 if (v->tile == v->dest_tile) return;
2243 break;
2244
2245 case OT_GOTO_WAYPOINT:
2246 /* If we reached our waypoint, make sure we see that. */
2247 if (IsRailWaypointTile(v->tile) && GetStationIndex(v->tile) == v->current_order.GetDestination()) ProcessOrders(v);
2248 break;
2249
2250 case OT_NOTHING:
2251 case OT_LEAVESTATION:
2252 case OT_LOADING:
2253 /* Exit if the current order doesn't have a destination, but the train has orders. */
2254 if (v->GetNumOrders() > 0) return;
2255 break;
2256
2257 default:
2258 break;
2259 }
2260 /* Exit if we are on a station tile and are going to stop. */
2261 if (IsRailStationTile(v->tile) && v->current_order.ShouldStopAtStation(v, GetStationIndex(v->tile))) return;
2262
2263 Trackdir td = v->GetVehicleTrackdir();
2264
2265 /* On a tile with a red non-pbs signal, don't look ahead. */
2266 if (IsTileType(v->tile, MP_RAILWAY) && HasSignalOnTrackdir(v->tile, td) &&
2267 !IsPbsSignal(GetSignalType(v->tile, TrackdirToTrack(td))) &&
2268 GetSignalStateByTrackdir(v->tile, td) == SIGNAL_STATE_RED) return;
2269
2270 CFollowTrackRail ft(v);
2271 if (!ft.Follow(v->tile, td)) return;
2272
2273 if (!HasReservedTracks(ft.new_tile, TrackdirBitsToTrackBits(ft.new_td_bits))) {
2274 /* Next tile is not reserved. */
2275 if (KillFirstBit(ft.new_td_bits) == TRACKDIR_BIT_NONE) {
2276 if (HasPbsSignalOnTrackdir(ft.new_tile, FindFirstTrackdir(ft.new_td_bits))) {
2277 /* If the next tile is a PBS signal, try to make a reservation. */
2278 TrackBits tracks = TrackdirBitsToTrackBits(ft.new_td_bits);
2279 if (Rail90DegTurnDisallowed(GetTileRailType(ft.old_tile), GetTileRailType(ft.new_tile))) {
2280 tracks &= ~TrackCrossesTracks(TrackdirToTrack(ft.old_td));
2281 }
2282 ChooseTrainTrack(v, ft.new_tile, ft.exitdir, tracks, false, nullptr, false);
2283 }
2284 }
2285 }
2286}
2287
2293 static bool CheckTrainStayInDepot(Train *v)
2294{
2295 /* bail out if not all wagons are in the same depot or not in a depot at all */
2296 for (const Train *u = v; u != nullptr; u = u->Next()) {
2297 if (u->track != TRACK_BIT_DEPOT || u->tile != v->tile) return false;
2298 }
2299
2300 /* if the train got no power, then keep it in the depot */
2301 if (v->gcache.cached_power == 0) {
2302 v->vehstatus.Set(VehState::Stopped);
2303 SetWindowDirty(WC_VEHICLE_DEPOT, v->tile);
2304 return true;
2305 }
2306
2307 /* Check if we should wait here for unbunching. */
2308 if (v->IsWaitingForUnbunching()) return true;
2309
2310 SigSegState seg_state;
2311
2312 if (v->force_proceed == TFP_NONE) {
2313 /* force proceed was not pressed */
2314 if (++v->wait_counter < 37) {
2315 SetWindowClassesDirty(WC_TRAINS_LIST);
2316 return true;
2317 }
2318
2319 v->wait_counter = 0;
2320
2321 seg_state = _settings_game.pf.reserve_paths ? SIGSEG_PBS : UpdateSignalsOnSegment(v->tile, INVALID_DIAGDIR, v->owner);
2322 if (seg_state == SIGSEG_FULL || HasDepotReservation(v->tile)) {
2323 /* Full and no PBS signal in block or depot reserved, can't exit. */
2324 SetWindowClassesDirty(WC_TRAINS_LIST);
2325 return true;
2326 }
2327 } else {
2328 seg_state = _settings_game.pf.reserve_paths ? SIGSEG_PBS : UpdateSignalsOnSegment(v->tile, INVALID_DIAGDIR, v->owner);
2329 }
2330
2331 /* We are leaving a depot, but have to go to the exact same one; re-enter. */
2332 if (v->current_order.IsType(OT_GOTO_DEPOT) && v->tile == v->dest_tile) {
2333 /* Service when depot has no reservation. */
2334 if (!HasDepotReservation(v->tile)) VehicleEnterDepot(v);
2335 return true;
2336 }
2337
2338 /* Only leave when we can reserve a path to our destination. */
2339 if (seg_state == SIGSEG_PBS && !TryPathReserve(v) && v->force_proceed == TFP_NONE) {
2340 /* No path and no force proceed. */
2341 SetWindowClassesDirty(WC_TRAINS_LIST);
2342 MarkTrainAsStuck(v);
2343 return true;
2344 }
2345
2346 SetDepotReservation(v->tile, true);
2347 if (_settings_client.gui.show_track_reservation) MarkTileDirtyByTile(v->tile);
2348
2349 VehicleServiceInDepot(v);
2350 v->LeaveUnbunchingDepot();
2351 v->PlayLeaveStationSound();
2352 SetWindowClassesDirty(WC_TRAINS_LIST);
2353
2354 v->track = TRACK_BIT_X;
2355 if (v->direction & 2) v->track = TRACK_BIT_Y;
2356
2357 v->vehstatus.Reset(VehState::Hidden);
2358 v->cur_speed = 0;
2359
2360 v->UpdateViewport(true, true);
2361 v->UpdatePosition();
2362 UpdateSignalsOnSegment(v->tile, INVALID_DIAGDIR, v->owner);
2363 v->UpdateAcceleration();
2364 InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
2365
2366 return false;
2367}
2368
2375 static void ClearPathReservation(const Train *v, TileIndex tile, Trackdir track_dir)
2376{
2377 DiagDirection dir = TrackdirToExitdir(track_dir);
2378
2379 if (IsTileType(tile, MP_TUNNELBRIDGE)) {
2380 /* Are we just leaving a tunnel/bridge? */
2381 if (GetTunnelBridgeDirection(tile) == ReverseDiagDir(dir)) {
2382 TileIndex end = GetOtherTunnelBridgeEnd(tile);
2383
2384 if (TunnelBridgeIsFree(tile, end, v).Succeeded()) {
2385 /* Free the reservation only if no other train is on the tiles. */
2386 SetTunnelBridgeReservation(tile, false);
2387 SetTunnelBridgeReservation(end, false);
2388
2389 if (_settings_client.gui.show_track_reservation) {
2390 if (IsBridge(tile)) {
2391 MarkBridgeDirty(tile);
2392 } else {
2393 MarkTileDirtyByTile(tile);
2394 MarkTileDirtyByTile(end);
2395 }
2396 }
2397 }
2398 }
2399 } else if (IsRailStationTile(tile)) {
2400 TileIndex new_tile = TileAddByDiagDir(tile, dir);
2401 /* If the new tile is not a further tile of the same station, we
2402 * clear the reservation for the whole platform. */
2403 if (!IsCompatibleTrainStationTile(new_tile, tile)) {
2404 SetRailStationPlatformReservation(tile, ReverseDiagDir(dir), false);
2405 }
2406 } else {
2407 /* Any other tile */
2408 UnreserveRailTrack(tile, TrackdirToTrack(track_dir));
2409 }
2410}
2411
2416 void FreeTrainTrackReservation(const Train *v)
2417{
2418 assert(v->IsFrontEngine());
2419
2420 TileIndex tile = v->tile;
2421 Trackdir td = v->GetVehicleTrackdir();
2422 bool free_tile = !(IsRailStationTile(v->tile) || IsTileType(v->tile, MP_TUNNELBRIDGE));
2423 StationID station_id = IsRailStationTile(v->tile) ? GetStationIndex(v->tile) : StationID::Invalid();
2424
2425 /* Can't be holding a reservation if we enter a depot. */
2426 if (IsRailDepotTile(tile) && TrackdirToExitdir(td) != GetRailDepotDirection(tile)) return;
2427 if (v->track == TRACK_BIT_DEPOT) {
2428 /* Front engine is in a depot. We enter if some part is not in the depot. */
2429 for (const Train *u = v; u != nullptr; u = u->Next()) {
2430 if (u->track != TRACK_BIT_DEPOT || u->tile != v->tile) return;
2431 }
2432 }
2433 /* Don't free reservation if it's not ours. */
2434 if (TracksOverlap(GetReservedTrackbits(tile) | TrackToTrackBits(TrackdirToTrack(td)))) return;
2435
2436 CFollowTrackRail ft(v, GetAllCompatibleRailTypes(v->railtypes));
2437 while (ft.Follow(tile, td)) {
2438 tile = ft.new_tile;
2439 TrackdirBits bits = ft.new_td_bits & TrackBitsToTrackdirBits(GetReservedTrackbits(tile));
2440 td = RemoveFirstTrackdir(&bits);
2441 assert(bits == TRACKDIR_BIT_NONE);
2442
2443 if (!IsValidTrackdir(td)) break;
2444
2445 if (IsTileType(tile, MP_RAILWAY)) {
2446 if (HasSignalOnTrackdir(tile, td) && !IsPbsSignal(GetSignalType(tile, TrackdirToTrack(td)))) {
2447 /* Conventional signal along trackdir: remove reservation and stop. */
2448 UnreserveRailTrack(tile, TrackdirToTrack(td));
2449 break;
2450 }
2451 if (HasPbsSignalOnTrackdir(tile, td)) {
2452 if (GetSignalStateByTrackdir(tile, td) == SIGNAL_STATE_RED) {
2453 /* Red PBS signal? Can't be our reservation, would be green then. */
2454 break;
2455 } else {
2456 /* Turn the signal back to red. */
2457 SetSignalStateByTrackdir(tile, td, SIGNAL_STATE_RED);
2458 MarkTileDirtyByTile(tile);
2459 }
2460 } else if (HasPbsSignalOnTrackdir(tile, ReverseTrackdir(td))) {
2461 /* Reservation passes an opposing path signal. Mark signal for update to re-establish the proper default state. */
2462 AddSideToSignalBuffer(tile, TrackdirToExitdir(ReverseTrackdir(td)), v->owner);
2463 } else if (HasSignalOnTrackdir(tile, ReverseTrackdir(td)) && IsOnewaySignal(tile, TrackdirToTrack(td))) {
2464 break;
2465 }
2466 }
2467
2468 /* Don't free first station/bridge/tunnel if we are on it. */
2469 if (free_tile || (!(ft.is_station && GetStationIndex(ft.new_tile) == station_id) && !ft.is_tunnel && !ft.is_bridge)) ClearPathReservation(v, tile, td);
2470
2471 free_tile = true;
2472 }
2473
2474 UpdateSignalsInBuffer();
2475}
2476
2477static const uint8_t _initial_tile_subcoord[6][4][3] = {
2478{{ 15, 8, 1 }, { 0, 0, 0 }, { 0, 8, 5 }, { 0, 0, 0 }},
2479{{ 0, 0, 0 }, { 8, 0, 3 }, { 0, 0, 0 }, { 8, 15, 7 }},
2480{{ 0, 0, 0 }, { 7, 0, 2 }, { 0, 7, 6 }, { 0, 0, 0 }},
2481{{ 15, 8, 2 }, { 0, 0, 0 }, { 0, 0, 0 }, { 8, 15, 6 }},
2482{{ 15, 7, 0 }, { 8, 0, 4 }, { 0, 0, 0 }, { 0, 0, 0 }},
2483{{ 0, 0, 0 }, { 0, 0, 0 }, { 0, 8, 4 }, { 7, 15, 0 }},
2484};
2485
2499 static Track DoTrainPathfind(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool do_track_reservation, PBSTileInfo *dest, TileIndex *final_dest)
2500{
2501 if (final_dest != nullptr) *final_dest = INVALID_TILE;
2502 return YapfTrainChooseTrack(v, tile, enterdir, tracks, path_found, do_track_reservation, dest, final_dest);
2503}
2504
2510 static PBSTileInfo ExtendTrainReservation(const Train *v, TrackBits *new_tracks, DiagDirection *enterdir)
2511{
2512 PBSTileInfo origin = FollowTrainReservation(v);
2513
2514 CFollowTrackRail ft(v);
2515
2516 std::vector<std::pair<TileIndex, Trackdir>> signals_set_to_red;
2517
2518 TileIndex tile = origin.tile;
2519 Trackdir cur_td = origin.trackdir;
2520 while (ft.Follow(tile, cur_td)) {
2521 if (KillFirstBit(ft.new_td_bits) == TRACKDIR_BIT_NONE) {
2522 /* Possible signal tile. */
2523 if (HasOnewaySignalBlockingTrackdir(ft.new_tile, FindFirstTrackdir(ft.new_td_bits))) break;
2524 }
2525
2526 if (Rail90DegTurnDisallowed(GetTileRailType(ft.old_tile), GetTileRailType(ft.new_tile))) {
2527 ft.new_td_bits &= ~TrackdirCrossesTrackdirs(ft.old_td);
2528 if (ft.new_td_bits == TRACKDIR_BIT_NONE) break;
2529 }
2530
2531 /* Station, depot or waypoint are a possible target. */
2532 bool target_seen = ft.is_station || (IsTileType(ft.new_tile, MP_RAILWAY) && !IsPlainRail(ft.new_tile));
2533 if (target_seen || KillFirstBit(ft.new_td_bits) != TRACKDIR_BIT_NONE) {
2534 /* Choice found or possible target encountered.
2535 * On finding a possible target, we need to stop and let the pathfinder handle the
2536 * remaining path. This is because we don't know if this target is in one of our
2537 * orders, so we might cause pathfinding to fail later on if we find a choice.
2538 * This failure would cause a bogous call to TryReserveSafePath which might reserve
2539 * a wrong path not leading to our next destination. */
2540 if (HasReservedTracks(ft.new_tile, TrackdirBitsToTrackBits(TrackdirReachesTrackdirs(ft.old_td)))) break;
2541
2542 /* If we did skip some tiles, backtrack to the first skipped tile so the pathfinder
2543 * actually starts its search at the first unreserved tile. */
2544 if (ft.tiles_skipped != 0) ft.new_tile -= TileOffsByDiagDir(ft.exitdir) * ft.tiles_skipped;
2545
2546 /* Choice found, path valid but not okay. Save info about the choice tile as well. */
2547 if (new_tracks != nullptr) *new_tracks = TrackdirBitsToTrackBits(ft.new_td_bits);
2548 if (enterdir != nullptr) *enterdir = ft.exitdir;
2549 return PBSTileInfo(ft.new_tile, ft.old_td, false);
2550 }
2551
2552 tile = ft.new_tile;
2553 cur_td = FindFirstTrackdir(ft.new_td_bits);
2554
2555 Trackdir rev_td = ReverseTrackdir(cur_td);
2556 if (IsSafeWaitingPosition(v, tile, cur_td, true, _settings_game.pf.forbid_90_deg)) {
2557 bool wp_free = IsWaitingPositionFree(v, tile, cur_td, _settings_game.pf.forbid_90_deg);
2558 if (!(wp_free && TryReserveRailTrack(tile, TrackdirToTrack(cur_td)))) break;
2559 /* Green path signal opposing the path? Turn to red. */
2560 if (HasPbsSignalOnTrackdir(tile, rev_td) && GetSignalStateByTrackdir(tile, rev_td) == SIGNAL_STATE_GREEN) {
2561 signals_set_to_red.emplace_back(tile, rev_td);
2562 SetSignalStateByTrackdir(tile, rev_td, SIGNAL_STATE_RED);
2563 MarkTileDirtyByTile(tile);
2564 }
2565 /* Safe position is all good, path valid and okay. */
2566 return PBSTileInfo(tile, cur_td, true);
2567 }
2568
2569 if (!TryReserveRailTrack(tile, TrackdirToTrack(cur_td))) break;
2570
2571 /* Green path signal opposing the path? Turn to red. */
2572 if (HasPbsSignalOnTrackdir(tile, rev_td) && GetSignalStateByTrackdir(tile, rev_td) == SIGNAL_STATE_GREEN) {
2573 signals_set_to_red.emplace_back(tile, rev_td);
2574 SetSignalStateByTrackdir(tile, rev_td, SIGNAL_STATE_RED);
2575 MarkTileDirtyByTile(tile);
2576 }
2577 }
2578
2579 if (ft.err == CFollowTrackRail::EC_OWNER || ft.err == CFollowTrackRail::EC_NO_WAY) {
2580 /* End of line, path valid and okay. */
2581 return PBSTileInfo(ft.old_tile, ft.old_td, true);
2582 }
2583
2584 /* Sorry, can't reserve path, back out. */
2585 tile = origin.tile;
2586 cur_td = origin.trackdir;
2587 TileIndex stopped = ft.old_tile;
2588 Trackdir stopped_td = ft.old_td;
2589 while (tile != stopped || cur_td != stopped_td) {
2590 if (!ft.Follow(tile, cur_td)) break;
2591
2592 if (Rail90DegTurnDisallowed(GetTileRailType(ft.old_tile), GetTileRailType(ft.new_tile))) {
2593 ft.new_td_bits &= ~TrackdirCrossesTrackdirs(ft.old_td);
2594 assert(ft.new_td_bits != TRACKDIR_BIT_NONE);
2595 }
2596 assert(KillFirstBit(ft.new_td_bits) == TRACKDIR_BIT_NONE);
2597
2598 tile = ft.new_tile;
2599 cur_td = FindFirstTrackdir(ft.new_td_bits);
2600
2601 UnreserveRailTrack(tile, TrackdirToTrack(cur_td));
2602 }
2603
2604 /* Re-instate green signals we turned to red. */
2605 for (auto [sig_tile, td] : signals_set_to_red) {
2606 SetSignalStateByTrackdir(sig_tile, td, SIGNAL_STATE_GREEN);
2607 }
2608
2609 /* Path invalid. */
2610 return PBSTileInfo();
2611}
2612
2623 static bool TryReserveSafeTrack(const Train *v, TileIndex tile, Trackdir td, bool override_railtype)
2624{
2625 return YapfTrainFindNearestSafeTile(v, tile, td, override_railtype);
2626}
2627
2629 class VehicleOrderSaver {
2630private:
2631 Train *v;
2632 Order old_order;
2633 TileIndex old_dest_tile;
2634 StationID old_last_station_visited;
2635 VehicleOrderID index;
2636 bool suppress_implicit_orders;
2637 bool restored;
2638
2639public:
2640 VehicleOrderSaver(Train *_v) :
2641 v(_v),
2642 old_order(_v->current_order),
2643 old_dest_tile(_v->dest_tile),
2644 old_last_station_visited(_v->last_station_visited),
2645 index(_v->cur_real_order_index),
2646 suppress_implicit_orders(HasBit(_v->gv_flags, GVF_SUPPRESS_IMPLICIT_ORDERS)),
2647 restored(false)
2648 {
2649 }
2650
2654 void Restore()
2655 {
2656 this->v->current_order = this->old_order;
2657 this->v->dest_tile = this->old_dest_tile;
2658 this->v->last_station_visited = this->old_last_station_visited;
2659 AssignBit(this->v->gv_flags, GVF_SUPPRESS_IMPLICIT_ORDERS, suppress_implicit_orders);
2660 this->restored = true;
2661 }
2662
2666 ~VehicleOrderSaver()
2667 {
2668 if (!this->restored) this->Restore();
2669 }
2670
2676 bool SwitchToNextOrder(bool skip_first)
2677 {
2678 if (this->v->GetNumOrders() == 0) return false;
2679
2680 if (skip_first) ++this->index;
2681
2682 int depth = 0;
2683
2684 do {
2685 /* Wrap around. */
2686 if (this->index >= this->v->GetNumOrders()) this->index = 0;
2687
2688 Order *order = this->v->GetOrder(this->index);
2689 assert(order != nullptr);
2690
2691 switch (order->GetType()) {
2692 case OT_GOTO_DEPOT:
2693 /* Skip service in depot orders when the train doesn't need service. */
2694 if (order->GetDepotOrderType().Test(OrderDepotTypeFlag::Service) && !this->v->NeedsServicing()) break;
2695 [[fallthrough]];
2696 case OT_GOTO_STATION:
2697 case OT_GOTO_WAYPOINT:
2698 this->v->current_order = *order;
2699 return UpdateOrderDest(this->v, order, 0, true);
2700 case OT_CONDITIONAL: {
2701 VehicleOrderID next = ProcessConditionalOrder(order, this->v);
2702 if (next != INVALID_VEH_ORDER_ID) {
2703 depth++;
2704 this->index = next;
2705 /* Don't increment next, so no break here. */
2706 continue;
2707 }
2708 break;
2709 }
2710 default:
2711 break;
2712 }
2713 /* Don't increment inside the while because otherwise conditional
2714 * orders can lead to an infinite loop. */
2715 ++this->index;
2716 depth++;
2717 } while (this->index != this->v->cur_real_order_index && depth < this->v->GetNumOrders());
2718
2719 return false;
2720 }
2721};
2722
2723/* choose a track */
2724static Track ChooseTrainTrack(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool force_res, bool *got_reservation, bool mark_stuck)
2725{
2726 Track best_track = INVALID_TRACK;
2727 bool do_track_reservation = _settings_game.pf.reserve_paths || force_res;
2728 bool changed_signal = false;
2729 TileIndex final_dest = INVALID_TILE;
2730
2731 assert((tracks & ~TRACK_BIT_MASK) == 0);
2732
2733 if (got_reservation != nullptr) *got_reservation = false;
2734
2735 /* Don't use tracks here as the setting to forbid 90 deg turns might have been switched between reservation and now. */
2736 TrackBits res_tracks = (TrackBits)(GetReservedTrackbits(tile) & DiagdirReachesTracks(enterdir));
2737 /* Do we have a suitable reserved track? */
2738 if (res_tracks != TRACK_BIT_NONE) return FindFirstTrack(res_tracks);
2739
2740 /* Quick return in case only one possible track is available */
2741 if (KillFirstBit(tracks) == TRACK_BIT_NONE) {
2742 Track track = FindFirstTrack(tracks);
2743 /* We need to check for signals only here, as a junction tile can't have signals. */
2744 if (track != INVALID_TRACK && HasPbsSignalOnTrackdir(tile, TrackEnterdirToTrackdir(track, enterdir))) {
2745 do_track_reservation = true;
2746 changed_signal = true;
2747 SetSignalStateByTrackdir(tile, TrackEnterdirToTrackdir(track, enterdir), SIGNAL_STATE_GREEN);
2748 } else if (!do_track_reservation) {
2749 return track;
2750 }
2751 best_track = track;
2752 }
2753
2754 PBSTileInfo res_dest(tile, INVALID_TRACKDIR, false);
2755 DiagDirection dest_enterdir = enterdir;
2756 if (do_track_reservation) {
2757 res_dest = ExtendTrainReservation(v, &tracks, &dest_enterdir);
2758 if (res_dest.tile == INVALID_TILE) {
2759 /* Reservation failed? */
2760 if (mark_stuck) MarkTrainAsStuck(v);
2761 if (changed_signal) SetSignalStateByTrackdir(tile, TrackEnterdirToTrackdir(best_track, enterdir), SIGNAL_STATE_RED);
2762 return FindFirstTrack(tracks);
2763 }
2764 if (res_dest.okay) {
2765 /* Got a valid reservation that ends at a safe target, quick exit. */
2766 if (got_reservation != nullptr) *got_reservation = true;
2767 if (changed_signal) MarkTileDirtyByTile(tile);
2768 TryReserveRailTrack(v->tile, TrackdirToTrack(v->GetVehicleTrackdir()));
2769 return best_track;
2770 }
2771
2772 /* Check if the train needs service here, so it has a chance to always find a depot.
2773 * Also check if the current order is a service order so we don't reserve a path to
2774 * the destination but instead to the next one if service isn't needed. */
2775 CheckIfTrainNeedsService(v);
2776 if (v->current_order.IsType(OT_DUMMY) || v->current_order.IsType(OT_CONDITIONAL) || v->current_order.IsType(OT_GOTO_DEPOT)) ProcessOrders(v);
2777 }
2778
2779 /* Save the current train order. The destructor will restore the old order on function exit. */
2780 VehicleOrderSaver orders(v);
2781
2782 /* If the current tile is the destination of the current order and
2783 * a reservation was requested, advance to the next order.
2784 * Don't advance on a depot order as depots are always safe end points
2785 * for a path and no look-ahead is necessary. This also avoids a
2786 * problem with depot orders not part of the order list when the
2787 * order list itself is empty. */
2788 if (v->current_order.IsType(OT_LEAVESTATION)) {
2789 orders.SwitchToNextOrder(false);
2790 } else if (v->current_order.IsType(OT_LOADING) || (!v->current_order.IsType(OT_GOTO_DEPOT) && (
2791 v->current_order.IsType(OT_GOTO_STATION) ?
2792 IsRailStationTile(v->tile) && v->current_order.GetDestination() == GetStationIndex(v->tile) :
2793 v->tile == v->dest_tile))) {
2794 orders.SwitchToNextOrder(true);
2795 }
2796
2797 if (res_dest.tile != INVALID_TILE && !res_dest.okay) {
2798 /* Pathfinders are able to tell that route was only 'guessed'. */
2799 bool path_found = true;
2800 TileIndex new_tile = res_dest.tile;
2801
2802 Track next_track = DoTrainPathfind(v, new_tile, dest_enterdir, tracks, path_found, do_track_reservation, &res_dest, &final_dest);
2803 if (new_tile == tile) best_track = next_track;
2804 v->HandlePathfindingResult(path_found);
2805 }
2806
2807 /* No track reservation requested -> finished. */
2808 if (!do_track_reservation) return best_track;
2809
2810 /* A path was found, but could not be reserved. */
2811 if (res_dest.tile != INVALID_TILE && !res_dest.okay) {
2812 if (mark_stuck) MarkTrainAsStuck(v);
2813 FreeTrainTrackReservation(v);
2814 return best_track;
2815 }
2816
2817 /* No possible reservation target found, we are probably lost. */
2818 if (res_dest.tile == INVALID_TILE) {
2819 /* Try to find any safe destination. */
2820 PBSTileInfo origin = FollowTrainReservation(v);
2821 if (TryReserveSafeTrack(v, origin.tile, origin.trackdir, false)) {
2822 TrackBits res = GetReservedTrackbits(tile) & DiagdirReachesTracks(enterdir);
2823 best_track = FindFirstTrack(res);
2824 TryReserveRailTrack(v->tile, TrackdirToTrack(v->GetVehicleTrackdir()));
2825 if (got_reservation != nullptr) *got_reservation = true;
2826 if (changed_signal) MarkTileDirtyByTile(tile);
2827 } else {
2828 FreeTrainTrackReservation(v);
2829 if (mark_stuck) MarkTrainAsStuck(v);
2830 }
2831 return best_track;
2832 }
2833
2834 if (got_reservation != nullptr) *got_reservation = true;
2835
2836 /* Reservation target found and free, check if it is safe. */
2837 while (!IsSafeWaitingPosition(v, res_dest.tile, res_dest.trackdir, true, _settings_game.pf.forbid_90_deg)) {
2838 /* Extend reservation until we have found a safe position. */
2839 DiagDirection exitdir = TrackdirToExitdir(res_dest.trackdir);
2840 TileIndex next_tile = TileAddByDiagDir(res_dest.tile, exitdir);
2841 TrackBits reachable = TrackdirBitsToTrackBits((TrackdirBits)(GetTileTrackStatus(next_tile, TRANSPORT_RAIL, 0))) & DiagdirReachesTracks(exitdir);
2842 if (Rail90DegTurnDisallowed(GetTileRailType(res_dest.tile), GetTileRailType(next_tile))) {
2843 reachable &= ~TrackCrossesTracks(TrackdirToTrack(res_dest.trackdir));
2844 }
2845
2846 /* Get next order with destination. */
2847 if (orders.SwitchToNextOrder(true)) {
2848 PBSTileInfo cur_dest;
2849 bool path_found;
2850 DoTrainPathfind(v, next_tile, exitdir, reachable, path_found, true, &cur_dest, nullptr);
2851 if (cur_dest.tile != INVALID_TILE) {
2852 res_dest = cur_dest;
2853 if (res_dest.okay) continue;
2854 /* Path found, but could not be reserved. */
2855 FreeTrainTrackReservation(v);
2856 if (mark_stuck) MarkTrainAsStuck(v);
2857 if (got_reservation != nullptr) *got_reservation = false;
2858 changed_signal = false;
2859 break;
2860 }
2861 }
2862 /* No order or no safe position found, try any position. */
2863 if (!TryReserveSafeTrack(v, res_dest.tile, res_dest.trackdir, true)) {
2864 FreeTrainTrackReservation(v);
2865 if (mark_stuck) MarkTrainAsStuck(v);
2866 if (got_reservation != nullptr) *got_reservation = false;
2867 changed_signal = false;
2868 }
2869 break;
2870 }
2871
2872 TryReserveRailTrack(v->tile, TrackdirToTrack(v->GetVehicleTrackdir()));
2873
2874 if (changed_signal) MarkTileDirtyByTile(tile);
2875
2876 orders.Restore();
2877 if (v->current_order.IsType(OT_GOTO_DEPOT) &&
2878 v->current_order.GetDepotActionType().Test(OrderDepotActionFlag::NearestDepot) &&
2879 final_dest != INVALID_TILE && IsRailDepotTile(final_dest)) {
2880 v->current_order.SetDestination(GetDepotIndex(final_dest));
2881 v->dest_tile = final_dest;
2882 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
2883 }
2884
2885 return best_track;
2886}
2887
2896 bool TryPathReserve(Train *v, bool mark_as_stuck, bool first_tile_okay)
2897{
2898 assert(v->IsFrontEngine());
2899
2900 /* We have to handle depots specially as the track follower won't look
2901 * at the depot tile itself but starts from the next tile. If we are still
2902 * inside the depot, a depot reservation can never be ours. */
2903 if (v->track == TRACK_BIT_DEPOT) {
2904 if (HasDepotReservation(v->tile)) {
2905 if (mark_as_stuck) MarkTrainAsStuck(v);
2906 return false;
2907 } else {
2908 /* Depot not reserved, but the next tile might be. */
2909 TileIndex next_tile = TileAddByDiagDir(v->tile, GetRailDepotDirection(v->tile));
2910 if (HasReservedTracks(next_tile, DiagdirReachesTracks(GetRailDepotDirection(v->tile)))) return false;
2911 }
2912 }
2913
2914 Vehicle *other_train = nullptr;
2915 PBSTileInfo origin = FollowTrainReservation(v, &other_train);
2916 /* The path we are driving on is already blocked by some other train.
2917 * This can only happen in certain situations when mixing path and
2918 * block signals or when changing tracks and/or signals.
2919 * Exit here as doing any further reservations will probably just
2920 * make matters worse. */
2921 if (other_train != nullptr && other_train->index != v->index) {
2922 if (mark_as_stuck) MarkTrainAsStuck(v);
2923 return false;
2924 }
2925 /* If we have a reserved path and the path ends at a safe tile, we are finished already. */
2926 if (origin.okay && (v->tile != origin.tile || first_tile_okay)) {
2927 /* Can't be stuck then. */
2928 if (v->flags.Test(VehicleRailFlag::Stuck)) SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
2929 v->flags.Reset(VehicleRailFlag::Stuck);
2930 return true;
2931 }
2932
2933 /* If we are in a depot, tentatively reserve the depot. */
2934 if (v->track == TRACK_BIT_DEPOT) {
2935 SetDepotReservation(v->tile, true);
2936 if (_settings_client.gui.show_track_reservation) MarkTileDirtyByTile(v->tile);
2937 }
2938
2939 DiagDirection exitdir = TrackdirToExitdir(origin.trackdir);
2940 TileIndex new_tile = TileAddByDiagDir(origin.tile, exitdir);
2941 TrackBits reachable = TrackdirBitsToTrackBits(TrackStatusToTrackdirBits(GetTileTrackStatus(new_tile, TRANSPORT_RAIL, 0)) & DiagdirReachesTrackdirs(exitdir));
2942
2943 if (Rail90DegTurnDisallowed(GetTileRailType(origin.tile), GetTileRailType(new_tile))) reachable &= ~TrackCrossesTracks(TrackdirToTrack(origin.trackdir));
2944
2945 bool res_made = false;
2946 ChooseTrainTrack(v, new_tile, exitdir, reachable, true, &res_made, mark_as_stuck);
2947
2948 if (!res_made) {
2949 /* Free the depot reservation as well. */
2950 if (v->track == TRACK_BIT_DEPOT) SetDepotReservation(v->tile, false);
2951 return false;
2952 }
2953
2954 if (v->flags.Test(VehicleRailFlag::Stuck)) {
2955 v->wait_counter = 0;
2956 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
2957 }
2958 v->flags.Reset(VehicleRailFlag::Stuck);
2959 return true;
2960}
2961
2962
2963static bool CheckReverseTrain(const Train *v)
2964{
2965 if (_settings_game.difficulty.line_reverse_mode != 0 ||
2966 v->track == TRACK_BIT_DEPOT || v->track == TRACK_BIT_WORMHOLE ||
2967 !(v->direction & 1)) {
2968 return false;
2969 }
2970
2971 assert(v->track != TRACK_BIT_NONE);
2972
2973 return YapfTrainCheckReverse(v);
2974}
2975
2981 TileIndex Train::GetOrderStationLocation(StationID station)
2982{
2983 if (station == this->last_station_visited) this->last_station_visited = StationID::Invalid();
2984
2985 const Station *st = Station::Get(station);
2986 if (!st->facilities.Test(StationFacility::Train)) {
2987 /* The destination station has no trainstation tiles. */
2988 this->IncrementRealOrderIndex();
2989 return TileIndex{};
2990 }
2991
2992 return st->xy;
2993}
2994
2996 void Train::MarkDirty()
2997{
2998 Train *v = this;
2999 do {
3000 v->colourmap = PAL_NONE;
3001 v->UpdateViewport(true, false);
3002 } while ((v = v->Next()) != nullptr);
3003
3004 /* need to update acceleration and cached values since the goods on the train changed. */
3005 this->CargoChanged();
3006 this->UpdateAcceleration();
3007}
3008
3016 int Train::UpdateSpeed()
3017{
3018 switch (_settings_game.vehicle.train_acceleration_model) {
3019 default: NOT_REACHED();
3020 case AM_ORIGINAL:
3021 return this->DoUpdateSpeed(this->acceleration * (this->GetAccelerationStatus() == AS_BRAKE ? -4 : 2), 0, this->GetCurrentMaxSpeed());
3022
3023 case AM_REALISTIC:
3024 return this->DoUpdateSpeed(this->GetAcceleration(), this->GetAccelerationStatus() == AS_BRAKE ? 0 : 2, this->GetCurrentMaxSpeed());
3025 }
3026}
3027
3033 static void TrainEnterStation(Train *v, StationID station)
3034{
3035 v->last_station_visited = station;
3036
3037 /* check if a train ever visited this station before */
3038 Station *st = Station::Get(station);
3039 if (!(st->had_vehicle_of_type & HVOT_TRAIN)) {
3040 st->had_vehicle_of_type |= HVOT_TRAIN;
3041 AddVehicleNewsItem(
3042 GetEncodedString(STR_NEWS_FIRST_TRAIN_ARRIVAL, st->index),
3043 v->owner == _local_company ? NewsType::ArrivalCompany : NewsType::ArrivalOther,
3044 v->index,
3045 st->index
3046 );
3047 AI::NewEvent(v->owner, new ScriptEventStationFirstVehicle(st->index, v->index));
3048 Game::NewEvent(new ScriptEventStationFirstVehicle(st->index, v->index));
3049 }
3050
3051 v->force_proceed = TFP_NONE;
3052 SetWindowDirty(WC_VEHICLE_VIEW, v->index);
3053
3054 v->BeginLoading();
3055
3056 TriggerStationRandomisation(st, v->tile, StationRandomTrigger::VehicleArrives);
3057 TriggerStationAnimation(st, v->tile, StationAnimationTrigger::VehicleArrives);
3058}
3059
3060/* Check if the vehicle is compatible with the specified tile */
3061static inline bool CheckCompatibleRail(const Train *v, TileIndex tile)
3062{
3063 return IsTileOwner(tile, v->owner) &&
3064 (!v->IsFrontEngine() || v->compatible_railtypes.Test(GetRailType(tile)));
3065}
3066
3068 struct AccelerationSlowdownParams {
3069 uint8_t small_turn;
3070 uint8_t large_turn;
3071 uint8_t z_up;
3072 uint8_t z_down;
3073};
3074
3076 static const AccelerationSlowdownParams _accel_slowdown[] = {
3077 /* normal accel */
3078 {256 / 4, 256 / 2, 256 / 4, 2},
3079 {256 / 4, 256 / 2, 256 / 4, 2},
3080 {0, 256 / 2, 256 / 4, 2},
3081};
3082
3088 static inline void AffectSpeedByZChange(Train *v, int old_z)
3089{
3090 if (old_z == v->z_pos || _settings_game.vehicle.train_acceleration_model != AM_ORIGINAL) return;
3091
3092 const AccelerationSlowdownParams *asp = &_accel_slowdown[static_cast<int>(v->GetAccelerationType())];
3093
3094 if (old_z < v->z_pos) {
3095 v->cur_speed -= (v->cur_speed * asp->z_up >> 8);
3096 } else {
3097 uint16_t spd = v->cur_speed + asp->z_down;
3098 if (spd <= v->gcache.cached_max_track_speed) v->cur_speed = spd;
3099 }
3100}
3101
3102static bool TrainMovedChangeSignals(TileIndex tile, DiagDirection dir)
3103{
3104 if (IsTileType(tile, MP_RAILWAY) &&
3105 GetRailTileType(tile) == RailTileType::Signals) {
3106 TrackdirBits tracks = TrackBitsToTrackdirBits(GetTrackBits(tile)) & DiagdirReachesTrackdirs(dir);
3107 Trackdir trackdir = FindFirstTrackdir(tracks);
3108 if (UpdateSignalsOnSegment(tile, TrackdirToExitdir(trackdir), GetTileOwner(tile)) == SIGSEG_PBS && HasSignalOnTrackdir(tile, trackdir)) {
3109 /* A PBS block with a non-PBS signal facing us? */
3110 if (!IsPbsSignal(GetSignalType(tile, TrackdirToTrack(trackdir)))) return true;
3111 }
3112 }
3113 return false;
3114}
3115
3117 void Train::ReserveTrackUnderConsist() const
3118{
3119 for (const Train *u = this; u != nullptr; u = u->Next()) {
3120 switch (u->track) {
3121 case TRACK_BIT_WORMHOLE:
3122 TryReserveRailTrack(u->tile, DiagDirToDiagTrack(GetTunnelBridgeDirection(u->tile)));
3123 break;
3124 case TRACK_BIT_DEPOT:
3125 break;
3126 default:
3127 TryReserveRailTrack(u->tile, TrackBitsToTrack(u->track));
3128 break;
3129 }
3130 }
3131}
3132
3139uint Train::Crash(bool flooded)
3140{
3141 uint victims = 0;
3142 if (this->IsFrontEngine()) {
3143 victims += 2; // driver
3144
3145 /* Remove the reserved path in front of the train if it is not stuck.
3146 * Also clear all reserved tracks the train is currently on. */
3147 if (!this->flags.Test(VehicleRailFlag::Stuck)) FreeTrainTrackReservation(this);
3148 for (const Train *v = this; v != nullptr; v = v->Next()) {
3149 ClearPathReservation(v, v->tile, v->GetVehicleTrackdir());
3150 if (IsTileType(v->tile, MP_TUNNELBRIDGE)) {
3151 /* ClearPathReservation will not free the wormhole exit
3152 * if the train has just entered the wormhole. */
3153 SetTunnelBridgeReservation(GetOtherTunnelBridgeEnd(v->tile), false);
3154 }
3155 }
3156
3157 /* we may need to update crossing we were approaching,
3158 * but must be updated after the train has been marked crashed */
3159 TileIndex crossing = TrainApproachingCrossingTile(this);
3160 if (crossing != INVALID_TILE) UpdateLevelCrossing(crossing);
3161
3162 /* Remove the loading indicators (if any) */
3163 HideFillingPercent(&this->fill_percent_te_id);
3164 }
3165
3166 victims += this->GroundVehicleBase::Crash(flooded);
3167
3168 this->crash_anim_pos = flooded ? 4000 : 1; // max 4440, disappear pretty fast when flooded
3169 return victims;
3170}
3171
3178 static uint TrainCrashed(Train *v)
3179{
3180 uint victims = 0;
3181
3182 /* do not crash train twice */
3183 if (!v->vehstatus.Test(VehState::Crashed)) {
3184 victims = v->Crash();
3185 AI::NewEvent(v->owner, new ScriptEventVehicleCrashed(v->index, v->tile, ScriptEventVehicleCrashed::CRASH_TRAIN, victims, v->owner));
3186 Game::NewEvent(new ScriptEventVehicleCrashed(v->index, v->tile, ScriptEventVehicleCrashed::CRASH_TRAIN, victims, v->owner));
3187 }
3188
3189 /* Try to re-reserve track under already crashed train too.
3190 * Crash() clears the reservation! */
3191 v->ReserveTrackUnderConsist();
3192
3193 return victims;
3194}
3195
3202 static uint CheckTrainCollision(Vehicle *v, Train *t)
3203{
3204 /* not a train or in depot */
3205 if (v->type != VEH_TRAIN || Train::From(v)->track == TRACK_BIT_DEPOT) return 0;
3206
3207 /* do not crash into trains of another company. */
3208 if (v->owner != t->owner) return 0;
3209
3210 /* get first vehicle now to make most usual checks faster */
3211 Train *coll = Train::From(v)->First();
3212
3213 /* can't collide with own wagons */
3214 if (coll == t) return 0;
3215
3216 int x_diff = v->x_pos - t->x_pos;
3217 int y_diff = v->y_pos - t->y_pos;
3218
3219 /* Do fast calculation to check whether trains are not in close vicinity
3220 * and quickly reject trains distant enough for any collision.
3221 * Differences are shifted by 7, mapping range [-7 .. 8] into [0 .. 15]
3222 * Differences are then ORed and then we check for any higher bits */
3223 uint hash = (y_diff + 7) | (x_diff + 7);
3224 if (hash & ~15) return 0;
3225
3226 /* Slower check using multiplication */
3227 int min_diff = (Train::From(v)->gcache.cached_veh_length + 1) / 2 + (t->gcache.cached_veh_length + 1) / 2 - 1;
3228 if (x_diff * x_diff + y_diff * y_diff > min_diff * min_diff) return 0;
3229
3230 /* Happens when there is a train under bridge next to bridge head */
3231 if (abs(v->z_pos - t->z_pos) > 5) return 0;
3232
3233 /* crash both trains */
3234 return TrainCrashed(t) + TrainCrashed(coll);
3235}
3236
3244 static bool CheckTrainCollision(Train *v)
3245{
3246 /* can't collide in depot */
3247 if (v->track == TRACK_BIT_DEPOT) return false;
3248
3249 assert(v->track == TRACK_BIT_WORMHOLE || TileVirtXY(v->x_pos, v->y_pos) == v->tile);
3250
3251 uint num_victims = 0;
3252
3253 /* find colliding vehicles */
3254 if (v->track == TRACK_BIT_WORMHOLE) {
3255 for (Vehicle *u : VehiclesOnTile(v->tile)) {
3256 num_victims += CheckTrainCollision(u, v);
3257 }
3258 for (Vehicle *u : VehiclesOnTile(GetOtherTunnelBridgeEnd(v->tile))) {
3259 num_victims += CheckTrainCollision(u, v);
3260 }
3261 } else {
3262 for (Vehicle *u : VehiclesNearTileXY(v->x_pos, v->y_pos, 7)) {
3263 num_victims += CheckTrainCollision(u, v);
3264 }
3265 }
3266
3267 /* any dead -> no crash */
3268 if (num_victims == 0) return false;
3269
3270 AddTileNewsItem(GetEncodedString(STR_NEWS_TRAIN_CRASH, num_victims), NewsType::Accident, v->tile);
3271
3272 ModifyStationRatingAround(v->tile, v->owner, -160, 30);
3273 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_13_TRAIN_COLLISION, v);
3274 return true;
3275}
3276
3284 bool TrainController(Train *v, Vehicle *nomove, bool reverse)
3285{
3286 Train *first = v->First();
3287 Train *prev;
3288 bool direction_changed = false; // has direction of any part changed?
3289
3290 /* For every vehicle after and including the given vehicle */
3291 for (prev = v->Previous(); v != nomove; prev = v, v = v->Next()) {
3292 DiagDirection enterdir = DIAGDIR_BEGIN;
3293 bool update_signals_crossing = false; // will we update signals or crossing state?
3294
3295 GetNewVehiclePosResult gp = GetNewVehiclePos(v);
3296 if (v->track != TRACK_BIT_WORMHOLE) {
3297 /* Not inside tunnel */
3298 if (gp.old_tile == gp.new_tile) {
3299 /* Staying in the old tile */
3300 if (v->track == TRACK_BIT_DEPOT) {
3301 /* Inside depot */
3302 gp.x = v->x_pos;
3303 gp.y = v->y_pos;
3304 } else {
3305 /* Not inside depot */
3306
3307 /* Reverse when we are at the end of the track already, do not move to the new position */
3308 if (v->IsFrontEngine() && !TrainCheckIfLineEnds(v, reverse)) return false;
3309
3310 auto vets = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
3311 if (vets.Test(VehicleEnterTileState::CannotEnter)) {
3312 goto invalid_rail;
3313 }
3314 if (vets.Test(VehicleEnterTileState::EnteredStation)) {
3315 /* The new position is the end of the platform */
3316 TrainEnterStation(v, GetStationIndex(gp.new_tile));
3317 }
3318 }
3319 } else {
3320 /* A new tile is about to be entered. */
3321
3322 /* Determine what direction we're entering the new tile from */
3323 enterdir = DiagdirBetweenTiles(gp.old_tile, gp.new_tile);
3324 assert(IsValidDiagDirection(enterdir));
3325
3326 /* Get the status of the tracks in the new tile and mask
3327 * away the bits that aren't reachable. */
3328 TrackStatus ts = GetTileTrackStatus(gp.new_tile, TRANSPORT_RAIL, 0, ReverseDiagDir(enterdir));
3329 TrackdirBits reachable_trackdirs = DiagdirReachesTrackdirs(enterdir);
3330
3331 TrackdirBits trackdirbits = TrackStatusToTrackdirBits(ts) & reachable_trackdirs;
3332 TrackBits red_signals = TrackdirBitsToTrackBits(TrackStatusToRedSignals(ts) & reachable_trackdirs);
3333
3334 TrackBits bits = TrackdirBitsToTrackBits(trackdirbits);
3335 if (Rail90DegTurnDisallowed(GetTileRailType(gp.old_tile), GetTileRailType(gp.new_tile)) && prev == nullptr) {
3336 /* We allow wagons to make 90 deg turns, because forbid_90_deg
3337 * can be switched on halfway a turn */
3338 bits &= ~TrackCrossesTracks(FindFirstTrack(v->track));
3339 }
3340
3341 if (bits == TRACK_BIT_NONE) goto invalid_rail;
3342
3343 /* Check if the new tile constrains tracks that are compatible
3344 * with the current train, if not, bail out. */
3345 if (!CheckCompatibleRail(v, gp.new_tile)) goto invalid_rail;
3346
3347 TrackBits chosen_track;
3348 if (prev == nullptr) {
3349 /* Currently the locomotive is active. Determine which one of the
3350 * available tracks to choose */
3351 chosen_track = TrackToTrackBits(ChooseTrainTrack(v, gp.new_tile, enterdir, bits, false, nullptr, true));
3352 assert(chosen_track & (bits | GetReservedTrackbits(gp.new_tile)));
3353
3354 if (v->force_proceed != TFP_NONE && IsPlainRailTile(gp.new_tile) && HasSignals(gp.new_tile)) {
3355 /* For each signal we find decrease the counter by one.
3356 * We start at two, so the first signal we pass decreases
3357 * this to one, then if we reach the next signal it is
3358 * decreased to zero and we won't pass that new signal. */
3359 Trackdir dir = FindFirstTrackdir(trackdirbits);
3360 if (HasSignalOnTrackdir(gp.new_tile, dir) ||
3361 (HasSignalOnTrackdir(gp.new_tile, ReverseTrackdir(dir)) &&
3362 GetSignalType(gp.new_tile, TrackdirToTrack(dir)) != SIGTYPE_PBS)) {
3363 /* However, we do not want to be stopped by PBS signals
3364 * entered via the back. */
3365 v->force_proceed = (v->force_proceed == TFP_SIGNAL) ? TFP_STUCK : TFP_NONE;
3366 SetWindowDirty(WC_VEHICLE_VIEW, v->index);
3367 }
3368 }
3369
3370 /* Check if it's a red signal and that force proceed is not clicked. */
3371 if ((red_signals & chosen_track) && v->force_proceed == TFP_NONE) {
3372 /* In front of a red signal */
3373 Trackdir i = FindFirstTrackdir(trackdirbits);
3374
3375 /* Don't handle stuck trains here. */
3376 if (v->flags.Test(VehicleRailFlag::Stuck)) return false;
3377
3378 if (!HasSignalOnTrackdir(gp.new_tile, ReverseTrackdir(i))) {
3379 v->cur_speed = 0;
3380 v->subspeed = 0;
3381 v->progress = 255; // make sure that every bit of acceleration will hit the signal again, so speed stays 0.
3382 if (!_settings_game.pf.reverse_at_signals || ++v->wait_counter < _settings_game.pf.wait_oneway_signal * Ticks::DAY_TICKS * 2) return false;
3383 } else if (HasSignalOnTrackdir(gp.new_tile, i)) {
3384 v->cur_speed = 0;
3385 v->subspeed = 0;
3386 v->progress = 255; // make sure that every bit of acceleration will hit the signal again, so speed stays 0.
3387 if (!_settings_game.pf.reverse_at_signals || ++v->wait_counter < _settings_game.pf.wait_twoway_signal * Ticks::DAY_TICKS * 2) {
3388 DiagDirection exitdir = TrackdirToExitdir(i);
3389 TileIndex o_tile = TileAddByDiagDir(gp.new_tile, exitdir);
3390
3391 exitdir = ReverseDiagDir(exitdir);
3392
3393 /* check if a train is waiting on the other side */
3394 if (!HasVehicleOnTile(o_tile, [&exitdir](const Vehicle *u) {
3395 if (u->type != VEH_TRAIN || u->vehstatus.Test(VehState::Crashed)) return false;
3396 const Train *t = Train::From(u);
3397
3398 /* not front engine of a train, inside wormhole or depot, crashed */
3399 if (!t->IsFrontEngine() || !(t->track & TRACK_BIT_MASK)) return false;
3400
3401 if (t->cur_speed > 5 || VehicleExitDir(t->direction, t->track) != exitdir) return false;
3402
3403 return true;
3404 })) return false;
3405 }
3406 }
3407
3408 /* If we would reverse but are currently in a PBS block and
3409 * reversing of stuck trains is disabled, don't reverse.
3410 * This does not apply if the reason for reversing is a one-way
3411 * signal blocking us, because a train would then be stuck forever. */
3412 if (!_settings_game.pf.reverse_at_signals && !HasOnewaySignalBlockingTrackdir(gp.new_tile, i) &&
3413 UpdateSignalsOnSegment(v->tile, enterdir, v->owner) == SIGSEG_PBS) {
3414 v->wait_counter = 0;
3415 return false;
3416 }
3417 goto reverse_train_direction;
3418 } else {
3419 TryReserveRailTrack(gp.new_tile, TrackBitsToTrack(chosen_track), false);
3420 }
3421 } else {
3422 /* The wagon is active, simply follow the prev vehicle. */
3423 if (prev->tile == gp.new_tile) {
3424 /* Choose the same track as prev */
3425 if (prev->track == TRACK_BIT_WORMHOLE) {
3426 /* Vehicles entering tunnels enter the wormhole earlier than for bridges.
3427 * However, just choose the track into the wormhole. */
3428 assert(IsTunnel(prev->tile));
3429 chosen_track = bits;
3430 } else {
3431 chosen_track = prev->track;
3432 }
3433 } else {
3434 /* Choose the track that leads to the tile where prev is.
3435 * This case is active if 'prev' is already on the second next tile, when 'v' just enters the next tile.
3436 * I.e. when the tile between them has only space for a single vehicle like
3437 * 1) horizontal/vertical track tiles and
3438 * 2) some orientations of tunnel entries, where the vehicle is already inside the wormhole at 8/16 from the tile edge.
3439 * Is also the train just reversing, the wagon inside the tunnel is 'on' the tile of the opposite tunnel entry.
3440 */
3441 static const TrackBits _connecting_track[DIAGDIR_END][DIAGDIR_END] = {
3442 {TRACK_BIT_X, TRACK_BIT_LOWER, TRACK_BIT_NONE, TRACK_BIT_LEFT },
3443 {TRACK_BIT_UPPER, TRACK_BIT_Y, TRACK_BIT_LEFT, TRACK_BIT_NONE },
3444 {TRACK_BIT_NONE, TRACK_BIT_RIGHT, TRACK_BIT_X, TRACK_BIT_UPPER},
3445 {TRACK_BIT_RIGHT, TRACK_BIT_NONE, TRACK_BIT_LOWER, TRACK_BIT_Y }
3446 };
3447 DiagDirection exitdir = DiagdirBetweenTiles(gp.new_tile, prev->tile);
3448 assert(IsValidDiagDirection(exitdir));
3449 chosen_track = _connecting_track[enterdir][exitdir];
3450 }
3451 chosen_track &= bits;
3452 }
3453
3454 /* Make sure chosen track is a valid track */
3455 assert(
3456 chosen_track == TRACK_BIT_X || chosen_track == TRACK_BIT_Y ||
3457 chosen_track == TRACK_BIT_UPPER || chosen_track == TRACK_BIT_LOWER ||
3458 chosen_track == TRACK_BIT_LEFT || chosen_track == TRACK_BIT_RIGHT);
3459
3460 /* Update XY to reflect the entrance to the new tile, and select the direction to use */
3461 const uint8_t *b = _initial_tile_subcoord[FindFirstBit(chosen_track)][enterdir];
3462 gp.x = (gp.x & ~0xF) | b[0];
3463 gp.y = (gp.y & ~0xF) | b[1];
3464 Direction chosen_dir = (Direction)b[2];
3465
3466 /* Call the landscape function and tell it that the vehicle entered the tile */
3467 auto vets = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
3468 if (vets.Test(VehicleEnterTileState::CannotEnter)) {
3469 goto invalid_rail;
3470 }
3471
3472 if (!vets.Test(VehicleEnterTileState::EnteredWormhole)) {
3473 Track track = FindFirstTrack(chosen_track);
3474 Trackdir tdir = TrackDirectionToTrackdir(track, chosen_dir);
3475 if (v->IsFrontEngine() && HasPbsSignalOnTrackdir(gp.new_tile, tdir)) {
3476 SetSignalStateByTrackdir(gp.new_tile, tdir, SIGNAL_STATE_RED);
3477 MarkTileDirtyByTile(gp.new_tile);
3478 }
3479
3480 /* Clear any track reservation when the last vehicle leaves the tile */
3481 if (v->Next() == nullptr) ClearPathReservation(v, v->tile, v->GetVehicleTrackdir());
3482
3483 v->tile = gp.new_tile;
3484
3485 if (GetTileRailType(gp.new_tile) != GetTileRailType(gp.old_tile)) {
3486 v->First()->ConsistChanged(CCF_TRACK);
3487 }
3488
3489 v->track = chosen_track;
3490 assert(v->track);
3491 }
3492
3493 /* We need to update signal status, but after the vehicle position hash
3494 * has been updated by UpdateInclination() */
3495 update_signals_crossing = true;
3496
3497 if (chosen_dir != v->direction) {
3498 if (prev == nullptr && _settings_game.vehicle.train_acceleration_model == AM_ORIGINAL) {
3499 const AccelerationSlowdownParams *asp = &_accel_slowdown[static_cast<int>(v->GetAccelerationType())];
3500 DirDiff diff = DirDifference(v->direction, chosen_dir);
3501 v->cur_speed -= (diff == DIRDIFF_45RIGHT || diff == DIRDIFF_45LEFT ? asp->small_turn : asp->large_turn) * v->cur_speed >> 8;
3502 }
3503 direction_changed = true;
3504 v->direction = chosen_dir;
3505 }
3506
3507 if (v->IsFrontEngine()) {
3508 v->wait_counter = 0;
3509
3510 /* If we are approaching a crossing that is reserved, play the sound now. */
3511 TileIndex crossing = TrainApproachingCrossingTile(v);
3512 if (crossing != INVALID_TILE && HasCrossingReservation(crossing) && _settings_client.sound.ambient) SndPlayTileFx(SND_0E_LEVEL_CROSSING, crossing);
3513
3514 /* Always try to extend the reservation when entering a tile. */
3515 CheckNextTrainTile(v);
3516 }
3517
3518 if (vets.Test(VehicleEnterTileState::EnteredStation)) {
3519 /* The new position is the location where we want to stop */
3520 TrainEnterStation(v, GetStationIndex(gp.new_tile));
3521 }
3522 }
3523 } else {
3524 if (IsTileType(gp.new_tile, MP_TUNNELBRIDGE) && VehicleEnterTile(v, gp.new_tile, gp.x, gp.y).Test(VehicleEnterTileState::EnteredWormhole)) {
3525 /* Perform look-ahead on tunnel exit. */
3526 if (v->IsFrontEngine()) {
3527 TryReserveRailTrack(gp.new_tile, DiagDirToDiagTrack(GetTunnelBridgeDirection(gp.new_tile)));
3528 CheckNextTrainTile(v);
3529 }
3530 /* Prevent v->UpdateInclination() being called with wrong parameters.
3531 * This could happen if the train was reversed inside the tunnel/bridge. */
3532 if (gp.old_tile == gp.new_tile) {
3533 gp.old_tile = GetOtherTunnelBridgeEnd(gp.old_tile);
3534 }
3535 } else {
3536 v->x_pos = gp.x;
3537 v->y_pos = gp.y;
3538 v->UpdatePosition();
3539 if (!v->vehstatus.Test(VehState::Hidden)) v->Vehicle::UpdateViewport(true);
3540 continue;
3541 }
3542 }
3543
3544 /* update image of train, as well as delta XY */
3545 v->UpdateDeltaXY();
3546
3547 v->x_pos = gp.x;
3548 v->y_pos = gp.y;
3549 v->UpdatePosition();
3550
3551 /* update the Z position of the vehicle */
3552 int old_z = v->UpdateInclination(gp.new_tile != gp.old_tile, false);
3553
3554 if (prev == nullptr) {
3555 /* This is the first vehicle in the train */
3556 AffectSpeedByZChange(v, old_z);
3557 }
3558
3559 if (update_signals_crossing) {
3560 if (v->IsFrontEngine()) {
3561 if (TrainMovedChangeSignals(gp.new_tile, enterdir)) {
3562 /* We are entering a block with PBS signals right now, but
3563 * not through a PBS signal. This means we don't have a
3564 * reservation right now. As a conventional signal will only
3565 * ever be green if no other train is in the block, getting
3566 * a path should always be possible. If the player built
3567 * such a strange network that it is not possible, the train
3568 * will be marked as stuck and the player has to deal with
3569 * the problem. */
3570 if ((!HasReservedTracks(gp.new_tile, v->track) &&
3571 !TryReserveRailTrack(gp.new_tile, FindFirstTrack(v->track))) ||
3572 !TryPathReserve(v)) {
3573 MarkTrainAsStuck(v);
3574 }
3575 }
3576 }
3577
3578 /* Signals can only change when the first
3579 * (above) or the last vehicle moves. */
3580 if (v->Next() == nullptr) {
3581 TrainMovedChangeSignals(gp.old_tile, ReverseDiagDir(enterdir));
3582 if (IsLevelCrossingTile(gp.old_tile)) UpdateLevelCrossing(gp.old_tile);
3583 }
3584 }
3585
3586 /* Do not check on every tick to save some computing time. */
3587 if (v->IsFrontEngine() && v->tick_counter % _settings_game.pf.path_backoff_interval == 0) CheckNextTrainTile(v);
3588 }
3589
3590 if (direction_changed) first->tcache.cached_max_curve_speed = first->GetCurveSpeedLimit();
3591
3592 return true;
3593
3594invalid_rail:
3595 /* We've reached end of line?? */
3596 if (prev != nullptr) FatalError("Disconnecting train");
3597
3598reverse_train_direction:
3599 if (reverse) {
3600 v->wait_counter = 0;
3601 v->cur_speed = 0;
3602 v->subspeed = 0;
3603 ReverseTrainDirection(v);
3604 }
3605
3606 return false;
3607}
3608
3609static bool IsRailStationPlatformOccupied(TileIndex tile)
3610{
3611 TileIndexDiff delta = TileOffsByAxis(GetRailStationAxis(tile));
3612
3613 for (TileIndex t = tile; IsCompatibleTrainStationTile(t, tile); t -= delta) {
3614 if (HasVehicleOnTile(t, IsTrain)) return true;
3615 }
3616 for (TileIndex t = tile + delta; IsCompatibleTrainStationTile(t, tile); t += delta) {
3617 if (HasVehicleOnTile(t, IsTrain)) return true;
3618 }
3619
3620 return false;
3621}
3622
3630 static void DeleteLastWagon(Train *v)
3631{
3632 Train *first = v->First();
3633
3634 /* Go to the last wagon and delete the link pointing there
3635 * new_last is then the one-before-last wagon, and v the last
3636 * one which will physically be removed */
3637 Train *new_last = v;
3638 for (; v->Next() != nullptr; v = v->Next()) new_last = v;
3639 new_last->SetNext(nullptr);
3640
3641 if (first != v) {
3642 /* Recalculate cached train properties */
3643 first->ConsistChanged(CCF_ARRANGE);
3644 /* Update the depot window if the first vehicle is in depot -
3645 * if v == first, then it is updated in PreDestructor() */
3646 if (first->track == TRACK_BIT_DEPOT) {
3647 SetWindowDirty(WC_VEHICLE_DEPOT, first->tile);
3648 }
3649 v->last_station_visited = first->last_station_visited; // for PreDestructor
3650 }
3651
3652 /* 'v' shouldn't be accessed after it has been deleted */
3653 TrackBits trackbits = v->track;
3654 TileIndex tile = v->tile;
3655 Owner owner = v->owner;
3656
3657 delete v;
3658 v = nullptr; // make sure nobody will try to read 'v' anymore
3659
3660 if (trackbits == TRACK_BIT_WORMHOLE) {
3661 /* Vehicle is inside a wormhole, v->track contains no useful value then. */
3662 trackbits = DiagDirToDiagTrackBits(GetTunnelBridgeDirection(tile));
3663 }
3664
3665 Track track = TrackBitsToTrack(trackbits);
3666 if (HasReservedTracks(tile, trackbits)) {
3667 UnreserveRailTrack(tile, track);
3668
3669 /* If there are still crashed vehicles on the tile, give the track reservation to them */
3670 TrackBits remaining_trackbits = TRACK_BIT_NONE;
3671 for (const Vehicle *u : VehiclesOnTile(tile)) {
3672 if (u->type != VEH_TRAIN || !u->vehstatus.Test(VehState::Crashed)) continue;
3673 TrackBits train_tbits = Train::From(u)->track;
3674 if (train_tbits == TRACK_BIT_WORMHOLE) {
3675 /* Vehicle is inside a wormhole, u->track contains no useful value then. */
3676 remaining_trackbits |= DiagDirToDiagTrackBits(GetTunnelBridgeDirection(u->tile));
3677 } else if (train_tbits != TRACK_BIT_DEPOT) {
3678 remaining_trackbits |= train_tbits;
3679 }
3680 }
3681
3682 /* It is important that these two are the first in the loop, as reservation cannot deal with every trackbit combination */
3683 assert(TRACK_BEGIN == TRACK_X && TRACK_Y == TRACK_BEGIN + 1);
3684 for (Track t : SetTrackBitIterator(remaining_trackbits)) TryReserveRailTrack(tile, t);
3685 }
3686
3687 /* check if the wagon was on a road/rail-crossing */
3688 if (IsLevelCrossingTile(tile)) UpdateLevelCrossing(tile);
3689
3690 if (IsRailStationTile(tile)) {
3691 bool occupied = IsRailStationPlatformOccupied(tile);
3692 DiagDirection dir = AxisToDiagDir(GetRailStationAxis(tile));
3693 SetRailStationPlatformReservation(tile, dir, occupied);
3694 SetRailStationPlatformReservation(tile, ReverseDiagDir(dir), occupied);
3695 }
3696
3697 /* Update signals */
3698 if (IsTileType(tile, MP_TUNNELBRIDGE) || IsRailDepotTile(tile)) {
3699 UpdateSignalsOnSegment(tile, INVALID_DIAGDIR, owner);
3700 } else {
3701 SetSignalsOnBothDir(tile, track, owner);
3702 }
3703}
3704
3709 static void ChangeTrainDirRandomly(Train *v)
3710{
3711 static const DirDiff delta[] = {
3712 DIRDIFF_45LEFT, DIRDIFF_SAME, DIRDIFF_SAME, DIRDIFF_45RIGHT
3713 };
3714
3715 do {
3716 /* We don't need to twist around vehicles if they're not visible */
3717 if (!v->vehstatus.Test(VehState::Hidden)) {
3718 v->direction = ChangeDir(v->direction, delta[GB(Random(), 0, 2)]);
3719 /* Refrain from updating the z position of the vehicle when on
3720 * a bridge, because UpdateInclination() will put the vehicle under
3721 * the bridge in that case */
3722 if (v->track != TRACK_BIT_WORMHOLE) {
3723 v->UpdatePosition();
3724 v->UpdateInclination(false, true);
3725 } else {
3726 v->UpdateViewport(false, true);
3727 }
3728 }
3729 } while ((v = v->Next()) != nullptr);
3730}
3731
3737 static bool HandleCrashedTrain(Train *v)
3738{
3739 int state = ++v->crash_anim_pos;
3740
3741 if (state == 4 && !v->vehstatus.Test(VehState::Hidden)) {
3742 CreateEffectVehicleRel(v, 4, 4, 8, EV_EXPLOSION_LARGE);
3743 }
3744
3745 uint32_t r;
3746 if (state <= 200 && Chance16R(1, 7, r)) {
3747 int index = (r * 10 >> 16);
3748
3749 Vehicle *u = v;
3750 do {
3751 if (--index < 0) {
3752 r = Random();
3753
3754 CreateEffectVehicleRel(u,
3755 GB(r, 8, 3) + 2,
3756 GB(r, 16, 3) + 2,
3757 GB(r, 0, 3) + 5,
3758 EV_EXPLOSION_SMALL);
3759 break;
3760 }
3761 } while ((u = u->Next()) != nullptr);
3762 }
3763
3764 if (state <= 240 && !(v->tick_counter & 3)) ChangeTrainDirRandomly(v);
3765
3766 if (state >= 4440 && !(v->tick_counter & 0x1F)) {
3767 bool ret = v->Next() != nullptr;
3768 DeleteLastWagon(v);
3769 return ret;
3770 }
3771
3772 return true;
3773}
3774
3776 static const uint16_t _breakdown_speeds[16] = {
3777 225, 210, 195, 180, 165, 150, 135, 120, 105, 90, 75, 60, 45, 30, 15, 15
3778};
3779
3780
3789 static bool TrainApproachingLineEnd(Train *v, bool signal, bool reverse)
3790{
3791 /* Calc position within the current tile */
3792 uint x = v->x_pos & 0xF;
3793 uint y = v->y_pos & 0xF;
3794
3795 /* for diagonal directions, 'x' will be 0..15 -
3796 * for other directions, it will be 1, 3, 5, ..., 15 */
3797 switch (v->direction) {
3798 case DIR_N : x = ~x + ~y + 25; break;
3799 case DIR_NW: x = y; [[fallthrough]];
3800 case DIR_NE: x = ~x + 16; break;
3801 case DIR_E : x = ~x + y + 9; break;
3802 case DIR_SE: x = y; break;
3803 case DIR_S : x = x + y - 7; break;
3804 case DIR_W : x = ~y + x + 9; break;
3805 default: break;
3806 }
3807
3808 /* Do not reverse when approaching red signal. Make sure the vehicle's front
3809 * does not cross the tile boundary when we do reverse, but as the vehicle's
3810 * location is based on their center, use half a vehicle's length as offset.
3811 * Multiply the half-length by two for straight directions to compensate that
3812 * we only get odd x offsets there. */
3813 if (!signal && x + (v->gcache.cached_veh_length + 1) / 2 * (IsDiagonalDirection(v->direction) ? 1 : 2) >= TILE_SIZE) {
3814 /* we are too near the tile end, reverse now */
3815 v->cur_speed = 0;
3816 if (reverse) ReverseTrainDirection(v);
3817 return false;
3818 }
3819
3820 /* slow down */
3821 v->vehstatus.Set(VehState::TrainSlowing);
3822 uint16_t break_speed = _breakdown_speeds[x & 0xF];
3823 if (break_speed < v->cur_speed) v->cur_speed = break_speed;
3824
3825 return true;
3826}
3827
3828
3834 static bool TrainCanLeaveTile(const Train *v)
3835{
3836 /* Exit if inside a tunnel/bridge or a depot */
3837 if (v->track == TRACK_BIT_WORMHOLE || v->track == TRACK_BIT_DEPOT) return false;
3838
3839 TileIndex tile = v->tile;
3840
3841 /* entering a tunnel/bridge? */
3842 if (IsTileType(tile, MP_TUNNELBRIDGE)) {
3843 DiagDirection dir = GetTunnelBridgeDirection(tile);
3844 if (DiagDirToDir(dir) == v->direction) return false;
3845 }
3846
3847 /* entering a depot? */
3848 if (IsRailDepotTile(tile)) {
3849 DiagDirection dir = ReverseDiagDir(GetRailDepotDirection(tile));
3850 if (DiagDirToDir(dir) == v->direction) return false;
3851 }
3852
3853 return true;
3854}
3855
3856
3864 static TileIndex TrainApproachingCrossingTile(const Train *v)
3865{
3866 assert(v->IsFrontEngine());
3867 assert(!v->vehstatus.Test(VehState::Crashed));
3868
3869 if (!TrainCanLeaveTile(v)) return INVALID_TILE;
3870
3871 DiagDirection dir = VehicleExitDir(v->direction, v->track);
3872 TileIndex tile = v->tile + TileOffsByDiagDir(dir);
3873
3874 /* not a crossing || wrong axis || unusable rail (wrong type or owner) */
3875 if (!IsLevelCrossingTile(tile) || DiagDirToAxis(dir) == GetCrossingRoadAxis(tile) ||
3876 !CheckCompatibleRail(v, tile)) {
3877 return INVALID_TILE;
3878 }
3879
3880 return tile;
3881}
3882
3883
3891 static bool TrainCheckIfLineEnds(Train *v, bool reverse)
3892{
3893 /* First, handle broken down train */
3894
3895 int t = v->breakdown_ctr;
3896 if (t > 1) {
3897 v->vehstatus.Set(VehState::TrainSlowing);
3898
3899 uint16_t break_speed = _breakdown_speeds[GB(~t, 4, 4)];
3900 if (break_speed < v->cur_speed) v->cur_speed = break_speed;
3901 } else {
3902 v->vehstatus.Reset(VehState::TrainSlowing);
3903 }
3904
3905 if (!TrainCanLeaveTile(v)) return true;
3906
3907 /* Determine the non-diagonal direction in which we will exit this tile */
3908 DiagDirection dir = VehicleExitDir(v->direction, v->track);
3909 /* Calculate next tile */
3910 TileIndex tile = v->tile + TileOffsByDiagDir(dir);
3911
3912 /* Determine the track status on the next tile */
3913 TrackStatus ts = GetTileTrackStatus(tile, TRANSPORT_RAIL, 0, ReverseDiagDir(dir));
3914 TrackdirBits reachable_trackdirs = DiagdirReachesTrackdirs(dir);
3915
3916 TrackdirBits trackdirbits = TrackStatusToTrackdirBits(ts) & reachable_trackdirs;
3917 TrackdirBits red_signals = TrackStatusToRedSignals(ts) & reachable_trackdirs;
3918
3919 /* We are sure the train is not entering a depot, it is detected above */
3920
3921 /* mask unreachable track bits if we are forbidden to do 90deg turns */
3922 TrackBits bits = TrackdirBitsToTrackBits(trackdirbits);
3923 if (Rail90DegTurnDisallowed(GetTileRailType(v->tile), GetTileRailType(tile))) {
3924 bits &= ~TrackCrossesTracks(FindFirstTrack(v->track));
3925 }
3926
3927 /* no suitable trackbits at all || unusable rail (wrong type or owner) */
3928 if (bits == TRACK_BIT_NONE || !CheckCompatibleRail(v, tile)) {
3929 return TrainApproachingLineEnd(v, false, reverse);
3930 }
3931
3932 /* approaching red signal */
3933 if ((trackdirbits & red_signals) != 0) return TrainApproachingLineEnd(v, true, reverse);
3934
3935 /* approaching a rail/road crossing? then make it red */
3936 if (IsLevelCrossingTile(tile)) MaybeBarCrossingWithSound(tile);
3937
3938 return true;
3939}
3940
3941
3942static bool TrainLocoHandler(Train *v, bool mode)
3943{
3944 /* train has crashed? */
3945 if (v->vehstatus.Test(VehState::Crashed)) {
3946 return mode ? true : HandleCrashedTrain(v); // 'this' can be deleted here
3947 }
3948
3949 if (v->force_proceed != TFP_NONE) {
3950 v->flags.Reset(VehicleRailFlag::Stuck);
3951 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
3952 }
3953
3954 /* train is broken down? */
3955 if (v->HandleBreakdown()) return true;
3956
3957 if (v->flags.Test(VehicleRailFlag::Reversing) && v->cur_speed == 0) {
3958 ReverseTrainDirection(v);
3959 }
3960
3961 /* exit if train is stopped */
3962 if (v->vehstatus.Test(VehState::Stopped) && v->cur_speed == 0) return true;
3963
3964 bool valid_order = !v->current_order.IsType(OT_NOTHING) && v->current_order.GetType() != OT_CONDITIONAL;
3965 if (ProcessOrders(v) && CheckReverseTrain(v)) {
3966 v->wait_counter = 0;
3967 v->cur_speed = 0;
3968 v->subspeed = 0;
3969 v->flags.Reset(VehicleRailFlag::LeavingStation);
3970 ReverseTrainDirection(v);
3971 return true;
3972 } else if (v->flags.Test(VehicleRailFlag::LeavingStation)) {
3973 /* Try to reserve a path when leaving the station as we
3974 * might not be marked as wanting a reservation, e.g.
3975 * when an overlength train gets turned around in a station. */
3976 DiagDirection dir = VehicleExitDir(v->direction, v->track);
3977 if (IsRailDepotTile(v->tile) || IsTileType(v->tile, MP_TUNNELBRIDGE)) dir = INVALID_DIAGDIR;
3978
3979 if (UpdateSignalsOnSegment(v->tile, dir, v->owner) == SIGSEG_PBS || _settings_game.pf.reserve_paths) {
3980 TryPathReserve(v, true, true);
3981 }
3982 v->flags.Reset(VehicleRailFlag::LeavingStation);
3983 }
3984
3985 v->HandleLoading(mode);
3986
3987 if (v->current_order.IsType(OT_LOADING)) return true;
3988
3989 if (CheckTrainStayInDepot(v)) return true;
3990
3991 if (!mode) v->ShowVisualEffect();
3992
3993 /* We had no order but have an order now, do look ahead. */
3994 if (!valid_order && !v->current_order.IsType(OT_NOTHING)) {
3995 CheckNextTrainTile(v);
3996 }
3997
3998 /* Handle stuck trains. */
3999 if (!mode && v->flags.Test(VehicleRailFlag::Stuck)) {
4000 ++v->wait_counter;
4001
4002 /* Should we try reversing this tick if still stuck? */
4003 bool turn_around = v->wait_counter % (_settings_game.pf.wait_for_pbs_path * Ticks::DAY_TICKS) == 0 && _settings_game.pf.reverse_at_signals;
4004
4005 if (!turn_around && v->wait_counter % _settings_game.pf.path_backoff_interval != 0 && v->force_proceed == TFP_NONE) return true;
4006 if (!TryPathReserve(v)) {
4007 /* Still stuck. */
4008 if (turn_around) ReverseTrainDirection(v);
4009
4010 if (v->flags.Test(VehicleRailFlag::Stuck) && v->wait_counter > 2 * _settings_game.pf.wait_for_pbs_path * Ticks::DAY_TICKS) {
4011 /* Show message to player. */
4012 if (_settings_client.gui.lost_vehicle_warn && v->owner == _local_company) {
4013 AddVehicleAdviceNewsItem(AdviceType::TrainStuck, GetEncodedString(STR_NEWS_TRAIN_IS_STUCK, v->index), v->index);
4014 }
4015 v->wait_counter = 0;
4016 }
4017 /* Exit if force proceed not pressed, else reset stuck flag anyway. */
4018 if (v->force_proceed == TFP_NONE) return true;
4019 v->flags.Reset(VehicleRailFlag::Stuck);
4020 v->wait_counter = 0;
4021 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
4022 }
4023 }
4024
4025 if (v->current_order.IsType(OT_LEAVESTATION)) {
4026 v->current_order.Free();
4027 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
4028 return true;
4029 }
4030
4031 int j = v->UpdateSpeed();
4032
4033 /* we need to invalidate the widget if we are stopping from 'Stopping 0 km/h' to 'Stopped' */
4034 if (v->cur_speed == 0 && v->vehstatus.Test(VehState::Stopped)) {
4035 /* If we manually stopped, we're not force-proceeding anymore. */
4036 v->force_proceed = TFP_NONE;
4037 SetWindowDirty(WC_VEHICLE_VIEW, v->index);
4038 }
4039
4040 int adv_spd = v->GetAdvanceDistance();
4041 if (j < adv_spd) {
4042 /* if the vehicle has speed 0, update the last_speed field. */
4043 if (v->cur_speed == 0) v->SetLastSpeed();
4044 } else {
4045 TrainCheckIfLineEnds(v);
4046 /* Loop until the train has finished moving. */
4047 for (;;) {
4048 j -= adv_spd;
4049 TrainController(v, nullptr);
4050 /* Don't continue to move if the train crashed. */
4051 if (CheckTrainCollision(v)) break;
4052 /* Determine distance to next map position */
4053 adv_spd = v->GetAdvanceDistance();
4054
4055 /* No more moving this tick */
4056 if (j < adv_spd || v->cur_speed == 0) break;
4057
4058 OrderType order_type = v->current_order.GetType();
4059 /* Do not skip waypoints (incl. 'via' stations) when passing through at full speed. */
4060 if ((order_type == OT_GOTO_WAYPOINT || order_type == OT_GOTO_STATION) &&
4061 v->current_order.GetNonStopType().Test(OrderNonStopFlag::NoDestination) &&
4062 IsTileType(v->tile, MP_STATION) &&
4063 v->current_order.GetDestination() == GetStationIndex(v->tile)) {
4064 ProcessOrders(v);
4065 }
4066 }
4067 v->SetLastSpeed();
4068 }
4069
4070 for (Train *u = v; u != nullptr; u = u->Next()) {
4071 if (u->vehstatus.Test(VehState::Hidden)) continue;
4072
4073 u->UpdateViewport(false, false);
4074 }
4075
4076 if (v->progress == 0) v->progress = j; // Save unused spd for next time, if TrainController didn't set progress
4077
4078 return true;
4079}
4080
4085 Money Train::GetRunningCost() const
4086{
4087 Money cost = 0;
4088 const Train *v = this;
4089
4090 do {
4091 const Engine *e = v->GetEngine();
4092 if (e->VehInfo<RailVehicleInfo>().running_cost_class == INVALID_PRICE) continue;
4093
4094 uint cost_factor = GetVehicleProperty(v, PROP_TRAIN_RUNNING_COST_FACTOR, e->VehInfo<RailVehicleInfo>().running_cost);
4095 if (cost_factor == 0) continue;
4096
4097 /* Halve running cost for multiheaded parts */
4098 if (v->IsMultiheaded()) cost_factor /= 2;
4099
4100 cost += GetPrice(e->VehInfo<RailVehicleInfo>().running_cost_class, cost_factor, e->GetGRF());
4101 } while ((v = v->GetNextVehicle()) != nullptr);
4102
4103 return cost;
4104}
4105
4110 bool Train::Tick()
4111{
4112 this->tick_counter++;
4113
4114 if (this->IsFrontEngine()) {
4115 PerformanceAccumulator framerate(PFE_GL_TRAINS);
4116
4117 if (!this->vehstatus.Test(VehState::Stopped) || this->cur_speed > 0) this->running_ticks++;
4118
4119 this->current_order_time++;
4120
4121 if (!TrainLocoHandler(this, false)) return false;
4122
4123 return TrainLocoHandler(this, true);
4124 } else if (this->IsFreeWagon() && this->vehstatus.Test(VehState::Crashed)) {
4125 /* Delete flooded standalone wagon chain */
4126 if (++this->crash_anim_pos >= 4400) {
4127 delete this;
4128 return false;
4129 }
4130 }
4131
4132 return true;
4133}
4134
4139 static void CheckIfTrainNeedsService(Train *v)
4140{
4141 if (Company::Get(v->owner)->settings.vehicle.servint_trains == 0 || !v->NeedsAutomaticServicing()) return;
4142 if (v->IsChainInDepot()) {
4143 VehicleServiceInDepot(v);
4144 return;
4145 }
4146
4147 uint max_penalty = _settings_game.pf.yapf.maximum_go_to_depot_penalty;
4148
4149 FindDepotData tfdd = FindClosestTrainDepot(v, max_penalty);
4150 /* Only go to the depot if it is not too far out of our way. */
4151 if (tfdd.best_length == UINT_MAX || tfdd.best_length > max_penalty) {
4152 if (v->current_order.IsType(OT_GOTO_DEPOT)) {
4153 /* If we were already heading for a depot but it has
4154 * suddenly moved farther away, we continue our normal
4155 * schedule? */
4156 v->current_order.MakeDummy();
4157 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
4158 }
4159 return;
4160 }
4161
4162 DepotID depot = GetDepotIndex(tfdd.tile);
4163
4164 if (v->current_order.IsType(OT_GOTO_DEPOT) &&
4165 v->current_order.GetDestination() != depot &&
4166 !Chance16(3, 16)) {
4167 return;
4168 }
4169
4170 SetBit(v->gv_flags, GVF_SUPPRESS_IMPLICIT_ORDERS);
4171 v->current_order.MakeGoToDepot(depot, OrderDepotTypeFlag::Service, OrderNonStopFlag::NoIntermediate, OrderDepotActionFlag::NearestDepot);
4172 v->dest_tile = tfdd.tile;
4173 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, WID_VV_START_STOP);
4174}
4175
4177 void Train::OnNewCalendarDay()
4178{
4179 AgeVehicle(this);
4180}
4181
4183 void Train::OnNewEconomyDay()
4184{
4185 EconomyAgeVehicle(this);
4186
4187 if ((++this->day_counter & 7) == 0) DecreaseVehicleValue(this);
4188
4189 if (this->IsFrontEngine()) {
4190 CheckVehicleBreakdown(this);
4191
4192 CheckIfTrainNeedsService(this);
4193
4194 CheckOrders(this);
4195
4196 /* update destination */
4197 if (this->current_order.IsType(OT_GOTO_STATION)) {
4198 TileIndex tile = Station::Get(this->current_order.GetDestination().ToStationID())->train_station.tile;
4199 if (tile != INVALID_TILE) this->dest_tile = tile;
4200 }
4201
4202 if (this->running_ticks != 0) {
4203 /* running costs */
4204 CommandCost cost(EXPENSES_TRAIN_RUN, this->GetRunningCost() * this->running_ticks / (CalendarTime::DAYS_IN_YEAR * Ticks::DAY_TICKS));
4205
4206 this->profit_this_year -= cost.GetCost();
4207 this->running_ticks = 0;
4208
4209 SubtractMoneyFromCompanyFract(this->owner, cost);
4210
4211 SetWindowDirty(WC_VEHICLE_DETAILS, this->index);
4212 SetWindowClassesDirty(WC_TRAINS_LIST);
4213 }
4214 }
4215}
4216
4221 Trackdir Train::GetVehicleTrackdir() const
4222{
4223 if (this->vehstatus.Test(VehState::Crashed)) return INVALID_TRACKDIR;
4224
4225 if (this->track == TRACK_BIT_DEPOT) {
4226 /* We'll assume the train is facing outwards */
4227 return DiagDirToDiagTrackdir(GetRailDepotDirection(this->tile)); // Train in depot
4228 }
4229
4230 if (this->track == TRACK_BIT_WORMHOLE) {
4231 /* train in tunnel or on bridge, so just use its direction and assume a diagonal track */
4232 return DiagDirToDiagTrackdir(DirToDiagDir(this->direction));
4233 }
4234
4235 return TrackDirectionToTrackdir(FindFirstTrack(this->track), this->direction);
4236}
4237
4238uint16_t Train::GetMaxWeight() const
4239{
4240 uint16_t weight = CargoSpec::Get(this->cargo_type)->WeightOfNUnitsInTrain(this->GetEngine()->DetermineCapacity(this));
4241
4242 /* Vehicle weight is not added for articulated parts. */
4243 if (!this->IsArticulatedPart()) {
4244 weight += GetVehicleProperty(this, PROP_TRAIN_WEIGHT, RailVehInfo(this->engine_type)->weight);
4245 }
4246
4247 /* Powered wagons have extra weight added. */
4248 if (this->flags.Test(VehicleRailFlag::PoweredWagon)) {
4249 weight += RailVehInfo(this->gcache.first_engine)->pow_wag_weight;
4250 }
4251
4252 return weight;
4253}
ai.hpp
Base functions for all AIs.
AddArticulatedParts
void AddArticulatedParts(Vehicle *first)
Add the remaining articulated parts to the given vehicle.
Definition articulated_vehicles.cpp:336
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:294
articulated_vehicles.h
Functions related to articulated vehicles.
CheckCargoCapacity
void CheckCargoCapacity(Vehicle *v)
Check the capacity of all vehicles in a chain and spread cargo if needed.
Definition autoreplace_cmd.cpp:107
VehicleFlag::BuiltAsPrototype
@ BuiltAsPrototype
Vehicle is a prototype (accepted as exclusive preview).
AssignBit
constexpr T AssignBit(T &x, const uint8_t y, bool value)
Assigns a bit in a variable.
Definition bitmath_func.hpp:176
GB
static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition bitmath_func.hpp:32
SetBit
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
Definition bitmath_func.hpp:121
FindFirstBit
constexpr uint8_t FindFirstBit(T x)
Search the first set bit in a value.
Definition bitmath_func.hpp:189
HasBit
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition bitmath_func.hpp:103
KillFirstBit
constexpr T KillFirstBit(T value)
Clear the first bit in an integer.
Definition bitmath_func.hpp:226
ClrBit
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
Definition bitmath_func.hpp:139
GetBridgeSpec
const BridgeSpec * GetBridgeSpec(BridgeType i)
Get the specification of a bridge type.
Definition bridge.h:60
IsBridgeTile
bool IsBridgeTile(Tile t)
checks if there is a bridge on this tile
Definition bridge_map.h:35
GetBridgeType
BridgeType GetBridgeType(Tile t)
Determines the type of bridge on a tile.
Definition bridge_map.h:56
IsBridge
bool IsBridge(Tile t)
Checks if this is a bridge, instead of a tunnel.
Definition bridge_map.h:24
CargoType
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:21
IsValidCargoType
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
Definition cargo_type.h:104
AI::NewEvent
static void NewEvent(CompanyID company, ScriptEvent *event)
Queue a new event for an AI.
Definition ai_core.cpp:235
BaseBitSet::Test
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
Definition base_bitset_type.hpp:141
BaseBitSet::Reset
constexpr Timpl & Reset()
Reset all bits.
Definition base_bitset_type.hpp:83
BaseBitSet::Flip
constexpr Timpl & Flip(Tvalue_type value)
Flip the value-th bit.
Definition base_bitset_type.hpp:116
BaseBitSet::Set
constexpr Timpl & Set()
Set all bits.
Definition base_bitset_type.hpp:40
CommandCost
Common return value for all commands.
Definition command_type.h:24
CommandCost::AddCost
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Definition command_type.h:98
CommandCost::GetCost
Money GetCost() const
The costs as made up to this moment.
Definition command_type.h:118
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition command_type.h:177
Engine
Definition engine_base.h:38
Engine::GetGRFID
uint32_t GetGRFID() const
Retrieve the GRF ID of the NewGRF the engine is tied to.
Definition engine.cpp:156
Engine::reliability_spd_dec
uint16_t reliability_spd_dec
Speed of reliability decay between services (per day).
Definition engine_base.h:50
Engine::GetGRF
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition engine_base.h:166
Engine::DetermineCapacity
uint DetermineCapacity(const Vehicle *v, uint16_t *mail_capacity=nullptr) const
Determines capacity of a given vehicle from scratch.
Definition engine.cpp:200
Engine::flags
EngineFlags flags
Flags of the engine.
Definition engine_base.h:57
Engine::original_image_index
uint8_t original_image_index
Original vehicle image index, thus the image index of the overridden vehicle.
Definition engine_base.h:61
Engine::GetLifeLengthInDays
TimerGameCalendar::Date GetLifeLengthInDays() const
Returns the vehicle's (not model's!) life length in days.
Definition engine.cpp:442
Engine::GetDefaultCargoType
CargoType GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition engine_base.h:95
Engine::reliability
uint16_t reliability
Current reliability of the engine.
Definition engine_base.h:49
EnumBitSet
Enum-as-bit-set wrapper.
Definition enum_type.hpp:177
Game::NewEvent
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition game_core.cpp:136
OverflowSafeInt< int64_t >
PerformanceAccumulator
RAII class for measuring multi-step elements of performance.
Definition framerate_type.h:113
RailTypeInfo
This struct contains all the info that is needed to draw and construct tracks.
Definition rail.h:115
RailTypeInfo::curve_speed
uint8_t curve_speed
Multiplier for curve maximum speed advantage.
Definition rail.h:195
Ticks::DAY_TICKS
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
Definition timer_game_tick.h:75
TimerGameCalendar::date
static Date date
Current date in days (day counter).
Definition timer_game_calendar.h:33
TimerGameCalendar::year
static Year year
Current year, starting at 0.
Definition timer_game_calendar.h:31
TimerGameConst< struct Calendar >::DAYS_IN_YEAR
static constexpr int DAYS_IN_YEAR
days per year
Definition timer_game_common.h:149
TimerGameEconomy::date
static Date date
Current date in days (day counter).
Definition timer_game_economy.h:38
VehicleCargoList::StoredCount
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Definition cargopacket.h:425
VehicleOrderSaver
This class will save the current order of a vehicle and restore it on destruction.
Definition train_cmd.cpp:2629
VehicleOrderSaver::Restore
void Restore()
Restore the saved order to the vehicle.
Definition train_cmd.cpp:2654
VehicleOrderSaver::~VehicleOrderSaver
~VehicleOrderSaver()
Restore the saved order to the vehicle, if Restore() has not already been called.
Definition train_cmd.cpp:2666
VehicleOrderSaver::SwitchToNextOrder
bool SwitchToNextOrder(bool skip_first)
Set the current vehicle order to the next order in the order list.
Definition train_cmd.cpp:2676
VehiclesNearTileXY
Iterate over all vehicles near a given world coordinate.
Definition vehicle_func.h:119
VehiclesOnTile
Iterate over all vehicles on a tile.
Definition vehicle_func.h:53
command_func.h
Functions related to commands.
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition command_func.h:28
DoCommandFlag::Execute
@ Execute
execute the given command
DoCommandFlag::NoCargoCapacityCheck
@ NoCargoCapacityCheck
when autoreplace/autorenew is in progress, this shall prevent truncating the amount of cargo in the v...
DoCommandFlag::AutoReplace
@ AutoReplace
autoreplace/autorenew is in progress, this shall disable vehicle limits when building,...
company_base.h
Definition of stuff that is very close to a company, like the company struct itself.
CheckOwnership
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
Definition company_cmd.cpp:381
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition company_cmd.cpp:55
_current_company
CompanyID _current_company
Company currently doing an action.
Definition company_cmd.cpp:56
SubtractMoneyFromCompanyFract
void SubtractMoneyFromCompanyFract(CompanyID company, const CommandCost &cst)
Subtract money from a company, including the money fraction.
Definition company_cmd.cpp:324
company_func.h
Functions related to companies.
GetDepotIndex
DepotID GetDepotIndex(Tile t)
Get the index of which depot is attached to the tile.
Definition depot_map.h:53
DirDifference
DirDiff DirDifference(Direction d0, Direction d1)
Calculate the difference between two directions.
Definition direction_func.h:68
DiagDirToDir
Direction DiagDirToDir(DiagDirection dir)
Convert a DiagDirection to a Direction.
Definition direction_func.h:182
ReverseDiagDir
DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
Definition direction_func.h:118
ReverseDir
Direction ReverseDir(Direction d)
Return the reverse of a direction.
Definition direction_func.h:54
IsValidDiagDirection
bool IsValidDiagDirection(DiagDirection d)
Checks if an integer value is a valid DiagDirection.
Definition direction_func.h:21
ChangeDir
Direction ChangeDir(Direction d, DirDiff delta)
Change a direction by a given difference.
Definition direction_func.h:104
AxisToDiagDir
DiagDirection AxisToDiagDir(Axis a)
Converts an Axis to a DiagDirection.
Definition direction_func.h:232
IsDiagonalDirection
bool IsDiagonalDirection(Direction dir)
Checks if a given Direction is diagonal.
Definition direction_func.h:290
DiagDirToAxis
Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
Definition direction_func.h:214
DirToDiagDir
DiagDirection DirToDiagDir(Direction dir)
Convert a Direction to a DiagDirection.
Definition direction_func.h:166
DirDiff
DirDiff
Enumeration for the difference between two directions.
Definition direction_type.h:63
DIRDIFF_90LEFT
@ DIRDIFF_90LEFT
Angle of 90 degrees left.
Definition direction_type.h:68
DIRDIFF_45LEFT
@ DIRDIFF_45LEFT
Angle of 45 degrees left.
Definition direction_type.h:69
DIRDIFF_45RIGHT
@ DIRDIFF_45RIGHT
Angle of 45 degrees right.
Definition direction_type.h:65
DIRDIFF_SAME
@ DIRDIFF_SAME
Both directions faces to the same direction.
Definition direction_type.h:64
DIRDIFF_90RIGHT
@ DIRDIFF_90RIGHT
Angle of 90 degrees right.
Definition direction_type.h:66
Direction
Direction
Defines the 8 directions on the map.
Definition direction_type.h:24
DIR_SW
@ DIR_SW
Southwest.
Definition direction_type.h:31
DIR_NW
@ DIR_NW
Northwest.
Definition direction_type.h:33
DIR_N
@ DIR_N
North.
Definition direction_type.h:26
DIR_SE
@ DIR_SE
Southeast.
Definition direction_type.h:29
DIR_S
@ DIR_S
South.
Definition direction_type.h:30
DIR_NE
@ DIR_NE
Northeast.
Definition direction_type.h:27
DIR_W
@ DIR_W
West.
Definition direction_type.h:32
DIR_E
@ DIR_E
East.
Definition direction_type.h:28
Axis
Axis
Allow incrementing of DiagDirDiff variables.
Definition direction_type.h:123
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition direction_type.h:78
DIAGDIR_END
@ DIAGDIR_END
Used for iterations.
Definition direction_type.h:84
DIAGDIR_BEGIN
@ DIAGDIR_BEGIN
Used for iterations.
Definition direction_type.h:79
INVALID_DIAGDIR
@ INVALID_DIAGDIR
Flag for an invalid DiagDirection.
Definition direction_type.h:85
GetPrice
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition economy.cpp:949
EXPENSES_TRAIN_RUN
@ EXPENSES_TRAIN_RUN
Running costs trains.
Definition economy_type.h:181
EXPENSES_NEW_VEHICLES
@ EXPENSES_NEW_VEHICLES
New vehicles.
Definition economy_type.h:180
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:610
effectvehicle_func.h
Functions related to effect vehicles.
EV_EXPLOSION_SMALL
@ EV_EXPLOSION_SMALL
Various explosions.
Definition effectvehicle_func.h:24
EV_EXPLOSION_LARGE
@ EV_EXPLOSION_LARGE
Various explosions.
Definition effectvehicle_func.h:22
EngineMiscFlag::RailFlips
@ RailFlips
Rail vehicle has old depot-flip handling.
EngineMiscFlag::RailTilts
@ RailTilts
Rail vehicle tilts in curves.
VE_DISABLE_WAGON_POWER
@ VE_DISABLE_WAGON_POWER
Flag to disable wagon power.
Definition engine_type.h:68
EngineFlag::ExclusivePreview
@ ExclusivePreview
This vehicle is in the exclusive preview stage, either being used or being offered to a company.
RAILVEH_WAGON
@ RAILVEH_WAGON
simple wagon, not motorized
Definition engine_type.h:34
RAILVEH_MULTIHEAD
@ RAILVEH_MULTIHEAD
indicates a combination of two locomotives
Definition engine_type.h:33
error.h
Functions related to errors.
WL_CRITICAL
@ WL_CRITICAL
Critical errors, the MessageBox is shown in all cases.
Definition error.h:27
ShowErrorMessage
void ShowErrorMessage(EncodedString &&summary_msg, int x, int y, CommandCost &cc)
Display an error message in a window.
Definition error_gui.cpp:290
error_func.h
Error reporting related functions.
settings
fluid_settings_t * settings
FluidSynth settings handle.
Definition fluidsynth.cpp:25
framerate_type.h
Types for recording game performance data.
PFE_GL_TRAINS
@ PFE_GL_TRAINS
Time spent processing trains.
Definition framerate_type.h:50
game.hpp
Base functions for all Games.
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
PaletteID
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
AS_BRAKE
@ AS_BRAKE
We want to stop.
Definition ground_vehicle.hpp:23
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:57
GVF_GOINGDOWN_BIT
@ GVF_GOINGDOWN_BIT
Vehicle is currently going downhill. (Cached track information for acceleration)
Definition ground_vehicle.hpp:56
GVF_GOINGUP_BIT
@ GVF_GOINGUP_BIT
Vehicle is currently going uphill. (Cached track information for acceleration)
Definition ground_vehicle.hpp:55
UpdateTrainGroupID
void UpdateTrainGroupID(Train *v)
Recalculates the groupID of a train.
Definition group_cmd.cpp:783
SetTrainGroupID
void SetTrainGroupID(Train *v, GroupID grp)
Affect the groupID of a train to new_g.
Definition group_cmd.cpp:755
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:2128
DEFAULT_GROUP
static constexpr GroupID DEFAULT_GROUP
Ungrouped vehicles are in this group.
Definition group_type.h:18
GetTileTrackStatus
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
Definition landscape.cpp:559
GetSlopePixelZ
int GetSlopePixelZ(int x, int y, bool ground_vehicle)
Return world Z coordinate of a given point of a tile.
Definition landscape.cpp:306
BorderFlag::Random
@ Random
Randomise borders.
DiagdirBetweenTiles
DiagDirection DiagdirBetweenTiles(TileIndex tile_from, TileIndex tile_to)
Determines the DiagDirection to get from one tile to another.
Definition map_func.h:635
TileVirtXY
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:416
TileAddByDiagDir
TileIndex TileAddByDiagDir(TileIndex tile, DiagDirection dir)
Adds a DiagDir to a tile.
Definition map_func.h:623
TileOffsByAxis
TileIndexDiff TileOffsByAxis(Axis axis)
Convert an Axis to a TileIndexDiff.
Definition map_func.h:567
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:437
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:427
TileOffsByDiagDir
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:582
TileIndexDiff
int32_t TileIndexDiff
An offset value between two tiles.
Definition map_type.h:23
abs
constexpr T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition math_func.hpp:23
CeilDiv
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition math_func.hpp:310
Clamp
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
misc_cmd.h
Miscellaneous command definitions.
HideFillingPercent
void HideFillingPercent(TextEffectID *te_id)
Hide vehicle loading indicators.
Definition misc_gui.cpp:586
_networking
bool _networking
are we in networking mode?
Definition network.cpp:66
network.h
Basic functions/variables used all over the place.
ClientID
ClientID
'Unique' identifier to be given to clients
Definition network_type.h:43
newgrf.h
Base for the NewGRF implementation.
VehicleCallbackMask::ArticEngine
@ ArticEngine
Add articulated engines (trains and road vehicles)
VehicleCallbackMask::Length
@ Length
Vehicle length (trains and road vehicles)
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:35
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:74
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition newgrf_callbacks.h:439
ErrorUnknownCallbackResult
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Definition newgrf_commons.cpp:517
GRFBug::VehCapacity
@ VehCapacity
Capacity of vehicle changes when not refitting or arranging.
newgrf_debug.h
Functions/types related to NewGRF debugging.
InvalidateNewGRFInspectWindow
void InvalidateNewGRFInspectWindow(GrfSpecFeature feature, uint index)
Invalidate the inspect window for a given feature and index.
Definition newgrf_debug_gui.cpp:710
DeleteNewGRFInspectWindow
void DeleteNewGRFInspectWindow(GrfSpecFeature feature, uint index)
Delete inspect window for a given feature and index.
Definition newgrf_debug_gui.cpp:726
GetVehicleCallbackParent
uint16_t GetVehicleCallbackParent(CallbackID callback, uint32_t param1, uint32_t param2, EngineID engine, const Vehicle *v, const Vehicle *parent, std::span< int32_t > regs100)
Evaluate a newgrf callback for vehicles with a different vehicle for parent scope.
Definition newgrf_engine.cpp:1215
TestVehicleBuildProbability
std::optional< bool > TestVehicleBuildProbability(Vehicle *v, EngineID engine, BuildProbabilityType type)
Test for vehicle build probability type.
Definition newgrf_engine.cpp:1251
UsesWagonOverride
bool UsesWagonOverride(const Vehicle *v)
Check if a wagon is currently using a wagon override.
Definition newgrf_engine.cpp:1182
GetVehicleCallback
uint16_t GetVehicleCallback(CallbackID callback, uint32_t param1, uint32_t param2, EngineID engine, const Vehicle *v, std::span< int32_t > regs100)
Evaluate a newgrf callback for vehicles.
Definition newgrf_engine.cpp:1198
PROP_TRAIN_SHORTEN_FACTOR
@ PROP_TRAIN_SHORTEN_FACTOR
Shorter vehicles.
Definition newgrf_properties.h:28
PROP_TRAIN_USER_DATA
@ PROP_TRAIN_USER_DATA
User defined data for vehicle variable 0x42.
Definition newgrf_properties.h:29
PROP_TRAIN_WEIGHT
@ PROP_TRAIN_WEIGHT
Weight in t (if dualheaded: for each single vehicle)
Definition newgrf_properties.h:25
PROP_TRAIN_CARGO_AGE_PERIOD
@ PROP_TRAIN_CARGO_AGE_PERIOD
Number of ticks before carried cargo is aged.
Definition newgrf_properties.h:30
PROP_TRAIN_RUNNING_COST_FACTOR
@ PROP_TRAIN_RUNNING_COST_FACTOR
Yearly runningcost (if dualheaded: sum of both vehicles)
Definition newgrf_properties.h:23
PROP_TRAIN_SPEED
@ PROP_TRAIN_SPEED
Max. speed: 1 unit = 1/1.6 mph = 1 km-ish/h.
Definition newgrf_properties.h:21
PlayVehicleSound
bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event, bool force)
Checks whether a NewGRF wants to play a different vehicle sound effect.
Definition newgrf_sound.cpp:143
newgrf_sound.h
Functions related to NewGRF provided sounds.
VSE_START
@ VSE_START
Vehicle starting, i.e. leaving, the station.
Definition newgrf_sound.h:19
TriggerStationRandomisation
void TriggerStationRandomisation(BaseStation *st, TileIndex trigger_tile, StationRandomTrigger trigger, CargoType cargo_type)
Trigger station randomisation.
Definition newgrf_station.cpp:950
newgrf_station.h
Header file for NewGRF stations.
GetGRFStringID
StringID GetGRFStringID(uint32_t grfid, GRFStringID stringid)
Returns the index for this stringid associated with its grfID.
Definition newgrf_text.cpp:580
newgrf_text.h
Header of Action 04 "universal holder" structure and functions.
GRFSTR_MISC_GRF_TEXT
static constexpr GRFStringID GRFSTR_MISC_GRF_TEXT
Miscellaneous GRF text range.
Definition newgrf_text_type.h:18
news_func.h
Functions related to news.
AddVehicleNewsItem
void AddVehicleNewsItem(EncodedString &&headline, NewsType type, VehicleID vehicle, StationID station=StationID::Invalid())
Adds a newsitem referencing a vehicle.
Definition news_func.h:30
AddVehicleAdviceNewsItem
void AddVehicleAdviceNewsItem(AdviceType advice_type, EncodedString &&headline, VehicleID vehicle)
Adds a vehicle-advice news item.
Definition news_func.h:40
NewsType::ArrivalCompany
@ ArrivalCompany
First vehicle arrived for company.
NewsType::ArrivalOther
@ ArrivalOther
First vehicle arrived for competitor.
NewsType::Accident
@ Accident
An accident or disaster has occurred.
AdviceType::TrainStuck
@ TrainStuck
The train got stuck and needs to be unstuck manually.
PauseMode::Error
@ Error
A game paused because a (critical) error.
order_backup.h
Functions related to order backups.
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:2075
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:1946
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:1678
DeleteVehicleOrders
void DeleteVehicleOrders(Vehicle *v, bool keep_orderlist, bool reset_order_indices)
Delete all orders from a vehicle.
Definition order_cmd.cpp:1830
ProcessConditionalOrder
VehicleOrderID ProcessConditionalOrder(const Order *order, const Vehicle *v)
Process a conditional order and determine the next order.
Definition order_cmd.cpp:1916
OrderStopLocation
OrderStopLocation
Where to stop the trains.
Definition order_type.h:97
OrderStopLocation::NearEnd
@ NearEnd
Stop at the near end of the platform.
OrderStopLocation::FarEnd
@ FarEnd
Stop at the far end of the platform.
OrderStopLocation::Middle
@ Middle
Stop at the middle of the platform.
OrderNonStopFlag::NoDestination
@ NoDestination
The vehicle will stop at any station it passes except the destination, aka via.
OrderNonStopFlag::NoIntermediate
@ NoIntermediate
The vehicle will not stop at any stations it passes except the destination, aka non-stop.
VehicleOrderID
uint8_t VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition order_type.h:18
OrderDepotActionFlag::NearestDepot
@ NearestDepot
Send the vehicle to the nearest depot.
OrderDepotTypeFlag::Service
@ Service
This depot order is because of the servicing limit.
INVALID_VEH_ORDER_ID
static const VehicleOrderID INVALID_VEH_ORDER_ID
Invalid vehicle order index (sentinel)
Definition order_type.h:39
OrderType
OrderType
Order types.
Definition order_type.h:50
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
FollowTrainReservation
PBSTileInfo FollowTrainReservation(const Train *v, Vehicle **train_on_res)
Follow a train reservation to the last tile.
Definition pbs.cpp:289
TryReserveRailTrack
bool TryReserveRailTrack(TileIndex tile, Track t, bool trigger_stations)
Try to reserve a specific track on a tile.
Definition pbs.cpp:80
IsWaitingPositionFree
bool IsWaitingPositionFree(const Train *v, TileIndex tile, Trackdir trackdir, bool forbid_90deg)
Check if a safe position is free.
Definition pbs.cpp:427
UnreserveRailTrack
void UnreserveRailTrack(TileIndex tile, Track t)
Lift the reservation of a specific track on a tile.
Definition pbs.cpp:144
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
HasReservedTracks
bool HasReservedTracks(TileIndex tile, TrackBits tracks)
Check whether some of tracks is reserved on a tile.
Definition pbs.h:58
GetTileRailType
RailType GetTileRailType(Tile tile)
Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
Definition rail.cpp:37
TicksToLeaveDepot
int TicksToLeaveDepot(const Train *v)
Compute number of ticks when next wagon will leave a depot.
Definition rail_cmd.cpp:2926
GetAllPoweredRailTypes
RailTypes GetAllPoweredRailTypes(RailTypes railtypes)
Returns all powered railtypes for a set of railtypes.
Definition rail.h:324
IsCompatibleRail
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:351
HasPowerOnRail
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:376
Rail90DegTurnDisallowed
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:410
GetRailTypeInfo
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition rail.h:300
GetAllCompatibleRailTypes
RailTypes GetAllCompatibleRailTypes(RailTypes railtypes)
Returns all compatible railtypes for a set of railtypes.
Definition rail.h:312
TrainList
std::vector< Train * > TrainList
Helper type for lists/vectors of trains.
Definition rail_cmd.cpp:44
HasOnewaySignalBlockingTrackdir
bool HasOnewaySignalBlockingTrackdir(Tile 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:474
GetRailTileType
static RailTileType GetRailTileType(Tile t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition rail_map.h:36
IsPlainRail
static bool IsPlainRail(Tile t)
Returns whether this is plain rails, with or without signals.
Definition rail_map.h:49
GetRailType
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
HasSignalOnTrackdir
bool HasSignalOnTrackdir(Tile tile, Trackdir trackdir)
Checks for the presence of signals along the given trackdir on the given rail tile.
Definition rail_map.h:425
GetTrackBits
TrackBits GetTrackBits(Tile tile)
Gets the track bits of the given tile.
Definition rail_map.h:136
IsPlainRailTile
static bool IsPlainRailTile(Tile t)
Checks whether the tile is a rail tile or rail tile with signals.
Definition rail_map.h:60
RailTileType::Signals
@ Signals
Normal rail tile with signals.
GetRailDepotTrack
Track GetRailDepotTrack(Tile t)
Returns the track of a depot, ignoring direction.
Definition rail_map.h:182
GetRailDepotDirection
DiagDirection GetRailDepotDirection(Tile t)
Returns the direction the depot is facing to.
Definition rail_map.h:171
SetSignalStateByTrackdir
void SetSignalStateByTrackdir(Tile tile, Trackdir trackdir, SignalState state)
Sets the state of the signal along the given trackdir.
Definition rail_map.h:448
HasSignalOnTrack
bool HasSignalOnTrack(Tile tile, Track track)
Checks for the presence of signals (either way) on the given track on the given rail tile.
Definition rail_map.h:412
HasPbsSignalOnTrackdir
bool HasPbsSignalOnTrackdir(Tile tile, Trackdir td)
Is a pbs signal present along the trackdir?
Definition rail_map.h:462
IsOnewaySignal
bool IsOnewaySignal(Tile t, Track track)
One-way signals can't be passed the 'wrong' way.
Definition rail_map.h:318
SetDepotReservation
void SetDepotReservation(Tile t, bool b)
Set the reservation state of the depot.
Definition rail_map.h:269
HasDepotReservation
bool HasDepotReservation(Tile t)
Get the reservation state of the depot.
Definition rail_map.h:257
HasSignals
bool HasSignals(Tile t)
Checks if a rail tile has signals.
Definition rail_map.h:72
GetSignalStateByTrackdir
SignalState GetSignalStateByTrackdir(Tile tile, Trackdir trackdir)
Gets the state of the signal along the given trackdir.
Definition rail_map.h:437
IsRailDepotTile
static bool IsRailDepotTile(Tile t)
Is this tile rail tile and a rail depot?
Definition rail_map.h:105
RAILTYPE_RAIL
@ RAILTYPE_RAIL
Standard non-electric rails.
Definition rail_type.h:27
random_func.hpp
Pseudo random number generator.
Chance16
bool Chance16(const uint32_t a, const uint32_t b, const std::source_location location=std::source_location::current())
Flips a coin with given probability.
Definition random_func.hpp:134
Chance16R
bool Chance16R(const uint32_t a, const uint32_t b, uint32_t &r, const std::source_location location=std::source_location::current())
Flips a coin with a given probability and saves the randomize-number in a variable.
Definition random_func.hpp:154
UpdateLevelCrossing
void UpdateLevelCrossing(TileIndex tile, bool sound=true, bool force_bar=false)
Update a level crossing to barred or open (crossing may include multiple adjacent tiles).
Definition train_cmd.cpp:1788
HasCrossingReservation
bool HasCrossingReservation(Tile t)
Get the reservation state of the rail crossing.
Definition road_map.h:364
IsLevelCrossingTile
bool IsLevelCrossingTile(Tile t)
Return whether a tile is a level crossing tile.
Definition road_map.h:79
GetCrossingRoadAxis
Axis GetCrossingRoadAxis(Tile t)
Get the road axis of a level crossing.
Definition road_map.h:309
SetCrossingBarred
void SetCrossingBarred(Tile t, bool barred)
Set the bar state of a level crossing.
Definition road_map.h:412
GetCrossingRailAxis
Axis GetCrossingRailAxis(Tile t)
Get the rail axis of a level crossing.
Definition road_map.h:321
IsCrossingBarred
bool IsCrossingBarred(Tile t)
Check if the level crossing is barred.
Definition road_map.h:400
SetCrossingReservation
void SetCrossingReservation(Tile t, bool b)
Set the reservation state of the rail crossing.
Definition road_map.h:377
safeguards.h
A number of safeguards to prevent using unsafe methods.
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
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:647
UpdateSignalsInBuffer
void UpdateSignalsInBuffer()
Update signals in buffer Called from 'outside'.
Definition signal.cpp:573
AddSideToSignalBuffer
void AddSideToSignalBuffer(TileIndex tile, DiagDirection side, Owner owner)
Add side of tile to signal update buffer.
Definition signal.cpp:621
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:665
SigSegState
SigSegState
State of the signal segment.
Definition signal_func.h:49
SIGSEG_PBS
@ SIGSEG_PBS
Segment is a PBS segment.
Definition signal_func.h:52
SIGSEG_FULL
@ SIGSEG_FULL
Occupied by a train.
Definition signal_func.h:51
SIGTYPE_PBS
@ SIGTYPE_PBS
normal pbs signal
Definition signal_type.h:28
SIGNAL_STATE_RED
@ SIGNAL_STATE_RED
The signal is red.
Definition signal_type.h:43
SIGNAL_STATE_GREEN
@ SIGNAL_STATE_GREEN
The signal is green.
Definition signal_type.h:44
sound_func.h
Functions related to sound.
SoundFx
SoundFx
Sound effects from baseset.
Definition sound_type.h:45
SND_04_DEPARTURE_STEAM
@ SND_04_DEPARTURE_STEAM
2 == 0x02 Station departure: steam engine
Definition sound_type.h:49
SND_41_DEPARTURE_MAGLEV
@ SND_41_DEPARTURE_MAGLEV
65 == 0x41 Station departure: maglev engine
Definition sound_type.h:112
SND_13_TRAIN_COLLISION
@ SND_13_TRAIN_COLLISION
15 == 0x11 Train+train crash
Definition sound_type.h:64
SND_0E_LEVEL_CROSSING
@ SND_0E_LEVEL_CROSSING
12 == 0x0C Train passes through level crossing
Definition sound_type.h:59
SND_0A_DEPARTURE_TRAIN
@ SND_0A_DEPARTURE_TRAIN
8 == 0x08 Station departure: diesel and electric engine
Definition sound_type.h:55
SND_47_DEPARTURE_MONORAIL
@ SND_47_DEPARTURE_MONORAIL
71 == 0x47 Station departure: monorail engine
Definition sound_type.h:118
PALETTE_CRASH
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition sprites.h:1619
ModifyStationRatingAround
void ModifyStationRatingAround(TileIndex tile, Owner owner, int amount, uint radius)
Forcibly modify station ratings near a given tile.
Definition station_cmd.cpp:4374
IsRailWaypointTile
bool IsRailWaypointTile(Tile t)
Is this tile a station tile and a rail waypoint?
Definition station_map.h:123
IsCompatibleTrainStationTile
bool IsCompatibleTrainStationTile(Tile test_tile, Tile station_tile)
Check if a tile is a valid continuation to a railstation tile.
Definition station_map.h:544
IsRailStationTile
bool IsRailStationTile(Tile t)
Is this tile a station tile and a rail station?
Definition station_map.h:102
GetStationIndex
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
GetRailStationAxis
Axis GetRailStationAxis(Tile t)
Get the rail direction of a rail station.
Definition station_map.h:503
HVOT_TRAIN
@ HVOT_TRAIN
Station has seen a train.
Definition station_type.h:66
StationFacility::Train
@ Train
Station with train station.
StationRandomTrigger::VehicleArrives
@ VehicleArrives
Trigger platform when train arrives.
StationAnimationTrigger::VehicleArrives
@ VehicleArrives
Trigger platform when train arrives.
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
lengthof
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:271
GetEncodedString
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
strings_func.h
Functions related to OTTD's strings.
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
AccelerationSlowdownParams
Data structure for storing engine speed changes of an acceleration type.
Definition train_cmd.cpp:3068
AccelerationSlowdownParams::large_turn
uint8_t large_turn
Speed change due to a large turn.
Definition train_cmd.cpp:3070
AccelerationSlowdownParams::z_up
uint8_t z_up
Fraction to remove when moving up.
Definition train_cmd.cpp:3071
AccelerationSlowdownParams::small_turn
uint8_t small_turn
Speed change due to a small turn.
Definition train_cmd.cpp:3069
AccelerationSlowdownParams::z_down
uint8_t z_down
Fraction to add when moving down.
Definition train_cmd.cpp:3072
BaseConsist::name
std::string name
Name of vehicle.
Definition base_consist.h:34
BaseConsist::current_order_time
TimerGameTick::Ticks current_order_time
How many ticks have passed since this order started.
Definition base_consist.h:37
BaseConsist::cur_real_order_index
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
Definition base_consist.h:47
BaseConsist::vehicle_flags
VehicleFlags vehicle_flags
Used for gradual loading and other miscellaneous things (.
Definition base_consist.h:50
BaseConsist::ResetDepotUnbunching
void ResetDepotUnbunching()
Resets all the data used for depot unbunching.
Definition base_consist.cpp:49
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition base_station_base.h:59
BaseStation::facilities
StationFacilities facilities
The facilities that this station has.
Definition base_station_base.h:69
BaseStation::train_station
TileArea train_station
Tile area the train 'station' part covers.
Definition base_station_base.h:83
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition vehicle_type.h:51
BridgeSpec::speed
uint16_t speed
maximum travel speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition bridge.h:39
CFollowTrackT
Track follower helper template class (can serve pathfinders and vehicle controllers).
Definition follow_track.hpp:28
CFollowTrackT::Follow
bool Follow(TileIndex old_tile, Trackdir old_td)
main follower routine.
Definition follow_track.hpp:120
CFollowTrackT::is_tunnel
bool is_tunnel
last turn passed tunnel
Definition follow_track.hpp:45
CFollowTrackT::is_bridge
bool is_bridge
last turn passed bridge ramp
Definition follow_track.hpp:46
CFollowTrackT::tiles_skipped
int tiles_skipped
number of skipped tunnel or station tiles
Definition follow_track.hpp:48
CFollowTrackT::exitdir
DiagDirection exitdir
exit direction (leaving the old tile)
Definition follow_track.hpp:44
CFollowTrackT::new_td_bits
TrackdirBits new_td_bits
the new set of available trackdirs
Definition follow_track.hpp:43
CFollowTrackT::new_tile
TileIndex new_tile
the new tile (the vehicle has entered)
Definition follow_track.hpp:42
CFollowTrackT::old_td
Trackdir old_td
the trackdir (the vehicle was on) before move
Definition follow_track.hpp:41
CFollowTrackT::is_station
bool is_station
last turn passed station
Definition follow_track.hpp:47
CFollowTrackT::old_tile
TileIndex old_tile
the origin (vehicle moved from) before move
Definition follow_track.hpp:40
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:137
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition settings_type.h:653
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition settings_type.h:650
ClosestDepot
Structure to return information about the closest depot location, and whether it could be found.
Definition vehicle_base.h:192
CommandHelper
Definition command_func.h:83
Coord2D< int >
Coord2D::y
T y
Y coordinate.
Definition geometry_type.hpp:35
Coord2D::x
T x
X coordinate.
Definition geometry_type.hpp:34
Coord3D::x
T x
X coordinate.
Definition geometry_type.hpp:44
Coord3D::y
T y
Y coordinate.
Definition geometry_type.hpp:45
DifficultySettings::line_reverse_mode
bool line_reverse_mode
reversing at stations or not
Definition settings_type.h:140
EngineInfo::cargo_age_period
uint16_t cargo_age_period
Number of ticks before carried cargo is aged.
Definition engine_type.h:214
EngineInfo::misc_flags
EngineMiscFlags misc_flags
Miscellaneous flags.
Definition engine_type.h:209
EngineInfo::callback_mask
VehicleCallbackMasks callback_mask
Bitmask of vehicle callbacks that have to be called.
Definition engine_type.h:210
FindDepotData
Helper container to find a depot.
Definition pathfinder_type.h:38
FindDepotData::best_length
uint best_length
The distance towards the depot in penalty, or UINT_MAX if not found.
Definition pathfinder_type.h:40
FindDepotData::reverse
bool reverse
True if reversing is necessary for the train to get to this depot.
Definition pathfinder_type.h:41
FindDepotData::tile
TileIndex tile
The tile of the depot.
Definition pathfinder_type.h:39
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:155
GRFFile::traininfo_vehicle_pitch
int traininfo_vehicle_pitch
Vertical offset for drawing train images in depot GUI and vehicle details.
Definition newgrf.h:154
GUISettings::lost_vehicle_warn
bool lost_vehicle_warn
if a vehicle can't find its destination, show a warning
Definition settings_type.h:165
GUISettings::show_track_reservation
bool show_track_reservation
highlight reserved tracks.
Definition settings_type.h:220
GameSettings::pf
PathfinderSettings pf
settings for all pathfinders
Definition settings_type.h:639
GameSettings::difficulty
DifficultySettings difficulty
settings related to the difficulty
Definition settings_type.h:633
GameSettings::vehicle
VehicleSettings vehicle
options for vehicles
Definition settings_type.h:641
GetNewVehiclePosResult
Position information of a vehicle after it moved.
Definition vehicle_func.h:214
GetNewVehiclePosResult::new_tile
TileIndex new_tile
Tile of the vehicle after moving.
Definition vehicle_func.h:217
GetNewVehiclePosResult::y
int y
x and y position of the vehicle after moving
Definition vehicle_func.h:215
GetNewVehiclePosResult::old_tile
TileIndex old_tile
Current tile of the vehicle.
Definition vehicle_func.h:216
GroundVehicleCache::cached_weight
uint32_t cached_weight
Total weight of the consist (valid only for the first engine).
Definition ground_vehicle.hpp:32
GroundVehicleCache::first_engine
EngineID first_engine
Cached EngineID of the front vehicle. EngineID::Invalid() for the front vehicle itself.
Definition ground_vehicle.hpp:44
GroundVehicleCache::cached_power
uint32_t cached_power
Total power of the consist (valid only for the first engine).
Definition ground_vehicle.hpp:39
GroundVehicleCache::cached_total_length
uint16_t cached_total_length
Length of the whole vehicle (valid only for the first engine).
Definition ground_vehicle.hpp:43
GroundVehicleCache::cached_veh_length
uint8_t 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:45
GroundVehicleCache::cached_max_track_speed
uint16_t cached_max_track_speed
Maximum consist speed (in internal units) limited by track type (valid only for the first engine).
Definition ground_vehicle.hpp:38
GroundVehicle::IsChainInDepot
bool IsChainInDepot() const override
Check whether the whole vehicle chain is in the depot.
Definition ground_vehicle.cpp:190
GroundVehicle::SetFreeWagon
void SetFreeWagon()
Set a vehicle as a free wagon.
Definition ground_vehicle.hpp:291
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:234
GroundVehicle< Train, VEH_TRAIN >::gcache
GroundVehicleCache gcache
Cache of often calculated values.
Definition ground_vehicle.hpp:83
GroundVehicle< Train, VEH_TRAIN >::CargoChanged
void CargoChanged()
Recalculates the cached weight of a vehicle and its parts.
Definition ground_vehicle.cpp:79
GroundVehicle::SetMultiheaded
void SetMultiheaded()
Set a vehicle as a multiheaded engine.
Definition ground_vehicle.hpp:301
GroundVehicle::IsEngine
bool IsEngine() const
Check if a vehicle is an engine (can be first in a consist).
Definition ground_vehicle.hpp:318
GroundVehicle::IsRearDualheaded
bool IsRearDualheaded() const
Tell if we are dealing with the rear end of a multiheaded engine.
Definition ground_vehicle.hpp:336
GroundVehicle::IsMultiheaded
bool IsMultiheaded() const
Check if the vehicle is a multiheaded engine.
Definition ground_vehicle.hpp:330
GroundVehicle::SetEngine
void SetEngine()
Set engine status.
Definition ground_vehicle.hpp:281
GroundVehicle::SetWagon
void SetWagon()
Set a vehicle to be a wagon.
Definition ground_vehicle.hpp:271
GroundVehicle::SetFrontEngine
void SetFrontEngine()
Set front engine state.
Definition ground_vehicle.hpp:251
GroundVehicle::gv_flags
uint16_t gv_flags
Definition ground_vehicle.hpp:84
GroundVehicle::ClearFreeWagon
void ClearFreeWagon()
Clear a vehicle from being a free wagon.
Definition ground_vehicle.hpp:296
GroundVehicle::IsWagon
bool IsWagon() const
Check if a vehicle is a wagon.
Definition ground_vehicle.hpp:324
GroundVehicle::Crash
uint Crash(bool flooded) override
Common code executed for crashed ground vehicles.
Definition ground_vehicle.hpp:103
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:312
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:365
GroundVehicle< Train, VEH_TRAIN >::GetAcceleration
int GetAcceleration() const
Calculates the acceleration of the vehicle under its current conditions.
Definition ground_vehicle.cpp:105
GroundVehicle::ClearFrontEngine
void ClearFrontEngine()
Remove the front engine state.
Definition ground_vehicle.hpp:256
GroundVehicle::SetLastSpeed
void SetLastSpeed()
Update the GUI variant of the current speed of the vehicle.
Definition ground_vehicle.hpp:343
GroupStatistics::CountVehicle
static void CountVehicle(const Vehicle *v, int delta)
Update num_vehicle when adding or removing a vehicle.
Definition group_cmd.cpp:143
Map::Size
static uint Size()
Get the size of the map.
Definition map_func.h:290
MutableSpriteCache::sprite_seq
VehicleSpriteSeq sprite_seq
Vehicle appearance.
Definition vehicle_base.h:162
OrderBackup::Backup
static void Backup(const Vehicle *v, uint32_t user)
Create an order backup for the given vehicle.
Definition order_backup.cpp:84
Order
Definition order_base.h:33
Order::GetDepotOrderType
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
Definition order_base.h:150
Order::GetMaxSpeed
uint16_t 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:207
Order::GetDestination
DestinationID GetDestination() const
Gets the destination of this order.
Definition order_base.h:99
Order::IsType
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition order_base.h:66
Order::GetStopLocation
OrderStopLocation GetStopLocation() const
Where must we stop at the platform?
Definition order_base.h:148
Order::GetType
OrderType GetType() const
Get the type of order of this order.
Definition order_base.h:72
Order::MakeDummy
void MakeDummy()
Makes this order a Dummy order.
Definition order_cmd.cpp:116
Order::MakeGoToDepot
void MakeGoToDepot(DestinationID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type=OrderNonStopFlag::NoIntermediate, OrderDepotActionFlags action={}, CargoType cargo=CARGO_NO_REFIT)
Makes this order a Go To Depot order.
Definition order_cmd.cpp:73
Order::SetDestination
void SetDestination(DestinationID destination)
Sets the destination of this order.
Definition order_base.h:106
Order::GetDepotActionType
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Definition order_base.h:152
Order::Free
void Free()
'Free' the order
Definition order_cmd.cpp:47
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:2173
Order::GetNonStopType
OrderNonStopFlags GetNonStopType() const
At which stations must we stop?
Definition order_base.h:146
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition tilearea_type.h:19
PBSTileInfo
This struct contains information about the end of a reserved path.
Definition pbs.h:26
PBSTileInfo::trackdir
Trackdir trackdir
The reserved trackdir on the tile.
Definition pbs.h:28
PBSTileInfo::tile
TileIndex tile
Tile the path ends, INVALID_TILE if no valid path was found.
Definition pbs.h:27
PBSTileInfo::okay
bool okay
True if tile is a safe waiting position, false otherwise.
Definition pbs.h:29
PathfinderSettings::path_backoff_interval
uint8_t path_backoff_interval
ticks between checks for a free path.
Definition settings_type.h:501
PathfinderSettings::wait_for_pbs_path
uint8_t wait_for_pbs_path
how long to wait for a path reservation.
Definition settings_type.h:500
PathfinderSettings::wait_oneway_signal
uint8_t wait_oneway_signal
waitingtime in days before a oneway signal
Definition settings_type.h:496
PathfinderSettings::reserve_paths
bool reserve_paths
always reserve paths regardless of signal type.
Definition settings_type.h:499
PathfinderSettings::yapf
YAPFSettings yapf
pathfinder settings for the yet another pathfinder
Definition settings_type.h:503
PathfinderSettings::reverse_at_signals
bool reverse_at_signals
whether to reverse at signals at all
Definition settings_type.h:495
PathfinderSettings::forbid_90_deg
bool forbid_90_deg
forbid trains to make 90 deg turns
Definition settings_type.h:493
PathfinderSettings::wait_twoway_signal
uint8_t wait_twoway_signal
waitingtime in days before a twoway signal
Definition settings_type.h:497
PoolID< uint16_t, struct EngineIDTag, 64000, 0xFFFF >
Pool::PoolItem<&_engine_pool >::Get
static Titem * Get(auto index)
Returns Titem with given index.
Definition pool_type.hpp:387
Pool::PoolItem<&_vehicle_pool >::index
Tindex index
Index of this pool item.
Definition pool_type.hpp:286
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:357
RailVehicleInfo
Information about a rail vehicle.
Definition engine_type.h:74
RailVehicleInfo::power
uint16_t power
Power of engine (hp); For multiheaded engines the sum of both engine powers.
Definition engine_type.h:82
RailVehicleInfo::user_def_data
uint8_t user_def_data
Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles.
Definition engine_type.h:94
RailVehicleInfo::running_cost
uint8_t running_cost
Running cost of engine; For multiheaded engines the sum of both running costs.
Definition engine_type.h:84
RailVehicleInfo::shorten_factor
uint8_t shorten_factor
length on main map for this type is 8 - shorten_factor
Definition engine_type.h:91
RailVehicleInfo::railtypes
RailTypes railtypes
Railtypes, mangled if elrail is disabled.
Definition engine_type.h:78
RailVehicleInfo::pow_wag_power
uint16_t pow_wag_power
Extra power applied to consist if wagon should be powered.
Definition engine_type.h:88
RailVehicleInfo::max_speed
uint16_t max_speed
Maximum speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition engine_type.h:81
RailVehicleInfo::capacity
uint8_t capacity
Cargo capacity of vehicle; For multiheaded engines the capacity of each single engine.
Definition engine_type.h:87
RailVehicleInfo::pow_wag_weight
uint8_t pow_wag_weight
Extra weight applied to consist if wagon should be powered.
Definition engine_type.h:89
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition geometry_type.hpp:101
Rect::Width
int Width() const
Get width of Rect.
Definition geometry_type.hpp:111
Rect::Height
int Height() const
Get height of Rect.
Definition geometry_type.hpp:117
SetBitIterator
Iterable ensemble of each set bit in a value.
Definition bitmath_func.hpp:277
SoundSettings::ambient
bool ambient
Play ambient, industry and town sounds.
Definition settings_type.h:279
SoundSettings::disaster
bool disaster
Play disaster and accident sounds.
Definition settings_type.h:277
SpecializedStation< Station, false >::Get
static Station * Get(auto index)
Gets station with given index.
Definition base_station_base.h:248
SpecializedVehicle::Next
T * Next() const
Get next vehicle in the chain.
Definition vehicle_base.h:1049
SpecializedVehicle::Iterate
static Pool::IterateWrapper< T > Iterate(size_t from=0)
Returns an iterable ensemble of all valid vehicles of type T.
Definition vehicle_base.h:1203
SpecializedVehicle::Previous
T * Previous() const
Get previous vehicle in the chain.
Definition vehicle_base.h:1055
SpecializedVehicle::From
static T * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition vehicle_base.h:1134
SpecializedVehicle::GetIfValid
static T * GetIfValid(auto index)
Returns vehicle if the index is a valid index for this vehicle type.
Definition vehicle_base.h:1124
SpecializedVehicle::First
T * First() const
Get the first vehicle in the chain.
Definition vehicle_base.h:1031
SpecializedVehicle::GetNextVehicle
T * GetNextVehicle() const
Get the next real (non-articulated part) vehicle in the consist.
Definition vehicle_base.h:1093
SpecializedVehicle::Get
static T * Get(auto index)
Gets vehicle with given index.
Definition vehicle_base.h:1115
SpecializedVehicle::UpdateViewport
void UpdateViewport(bool force_update, bool update_delta)
Update vehicle sprite- and position caches.
Definition vehicle_base.h:1156
SpecializedVehicle::GetLastEnginePart
T * GetLastEnginePart()
Get the last part of an articulated engine.
Definition vehicle_base.h:1087
SpecializedVehicle::GetFirstEnginePart
T * GetFirstEnginePart()
Get the first part of an articulated engine.
Definition vehicle_base.h:1075
SpecializedVehicle::Last
T * Last()
Get the last vehicle in the chain.
Definition vehicle_base.h:1037
SpriteBounds::offset
Coord3D< int8_t > offset
Relative position of sprite from bounding box.
Definition sprite.h:21
SpriteBounds::origin
Coord3D< int8_t > origin
Position of northern corner within tile.
Definition sprite.h:19
SpriteBounds::extent
Coord3D< uint8_t > extent
Size of bounding box.
Definition sprite.h:20
Station
Station data structure.
Definition station_base.h:500
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:289
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
TrainCache::cached_max_curve_speed
uint16_t cached_max_curve_speed
max consist speed limited by curves
Definition train.h:83
TrainCache::cached_curve_speed_mod
int16_t cached_curve_speed_mod
curve speed modifier of the entire train
Definition train.h:82
TrainCache::cached_tilt
bool cached_tilt
train can tilt; feature provides a bonus in curves
Definition train.h:79
Train
'Train' is either a loco or a wagon.
Definition train.h:91
Train::PlayLeaveStationSound
void PlayLeaveStationSound(bool force=false) const override
Play a sound for a train leaving the station.
Definition train_cmd.cpp:2212
Train::UpdateAcceleration
void UpdateAcceleration()
Update acceleration of the train from the cached power and weight.
Definition train_cmd.cpp:427
Train::OnNewCalendarDay
void OnNewCalendarDay() override
Calendar day handler.
Definition train_cmd.cpp:4177
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:150
Train::GetVehicleTrackdir
Trackdir GetVehicleTrackdir() const override
Get the tracks of the train vehicle.
Definition train_cmd.cpp:4221
Train::GetImage
void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override
Get the sprite to display the train.
Definition train_cmd.cpp:491
Train::crash_anim_pos
uint16_t crash_anim_pos
Crash animation counter.
Definition train.h:93
Train::Tick
bool Tick() override
Update train vehicle data for a tick.
Definition train_cmd.cpp:4110
Train::ReserveTrackUnderConsist
void ReserveTrackUnderConsist() const
Tries to reserve track under whole train consist.
Definition train_cmd.cpp:3117
Train::GetOrderStationLocation
TileIndex GetOrderStationLocation(StationID station) override
Get the location of the next station to visit.
Definition train_cmd.cpp:2981
Train::GetDisplayImageWidth
int GetDisplayImageWidth(Point *offset=nullptr) const
Get the width of a train vehicle image in the GUI.
Definition train_cmd.cpp:457
Train::FindClosestDepot
ClosestDepot FindClosestDepot() override
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Definition train_cmd.cpp:2203
Train::UpdateDeltaXY
void UpdateDeltaXY() override
Updates the x and y offsets and the size of the sprite used for this vehicle.
Definition train_cmd.cpp:1490
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:174
Train::GetMaxWeight
uint16_t GetMaxWeight() const override
Calculates the weight value that this vehicle will have when fully loaded with its current cargo.
Definition train_cmd.cpp:4238
Train::GetCurveSpeedLimit
uint16_t GetCurveSpeedLimit() const
Computes train speed limit caused by curves.
Definition train_cmd.cpp:304
Train::IsPrimaryVehicle
bool IsPrimaryVehicle() const override
Whether this is the primary vehicle in the chain.
Definition train.h:118
Train::MarkDirty
void MarkDirty() override
Goods at the consist have changed, update the graphics, cargo, and acceleration.
Definition train_cmd.cpp:2996
Train::UpdateSpeed
int UpdateSpeed()
This function looks at the vehicle and updates its speed (cur_speed and subspeed) variables.
Definition train_cmd.cpp:3016
Train::Crash
uint Crash(bool flooded=false) override
The train vehicle crashed! Update its status and other parts around it.
Definition train_cmd.cpp:3139
Train::GetAccelerationType
VehicleAccelerationModel GetAccelerationType() const
Allows to know the acceleration type of a vehicle.
Definition train.h:187
Train::GetAccelerationStatus
AccelStatus GetAccelerationStatus() const
Checks the current acceleration status of this vehicle.
Definition train.h:284
Train::OnNewEconomyDay
void OnNewEconomyDay() override
Economy day handler.
Definition train_cmd.cpp:4183
Train::ConsistChanged
void ConsistChanged(ConsistChangeFlags allowed_changes)
Recalculates the cached stuff of a train.
Definition train_cmd.cpp:107
Train::GetRunningCost
Money GetRunningCost() const override
Get running cost for the train consist.
Definition train_cmd.cpp:4085
Train::wait_counter
uint16_t wait_counter
Ticks waiting in front of a signal, ticks being stuck or a counter for forced proceeding through sign...
Definition train.h:94
Train::GetCurrentMaxSpeed
int GetCurrentMaxSpeed() const override
Calculates the maximum speed of the vehicle under its current conditions.
Definition train_cmd.cpp:379
VehicleCache::cached_max_speed
uint16_t cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Definition vehicle_base.h:93
VehicleSettings::max_trains
UnitID max_trains
max trains in game per company
Definition settings_type.h:526
VehicleSettings::train_acceleration_model
uint8_t train_acceleration_model
realistic acceleration for trains
Definition settings_type.h:520
VehicleSettings::wagon_speed_limits
bool wagon_speed_limits
enable wagon speed limits
Definition settings_type.h:524
VehicleSettings::freight_trains
uint8_t freight_trains
value to multiply the weight of cargo by
Definition settings_type.h:531
VehicleSettings::max_train_length
uint8_t max_train_length
maximum length for trains
Definition settings_type.h:518
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition vehicle_base.h:102
VehicleSpriteSeq::IsValid
bool IsValid() const
Check whether the sequence contains any sprites.
Definition vehicle_base.h:114
VehicleSpriteSeq::GetBounds
void GetBounds(Rect *bounds) const
Determine shared bounds of all sprites.
Definition vehicle.cpp:114
VehicleSpriteSeq::Set
void Set(SpriteID sprite)
Assign a single sprite to the sequence.
Definition vehicle_base.h:130
VehicleSpriteSeq::Draw
void Draw(int x, int y, PaletteID default_pal, bool force_pal) const
Draw the sprite sequence.
Definition vehicle.cpp:142
Vehicle
Vehicle data structure.
Definition vehicle_base.h:205
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition vehicle_base.h:278
Vehicle::z_pos
int32_t z_pos
z coordinate.
Definition vehicle_base.h:267
Vehicle::direction
Direction direction
facing
Definition vehicle_base.h:268
Vehicle::GetEngine
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition vehicle.cpp:718
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:854
Vehicle::IsStoppedInDepot
bool IsStoppedInDepot() const
Check whether the vehicle is in the depot and stopped.
Definition vehicle_base.h:515
Vehicle::GetOrder
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
Definition vehicle_base.h:890
Vehicle::LeaveStation
void LeaveStation()
Perform all actions when leaving a station.
Definition vehicle.cpp:2327
Vehicle::AddToShared
void AddToShared(Vehicle *shared_chain)
Adds this vehicle to a shared vehicle chain.
Definition vehicle.cpp:2956
Vehicle::cargo
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition vehicle_base.h:296
Vehicle::date_of_last_service
TimerGameEconomy::Date date_of_last_service
Last economy date the vehicle had a service at a depot.
Definition vehicle_base.h:256
Vehicle::cargo_cap
uint16_t cargo_cap
total capacity
Definition vehicle_base.h:299
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:293
Vehicle::GetNumOrders
VehicleOrderID GetNumOrders() const
Get the number of orders this vehicle has.
Definition vehicle_base.h:705
Vehicle::random_bits
uint16_t random_bits
Bits used for randomized variational spritegroups.
Definition vehicle_base.h:290
Vehicle::ReleaseUnitNumber
void ReleaseUnitNumber()
Release the vehicle's unit number.
Definition vehicle.cpp:2396
Vehicle::day_counter
uint8_t day_counter
Increased by one for each day.
Definition vehicle_base.h:304
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:2407
Vehicle::profit_this_year
Money profit_this_year
Profit this year << 8, low 8 bits are fract.
Definition vehicle_base.h:234
Vehicle::colourmap
SpriteID colourmap
NOSAVE: cached colour mapping.
Definition vehicle_base.h:249
Vehicle::breakdown_ctr
uint8_t breakdown_ctr
Counter for managing breakdown events.
Definition vehicle_base.h:260
Vehicle::GetAdvanceDistance
uint GetAdvanceDistance()
Determines the vehicle "progress" needed for moving a step.
Definition vehicle_base.h:412
Vehicle::group_id
GroupID group_id
Index of group Pool array.
Definition vehicle_base.h:321
Vehicle::vehstatus
VehStates vehstatus
Status.
Definition vehicle_base.h:309
Vehicle::date_of_last_service_newgrf
TimerGameCalendar::Date date_of_last_service_newgrf
Last calendar date the vehicle had a service at a depot, unchanged by the date cheat to protect again...
Definition vehicle_base.h:257
Vehicle::subspeed
uint8_t subspeed
fractional speed
Definition vehicle_base.h:284
Vehicle::IsArticulatedPart
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
Definition vehicle_base.h:922
Vehicle::LeaveUnbunchingDepot
void LeaveUnbunchingDepot()
Leave an unbunching depot and calculate the next departure time for shared order vehicles.
Definition vehicle.cpp:2486
Vehicle::cargo_type
CargoType cargo_type
type of cargo this vehicle is carrying
Definition vehicle_base.h:297
Vehicle::acceleration
uint8_t acceleration
used by train & aircraft
Definition vehicle_base.h:285
Vehicle::current_order
Order current_order
The current order (+ status, like: loading)
Definition vehicle_base.h:311
Vehicle::HandlePathfindingResult
void HandlePathfindingResult(bool path_found)
Handle the pathfinding result, especially the lost status.
Definition vehicle.cpp:762
Vehicle::Next
Vehicle * Next() const
Get the next vehicle of this vehicle.
Definition vehicle_base.h:587
Vehicle::y_pos
int32_t y_pos
y coordinate.
Definition vehicle_base.h:266
Vehicle::x_pos
int32_t x_pos
x coordinate.
Definition vehicle_base.h:265
Vehicle::GetGRF
const GRFFile * GetGRF() const
Retrieve the NewGRF the vehicle is tied to.
Definition vehicle.cpp:728
Vehicle::orders
OrderList * orders
Pointer to the order list for this vehicle.
Definition vehicle_base.h:314
Vehicle::value
Money value
Value of the vehicle.
Definition vehicle_base.h:236
Vehicle::refit_cap
uint16_t refit_cap
Capacity left over from before last refit.
Definition vehicle_base.h:300
Vehicle::InvalidateNewGRFCache
void InvalidateNewGRFCache()
Invalidates cached NewGRF variables.
Definition vehicle_base.h:450
Vehicle::vcache
VehicleCache vcache
Cache of often used vehicle values.
Definition vehicle_base.h:319
Vehicle::GetGRFID
uint32_t GetGRFID() const
Retrieve the GRF ID of the NewGRF the vehicle is tied to.
Definition vehicle.cpp:738
Vehicle::bounds
SpriteBounds bounds
Bounding box of vehicle.
Definition vehicle_base.h:277
Vehicle::BeginLoading
void BeginLoading()
Prepare everything to begin the loading when arriving at a station.
Definition vehicle.cpp:2183
Vehicle::spritenum
uint8_t spritenum
currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == res...
Definition vehicle_base.h:276
Vehicle::cur_speed
uint16_t cur_speed
current speed
Definition vehicle_base.h:283
Vehicle::cargo_subtype
uint8_t cargo_subtype
Used for livery refits (NewGRF variations)
Definition vehicle_base.h:298
Vehicle::IsFrontEngine
bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition vehicle_base.h:913
Vehicle::IsWaitingForUnbunching
bool IsWaitingForUnbunching() const
Check whether a vehicle inside a depot is waiting for unbunching.
Definition vehicle.cpp:2533
Vehicle::fill_percent_te_id
TextEffectID fill_percent_te_id
a text-effect id to a loading indicator object
Definition vehicle_base.h:280
Vehicle::SetNext
void SetNext(Vehicle *next)
Set the next vehicle of this vehicle.
Definition vehicle.cpp:2927
Vehicle::max_age
TimerGameCalendar::Date max_age
Maximum age.
Definition vehicle_base.h:255
Vehicle::sprite_cache
MutableSpriteCache sprite_cache
Cache of sprites and values related to recalculating them, see MutableSpriteCache.
Definition vehicle_base.h:323
Vehicle::reliability
uint16_t reliability
Reliability.
Definition vehicle_base.h:258
Vehicle::HandleBreakdown
bool HandleBreakdown()
Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds,...
Definition vehicle.cpp:1332
Vehicle::progress
uint8_t progress
The percentage (if divided by 256) this vehicle already crossed the tile unit.
Definition vehicle_base.h:287
Vehicle::reliability_spd_dec
uint16_t reliability_spd_dec
Reliability decrease speed.
Definition vehicle_base.h:259
Vehicle::tick_counter
uint8_t tick_counter
Increased by one for each tick.
Definition vehicle_base.h:305
Vehicle::tile
TileIndex tile
Current tile index.
Definition vehicle_base.h:225
Vehicle::dest_tile
TileIndex dest_tile
Heading for this tile.
Definition vehicle_base.h:232
Vehicle::CopyVehicleConfigAndStatistics
void CopyVehicleConfigAndStatistics(Vehicle *src)
Copy certain configurations and statistics of a vehicle after successful autoreplace/renew The functi...
Definition vehicle_base.h:733
Vehicle::UpdatePosition
void UpdatePosition()
Update the position of the vehicle.
Definition vehicle.cpp:1662
Vehicle::last_station_visited
StationID last_station_visited
The last station we stopped at.
Definition vehicle_base.h:292
Vehicle::ShowVisualEffect
void ShowVisualEffect() const
Draw visual effects (smoke and/or sparks) for a vehicle chain.
Definition vehicle.cpp:2777
Vehicle::build_year
TimerGameCalendar::Year build_year
Year the vehicle has been built.
Definition vehicle_base.h:252
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition vehicle_base.h:270
Vehicle::unitnumber
UnitID unitnumber
unit number, for display purposes only
Definition vehicle_base.h:281
Vehicle::NeedsAutomaticServicing
bool NeedsAutomaticServicing() const
Checks if the current order should be interrupted for a service-in-depot order.
Definition vehicle.cpp:283
Vehicle::running_ticks
uint8_t running_ticks
Number of ticks this vehicle was not stopped this day.
Definition vehicle_base.h:306
YAPFSettings::maximum_go_to_depot_penalty
uint32_t maximum_go_to_depot_penalty
What is the maximum penalty that may be endured for going to a depot.
Definition settings_type.h:455
VehicleEnterTileState::EnteredStation
@ EnteredStation
The vehicle entered a station.
VehicleEnterTileState::CannotEnter
@ CannotEnter
The vehicle cannot enter the tile.
VehicleEnterTileState::EnteredWormhole
@ EnteredWormhole
The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/...
VehicleEnterTile
VehicleEnterTileStates VehicleEnterTile(Vehicle *v, TileIndex tile, int x, int y)
Call the tile callback function for a vehicle entering a tile.
Definition vehicle.cpp:1819
IsTileType
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
IsTileOwner
bool IsTileOwner(Tile tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition tile_map.h:214
GetTileOwner
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
INVALID_TILE
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
TILE_SIZE
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
MP_STATION
@ MP_STATION
A tile of a station.
Definition tile_type.h:53
MP_TUNNELBRIDGE
@ MP_TUNNELBRIDGE
Tunnel entry/exit and bridge heads.
Definition tile_type.h:57
MP_RAILWAY
@ MP_RAILWAY
A railway.
Definition tile_type.h:49
timer_game_calendar.h
Definition of the game-calendar-timer.
timer_game_economy.h
Definition of the game-economy-timer.
RemoveFirstTrackdir
Trackdir RemoveFirstTrackdir(TrackdirBits *trackdirs)
Removes first Trackdir from TrackdirBits and returns it.
Definition track_func.h:156
TrackdirToTrack
Track TrackdirToTrack(Trackdir trackdir)
Returns the Track that a given Trackdir represents.
Definition track_func.h:262
TrackToTrackBits
TrackBits TrackToTrackBits(Track track)
Maps a Track to the corresponding TrackBits value.
Definition track_func.h:77
TrackBitsToTrackdirBits
TrackdirBits TrackBitsToTrackdirBits(TrackBits bits)
Converts TrackBits to TrackdirBits while allowing both directions.
Definition track_func.h:319
VehicleExitDir
DiagDirection VehicleExitDir(Direction direction, TrackBits track)
Determine the side in which the vehicle will leave the tile.
Definition track_func.h:714
TrackStatusToTrackdirBits
TrackdirBits TrackStatusToTrackdirBits(TrackStatus ts)
Returns the present-trackdir-information of a TrackStatus.
Definition track_func.h:352
TrackBitsToTrack
Track TrackBitsToTrack(TrackBits tracks)
Converts TrackBits to Track.
Definition track_func.h:193
ReverseTrackdir
Trackdir ReverseTrackdir(Trackdir trackdir)
Maps a trackdir to the reverse trackdir.
Definition track_func.h:247
TracksOverlap
bool TracksOverlap(TrackBits bits)
Checks if the given tracks overlap, ie form a crossing.
Definition track_func.h:645
TrackDirectionToTrackdir
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:498
IsValidTrackdir
bool IsValidTrackdir(Trackdir trackdir)
Checks if a Trackdir is valid for non-road vehicles.
Definition track_func.h:52
FindFirstTrackdir
Trackdir FindFirstTrackdir(TrackdirBits trackdirs)
Returns first Trackdir from TrackdirBits or INVALID_TRACKDIR.
Definition track_func.h:211
TrackdirReachesTrackdirs
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:584
DiagdirReachesTrackdirs
TrackdirBits DiagdirReachesTrackdirs(DiagDirection diagdir)
Returns all trackdirs that can be reached when entering a tile from a given (diagonal) direction.
Definition track_func.h:555
FindFirstTrack
Track FindFirstTrack(TrackBits tracks)
Returns first Track from TrackBits or INVALID_TRACK.
Definition track_func.h:177
TrackEnterdirToTrackdir
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:486
DiagdirReachesTracks
TrackBits DiagdirReachesTracks(DiagDirection diagdir)
Returns all tracks that can be reached when entering a tile from a given (diagonal) direction.
Definition track_func.h:573
DiagDirToDiagTrackBits
TrackBits DiagDirToDiagTrackBits(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track bits incidating with that diagdir.
Definition track_func.h:524
DiagDirToDiagTrackdir
Trackdir DiagDirToDiagTrackdir(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal trackdir that runs in that direction.
Definition track_func.h:537
TrackStatusToRedSignals
TrackdirBits TrackStatusToRedSignals(TrackStatus ts)
Returns the red-signal-information of a TrackStatus.
Definition track_func.h:376
TrackdirToExitdir
DiagDirection TrackdirToExitdir(Trackdir trackdir)
Maps a trackdir to the (4-way) direction the tile is exited when following that trackdir.
Definition track_func.h:439
DiagDirToDiagTrack
Track DiagDirToDiagTrack(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track incidating with that diagdir.
Definition track_func.h:512
TrackdirBitsToTrackBits
TrackBits TrackdirBitsToTrackBits(TrackdirBits bits)
Discards all directional information from a TrackdirBits value.
Definition track_func.h:308
TrackBits
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
TRACK_BIT_WORMHOLE
@ TRACK_BIT_WORMHOLE
Bitflag for a wormhole (used for tunnels)
Definition track_type.h:52
TRACK_BIT_UPPER
@ TRACK_BIT_UPPER
Upper track.
Definition track_type.h:39
TRACK_BIT_DEPOT
@ TRACK_BIT_DEPOT
Bitflag for a depot.
Definition track_type.h:53
TRACK_BIT_LEFT
@ TRACK_BIT_LEFT
Left track.
Definition track_type.h:41
TRACK_BIT_Y
@ TRACK_BIT_Y
Y-axis track.
Definition track_type.h:38
TRACK_BIT_NONE
@ TRACK_BIT_NONE
No track.
Definition track_type.h:36
TRACK_BIT_X
@ TRACK_BIT_X
X-axis track.
Definition track_type.h:37
TRACK_BIT_MASK
@ TRACK_BIT_MASK
Bitmask for the first 6 bits.
Definition track_type.h:51
TRACK_BIT_LOWER
@ TRACK_BIT_LOWER
Lower track.
Definition track_type.h:40
TRACK_BIT_RIGHT
@ TRACK_BIT_RIGHT
Right track.
Definition track_type.h:42
Trackdir
Trackdir
Enumeration for tracks and directions.
Definition track_type.h:66
INVALID_TRACKDIR
@ INVALID_TRACKDIR
Flag for an invalid trackdir.
Definition track_type.h:85
TrackdirBits
TrackdirBits
Allow incrementing of Trackdir variables.
Definition track_type.h:97
TRACKDIR_BIT_NONE
@ TRACKDIR_BIT_NONE
No track build.
Definition track_type.h:98
Track
Track
These are used to specify a single track.
Definition track_type.h:19
INVALID_TRACK
@ INVALID_TRACK
Flag for an invalid track.
Definition track_type.h:28
TRACK_Y
@ TRACK_Y
Track along the y-axis (north-west to south-east)
Definition track_type.h:22
TRACK_BEGIN
@ TRACK_BEGIN
Used for iterations.
Definition track_type.h:20
TRACK_X
@ TRACK_X
Track along the x-axis (north-east to south-west)
Definition track_type.h:21
ConsistChangeFlag::Capacity
@ Capacity
Allow vehicles to change capacity.
ConsistChangeFlag::Length
@ Length
Allow vehicles to change length.
CCF_TRACK
static constexpr ConsistChangeFlags CCF_TRACK
Valid changes while vehicle is driving, and possibly changing tracks.
Definition train.h:52
FreeTrainTrackReservation
void FreeTrainTrackReservation(const Train *v)
Free the reserved path in front of a vehicle.
Definition train_cmd.cpp:2416
Reversed
@ Reversed
Used for vehicle var 0xFE bit 8 (toggled each time the train is reversed, accurate for first vehicle ...
Definition train.h:31
AllowedOnNormalRail
@ AllowedOnNormalRail
Electric train engine is allowed to run on normal rail. *‍/.
Definition train.h:30
Stuck
@ Stuck
Train can't get a path reservation.
Definition train.h:32
Flipped
@ Flipped
Reverse the visible direction of the vehicle.
Definition train.h:28
PoweredWagon
@ PoweredWagon
Wagon is powered.
Definition train.h:27
LeavingStation
@ LeavingStation
Train is just leaving a station.
Definition train.h:33
Reversing
@ Reversing
Train is slowing down to reverse.
Definition train.h:26
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:260
TrainForceProceeding
TrainForceProceeding
Modes for ignoring signals.
Definition train.h:38
TFP_SIGNAL
@ TFP_SIGNAL
Ignore next signal, after the signal ignore being stuck.
Definition train.h:41
TFP_NONE
@ TFP_NONE
Normal operation.
Definition train.h:39
TFP_STUCK
@ TFP_STUCK
Proceed till next signal, but ignore being stuck till then. This includes force leaving depots.
Definition train.h:40
CCF_ARRANGE
static constexpr ConsistChangeFlags CCF_ARRANGE
Valid changes for arranging the consist in a depot.
Definition train.h:56
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:3088
CmdBuildRailWagon
static CommandCost CmdBuildRailWagon(DoCommandFlags flags, TileIndex tile, const Engine *e, Vehicle **ret)
Build a railroad wagon.
Definition train_cmd.cpp:636
NormaliseTrainHead
static void NormaliseTrainHead(Train *head)
Normalise the head of the train again, i.e.
Definition train_cmd.cpp:1188
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:1127
CheckTrainStayInDepot
static bool CheckTrainStayInDepot(Train *v)
Will the train stay in the depot the next tick?
Definition train_cmd.cpp:2293
FindClosestTrainDepot
static FindDepotData FindClosestTrainDepot(Train *v, int max_distance)
Try to find a depot nearby.
Definition train_cmd.cpp:2196
CmdForceTrainProceed
CommandCost CmdForceTrainProceed(DoCommandFlags flags, VehicleID veh_id)
Force a train through a red signal.
Definition train_cmd.cpp:2167
UpdateLevelCrossing
void UpdateLevelCrossing(TileIndex tile, bool sound, bool force_bar)
Update a level crossing to barred or open (crossing may include multiple adjacent tiles).
Definition train_cmd.cpp:1788
CheckTrainCollision
static uint CheckTrainCollision(Vehicle *v, Train *t)
Collision test function.
Definition train_cmd.cpp:3202
MakeTrainBackup
static void MakeTrainBackup(TrainList &list, Train *t)
Make a backup of a train into a train list.
Definition train_cmd.cpp:872
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:2231
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:1147
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:2896
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:2623
_breakdown_speeds
static const uint16_t _breakdown_speeds[16]
Maximum speeds for train that is broken down or approaching line end.
Definition train_cmd.cpp:3776
TrainApproachingLineEnd
static bool TrainApproachingLineEnd(Train *v, bool signal, bool reverse)
Train is approaching line end, slow down and possibly reverse.
Definition train_cmd.cpp:3789
InsertInConsist
static void InsertInConsist(Train *dst, Train *chain)
Inserts a chain into the train at dst.
Definition train_cmd.cpp:921
UpdateAdjacentLevelCrossingTilesOnLevelCrossingRemoval
void UpdateAdjacentLevelCrossingTilesOnLevelCrossingRemoval(TileIndex tile, Axis road_axis)
Update adjacent level crossing tiles in this multi-track crossing, due to removal of a level crossing...
Definition train_cmd.cpp:1837
SwapTrainFlags
static void SwapTrainFlags(uint16_t *swap_flag1, uint16_t *swap_flag2)
Swap the two up/down flags in two ways:
Definition train_cmd.cpp:1581
UpdateLevelCrossingTile
static void UpdateLevelCrossingTile(TileIndex tile, bool sound, bool force_barred)
Sets a level crossing tile to the correct state.
Definition train_cmd.cpp:1766
HandleCrashedTrain
static bool HandleCrashedTrain(Train *v)
Handle a crashed train.
Definition train_cmd.cpp:3737
NormalizeTrainVehInDepot
void NormalizeTrainVehInDepot(const Train *u)
Move all free vehicles in the depot to the train.
Definition train_cmd.cpp:714
CmdReverseTrainDirection
CommandCost CmdReverseTrainDirection(DoCommandFlags flags, VehicleID veh_id, bool reverse_single_veh)
Reverse train.
Definition train_cmd.cpp:2073
CheckLevelCrossing
static bool CheckLevelCrossing(TileIndex tile)
Check if a level crossing should be barred.
Definition train_cmd.cpp:1753
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:989
AdvanceWagonsBeforeSwap
static void AdvanceWagonsBeforeSwap(Train *v)
Advances wagons for train reversing, needed for variable length wagons.
Definition train_cmd.cpp:1889
CmdBuildRailVehicle
CommandCost CmdBuildRailVehicle(DoCommandFlags flags, TileIndex tile, const Engine *e, Vehicle **ret)
Build a railroad vehicle.
Definition train_cmd.cpp:770
AdvanceWagonsAfterSwap
static void AdvanceWagonsAfterSwap(Train *v)
Advances wagons for train reversing, needed for variable length wagons.
Definition train_cmd.cpp:1917
FreightWagonMult
uint8_t FreightWagonMult(CargoType cargo)
Return the cargo weight multiplier to use for a rail vehicle.
Definition train_cmd.cpp:68
TrainCheckIfLineEnds
static bool TrainCheckIfLineEnds(Train *v, bool reverse=true)
Checks for line end.
Definition train_cmd.cpp:3891
ReverseTrainDirection
void ReverseTrainDirection(Train *v)
Turn a train around.
Definition train_cmd.cpp:1982
FreeTrainTrackReservation
void FreeTrainTrackReservation(const Train *v)
Free the reserved path in front of a vehicle.
Definition train_cmd.cpp:2416
TrainCrashed
static uint TrainCrashed(Train *v)
Marks train as crashed and creates an AI event.
Definition train_cmd.cpp:3178
NormaliseDualHeads
static void NormaliseDualHeads(Train *t)
Normalise the dual heads in the train, i.e.
Definition train_cmd.cpp:935
CheckTrainAttachment
static CommandCost CheckTrainAttachment(Train *t)
Check whether the train parts can be attached.
Definition train_cmd.cpp:1013
_accel_slowdown
static const AccelerationSlowdownParams _accel_slowdown[]
Speed update fractions for each acceleration type.
Definition train_cmd.cpp:3076
CmdMoveRailVehicle
CommandCost CmdMoveRailVehicle(DoCommandFlags flags, VehicleID src_veh, VehicleID dest_veh, bool move_chain)
Move a rail vehicle around inside the depot.
Definition train_cmd.cpp:1218
DoTrainPathfind
static Track DoTrainPathfind(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool do_track_reservation, PBSTileInfo *dest, TileIndex *final_dest)
Perform pathfinding for a train.
Definition train_cmd.cpp:2499
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:2375
IsTrain
static bool IsTrain(const Vehicle *v)
Check if the vehicle is a train.
Definition train_cmd.cpp:1688
CheckTrainsLengths
void CheckTrainsLengths()
Checks if lengths of all rail vehicles are valid.
Definition train_cmd.cpp:75
MaybeBarCrossingWithSound
static void MaybeBarCrossingWithSound(TileIndex tile)
Bars crossing and plays ding-ding sound if not barred already.
Definition train_cmd.cpp:1875
TrainOnCrossing
bool TrainOnCrossing(TileIndex tile)
Check if a level crossing tile has a train on it.
Definition train_cmd.cpp:1699
ChangeTrainDirRandomly
static void ChangeTrainDirRandomly(Train *v)
Rotate all vehicles of a (crashed) train chain randomly to animate the crash.
Definition train_cmd.cpp:3709
MarkDirtyAdjacentLevelCrossingTiles
void MarkDirtyAdjacentLevelCrossingTiles(TileIndex tile, Axis road_axis)
Find adjacent level crossing tiles in this multi-track crossing and mark them dirty.
Definition train_cmd.cpp:1820
NormaliseSubtypes
static void NormaliseSubtypes(Train *chain)
Normalise the sub types of the parts in this chain.
Definition train_cmd.cpp:957
TrainController
bool TrainController(Train *v, Vehicle *nomove, bool reverse=true)
Move a vehicle chain one movement stop forwards.
Definition train_cmd.cpp:3284
CmdSellRailWagon
CommandCost CmdSellRailWagon(DoCommandFlags flags, Vehicle *t, bool sell_chain, bool backup_order, ClientID user)
Sell a (single) train wagon/engine.
Definition train_cmd.cpp:1416
TrainApproachingCrossingTile
static TileIndex TrainApproachingCrossingTile(const Train *v)
Determines whether train is approaching a rail-road crossing (thus making it barred)
Definition train_cmd.cpp:3864
DetermineNextTrainForceProceeding
static TrainForceProceeding DetermineNextTrainForceProceeding(const Train *t)
Determine to what force_proceed should be changed.
Definition train_cmd.cpp:2150
RemoveFromConsist
static void RemoveFromConsist(Train *part, bool chain=false)
Remove the given wagon from its consist.
Definition train_cmd.cpp:904
RestoreTrainBackup
static void RestoreTrainBackup(TrainList &list)
Restore the train from the backup list.
Definition train_cmd.cpp:881
DeleteLastWagon
static void DeleteLastWagon(Train *v)
Deletes/Clears the last wagon of a crashed train.
Definition train_cmd.cpp:3630
TrainCanLeaveTile
static bool TrainCanLeaveTile(const Train *v)
Determines whether train would like to leave the tile.
Definition train_cmd.cpp:3834
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:260
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:3033
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:1557
TrainApproachingCrossing
static bool TrainApproachingCrossing(TileIndex tile)
Finds a vehicle approaching rail-road crossing.
Definition train_cmd.cpp:1729
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:1646
ExtendTrainReservation
static PBSTileInfo ExtendTrainReservation(const Train *v, TrackBits *new_tracks, DiagDirection *enterdir)
Extend a train path as far as possible.
Definition train_cmd.cpp:2510
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:579
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:4139
TrainList
std::vector< Train * > TrainList
Helper type for lists/vectors of trains.
Definition train_cmd.cpp:865
TrainApproachingCrossingEnum
static bool TrainApproachingCrossingEnum(const Vehicle *v, TileIndex tile)
Checks if a train is approaching a rail-road crossing.
Definition train_cmd.cpp:1712
UpdateStatusAfterSwap
static void UpdateStatusAfterSwap(Train *v)
Updates some variables after swapping the vehicle.
Definition train_cmd.cpp:1609
GetFreeWagonsInDepot
static std::vector< VehicleID > GetFreeWagonsInDepot(TileIndex tile)
Get a list of free wagons in a depot.
Definition train_cmd.cpp:611
train_cmd.h
Command definitions related to trains.
train_sprites.h
Sprites to use for trains.
TRANSPORT_RAIL
@ TRANSPORT_RAIL
Transport by train.
Definition transport_type.h:25
IsTunnel
bool IsTunnel(Tile t)
Is this a tunnel (entrance)?
Definition tunnel_map.h:23
MarkBridgeDirty
void MarkBridgeDirty(TileIndex begin, TileIndex end, DiagDirection direction, uint bridge_height)
Mark bridge tiles dirty.
Definition tunnelbridge_cmd.cpp:64
GetTunnelBridgeDirection
DiagDirection GetTunnelBridgeDirection(Tile t)
Get the direction pointing to the other end.
Definition tunnelbridge_map.h:26
GetOtherTunnelBridgeEnd
TileIndex GetOtherTunnelBridgeEnd(Tile t)
Determines type of the wormhole and returns its other end.
Definition tunnelbridge_map.h:78
SetTunnelBridgeReservation
void SetTunnelBridgeReservation(Tile t, bool b)
Set the reservation state of the rail tunnel/bridge.
Definition tunnelbridge_map.h:104
ShowNewGrfVehicleError
void ShowNewGrfVehicleError(EngineID engine, StringID part1, StringID part2, GRFBug bug_type, bool critical)
Displays a "NewGrf Bug" error message for a engine, and pauses the game if not networking.
Definition vehicle.cpp:328
VehicleEnterDepot
void VehicleEnterDepot(Vehicle *v)
Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it,...
Definition vehicle.cpp:1520
GetFreeUnitNumber
UnitID GetFreeUnitNumber(VehicleType type)
Get an unused unit number for a vehicle (if allowed).
Definition vehicle.cpp:1876
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:354
VehicleServiceInDepot
void VehicleServiceInDepot(Vehicle *v)
Service a vehicle and all subsequent vehicles in the consist.
Definition vehicle.cpp:178
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:1765
DecreaseVehicleValue
void DecreaseVehicleValue(Vehicle *v)
Decrease the value of a vehicle.
Definition vehicle.cpp:1270
EconomyAgeVehicle
void EconomyAgeVehicle(Vehicle *v)
Update economy age of a vehicle.
Definition vehicle.cpp:1398
TunnelBridgeIsFree
CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore)
Finds vehicle in tunnel / bridge.
Definition vehicle.cpp:551
AgeVehicle
void AgeVehicle(Vehicle *v)
Update age of a vehicle.
Definition vehicle.cpp:1410
VehState::Crashed
@ Crashed
Vehicle is crashed.
VehState::TrainSlowing
@ TrainSlowing
Train is slowing down.
VehState::Hidden
@ Hidden
Vehicle is not visible.
VehState::DefaultPalette
@ DefaultPalette
Use default vehicle palette.
VehState::Stopped
@ Stopped
Vehicle is stopped by the player.
vehicle_func.h
Functions related to vehicles.
CUSTOM_VEHICLE_SPRITENUM_REVERSED
@ CUSTOM_VEHICLE_SPRITENUM_REVERSED
Vehicle sprite from NewGRF with reverse driving direction (from articulation callback)
Definition vehicle_func.h:29
HasVehicleOnTile
bool HasVehicleOnTile(TileIndex tile, UnaryPred &&predicate)
Loop over vehicles on a tile, and check whether a predicate is true for any of them.
Definition vehicle_func.h:106
VIWD_CONSIST_CHANGED
@ VIWD_CONSIST_CHANGED
Vehicle composition was changed.
Definition vehicle_gui.h:37
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition vehicle_type.h:74
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition vehicle_type.h:25
VEHICLE_LENGTH
static const uint VEHICLE_LENGTH
The length of a vehicle in tile units.
Definition vehicle_type.h:65
WID_VV_REFIT
@ WID_VV_REFIT
Open the refit window.
Definition vehicle_widget.h:22
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
viewport_func.h
Functions related to (drawing on) viewports.
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1193
SetWindowClassesDirty
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition window.cpp:3202
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:3294
SetWindowWidgetDirty
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, WidgetID widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
Definition window.cpp:3189
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3176
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:3311
WC_VEHICLE_ORDERS
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
Definition window_type.h:217
WC_VEHICLE_DEPOT
@ WC_VEHICLE_DEPOT
Depot view; Window numbers:
Definition window_type.h:356
WC_TRAINS_LIST
@ WC_TRAINS_LIST
Trains list; Window numbers:
Definition window_type.h:313
WC_VEHICLE_REFIT
@ WC_VEHICLE_REFIT
Vehicle refit; Window numbers:
Definition window_type.h:211
WC_VEHICLE_DETAILS
@ WC_VEHICLE_DETAILS
Vehicle details; Window numbers:
Definition window_type.h:205
WC_COMPANY
@ WC_COMPANY
Company view; Window numbers:
Definition window_type.h:374
WC_VEHICLE_VIEW
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
Definition window_type.h:344
WC_VEHICLE_TIMETABLE
@ WC_VEHICLE_TIMETABLE
Vehicle timetable; Window numbers:
Definition window_type.h:229
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:642
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:655
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:589
YapfTrainChooseTrack
Track YapfTrainChooseTrack(const Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found, bool reserve_track, struct PBSTileInfo *target, TileIndex *dest)
Finds the best path for given train using YAPF.
Definition yapf_rail.cpp:580
yapf.hpp
Base includes/functions for YAPF.
zoom_func.h
Functions related to zooming.
ScaleSpriteTrad
int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition zoom_func.h:107
UnScaleGUI
int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition zoom_func.h:77