/* $Id$ */ /* * This file is part of OpenTTD. * 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. * 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. * 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 . */ /** @file train_cmd.cpp Handling of trains. */ #include "stdafx.h" #include "gui.h" #include "articulated_vehicles.h" #include "command_func.h" #include "npf.h" #include "news_func.h" #include "company_func.h" #include "vehicle_gui.h" #include "newgrf_engine.h" #include "newgrf_sound.h" #include "newgrf_text.h" #include "yapf/follow_track.hpp" #include "group.h" #include "table/sprites.h" #include "strings_func.h" #include "functions.h" #include "window_func.h" #include "vehicle_func.h" #include "sound_func.h" #include "autoreplace_gui.h" #include "gfx_func.h" #include "ai/ai.hpp" #include "newgrf_station.h" #include "effectvehicle_func.h" #include "gamelog.h" #include "network/network.h" #include "table/strings.h" #include "table/train_cmd.h" static Track ChooseTrainTrack(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool force_res, bool *got_reservation, bool mark_stuck); static bool TrainCheckIfLineEnds(Train *v); static void TrainController(Train *v, Vehicle *nomove); static TileIndex TrainApproachingCrossingTile(const Train *v); static void CheckIfTrainNeedsService(Train *v); static void CheckNextTrainTile(Train *v); static const byte _vehicle_initial_x_fract[4] = {10, 8, 4, 8}; static const byte _vehicle_initial_y_fract[4] = { 8, 4, 8, 10}; /** * Determine the side in which the train will leave the tile * * @param direction vehicle direction * @param track vehicle track bits * @return side of tile the train will leave */ static inline DiagDirection TrainExitDir(Direction direction, TrackBits track) { static const TrackBits state_dir_table[DIAGDIR_END] = { TRACK_BIT_RIGHT, TRACK_BIT_LOWER, TRACK_BIT_LEFT, TRACK_BIT_UPPER }; DiagDirection diagdir = DirToDiagDir(direction); /* Determine the diagonal direction in which we will exit this tile */ if (!HasBit(direction, 0) && track != state_dir_table[diagdir]) { diagdir = ChangeDiagDir(diagdir, DIAGDIRDIFF_90LEFT); } return diagdir; } /** Return the cargo weight multiplier to use for a rail vehicle * @param cargo Cargo type to get multiplier for * @return Cargo weight multiplier */ byte FreightWagonMult(CargoID cargo) { if (!CargoSpec::Get(cargo)->is_freight) return 1; return _settings_game.vehicle.freight_trains; } /** * Recalculates the cached total power of a train. Should be called when the consist is changed * @param v First vehicle of the consist. */ void TrainPowerChanged(Train *v) { uint32 total_power = 0; uint32 max_te = 0; for (const Train *u = v; u != NULL; u = u->Next()) { RailType railtype = GetRailType(u->tile); /* Power is not added for articulated parts */ if (!u->IsArticulatedPart()) { bool engine_has_power = HasPowerOnRail(u->railtype, railtype); const RailVehicleInfo *rvi_u = RailVehInfo(u->engine_type); if (engine_has_power) { uint16 power = GetVehicleProperty(u, PROP_TRAIN_POWER, rvi_u->power); if (power != 0) { /* Halve power for multiheaded parts */ if (u->IsMultiheaded()) power /= 2; total_power += power; /* Tractive effort in (tonnes * 1000 * 10 =) N */ max_te += (u->tcache.cached_veh_weight * 10000 * GetVehicleProperty(u, PROP_TRAIN_TRACTIVE_EFFORT, rvi_u->tractive_effort)) / 256; } } } if (HasBit(u->flags, VRF_POWEREDWAGON) && HasPowerOnRail(v->railtype, railtype)) { total_power += RailVehInfo(u->tcache.first_engine)->pow_wag_power; } } if (v->tcache.cached_power != total_power || v->tcache.cached_max_te != max_te) { /* If it has no power (no catenary), stop the train */ if (total_power == 0) v->vehstatus |= VS_STOPPED; v->tcache.cached_power = total_power; v->tcache.cached_max_te = max_te; SetWindowDirty(WC_VEHICLE_DETAILS, v->index); SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } } /** * Recalculates the cached weight of a train and its vehicles. Should be called each time the cargo on * the consist changes. * @param v First vehicle of the consist. */ static void TrainCargoChanged(Train *v) { uint32 weight = 0; for (Train *u = v; u != NULL; u = u->Next()) { uint32 vweight = CargoSpec::Get(u->cargo_type)->weight * u->cargo.Count() * FreightWagonMult(u->cargo_type) / 16; /* Vehicle weight is not added for articulated parts. */ if (!u->IsArticulatedPart()) { /* vehicle weight is the sum of the weight of the vehicle and the weight of its cargo */ vweight += GetVehicleProperty(u, PROP_TRAIN_WEIGHT, RailVehInfo(u->engine_type)->weight); } /* powered wagons have extra weight added */ if (HasBit(u->flags, VRF_POWEREDWAGON)) { vweight += RailVehInfo(u->tcache.first_engine)->pow_wag_weight; } /* consist weight is the sum of the weight of all vehicles in the consist */ weight += vweight; /* store vehicle weight in cache */ u->tcache.cached_veh_weight = vweight; } /* store consist weight in cache */ v->tcache.cached_weight = weight; /* Now update train power (tractive effort is dependent on weight) */ TrainPowerChanged(v); } /** Logs a bug in GRF and shows a warning message if this * is for the first time this happened. * @param u first vehicle of chain */ static void RailVehicleLengthChanged(const Train *u) { /* show a warning once for each engine in whole game and once for each GRF after each game load */ const Engine *engine = Engine::Get(u->engine_type); uint32 grfid = engine->grffile->grfid; GRFConfig *grfconfig = GetGRFConfig(grfid); if (GamelogGRFBugReverse(grfid, engine->internal_id) || !HasBit(grfconfig->grf_bugs, GBUG_VEH_LENGTH)) { ShowNewGrfVehicleError(u->engine_type, STR_NEWGRF_BROKEN, STR_NEWGRF_BROKEN_VEHICLE_LENGTH, GBUG_VEH_LENGTH, true); } } /** Checks if lengths of all rail vehicles are valid. If not, shows an error message. */ void CheckTrainsLengths() { const Train *v; FOR_ALL_TRAINS(v) { if (v->First() == v && !(v->vehstatus & VS_CRASHED)) { for (const Train *u = v, *w = v->Next(); w != NULL; u = w, w = w->Next()) { if (u->track != TRACK_BIT_DEPOT) { if ((w->track != TRACK_BIT_DEPOT && max(abs(u->x_pos - w->x_pos), abs(u->y_pos - w->y_pos)) != u->tcache.cached_veh_length) || (w->track == TRACK_BIT_DEPOT && TicksToLeaveDepot(u) <= 0)) { SetDParam(0, v->index); SetDParam(1, v->owner); ShowErrorMessage(STR_BROKEN_VEHICLE_LENGTH, INVALID_STRING_ID, 0, 0, true); if (!_networking) DoCommandP(0, PM_PAUSED_ERROR, 1, CMD_PAUSE); } } } } } } /** * Recalculates the cached stuff of a train. Should be called each time a vehicle is added * to/removed from the chain, and when the game is loaded. * Note: this needs to be called too for 'wagon chains' (in the depot, without an engine) * @param v First vehicle of the chain. * @param same_length should length of vehicles stay the same? */ void TrainConsistChanged(Train *v, bool same_length) { uint16 max_speed = UINT16_MAX; assert(v->IsFrontEngine() || v->IsFreeWagon()); const RailVehicleInfo *rvi_v = RailVehInfo(v->engine_type); EngineID first_engine = v->IsFrontEngine() ? v->engine_type : INVALID_ENGINE; v->tcache.cached_total_length = 0; v->compatible_railtypes = RAILTYPES_NONE; bool train_can_tilt = true; for (Train *u = v; u != NULL; u = u->Next()) { const RailVehicleInfo *rvi_u = RailVehInfo(u->engine_type); /* Check the v->first cache. */ assert(u->First() == v); /* update the 'first engine' */ u->tcache.first_engine = v == u ? INVALID_ENGINE : first_engine; u->railtype = rvi_u->railtype; if (u->IsEngine()) first_engine = u->engine_type; /* Set user defined data to its default value */ u->tcache.user_def_data = rvi_u->user_def_data; v->InvalidateNewGRFCache(); u->InvalidateNewGRFCache(); } for (Train *u = v; u != NULL; u = u->Next()) { /* Update user defined data (must be done before other properties) */ u->tcache.user_def_data = GetVehicleProperty(u, PROP_TRAIN_USER_DATA, u->tcache.user_def_data); v->InvalidateNewGRFCache(); u->InvalidateNewGRFCache(); } for (Train *u = v; u != NULL; u = u->Next()) { const Engine *e_u = Engine::Get(u->engine_type); const RailVehicleInfo *rvi_u = &e_u->u.rail; if (!HasBit(e_u->info.misc_flags, EF_RAIL_TILTS)) train_can_tilt = false; /* Cache wagon override sprite group. NULL is returned if there is none */ u->tcache.cached_override = GetWagonOverrideSpriteSet(u->engine_type, u->cargo_type, u->tcache.first_engine); /* Reset colour map */ u->colourmap = PAL_NONE; if (rvi_u->visual_effect != 0) { u->tcache.cached_vis_effect = rvi_u->visual_effect; } else { if (u->IsWagon() || u->IsArticulatedPart()) { /* Wagons and articulated parts have no effect by default */ u->tcache.cached_vis_effect = 0x40; } else if (rvi_u->engclass == 0) { /* Steam is offset by -4 units */ u->tcache.cached_vis_effect = 4; } else { /* Diesel fumes and sparks come from the centre */ u->tcache.cached_vis_effect = 8; } } /* Check powered wagon / visual effect callback */ if (HasBit(e_u->info.callback_mask, CBM_TRAIN_WAGON_POWER)) { uint16 callback = GetVehicleCallback(CBID_TRAIN_WAGON_POWER, 0, 0, u->engine_type, u); if (callback != CALLBACK_FAILED) u->tcache.cached_vis_effect = GB(callback, 0, 8); } if (rvi_v->pow_wag_power != 0 && rvi_u->railveh_type == RAILVEH_WAGON && UsesWagonOverride(u) && !HasBit(u->tcache.cached_vis_effect, 7)) { /* wagon is powered */ SetBit(u->flags, VRF_POWEREDWAGON); // cache 'powered' status } else { ClrBit(u->flags, VRF_POWEREDWAGON); } if (!u->IsArticulatedPart()) { /* Do not count powered wagons for the compatible railtypes, as wagons always have railtype normal */ if (rvi_u->power > 0) { v->compatible_railtypes |= GetRailTypeInfo(u->railtype)->powered_railtypes; } /* Some electric engines can be allowed to run on normal rail. It happens to all * existing electric engines when elrails are disabled and then re-enabled */ if (HasBit(u->flags, VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL)) { u->railtype = RAILTYPE_RAIL; u->compatible_railtypes |= RAILTYPES_RAIL; } /* max speed is the minimum of the speed limits of all vehicles in the consist */ if ((rvi_u->railveh_type != RAILVEH_WAGON || _settings_game.vehicle.wagon_speed_limits) && !UsesWagonOverride(u)) { uint16 speed = GetVehicleProperty(u, PROP_TRAIN_SPEED, rvi_u->max_speed); if (speed != 0) max_speed = min(speed, max_speed); } } u->cargo_cap = GetVehicleCapacity(u); /* check the vehicle length (callback) */ uint16 veh_len = CALLBACK_FAILED; if (HasBit(e_u->info.callback_mask, CBM_VEHICLE_LENGTH)) { veh_len = GetVehicleCallback(CBID_VEHICLE_LENGTH, 0, 0, u->engine_type, u); } if (veh_len == CALLBACK_FAILED) veh_len = rvi_u->shorten_factor; veh_len = 8 - Clamp(veh_len, 0, 7); /* verify length hasn't changed */ if (same_length && veh_len != u->tcache.cached_veh_length) RailVehicleLengthChanged(u); /* update vehicle length? */ if (!same_length) u->tcache.cached_veh_length = veh_len; v->tcache.cached_total_length += u->tcache.cached_veh_length; v->InvalidateNewGRFCache(); u->InvalidateNewGRFCache(); } /* store consist weight/max speed in cache */ v->tcache.cached_max_speed = max_speed; v->tcache.cached_tilt = train_can_tilt; v->tcache.cached_max_curve_speed = GetTrainCurveSpeedLimit(v); /* 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) */ TrainCargoChanged(v); if (v->IsFrontEngine()) { UpdateTrainAcceleration(v); SetWindowDirty(WC_VEHICLE_DETAILS, v->index); } } enum AccelType { AM_ACCEL, AM_BRAKE }; /** * Get the stop location of (the center) of the front vehicle of a train at * a platform of a station. * @param station_id the ID of the station where we're stopping * @param tile the tile where the vehicle currently is * @param v the vehicle to get the stop location of * @param station_ahead 'return' the amount of 1/16th tiles in front of the train * @param station_length 'return' the station length in 1/16th tiles * @return the location, calculated from the begin of the station to stop at. */ int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, int *station_ahead, int *station_length) { const Station *st = Station::Get(station_id); *station_ahead = st->GetPlatformLength(tile, DirToDiagDir(v->direction)) * TILE_SIZE; *station_length = st->GetPlatformLength(tile) * TILE_SIZE; /* Default to the middle of the station for stations stops that are not in * the order list like intermediate stations when non-stop is disabled */ OrderStopLocation osl = OSL_PLATFORM_MIDDLE; if (v->tcache.cached_total_length >= *station_length) { /* The train is longer than the station, make it stop at the far end of the platform */ osl = OSL_PLATFORM_FAR_END; } else if (v->current_order.IsType(OT_GOTO_STATION) && v->current_order.GetDestination() == station_id) { osl = v->current_order.GetStopLocation(); } /* The stop location of the FRONT! of the train */ int stop; switch (osl) { default: NOT_REACHED(); case OSL_PLATFORM_NEAR_END: stop = v->tcache.cached_total_length; break; case OSL_PLATFORM_MIDDLE: stop = *station_length - (*station_length - v->tcache.cached_total_length) / 2; break; case OSL_PLATFORM_FAR_END: stop = *station_length; break; } /* Substract half the front vehicle length of the train so we get the real * stop location of the train. */ return stop - (v->tcache.cached_veh_length + 1) / 2; } /** * Computes train speed limit caused by curves * @param v first vehicle of consist * @return imposed speed limit */ int GetTrainCurveSpeedLimit(Train *v) { static const int absolute_max_speed = UINT16_MAX; int max_speed = absolute_max_speed; if (_settings_game.vehicle.train_acceleration_model == TAM_ORIGINAL) return max_speed; int curvecount[2] = {0, 0}; /* first find the curve speed limit */ int numcurve = 0; int sum = 0; int pos = 0; int lastpos = -1; for (const Vehicle *u = v; u->Next() != NULL; u = u->Next(), pos++) { Direction this_dir = u->direction; Direction next_dir = u->Next()->direction; DirDiff dirdiff = DirDifference(this_dir, next_dir); if (dirdiff == DIRDIFF_SAME) continue; if (dirdiff == DIRDIFF_45LEFT) curvecount[0]++; if (dirdiff == DIRDIFF_45RIGHT) curvecount[1]++; if (dirdiff == DIRDIFF_45LEFT || dirdiff == DIRDIFF_45RIGHT) { if (lastpos != -1) { numcurve++; sum += pos - lastpos; if (pos - lastpos == 1) { max_speed = 88; } } lastpos = pos; } /* if we have a 90 degree turn, fix the speed limit to 60 */ if (dirdiff == DIRDIFF_90LEFT || dirdiff == DIRDIFF_90RIGHT) { max_speed = 61; } } if (numcurve > 0 && max_speed > 88) { if (curvecount[0] == 1 && curvecount[1] == 1) { max_speed = absolute_max_speed; } else { sum /= numcurve; max_speed = 232 - (13 - Clamp(sum, 1, 12)) * (13 - Clamp(sum, 1, 12)); } } if (max_speed != absolute_max_speed) { /* Apply the engine's rail type curve speed advantage, if it slowed by curves */ const RailtypeInfo *rti = GetRailTypeInfo(v->railtype); max_speed += (max_speed / 2) * rti->curve_speed; if (v->tcache.cached_tilt) { /* Apply max_speed bonus of 20% for a tilting train */ max_speed += max_speed / 5; } } return max_speed; } /** new acceleration*/ static int GetTrainAcceleration(Train *v, bool mode) { int max_speed = v->tcache.cached_max_curve_speed; assert(max_speed == GetTrainCurveSpeedLimit(v)); // safety check, will be removed later int speed = v->cur_speed * 10 / 16; // km-ish/h -> mp/h if (IsRailStationTile(v->tile) && v->IsFrontEngine()) { StationID sid = GetStationIndex(v->tile); if (v->current_order.ShouldStopAtStation(v, sid)) { int station_ahead; int station_length; int stop_at = GetTrainStopLocation(sid, v->tile, v, &station_ahead, &station_length); /* The distance to go is whatever is still ahead of the train minus the * distance from the train's stop location to the end of the platform */ int distance_to_go = station_ahead / TILE_SIZE - (station_length - stop_at) / TILE_SIZE; if (distance_to_go > 0) { int st_max_speed = 120; int delta_v = v->cur_speed / (distance_to_go + 1); if (v->max_speed > (v->cur_speed - delta_v)) { st_max_speed = v->cur_speed - (delta_v / 10); } st_max_speed = max(st_max_speed, 25 * distance_to_go); max_speed = min(max_speed, st_max_speed); } } } int mass = v->tcache.cached_weight; int power = v->tcache.cached_power * 746; max_speed = min(max_speed, v->tcache.cached_max_speed); int num = 0; // number of vehicles, change this into the number of axles later int incl = 0; int drag_coeff = 20; //[1e-4] for (const Train *u = v; u != NULL; u = u->Next()) { num++; drag_coeff += 3; if (u->track == TRACK_BIT_DEPOT) max_speed = min(max_speed, 61); if (HasBit(u->flags, VRF_GOINGUP)) { incl += u->tcache.cached_veh_weight * 60; // 3% slope, quite a bit actually } else if (HasBit(u->flags, VRF_GOINGDOWN)) { incl -= u->tcache.cached_veh_weight * 60; } } v->max_speed = max_speed; const int area = 120; const int friction = 35; //[1e-3] int resistance; if (v->railtype != RAILTYPE_MAGLEV) { resistance = 13 * mass / 10; resistance += 60 * num; resistance += friction * mass * speed / 1000; resistance += (area * drag_coeff * speed * speed) / 10000; } else { resistance = (area * (drag_coeff / 2) * speed * speed) / 10000; } resistance += incl; resistance *= 4; //[N] const int max_te = v->tcache.cached_max_te; // [N] int force; if (speed > 0) { switch (v->railtype) { case RAILTYPE_RAIL: case RAILTYPE_ELECTRIC: case RAILTYPE_MONO: force = power / speed; //[N] force *= 22; force /= 10; if (mode == AM_ACCEL && force > max_te) force = max_te; break; default: NOT_REACHED(); case RAILTYPE_MAGLEV: force = power / 25; break; } } else { /* "kickoff" acceleration */ force = (mode == AM_ACCEL && v->railtype != RAILTYPE_MAGLEV) ? min(max_te, power) : power; force = max(force, (mass * 8) + resistance); } if (mode == AM_ACCEL) { return (force - resistance) / (mass * 2); } else { return min(-force - resistance, -10000) / mass; } } void UpdateTrainAcceleration(Train *v) { assert(v->IsFrontEngine()); v->max_speed = v->tcache.cached_max_speed; uint power = v->tcache.cached_power; uint weight = v->tcache.cached_weight; assert(weight != 0); v->acceleration = Clamp(power / weight * 4, 1, 255); } /** * Get the width of a train vehicle image in the GUI. * @param offset Additional offset for positioning the sprite; set to NULL if not needed * @return Width in pixels */ int Train::GetDisplayImageWidth(Point *offset) const { int reference_width = TRAININFO_DEFAULT_VEHICLE_WIDTH; int vehicle_pitch = 0; const Engine *e = Engine::Get(this->engine_type); if (e->grffile != NULL && is_custom_sprite(e->u.rail.image_index)) { reference_width = e->grffile->traininfo_vehicle_width; vehicle_pitch = e->grffile->traininfo_vehicle_pitch; } if (offset != NULL) { offset->x = reference_width / 2; offset->y = vehicle_pitch; } return this->tcache.cached_veh_length * reference_width / 8; } static SpriteID GetDefaultTrainSprite(uint8 spritenum, Direction direction) { return ((direction + _engine_sprite_add[spritenum]) & _engine_sprite_and[spritenum]) + _engine_sprite_base[spritenum]; } SpriteID Train::GetImage(Direction direction) const { uint8 spritenum = this->spritenum; SpriteID sprite; if (HasBit(this->flags, VRF_REVERSE_DIRECTION)) direction = ReverseDir(direction); if (is_custom_sprite(spritenum)) { sprite = GetCustomVehicleSprite(this, (Direction)(direction + 4 * IS_CUSTOM_SECONDHEAD_SPRITE(spritenum))); if (sprite != 0) return sprite; spritenum = Engine::Get(this->engine_type)->original_image_index; } sprite = GetDefaultTrainSprite(spritenum, direction); if (this->cargo.Count() >= this->cargo_cap / 2U) sprite += _wagon_full_adder[spritenum]; return sprite; } static SpriteID GetRailIcon(EngineID engine, bool rear_head, int &y) { const Engine *e = Engine::Get(engine); Direction dir = rear_head ? DIR_E : DIR_W; uint8 spritenum = e->u.rail.image_index; if (is_custom_sprite(spritenum)) { SpriteID sprite = GetCustomVehicleIcon(engine, dir); if (sprite != 0) { if (e->grffile != NULL) { y += e->grffile->traininfo_vehicle_pitch; } return sprite; } spritenum = Engine::Get(engine)->original_image_index; } if (rear_head) spritenum++; return GetDefaultTrainSprite(spritenum, DIR_W); } void DrawTrainEngine(int left, int right, int preferred_x, int y, EngineID engine, SpriteID pal) { if (RailVehInfo(engine)->railveh_type == RAILVEH_MULTIHEAD) { int yf = y; int yr = y; SpriteID spritef = GetRailIcon(engine, false, yf); SpriteID spriter = GetRailIcon(engine, true, yr); DrawSprite(spritef, pal, preferred_x - 14, yf); DrawSprite(spriter, pal, preferred_x + 15, yr); } else { SpriteID sprite = GetRailIcon(engine, false, y); DrawSprite(sprite, pal, preferred_x, y); } } static CommandCost CmdBuildRailWagon(EngineID engine, TileIndex tile, DoCommandFlag flags) { const Engine *e = Engine::Get(engine); const RailVehicleInfo *rvi = &e->u.rail; CommandCost value(EXPENSES_NEW_VEHICLES, e->GetCost()); /* Engines without valid cargo should not be available */ if (e->GetDefaultCargoType() == CT_INVALID) return CMD_ERROR; if (flags & DC_QUERY_COST) return value; /* Check that the wagon can drive on the track in question */ if (!IsCompatibleRail(rvi->railtype, GetRailType(tile))) return CMD_ERROR; uint num_vehicles = 1 + CountArticulatedParts(engine, false); /* Allow for the wagon and the articulated parts */ if (!Vehicle::CanAllocateItem(num_vehicles)) { return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME); } if (flags & DC_EXEC) { Vehicle *u = NULL; Train *w; FOR_ALL_TRAINS(w) { /* do not connect new wagon with crashed/flooded consists */ if (w->tile == tile && w->IsFreeWagon() && w->engine_type == engine && !(w->vehstatus & VS_CRASHED)) { u = w->Last(); break; } } Train *v = new Train(); v->spritenum = rvi->image_index; v->engine_type = engine; v->tcache.first_engine = INVALID_ENGINE; // needs to be set before first callback DiagDirection dir = GetRailDepotDirection(tile); v->direction = DiagDirToDir(dir); v->tile = tile; int x = TileX(tile) * TILE_SIZE | _vehicle_initial_x_fract[dir]; int y = TileY(tile) * TILE_SIZE | _vehicle_initial_y_fract[dir]; v->x_pos = x; v->y_pos = y; v->z_pos = GetSlopeZ(x, y); v->owner = _current_company; v->track = TRACK_BIT_DEPOT; v->vehstatus = VS_HIDDEN | VS_DEFPAL; // v->subtype = 0; v->SetWagon(); if (u != NULL) { u->SetNext(v); } else { v->SetFreeWagon(); InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile); } v->cargo_type = e->GetDefaultCargoType(); // v->cargo_subtype = 0; v->cargo_cap = rvi->capacity; v->value = value.GetCost(); // v->day_counter = 0; v->railtype = rvi->railtype; v->build_year = _cur_year; v->cur_image = SPR_IMG_QUERY; v->random_bits = VehicleRandomBits(); v->group_id = DEFAULT_GROUP; AddArticulatedParts(v); _new_vehicle_id = v->index; VehicleMove(v, false); TrainConsistChanged(v->First(), false); UpdateTrainGroupID(v->First()); SetWindowDirty(WC_VEHICLE_DEPOT, v->tile); if (IsLocalCompany()) { InvalidateAutoreplaceWindow(v->engine_type, v->group_id); // updates the replace Train window } Company::Get(_current_company)->num_engines[engine]++; CheckConsistencyOfArticulatedVehicle(v); } return value; } /** Move all free vehicles in the depot to the train */ static void NormalizeTrainVehInDepot(const Train *u) { const Train *v; FOR_ALL_TRAINS(v) { if (v->IsFreeWagon() && v->tile == u->tile && v->track == TRACK_BIT_DEPOT) { if (CmdFailed(DoCommand(0, v->index | (u->index << 16), 1, DC_EXEC, CMD_MOVE_RAIL_VEHICLE))) break; } } } static void AddRearEngineToMultiheadedTrain(Train *v) { Train *u = new Train(); v->value >>= 1; u->value = v->value; u->direction = v->direction; u->owner = v->owner; u->tile = v->tile; u->x_pos = v->x_pos; u->y_pos = v->y_pos; u->z_pos = v->z_pos; u->track = TRACK_BIT_DEPOT; u->vehstatus = v->vehstatus & ~VS_STOPPED; // u->subtype = 0; u->spritenum = v->spritenum + 1; u->cargo_type = v->cargo_type; u->cargo_subtype = v->cargo_subtype; u->cargo_cap = v->cargo_cap; u->railtype = v->railtype; u->engine_type = v->engine_type; u->build_year = v->build_year; u->cur_image = SPR_IMG_QUERY; u->random_bits = VehicleRandomBits(); v->SetMultiheaded(); u->SetMultiheaded(); v->SetNext(u); VehicleMove(u, false); /* Now we need to link the front and rear engines together */ v->other_multiheaded_part = u; u->other_multiheaded_part = v; } /** Build a railroad vehicle. * @param tile tile of the depot where rail-vehicle is built * @param flags type of operation * @param p1 engine type id * @param p2 bit 1 prevents any free cars from being added to the train * @param text unused * @return the cost of this operation or an error */ CommandCost CmdBuildRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text) { /* Check if the engine-type is valid (for the company) */ if (!IsEngineBuildable(p1, VEH_TRAIN, _current_company)) return_cmd_error(STR_ERROR_RAIL_VEHICLE_NOT_AVAILABLE); const Engine *e = Engine::Get(p1); const RailVehicleInfo *rvi = &e->u.rail; CommandCost value(EXPENSES_NEW_VEHICLES, e->GetCost()); /* Engines with CT_INVALID should not be available */ if (e->GetDefaultCargoType() == CT_INVALID) return CMD_ERROR; if (flags & DC_QUERY_COST) return value; /* Check if the train is actually being built in a depot belonging * to the company. Doesn't matter if only the cost is queried */ if (!IsRailDepotTile(tile)) return CMD_ERROR; if (!IsTileOwner(tile, _current_company)) return CMD_ERROR; if (rvi->railveh_type == RAILVEH_WAGON) return CmdBuildRailWagon(p1, tile, flags); uint num_vehicles = (rvi->railveh_type == RAILVEH_MULTIHEAD ? 2 : 1) + CountArticulatedParts(p1, false); /* Check if depot and new engine uses the same kind of tracks * * We need to see if the engine got power on the tile to avoid eletric engines in non-electric depots */ if (!HasPowerOnRail(rvi->railtype, GetRailType(tile))) return CMD_ERROR; /* Allow for the dual-heads and the articulated parts */ if (!Vehicle::CanAllocateItem(num_vehicles)) { return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME); } UnitID unit_num = (flags & DC_AUTOREPLACE) ? 0 : GetFreeUnitNumber(VEH_TRAIN); if (unit_num > _settings_game.vehicle.max_trains) { return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME); } if (flags & DC_EXEC) { DiagDirection dir = GetRailDepotDirection(tile); int x = TileX(tile) * TILE_SIZE + _vehicle_initial_x_fract[dir]; int y = TileY(tile) * TILE_SIZE + _vehicle_initial_y_fract[dir]; Train *v = new Train(); v->unitnumber = unit_num; v->direction = DiagDirToDir(dir); v->tile = tile; v->owner = _current_company; v->x_pos = x; v->y_pos = y; v->z_pos = GetSlopeZ(x, y); // v->running_ticks = 0; v->track = TRACK_BIT_DEPOT; v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL; v->spritenum = rvi->image_index; v->cargo_type = e->GetDefaultCargoType(); // v->cargo_subtype = 0; v->cargo_cap = rvi->capacity; v->max_speed = rvi->max_speed; v->value = value.GetCost(); v->last_station_visited = INVALID_STATION; // v->dest_tile = 0; v->engine_type = p1; v->tcache.first_engine = INVALID_ENGINE; // needs to be set before first callback v->reliability = e->reliability; v->reliability_spd_dec = e->reliability_spd_dec; v->max_age = e->GetLifeLengthInDays(); v->name = NULL; v->railtype = rvi->railtype; _new_vehicle_id = v->index; v->service_interval = Company::Get(_current_company)->settings.vehicle.servint_trains; v->date_of_last_service = _date; v->build_year = _cur_year; v->cur_image = SPR_IMG_QUERY; v->random_bits = VehicleRandomBits(); // v->vehicle_flags = 0; if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) SetBit(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE); v->group_id = DEFAULT_GROUP; // v->subtype = 0; v->SetFrontEngine(); v->SetEngine(); VehicleMove(v, false); if (rvi->railveh_type == RAILVEH_MULTIHEAD) { AddRearEngineToMultiheadedTrain(v); } else { AddArticulatedParts(v); } TrainConsistChanged(v, false); UpdateTrainGroupID(v); if (!HasBit(p2, 1) && !(flags & DC_AUTOREPLACE)) { // check if the cars should be added to the new vehicle NormalizeTrainVehInDepot(v); } InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile); InvalidateWindowClassesData(WC_TRAINS_LIST, 0); SetWindowDirty(WC_COMPANY, v->owner); if (IsLocalCompany()) { InvalidateAutoreplaceWindow(v->engine_type, v->group_id); // updates the replace Train window } Company::Get(_current_company)->num_engines[p1]++; CheckConsistencyOfArticulatedVehicle(v); } return value; } /* Check if all the wagons of the given train are in a depot, returns the * number of cars (including loco) then. If not it returns -1 */ int CheckTrainInDepot(const Train *v, bool needs_to_be_stopped) { TileIndex tile = v->tile; /* check if stopped in a depot */ if (!IsRailDepotTile(tile) || v->cur_speed != 0) return -1; int count = 0; for (; v != NULL; v = v->Next()) { /* This count is used by the depot code to determine the number of engines * in the consist. Exclude articulated parts so that autoreplacing to * engines with more articulated parts than before works correctly. * * Also skip counting rear ends of multiheaded engines */ if (!v->IsArticulatedPart() && !v->IsRearDualheaded()) count++; if (v->track != TRACK_BIT_DEPOT || v->tile != tile || (v->IsFrontEngine() && needs_to_be_stopped && !(v->vehstatus & VS_STOPPED))) { return -1; } } return count; } /* Used to check if the train is inside the depot and verifying that the VS_STOPPED flag is set */ int CheckTrainStoppedInDepot(const Train *v) { return CheckTrainInDepot(v, true); } /* Used to check if the train is inside the depot, but not checking the VS_STOPPED flag */ inline bool CheckTrainIsInsideDepot(const Train *v) { return CheckTrainInDepot(v, false) > 0; } /** * Unlink a rail wagon from the consist. * @param v Vehicle to remove. * @param first The first vehicle of the consist. * @return The first vehicle of the consist. */ static Train *UnlinkWagon(Train *v, Train *first) { /* unlinking the first vehicle of the chain? */ if (v == first) { v = v->GetNextVehicle(); if (v == NULL) return NULL; if (v->IsWagon()) v->SetFreeWagon(); /* First can be an articulated engine, meaning GetNextVehicle() isn't * v->Next(). Thus set the next vehicle of the last articulated part * and the last articulated part is just before the next vehicle (v). */ v->Previous()->SetNext(NULL); return v; } Train *u; for (u = first; u->GetNextVehicle() != v; u = u->GetNextVehicle()) {} u->GetLastEnginePart()->SetNext(v->GetNextVehicle()); return first; } static Train *FindGoodVehiclePos(const Train *src) { EngineID eng = src->engine_type; TileIndex tile = src->tile; Train *dst; FOR_ALL_TRAINS(dst) { if (dst->IsFreeWagon() && dst->tile == tile && !(dst->vehstatus & VS_CRASHED)) { /* check so all vehicles in the line have the same engine. */ Train *t = dst; while (t->engine_type == eng) { t = t->Next(); if (t == NULL) return dst; } } } return NULL; } /* * add a vehicle v behind vehicle dest * use this function since it sets flags as needed */ static void AddWagonToConsist(Train *v, Train *dest) { UnlinkWagon(v, v->First()); if (dest == NULL) return; Train *next = dest->Next(); v->SetNext(NULL); dest->SetNext(v); v->SetNext(next); v->ClearFreeWagon(); v->ClearFrontEngine(); } /* * move around on the train so rear engines are placed correctly according to the other engines * always call with the front engine */ static void NormaliseTrainConsist(Train *v) { if (v->IsFreeWagon()) return; assert(v->IsFrontEngine()); for (; v != NULL; v = v->GetNextVehicle()) { if (!v->IsMultiheaded() || !v->IsEngine()) continue; /* make sure that there are no free cars before next engine */ Train *u; for (u = v; u->Next() != NULL && !u->Next()->IsEngine(); u = u->Next()) {} if (u == v->other_multiheaded_part) continue; AddWagonToConsist(v->other_multiheaded_part, u); } } /** Move a rail vehicle around inside the depot. * @param tile unused * @param flags type of operation * Note: DC_AUTOREPLACE is set when autoreplace tries to undo its modifications or moves vehicles to temporary locations inside the depot. * @param p1 various bitstuffed elements * - p1 (bit 0 - 15) source vehicle index * - p1 (bit 16 - 31) what wagon to put the source wagon AFTER, XXX - INVALID_VEHICLE to make a new line * @param p2 (bit 0) move all vehicles following the source vehicle * @param text unused * @return the cost of this operation or an error */ CommandCost CmdMoveRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text) { VehicleID s = GB(p1, 0, 16); VehicleID d = GB(p1, 16, 16); Train *src = Train::GetIfValid(s); if (src == NULL || !CheckOwnership(src->owner)) return CMD_ERROR; /* Do not allow moving crashed vehicles inside the depot, it is likely to cause asserts later */ if (src->vehstatus & VS_CRASHED) return CMD_ERROR; /* if nothing is selected as destination, try and find a matching vehicle to drag to. */ Train *dst; if (d == INVALID_VEHICLE) { dst = src->IsEngine() ? NULL : FindGoodVehiclePos(src); } else { dst = Train::GetIfValid(d); if (dst == NULL || !CheckOwnership(dst->owner)) return CMD_ERROR; /* Do not allow appending to crashed vehicles, too */ if (dst->vehstatus & VS_CRASHED) return CMD_ERROR; } /* if an articulated part is being handled, deal with its parent vehicle */ src = src->GetFirstEnginePart(); if (dst != NULL) { dst = dst->GetFirstEnginePart(); } /* don't move the same vehicle.. */ if (src == dst) return CommandCost(); /* locate the head of the two chains */ Train *src_head = src->First(); Train *dst_head; if (dst != NULL) { dst_head = dst->First(); if (dst_head->tile != src_head->tile) return CMD_ERROR; /* Now deal with articulated part of destination wagon */ dst = dst->GetLastEnginePart(); } else { dst_head = NULL; } if (src->IsRearDualheaded()) return_cmd_error(STR_ERROR_REAR_ENGINE_FOLLOW_FRONT); /* when moving all wagons, we can't have the same src_head and dst_head */ if (HasBit(p2, 0) && src_head == dst_head) return CommandCost(); /* check if all vehicles in the source train are stopped inside a depot. */ int src_len = CheckTrainStoppedInDepot(src_head); if (src_len < 0) return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT); if ((flags & DC_AUTOREPLACE) == 0) { /* Check whether there are more than 'max_len' train units (articulated parts and rear heads do not count) in the new chain */ int max_len = _settings_game.vehicle.mammoth_trains ? 100 : 10; /* check the destination row if the source and destination aren't the same. */ if (src_head != dst_head) { int dst_len = 0; if (dst_head != NULL) { /* check if all vehicles in the dest train are stopped. */ dst_len = CheckTrainStoppedInDepot(dst_head); if (dst_len < 0) return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT); } if (src_head == src && !HasBit(p2, 0)) { /* Moving of a *single* vehicle at the front of the train. * If the next vehicle is an engine a new train will be created * instead of removing a vehicle from a free chain. The newly * created train may not be too long. */ const Train *u = src_head->GetNextVehicle(); if (u != NULL && u->IsEngine() && (src_len - 1) > max_len) return_cmd_error(STR_ERROR_TRAIN_TOO_LONG); } /* We are moving between rows, so only count the wagons from the source * row that are being moved. */ if (HasBit(p2, 0)) { const Train *u; for (u = src_head; u != src && u != NULL; u = u->GetNextVehicle()) { src_len--; } } else { /* If moving only one vehicle, just count that. */ src_len = 1; } if (src_len + dst_len > max_len) { /* Abort if we're adding too many wagons to a train. */ if (dst_head != NULL && dst_head->IsFrontEngine()) return_cmd_error(STR_ERROR_TRAIN_TOO_LONG); /* Abort if we're making a train on a new row. */ if (dst_head == NULL && src->IsEngine()) return_cmd_error(STR_ERROR_TRAIN_TOO_LONG); } } else { /* Abort if we're creating a new train on an existing row. */ if (src_len > max_len && src == src_head && src_head->GetNextVehicle()->IsEngine()) { return_cmd_error(STR_ERROR_TRAIN_TOO_LONG); } } } /* moving a loco to a new line?, then we need to assign a unitnumber. */ if (dst == NULL && !src->IsFrontEngine() && src->IsEngine()) { UnitID unit_num = ((flags & DC_AUTOREPLACE) != 0 ? 0 : GetFreeUnitNumber(VEH_TRAIN)); if (unit_num > _settings_game.vehicle.max_trains) return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME); if (flags & DC_EXEC) src->unitnumber = unit_num; } /* When we move the front vehicle, the second vehicle might need a unitnumber */ if (!HasBit(p2, 0) && (src->IsFreeWagon() || (src->IsFrontEngine() && dst == NULL)) && (flags & DC_AUTOREPLACE) == 0) { Train *second = src->GetNextUnit(); if (second != NULL && second->IsEngine() && GetFreeUnitNumber(VEH_TRAIN) > _settings_game.vehicle.max_trains) { return_cmd_error(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME); } } /* * Check whether the vehicles in the source chain are in the destination * chain. This can easily be done by checking whether the first vehicle * of the source chain is in the destination chain as the Next/Previous * pointers always make a doubly linked list of it where the assumption * v->Next()->Previous() == v holds (assuming v->Next() != NULL). */ bool src_in_dst = false; for (Train *v = dst_head; !src_in_dst && v != NULL; v = v->Next()) src_in_dst = v == src; /* * If the source chain is in the destination chain then the user is * only reordering the vehicles, thus not attaching a new vehicle. * Therefor the 'allow wagon attach' callback does not need to be * called. If it would be called strange things would happen because * one 'attaches' an already 'attached' vehicle causing more trouble * than it actually solves (infinite loops and such). */ if (dst_head != NULL && !src_in_dst && (flags & DC_AUTOREPLACE) == 0) { /* Forget everything, as everything is going to change */ src->InvalidateNewGRFCacheOfChain(); dst->InvalidateNewGRFCacheOfChain(); /* * When performing the 'allow wagon attach' callback, we have to check * that for each and every wagon, not only the first one. This means * that we have to test one wagon, attach it to the train and then test * the next wagon till we have reached the end. We have to restore it * to the state it was before we 'tried' attaching the train when the * attaching fails or succeeds because we are not 'only' doing this * in the DC_EXEC state. */ Train *dst_tail = dst_head; while (dst_tail->Next() != NULL) dst_tail = dst_tail->Next(); Train *orig_tail = dst_tail; Train *next_to_attach = src; Train *src_previous = src->Previous(); while (next_to_attach != NULL) { /* Don't check callback for articulated or rear dual headed parts */ if (!next_to_attach->IsArticulatedPart() && !next_to_attach->IsRearDualheaded()) { /* Back up and clear the first_engine data to avoid using wagon override group */ EngineID first_engine = next_to_attach->tcache.first_engine; next_to_attach->tcache.first_engine = INVALID_ENGINE; uint16 callback = GetVehicleCallbackParent(CBID_TRAIN_ALLOW_WAGON_ATTACH, 0, 0, dst_head->engine_type, next_to_attach, dst_head); /* Restore original first_engine data */ next_to_attach->tcache.first_engine = first_engine; /* We do not want to remember any cached variables from the test run */ next_to_attach->InvalidateNewGRFCache(); dst_head->InvalidateNewGRFCache(); if (callback != CALLBACK_FAILED) { StringID error = STR_NULL; if (callback == 0xFD) error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES; if (callback < 0xFD) error = GetGRFStringID(GetEngineGRFID(dst_head->engine_type), 0xD000 + callback); if (error != STR_NULL) { /* * The attaching is not allowed. In this case 'next_to_attach' * can contain some vehicles of the 'source' and the destination * train can have some too. We 'just' add the to-be added wagons * to the chain and then split it where it was previously * separated, i.e. the tail of the original destination train. * Furthermore the 'previous' link of the original source vehicle needs * to be restored, otherwise the train goes missing in the depot. */ dst_tail->SetNext(next_to_attach); orig_tail->SetNext(NULL); if (src_previous != NULL) src_previous->SetNext(src); return_cmd_error(error); } } } /* Only check further wagons if told to move the chain */ if (!HasBit(p2, 0)) break; /* * Adding a next wagon to the chain so we can test the other wagons. * First 'take' the first wagon from 'next_to_attach' and move it * to the next wagon. Then add that to the tail of the destination * train and update the tail with the new vehicle. */ Train *to_add = next_to_attach; next_to_attach = next_to_attach->Next(); to_add->SetNext(NULL); dst_tail->SetNext(to_add); dst_tail = dst_tail->Next(); } /* * When we reach this the attaching is allowed. It also means that the * chain of vehicles to attach is empty, so we do not need to merge that. * This means only the splitting needs to be done. * Furthermore the 'previous' link of the original source vehicle needs * to be restored, otherwise the train goes missing in the depot. */ orig_tail->SetNext(NULL); if (src_previous != NULL) src_previous->SetNext(src); } /* do it? */ if (flags & DC_EXEC) { /* If we move the front Engine and if the second vehicle is not an engine add the whole vehicle to the DEFAULT_GROUP */ if (src->IsFrontEngine() && !IsDefaultGroupID(src->group_id)) { Train *v = src->GetNextVehicle(); if (v != NULL && v->IsEngine()) { v->group_id = src->group_id; src->group_id = DEFAULT_GROUP; } } if (HasBit(p2, 0)) { /* unlink ALL wagons */ if (src != src_head) { Train *v = src_head; while (v->GetNextVehicle() != src) v = v->GetNextVehicle(); v->GetLastEnginePart()->SetNext(NULL); } else { InvalidateWindowData(WC_VEHICLE_DEPOT, src_head->tile); // We removed a line src_head = NULL; } } else { /* if moving within the same chain, dont use dst_head as it may get invalidated */ if (src_head == dst_head) dst_head = NULL; /* unlink single wagon from linked list */ src_head = UnlinkWagon(src, src_head); src->GetLastEnginePart()->SetNext(NULL); } if (dst == NULL) { /* We make a new line in the depot, so we know already that we invalidate the window data */ InvalidateWindowData(WC_VEHICLE_DEPOT, src->tile); /* move the train to an empty line. for locomotives, we set the type to TS_Front. for wagons, 4. */ if (src->IsEngine()) { if (!src->IsFrontEngine()) { /* setting the type to 0 also involves setting up the orders field. */ src->SetFrontEngine(); assert(src->orders.list == NULL); /* Decrease the engines number of the src engine_type */ if (!IsDefaultGroupID(src->group_id) && Group::IsValidID(src->group_id)) { Group::Get(src->group_id)->num_engines[src->engine_type]--; } /* If we move an engine to a new line affect it to the DEFAULT_GROUP */ src->group_id = DEFAULT_GROUP; } } else { src->SetFreeWagon(); } dst_head = src; } else { if (src->IsFrontEngine()) { /* the vehicle was previously a loco. need to free the order list and delete vehicle windows etc. */ DeleteWindowById(WC_VEHICLE_VIEW, src->index); DeleteWindowById(WC_VEHICLE_ORDERS, src->index); DeleteWindowById(WC_VEHICLE_REFIT, src->index); DeleteWindowById(WC_VEHICLE_DETAILS, src->index); DeleteWindowById(WC_VEHICLE_TIMETABLE, src->index); DeleteVehicleOrders(src); RemoveVehicleFromGroup(src); } if (src->IsFrontEngine() || src->IsFreeWagon()) { InvalidateWindowData(WC_VEHICLE_DEPOT, src->tile); src->ClearFrontEngine(); src->ClearFreeWagon(); src->unitnumber = 0; // doesn't occupy a unitnumber anymore. } /* link in the wagon(s) in the chain. */ { Train *v; for (v = src; v->GetNextVehicle() != NULL; v = v->GetNextVehicle()) {} v->GetLastEnginePart()->SetNext(dst->Next()); } dst->SetNext(src); } if (src->other_multiheaded_part != NULL) { if (src->other_multiheaded_part == src_head) { src_head = src_head->Next(); } AddWagonToConsist(src->other_multiheaded_part, src); } /* If there is an engine behind first_engine we moved away, it should become new first_engine * To do this, CmdMoveRailVehicle must be called once more * we can't loop forever here because next time we reach this line we will have a front engine */ if (src_head != NULL && !src_head->IsFrontEngine() && src_head->IsEngine()) { /* As in CmdMoveRailVehicle src_head->group_id will be equal to DEFAULT_GROUP * we need to save the group and reaffect it to src_head */ const GroupID tmp_g = src_head->group_id; CmdMoveRailVehicle(0, flags, src_head->index | (INVALID_VEHICLE << 16), 1, text); SetTrainGroupID(src_head, tmp_g); src_head = NULL; // don't do anything more to this train since the new call will do it } if (src_head != NULL) { NormaliseTrainConsist(src_head); TrainConsistChanged(src_head, false); UpdateTrainGroupID(src_head); if (src_head->IsFrontEngine()) { /* Update the refit button and window */ SetWindowDirty(WC_VEHICLE_REFIT, src_head->index); SetWindowWidgetDirty(WC_VEHICLE_VIEW, src_head->index, VVW_WIDGET_REFIT_VEH); } /* Update the depot window */ SetWindowDirty(WC_VEHICLE_DEPOT, src_head->tile); } if (dst_head != NULL) { NormaliseTrainConsist(dst_head); TrainConsistChanged(dst_head, false); UpdateTrainGroupID(dst_head); if (dst_head->IsFrontEngine()) { /* Update the refit button and window */ SetWindowWidgetDirty(WC_VEHICLE_VIEW, dst_head->index, VVW_WIDGET_REFIT_VEH); SetWindowDirty(WC_VEHICLE_REFIT, dst_head->index); } /* Update the depot window */ SetWindowDirty(WC_VEHICLE_DEPOT, dst_head->tile); } InvalidateWindowClassesData(WC_TRAINS_LIST, 0); } return CommandCost(); } /** Sell a (single) train wagon/engine. * @param tile unused * @param flags type of operation * @param p1 the wagon/engine index * @param p2 the selling mode * - p2 = 0: only sell the single dragged wagon/engine (and any belonging rear-engines) * - p2 = 1: sell the vehicle and all vehicles following it in the chain * if the wagon is dragged, don't delete the possibly belonging rear-engine to some front * @param text unused * @return the cost of this operation or an error */ CommandCost CmdSellRailWagon(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text) { /* Check if we deleted a vehicle window */ Window *w = NULL; Train *v = Train::GetIfValid(p1); if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR; if (p2 > 1) return CMD_ERROR; if (v->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_CAN_T_SELL_DESTROYED_VEHICLE); v = v->GetFirstEnginePart(); Train *first = v->First(); /* make sure the vehicle is stopped in the depot */ if (CheckTrainStoppedInDepot(first) < 0) { return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT); } if (v->IsRearDualheaded()) return_cmd_error(STR_ERROR_REAR_ENGINE_FOLLOW_FRONT); if (flags & DC_EXEC) { if (v == first && first->IsFrontEngine()) { DeleteWindowById(WC_VEHICLE_VIEW, first->index); DeleteWindowById(WC_VEHICLE_ORDERS, first->index); DeleteWindowById(WC_VEHICLE_REFIT, first->index); DeleteWindowById(WC_VEHICLE_DETAILS, first->index); DeleteWindowById(WC_VEHICLE_TIMETABLE, first->index); } SetWindowDirty(WC_VEHICLE_DEPOT, first->tile); InvalidateWindowClassesData(WC_TRAINS_LIST, 0); } CommandCost cost(EXPENSES_NEW_VEHICLES); switch (p2) { case 0: { // Delete given wagon bool switch_engine = false; // update second wagon to engine? /* 1. Delete the engine, if it is dualheaded also delete the matching * rear engine of the loco (from the point of deletion onwards) */ Train *rear = (v->IsMultiheaded() && v->IsEngine()) ? v->other_multiheaded_part : NULL; if (rear != NULL) { cost.AddCost(-rear->value); if (flags & DC_EXEC) { UnlinkWagon(rear, first); delete rear; } } /* 2. We are selling the front vehicle, some special action might be required * here, so take attention */ if (v == first) { Train *new_f = first->GetNextVehicle(); /* 2.2 If there are wagons present after the deleted front engine, check * if the second wagon (which will be first) is an engine. If it is one, * promote it as a new train, retaining the unitnumber, orders */ if (new_f != NULL && new_f->IsEngine()) { if (first->IsEngine()) { /* Let the new front engine take over the setup of the old engine */ switch_engine = true; if (flags & DC_EXEC) { /* Make sure the group counts stay correct. */ new_f->group_id = first->group_id; first->group_id = DEFAULT_GROUP; /* Copy orders (by sharing) */ new_f->orders.list = first->orders.list; new_f->AddToShared(first); DeleteVehicleOrders(first); /* Copy other important data from the front engine */ new_f->CopyVehicleConfigAndStatistics(first); /* If we deleted a window then open a new one for the 'new' train */ if (IsLocalCompany() && w != NULL) ShowVehicleViewWindow(new_f); } } else { /* We are selling a free wagon, and construct a new train at the same time. * This needs lots of extra checks (e.g. train limit), which are done by first moving * the remaining vehicles to a new row */ cost.AddCost(DoCommand(0, new_f->index | INVALID_VEHICLE << 16, 1, flags, CMD_MOVE_RAIL_VEHICLE)); if (cost.Failed()) return cost; } } } /* 3. Delete the requested wagon */ cost.AddCost(-v->value); if (flags & DC_EXEC) { first = UnlinkWagon(v, first); delete v; /* 4 If the second wagon was an engine, update it to front_engine * which UnlinkWagon() has changed to TS_Free_Car */ if (switch_engine) first->SetFrontEngine(); /* 5. If the train still exists, update its acceleration, window, etc. */ if (first != NULL) { NormaliseTrainConsist(first); TrainConsistChanged(first, false); UpdateTrainGroupID(first); if (first->IsFrontEngine()) SetWindowDirty(WC_VEHICLE_REFIT, first->index); } } } break; case 1: { // Delete wagon and all wagons after it given certain criteria /* Start deleting every vehicle after the selected one * If we encounter a matching rear-engine to a front-engine * earlier in the chain (before deletion), leave it alone */ for (Train *tmp; v != NULL; v = tmp) { tmp = v->GetNextVehicle(); if (v->IsMultiheaded()) { if (v->IsEngine()) { /* We got a front engine of a multiheaded set. Now we will sell the rear end too */ Train *rear = v->other_multiheaded_part; if (rear != NULL) { cost.AddCost(-rear->value); /* If this is a multiheaded vehicle with nothing * between the parts, tmp will be pointing to the * rear part, which is unlinked from the train and * deleted here. However, because tmp has already * been set it needs to be updated now so that the * loop never sees the rear part. */ if (tmp == rear) tmp = tmp->GetNextVehicle(); if (flags & DC_EXEC) { first = UnlinkWagon(rear, first); delete rear; } } } else if (v->other_multiheaded_part != NULL) { /* The front to this engine is earlier in this train. Do nothing */ continue; } } cost.AddCost(-v->value); if (flags & DC_EXEC) { first = UnlinkWagon(v, first); delete v; } } /* 3. If it is still a valid train after selling, update its acceleration and cached values */ if ((flags & DC_EXEC) && first != NULL) { NormaliseTrainConsist(first); TrainConsistChanged(first, false); UpdateTrainGroupID(first); SetWindowDirty(WC_VEHICLE_REFIT, first->index); } } break; } return cost; } void Train::UpdateDeltaXY(Direction direction) { #define MKIT(a, b, c, d) ((a & 0xFF) << 24) | ((b & 0xFF) << 16) | ((c & 0xFF) << 8) | ((d & 0xFF) << 0) static const uint32 _delta_xy_table[8] = { MKIT(3, 3, -1, -1), MKIT(3, 7, -1, -3), MKIT(3, 3, -1, -1), MKIT(7, 3, -3, -1), MKIT(3, 3, -1, -1), MKIT(3, 7, -1, -3), MKIT(3, 3, -1, -1), MKIT(7, 3, -3, -1), }; #undef MKIT uint32 x = _delta_xy_table[direction]; this->x_offs = GB(x, 0, 8); this->y_offs = GB(x, 8, 8); this->x_extent = GB(x, 16, 8); this->y_extent = GB(x, 24, 8); this->z_extent = 6; } static inline void SetLastSpeed(Train *v, int spd) { int old = v->tcache.last_speed; if (spd != old) { v->tcache.last_speed = spd; if (_settings_client.gui.vehicle_speed || (old == 0) != (spd == 0)) { SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } } } /** Mark a train as stuck and stop it if it isn't stopped right now. */ static void MarkTrainAsStuck(Train *v) { if (!HasBit(v->flags, VRF_TRAIN_STUCK)) { /* It is the first time the problem occured, set the "train stuck" flag. */ SetBit(v->flags, VRF_TRAIN_STUCK); /* When loading the vehicle is already stopped. No need to change that. */ if (v->current_order.IsType(OT_LOADING)) return; v->time_counter = 0; /* Stop train */ v->cur_speed = 0; v->subspeed = 0; SetLastSpeed(v, 0); SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } } static void SwapTrainFlags(uint16 *swap_flag1, uint16 *swap_flag2) { uint16 flag1 = *swap_flag1; uint16 flag2 = *swap_flag2; /* Clear the flags */ ClrBit(*swap_flag1, VRF_GOINGUP); ClrBit(*swap_flag1, VRF_GOINGDOWN); ClrBit(*swap_flag2, VRF_GOINGUP); ClrBit(*swap_flag2, VRF_GOINGDOWN); /* Reverse the rail-flags (if needed) */ if (HasBit(flag1, VRF_GOINGUP)) { SetBit(*swap_flag2, VRF_GOINGDOWN); } else if (HasBit(flag1, VRF_GOINGDOWN)) { SetBit(*swap_flag2, VRF_GOINGUP); } if (HasBit(flag2, VRF_GOINGUP)) { SetBit(*swap_flag1, VRF_GOINGDOWN); } else if (HasBit(flag2, VRF_GOINGDOWN)) { SetBit(*swap_flag1, VRF_GOINGUP); } } static void ReverseTrainSwapVeh(Train *v, int l, int r) { Train *a, *b; /* locate vehicles to swap */ for (a = v; l != 0; l--) a = a->Next(); for (b = v; r != 0; r--) b = b->Next(); if (a != b) { /* swap the hidden bits */ { uint16 tmp = (a->vehstatus & ~VS_HIDDEN) | (b->vehstatus&VS_HIDDEN); b->vehstatus = (b->vehstatus & ~VS_HIDDEN) | (a->vehstatus&VS_HIDDEN); a->vehstatus = tmp; } Swap(a->track, b->track); Swap(a->direction, b->direction); /* toggle direction */ if (a->track != TRACK_BIT_DEPOT) a->direction = ReverseDir(a->direction); if (b->track != TRACK_BIT_DEPOT) b->direction = ReverseDir(b->direction); Swap(a->x_pos, b->x_pos); Swap(a->y_pos, b->y_pos); Swap(a->tile, b->tile); Swap(a->z_pos, b->z_pos); SwapTrainFlags(&a->flags, &b->flags); /* update other vars */ a->UpdateViewport(true, true); b->UpdateViewport(true, true); /* call the proper EnterTile function unless we are in a wormhole */ if (a->track != TRACK_BIT_WORMHOLE) VehicleEnterTile(a, a->tile, a->x_pos, a->y_pos); if (b->track != TRACK_BIT_WORMHOLE) VehicleEnterTile(b, b->tile, b->x_pos, b->y_pos); } else { if (a->track != TRACK_BIT_DEPOT) a->direction = ReverseDir(a->direction); a->UpdateViewport(true, true); if (a->track != TRACK_BIT_WORMHOLE) VehicleEnterTile(a, a->tile, a->x_pos, a->y_pos); } /* Update train's power incase tiles were different rail type */ TrainPowerChanged(v); } /** * Check if the vehicle is a train * @param v vehicle on tile * @return v if it is a train, NULL otherwise */ static Vehicle *TrainOnTileEnum(Vehicle *v, void *) { return (v->type == VEH_TRAIN) ? v : NULL; } /** * Checks if a train is approaching a rail-road crossing * @param v vehicle on tile * @param data tile with crossing we are testing * @return v if it is approaching a crossing, NULL otherwise */ static Vehicle *TrainApproachingCrossingEnum(Vehicle *v, void *data) { if (v->type != VEH_TRAIN || (v->vehstatus & VS_CRASHED)) return NULL; Train *t = Train::From(v); if (!t->IsFrontEngine()) return NULL; TileIndex tile = *(TileIndex *)data; if (TrainApproachingCrossingTile(t) != tile) return NULL; return t; } /** * Finds a vehicle approaching rail-road crossing * @param tile tile to test * @return true if a vehicle is approaching the crossing * @pre tile is a rail-road crossing */ static bool TrainApproachingCrossing(TileIndex tile) { assert(IsLevelCrossingTile(tile)); DiagDirection dir = AxisToDiagDir(GetCrossingRailAxis(tile)); TileIndex tile_from = tile + TileOffsByDiagDir(dir); if (HasVehicleOnPos(tile_from, &tile, &TrainApproachingCrossingEnum)) return true; dir = ReverseDiagDir(dir); tile_from = tile + TileOffsByDiagDir(dir); return HasVehicleOnPos(tile_from, &tile, &TrainApproachingCrossingEnum); } /** * Sets correct crossing state * @param tile tile to update * @param sound should we play sound? * @pre tile is a rail-road crossing */ void UpdateLevelCrossing(TileIndex tile, bool sound) { assert(IsLevelCrossingTile(tile)); /* train on crossing || train approaching crossing || reserved */ bool new_state = HasVehicleOnPos(tile, NULL, &TrainOnTileEnum) || TrainApproachingCrossing(tile) || HasCrossingReservation(tile); if (new_state != IsCrossingBarred(tile)) { if (new_state && sound) { SndPlayTileFx(SND_0E_LEVEL_CROSSING, tile); } SetCrossingBarred(tile, new_state); MarkTileDirtyByTile(tile); } } /** * Bars crossing and plays ding-ding sound if not barred already * @param tile tile with crossing * @pre tile is a rail-road crossing */ static inline void MaybeBarCrossingWithSound(TileIndex tile) { if (!IsCrossingBarred(tile)) { BarCrossing(tile); SndPlayTileFx(SND_0E_LEVEL_CROSSING, tile); MarkTileDirtyByTile(tile); } } /** * Advances wagons for train reversing, needed for variable length wagons. * This one is called before the train is reversed. * @param v First vehicle in chain */ static void AdvanceWagonsBeforeSwap(Train *v) { Train *base = v; Train *first = base; // first vehicle to move Train *last = v->Last(); // last vehicle to move uint length = CountVehiclesInChain(v); while (length > 2) { last = last->Previous(); first = first->Next(); int differential = base->tcache.cached_veh_length - last->tcache.cached_veh_length; /* do not update images now * negative differential will be handled in AdvanceWagonsAfterSwap() */ for (int i = 0; i < differential; i++) TrainController(first, last->Next()); base = first; // == base->Next() length -= 2; } } /** * Advances wagons for train reversing, needed for variable length wagons. * This one is called after the train is reversed. * @param v First vehicle in chain */ static void AdvanceWagonsAfterSwap(Train *v) { /* first of all, fix the situation when the train was entering a depot */ Train *dep = v; // last vehicle in front of just left depot while (dep->Next() != NULL && (dep->track == TRACK_BIT_DEPOT || dep->Next()->track != TRACK_BIT_DEPOT)) { dep = dep->Next(); // find first vehicle outside of a depot, with next vehicle inside a depot } Train *leave = dep->Next(); // first vehicle in a depot we are leaving now if (leave != NULL) { /* 'pull' next wagon out of the depot, so we won't miss it (it could stay in depot forever) */ int d = TicksToLeaveDepot(dep); if (d <= 0) { leave->vehstatus &= ~VS_HIDDEN; // move it out of the depot leave->track = TrackToTrackBits(GetRailDepotTrack(leave->tile)); for (int i = 0; i >= d; i--) TrainController(leave, NULL); // maybe move it, and maybe let another wagon leave } } else { dep = NULL; // no vehicle in a depot, so no vehicle leaving a depot } Train *base = v; Train *first = base; // first vehicle to move Train *last = v->Last(); // last vehicle to move uint length = CountVehiclesInChain(v); /* we have to make sure all wagons that leave a depot because of train reversing are moved coorectly * they have already correct spacing, so we have to make sure they are moved how they should */ bool nomove = (dep == NULL); // if there is no vehicle leaving a depot, limit the number of wagons moved immediatelly while (length > 2) { /* we reached vehicle (originally) in front of a depot, stop now * (we would move wagons that are alredy moved with new wagon length) */ if (base == dep) break; /* the last wagon was that one leaving a depot, so do not move it anymore */ if (last == dep) nomove = true; last = last->Previous(); first = first->Next(); int differential = last->tcache.cached_veh_length - base->tcache.cached_veh_length; /* do not update images now */ for (int i = 0; i < differential; i++) TrainController(first, (nomove ? last->Next() : NULL)); base = first; // == base->Next() length -= 2; } } static void ReverseTrainDirection(Train *v) { if (IsRailDepotTile(v->tile)) { InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile); } /* Clear path reservation in front if train is not stuck. */ if (!HasBit(v->flags, VRF_TRAIN_STUCK)) FreeTrainTrackReservation(v); /* Check if we were approaching a rail/road-crossing */ TileIndex crossing = TrainApproachingCrossingTile(v); /* count number of vehicles */ int r = CountVehiclesInChain(v) - 1; // number of vehicles - 1 AdvanceWagonsBeforeSwap(v); /* swap start<>end, start+1<>end-1, ... */ int l = 0; do { ReverseTrainSwapVeh(v, l++, r--); } while (l <= r); AdvanceWagonsAfterSwap(v); if (IsRailDepotTile(v->tile)) { InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile); } ToggleBit(v->flags, VRF_TOGGLE_REVERSE); ClrBit(v->flags, VRF_REVERSING); /* recalculate cached data */ TrainConsistChanged(v, true); /* update all images */ for (Vehicle *u = v; u != NULL; u = u->Next()) u->UpdateViewport(false, false); /* update crossing we were approaching */ if (crossing != INVALID_TILE) UpdateLevelCrossing(crossing); /* maybe we are approaching crossing now, after reversal */ crossing = TrainApproachingCrossingTile(v); if (crossing != INVALID_TILE) MaybeBarCrossingWithSound(crossing); /* If we are inside a depot after reversing, don't bother with path reserving. */ if (v->track == TRACK_BIT_DEPOT) { /* Can't be stuck here as inside a depot is always a safe tile. */ if (HasBit(v->flags, VRF_TRAIN_STUCK)) SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); ClrBit(v->flags, VRF_TRAIN_STUCK); return; } /* TrainExitDir does not always produce the desired dir for depots and * tunnels/bridges that is needed for UpdateSignalsOnSegment. */ DiagDirection dir = TrainExitDir(v->direction, v->track); if (IsRailDepotTile(v->tile) || IsTileType(v->tile, MP_TUNNELBRIDGE)) dir = INVALID_DIAGDIR; if (UpdateSignalsOnSegment(v->tile, dir, v->owner) == SIGSEG_PBS || _settings_game.pf.reserve_paths) { /* If we are currently on a tile with conventional signals, we can't treat the * current tile as a safe tile or we would enter a PBS block without a reservation. */ bool first_tile_okay = !(IsTileType(v->tile, MP_RAILWAY) && HasSignalOnTrackdir(v->tile, v->GetVehicleTrackdir()) && !IsPbsSignal(GetSignalType(v->tile, FindFirstTrack(v->track)))); if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), true); if (TryPathReserve(v, false, first_tile_okay)) { /* Do a look-ahead now in case our current tile was already a safe tile. */ CheckNextTrainTile(v); } else if (v->current_order.GetType() != OT_LOADING) { /* Do not wait for a way out when we're still loading */ MarkTrainAsStuck(v); } } else if (HasBit(v->flags, VRF_TRAIN_STUCK)) { /* A train not inside a PBS block can't be stuck. */ ClrBit(v->flags, VRF_TRAIN_STUCK); v->time_counter = 0; } } /** Reverse train. * @param tile unused * @param flags type of operation * @param p1 train to reverse * @param p2 if true, reverse a unit in a train (needs to be in a depot) * @param text unused * @return the cost of this operation or an error */ CommandCost CmdReverseTrainDirection(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text) { Train *v = Train::GetIfValid(p1); if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR; if (p2 != 0) { /* turn a single unit around */ if (v->IsMultiheaded() || HasBit(EngInfo(v->engine_type)->callback_mask, CBM_VEHICLE_ARTIC_ENGINE)) { return_cmd_error(STR_ERROR_CAN_T_REVERSE_DIRECTION_RAIL_VEHICLE_MULTIPLE_UNITS); } Train *front = v->First(); /* make sure the vehicle is stopped in the depot */ if (CheckTrainStoppedInDepot(front) < 0) { return_cmd_error(STR_ERROR_TRAINS_CAN_ONLY_BE_ALTERED_INSIDE_A_DEPOT); } if (flags & DC_EXEC) { ToggleBit(v->flags, VRF_REVERSE_DIRECTION); SetWindowDirty(WC_VEHICLE_DEPOT, v->tile); SetWindowDirty(WC_VEHICLE_DETAILS, v->index); } } else { /* turn the whole train around */ if ((v->vehstatus & VS_CRASHED) || v->breakdown_ctr != 0) return CMD_ERROR; if (flags & DC_EXEC) { /* Properly leave the station if we are loading and won't be loading anymore */ if (v->current_order.IsType(OT_LOADING)) { const Vehicle *last = v; while (last->Next() != NULL) last = last->Next(); /* not a station || different station --> leave the station */ if (!IsTileType(last->tile, MP_STATION) || GetStationIndex(last->tile) != GetStationIndex(v->tile)) { v->LeaveStation(); } } if (_settings_game.vehicle.train_acceleration_model != TAM_ORIGINAL && v->cur_speed != 0) { ToggleBit(v->flags, VRF_REVERSING); } else { v->cur_speed = 0; SetLastSpeed(v, 0); HideFillingPercent(&v->fill_percent_te_id); ReverseTrainDirection(v); } } } return CommandCost(); } /** Force a train through a red signal * @param tile unused * @param flags type of operation * @param p1 train to ignore the red signal * @param p2 unused * @param text unused * @return the cost of this operation or an error */ CommandCost CmdForceTrainProceed(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text) { Train *t = Train::GetIfValid(p1); if (t == NULL || !CheckOwnership(t->owner)) return CMD_ERROR; if (flags & DC_EXEC) t->force_proceed = 0x50; return CommandCost(); } /** Refits a train to the specified cargo type. * @param tile unused * @param flags type of operation * @param p1 vehicle ID of the train to refit * @param p2 various bitstuffed elements * - p2 = (bit 0-7) - the new cargo type to refit to * - p2 = (bit 8-15) - the new cargo subtype to refit to * - p2 = (bit 16) - refit only this vehicle * @param text unused * @return the cost of this operation or an error */ CommandCost CmdRefitRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text) { CargoID new_cid = GB(p2, 0, 8); byte new_subtype = GB(p2, 8, 8); bool only_this = HasBit(p2, 16); Train *v = Train::GetIfValid(p1); if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR; if (CheckTrainStoppedInDepot(v) < 0) return_cmd_error(STR_TRAIN_MUST_BE_STOPPED); if (v->vehstatus & VS_CRASHED) return_cmd_error(STR_ERROR_CAN_T_REFIT_DESTROYED_VEHICLE); /* Check cargo */ if (new_cid >= NUM_CARGO) return CMD_ERROR; CommandCost cost = RefitVehicle(v, only_this, new_cid, new_subtype, flags); /* Update the train's cached variables */ if (flags & DC_EXEC) { Train *front = v->First(); TrainConsistChanged(front, false); SetWindowDirty(WC_VEHICLE_DETAILS, front->index); SetWindowDirty(WC_VEHICLE_DEPOT, front->tile); InvalidateWindowClassesData(WC_TRAINS_LIST, 0); } else { v->InvalidateNewGRFCacheOfChain(); // always invalidate; querycost might have filled it } return cost; } struct TrainFindDepotData { uint best_length; TileIndex tile; Owner owner; /** * true if reversing is necessary for the train to get to this depot * This value is unused when new depot finding and NPF are both disabled */ bool reverse; }; static bool NtpCallbFindDepot(TileIndex tile, TrainFindDepotData *tfdd, int track, uint length) { if (IsTileType(tile, MP_RAILWAY) && IsTileOwner(tile, tfdd->owner) && IsRailDepot(tile)) { /* approximate number of tiles by dividing by DIAG_FACTOR */ tfdd->best_length = length / DIAG_FACTOR; tfdd->tile = tile; return true; } return false; } /** returns the tile of a depot to goto to. The given vehicle must not be * crashed! */ static TrainFindDepotData FindClosestTrainDepot(Train *v, int max_distance) { assert(!(v->vehstatus & VS_CRASHED)); TrainFindDepotData tfdd; tfdd.owner = v->owner; tfdd.reverse = false; if (IsRailDepotTile(v->tile)) { tfdd.tile = v->tile; tfdd.best_length = 0; return tfdd; } PBSTileInfo origin = FollowTrainReservation(v); if (IsRailDepotTile(origin.tile)) { tfdd.tile = origin.tile; tfdd.best_length = 0; return tfdd; } tfdd.best_length = UINT_MAX; uint8 pathfinder = _settings_game.pf.pathfinder_for_trains; if ((_settings_game.pf.reserve_paths || HasReservedTracks(v->tile, v->track)) && pathfinder == VPF_NTP) pathfinder = VPF_NPF; switch (pathfinder) { case VPF_YAPF: { // YAPF bool found = YapfFindNearestRailDepotTwoWay(v, max_distance, NPF_INFINITE_PENALTY, &tfdd.tile, &tfdd.reverse); tfdd.best_length = found ? max_distance / 2 : UINT_MAX; // some fake distance or NOT_FOUND } break; case VPF_NPF: { // NPF const Vehicle *last = v->Last(); Trackdir trackdir = v->GetVehicleTrackdir(); Trackdir trackdir_rev = ReverseTrackdir(last->GetVehicleTrackdir()); assert(trackdir != INVALID_TRACKDIR); NPFFoundTargetData ftd = NPFRouteToDepotBreadthFirstTwoWay(v->tile, trackdir, false, last->tile, trackdir_rev, false, TRANSPORT_RAIL, 0, v->owner, v->compatible_railtypes, NPF_INFINITE_PENALTY); if (ftd.best_bird_dist == 0) { /* Found target */ tfdd.tile = ftd.node.tile; /* Our caller expects a number of tiles, so we just approximate that * number by this. It might not be completely what we want, but it will * work for now :-) We can possibly change this when the old pathfinder * is removed. */ tfdd.best_length = ftd.best_path_dist / NPF_TILE_LENGTH; if (NPFGetFlag(&ftd.node, NPF_FLAG_REVERSE)) tfdd.reverse = true; } } break; default: case VPF_NTP: { // NTP /* search in the forward direction first. */ DiagDirection i = TrainExitDir(v->direction, v->track); NewTrainPathfind(v->tile, 0, v->compatible_railtypes, i, (NTPEnumProc*)NtpCallbFindDepot, &tfdd); if (tfdd.best_length == UINT_MAX) { tfdd.reverse = true; /* search in backwards direction */ i = TrainExitDir(ReverseDir(v->direction), v->track); NewTrainPathfind(v->tile, 0, v->compatible_railtypes, i, (NTPEnumProc*)NtpCallbFindDepot, &tfdd); } } break; } return tfdd; } bool Train::FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse) { TrainFindDepotData tfdd = FindClosestTrainDepot(this, 0); if (tfdd.best_length == UINT_MAX) return false; if (location != NULL) *location = tfdd.tile; if (destination != NULL) *destination = GetDepotIndex(tfdd.tile); if (reverse != NULL) *reverse = tfdd.reverse; return true; } /** Send a train to a depot * @param tile unused * @param flags type of operation * @param p1 train to send to the depot * @param p2 various bitmasked elements * - p2 bit 0-3 - DEPOT_ flags (see vehicle.h) * - p2 bit 8-10 - VLW flag (for mass goto depot) * @param text unused * @return the cost of this operation or an error */ CommandCost CmdSendTrainToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text) { if (p2 & DEPOT_MASS_SEND) { /* Mass goto depot requested */ if (!ValidVLWFlags(p2 & VLW_MASK)) return CMD_ERROR; return SendAllVehiclesToDepot(VEH_TRAIN, flags, p2 & DEPOT_SERVICE, _current_company, (p2 & VLW_MASK), p1); } Train *v = Train::GetIfValid(p1); if (v == NULL) return CMD_ERROR; return v->SendToDepot(flags, (DepotCommand)(p2 & DEPOT_COMMAND_MASK)); } static const int8 _vehicle_smoke_pos[8] = { 1, 1, 1, 0, -1, -1, -1, 0 }; static void HandleLocomotiveSmokeCloud(const Train *v) { bool sound = false; if ((v->vehstatus & VS_TRAIN_SLOWING) || v->cur_speed < 2) { return; } const Train *u = v; do { const RailVehicleInfo *rvi = RailVehInfo(v->engine_type); int effect_offset = GB(v->tcache.cached_vis_effect, 0, 4) - 8; byte effect_type = GB(v->tcache.cached_vis_effect, 4, 2); bool disable_effect = HasBit(v->tcache.cached_vis_effect, 6); /* no smoke? */ if ((rvi->railveh_type == RAILVEH_WAGON && effect_type == 0) || disable_effect || v->vehstatus & VS_HIDDEN) { continue; } /* No smoke in depots or tunnels */ if (IsRailDepotTile(v->tile) || IsTunnelTile(v->tile)) continue; /* No sparks for electric vehicles on nonelectrified tracks */ if (!HasPowerOnRail(v->railtype, GetTileRailType(v->tile))) continue; if (effect_type == 0) { /* Use default effect type for engine class. */ effect_type = rvi->engclass; } else { effect_type--; } int x = _vehicle_smoke_pos[v->direction] * effect_offset; int y = _vehicle_smoke_pos[(v->direction + 2) % 8] * effect_offset; if (HasBit(v->flags, VRF_REVERSE_DIRECTION)) { x = -x; y = -y; } switch (effect_type) { case 0: /* steam smoke. */ if (GB(v->tick_counter, 0, 4) == 0) { CreateEffectVehicleRel(v, x, y, 10, EV_STEAM_SMOKE); sound = true; } break; case 1: /* diesel smoke */ if (u->cur_speed <= 40 && Chance16(15, 128)) { CreateEffectVehicleRel(v, 0, 0, 10, EV_DIESEL_SMOKE); sound = true; } break; case 2: /* blue spark */ if (GB(v->tick_counter, 0, 2) == 0 && Chance16(1, 45)) { CreateEffectVehicleRel(v, 0, 0, 10, EV_ELECTRIC_SPARK); sound = true; } break; default: break; } } while ((v = v->Next()) != NULL); if (sound) PlayVehicleSound(u, VSE_TRAIN_EFFECT); } void Train::PlayLeaveStationSound() const { static const SoundFx sfx[] = { SND_04_TRAIN, SND_0A_TRAIN_HORN, SND_0A_TRAIN_HORN, SND_47_MAGLEV_2, SND_41_MAGLEV }; if (PlayVehicleSound(this, VSE_START)) return; EngineID engtype = this->engine_type; SndPlayVehicleFx(sfx[RailVehInfo(engtype)->engclass], this); } /** Check if the train is on the last reserved tile and try to extend the path then. */ static void CheckNextTrainTile(Train *v) { /* Don't do any look-ahead if path_backoff_interval is 255. */ if (_settings_game.pf.path_backoff_interval == 255) return; /* Exit if we reached our destination depot or are inside a depot. */ if ((v->tile == v->dest_tile && v->current_order.IsType(OT_GOTO_DEPOT)) || v->track == TRACK_BIT_DEPOT) return; /* Exit if we are on a station tile and are going to stop. */ if (IsRailStationTile(v->tile) && v->current_order.ShouldStopAtStation(v, GetStationIndex(v->tile))) return; /* Exit if the current order doesn't have a destination, but the train has orders. */ if ((v->current_order.IsType(OT_NOTHING) || v->current_order.IsType(OT_LEAVESTATION) || v->current_order.IsType(OT_LOADING)) && v->GetNumOrders() > 0) return; Trackdir td = v->GetVehicleTrackdir(); /* On a tile with a red non-pbs signal, don't look ahead. */ if (IsTileType(v->tile, MP_RAILWAY) && HasSignalOnTrackdir(v->tile, td) && !IsPbsSignal(GetSignalType(v->tile, TrackdirToTrack(td))) && GetSignalStateByTrackdir(v->tile, td) == SIGNAL_STATE_RED) return; CFollowTrackRail ft(v); if (!ft.Follow(v->tile, td)) return; if (!HasReservedTracks(ft.m_new_tile, TrackdirBitsToTrackBits(ft.m_new_td_bits))) { /* Next tile is not reserved. */ if (KillFirstBit(ft.m_new_td_bits) == TRACKDIR_BIT_NONE) { if (HasPbsSignalOnTrackdir(ft.m_new_tile, FindFirstTrackdir(ft.m_new_td_bits))) { /* If the next tile is a PBS signal, try to make a reservation. */ TrackBits tracks = TrackdirBitsToTrackBits(ft.m_new_td_bits); if (_settings_game.pf.pathfinder_for_trains != VPF_NTP && _settings_game.pf.forbid_90_deg) { tracks &= ~TrackCrossesTracks(TrackdirToTrack(ft.m_old_td)); } ChooseTrainTrack(v, ft.m_new_tile, ft.m_exitdir, tracks, false, NULL, false); } } } } static bool CheckTrainStayInDepot(Train *v) { /* bail out if not all wagons are in the same depot or not in a depot at all */ for (const Train *u = v; u != NULL; u = u->Next()) { if (u->track != TRACK_BIT_DEPOT || u->tile != v->tile) return false; } /* if the train got no power, then keep it in the depot */ if (v->tcache.cached_power == 0) { v->vehstatus |= VS_STOPPED; SetWindowDirty(WC_VEHICLE_DEPOT, v->tile); return true; } SigSegState seg_state; if (v->force_proceed == 0) { /* force proceed was not pressed */ if (++v->time_counter < 37) { SetWindowClassesDirty(WC_TRAINS_LIST); return true; } v->time_counter = 0; seg_state = _settings_game.pf.reserve_paths ? SIGSEG_PBS : UpdateSignalsOnSegment(v->tile, INVALID_DIAGDIR, v->owner); if (seg_state == SIGSEG_FULL || HasDepotReservation(v->tile)) { /* Full and no PBS signal in block or depot reserved, can't exit. */ SetWindowClassesDirty(WC_TRAINS_LIST); return true; } } else { seg_state = _settings_game.pf.reserve_paths ? SIGSEG_PBS : UpdateSignalsOnSegment(v->tile, INVALID_DIAGDIR, v->owner); } /* We are leaving a depot, but have to go to the exact same one; re-enter */ if (v->current_order.IsType(OT_GOTO_DEPOT) && v->tile == v->dest_tile) { /* We need to have a reservation for this to work. */ if (HasDepotReservation(v->tile)) return true; SetDepotReservation(v->tile, true); VehicleEnterDepot(v); return true; } /* Only leave when we can reserve a path to our destination. */ if (seg_state == SIGSEG_PBS && !TryPathReserve(v) && v->force_proceed == 0) { /* No path and no force proceed. */ SetWindowClassesDirty(WC_TRAINS_LIST); MarkTrainAsStuck(v); return true; } SetDepotReservation(v->tile, true); if (_settings_client.gui.show_track_reservation) MarkTileDirtyByTile(v->tile); VehicleServiceInDepot(v); SetWindowClassesDirty(WC_TRAINS_LIST); v->PlayLeaveStationSound(); v->track = TRACK_BIT_X; if (v->direction & 2) v->track = TRACK_BIT_Y; v->vehstatus &= ~VS_HIDDEN; v->cur_speed = 0; v->UpdateDeltaXY(v->direction); v->cur_image = v->GetImage(v->direction); VehicleMove(v, false); UpdateSignalsOnSegment(v->tile, INVALID_DIAGDIR, v->owner); UpdateTrainAcceleration(v); InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile); return false; } /** Clear the reservation of a tile that was just left by a wagon on track_dir. */ static void ClearPathReservation(const Train *v, TileIndex tile, Trackdir track_dir) { DiagDirection dir = TrackdirToExitdir(track_dir); if (IsTileType(tile, MP_TUNNELBRIDGE)) { /* Are we just leaving a tunnel/bridge? */ if (GetTunnelBridgeDirection(tile) == ReverseDiagDir(dir)) { TileIndex end = GetOtherTunnelBridgeEnd(tile); if (!HasVehicleOnTunnelBridge(tile, end, v)) { /* Free the reservation only if no other train is on the tiles. */ SetTunnelBridgeReservation(tile, false); SetTunnelBridgeReservation(end, false); if (_settings_client.gui.show_track_reservation) { MarkTileDirtyByTile(tile); MarkTileDirtyByTile(end); } } } } else if (IsRailStationTile(tile)) { TileIndex new_tile = TileAddByDiagDir(tile, dir); /* If the new tile is not a further tile of the same station, we * clear the reservation for the whole platform. */ if (!IsCompatibleTrainStationTile(new_tile, tile)) { SetRailStationPlatformReservation(tile, ReverseDiagDir(dir), false); } } else { /* Any other tile */ UnreserveRailTrack(tile, TrackdirToTrack(track_dir)); } } /** Free the reserved path in front of a vehicle. */ void FreeTrainTrackReservation(const Train *v, TileIndex origin, Trackdir orig_td) { assert(v->IsFrontEngine()); TileIndex tile = origin != INVALID_TILE ? origin : v->tile; Trackdir td = orig_td != INVALID_TRACKDIR ? orig_td : v->GetVehicleTrackdir(); bool free_tile = tile != v->tile || !(IsRailStationTile(v->tile) || IsTileType(v->tile, MP_TUNNELBRIDGE)); StationID station_id = IsRailStationTile(v->tile) ? GetStationIndex(v->tile) : INVALID_STATION; /* Don't free reservation if it's not ours. */ if (TracksOverlap(GetReservedTrackbits(tile) | TrackToTrackBits(TrackdirToTrack(td)))) return; CFollowTrackRail ft(v, GetRailTypeInfo(v->railtype)->compatible_railtypes); while (ft.Follow(tile, td)) { tile = ft.m_new_tile; TrackdirBits bits = ft.m_new_td_bits & TrackBitsToTrackdirBits(GetReservedTrackbits(tile)); td = RemoveFirstTrackdir(&bits); assert(bits == TRACKDIR_BIT_NONE); if (!IsValidTrackdir(td)) break; if (IsTileType(tile, MP_RAILWAY)) { if (HasSignalOnTrackdir(tile, td) && !IsPbsSignal(GetSignalType(tile, TrackdirToTrack(td)))) { /* Conventional signal along trackdir: remove reservation and stop. */ UnreserveRailTrack(tile, TrackdirToTrack(td)); break; } if (HasPbsSignalOnTrackdir(tile, td)) { if (GetSignalStateByTrackdir(tile, td) == SIGNAL_STATE_RED) { /* Red PBS signal? Can't be our reservation, would be green then. */ break; } else { /* Turn the signal back to red. */ SetSignalStateByTrackdir(tile, td, SIGNAL_STATE_RED); MarkTileDirtyByTile(tile); } } else if (HasSignalOnTrackdir(tile, ReverseTrackdir(td)) && IsOnewaySignal(tile, TrackdirToTrack(td))) { break; } } /* Don't free first station/bridge/tunnel if we are on it. */ if (free_tile || (!(ft.m_is_station && GetStationIndex(ft.m_new_tile) == station_id) && !ft.m_is_tunnel && !ft.m_is_bridge)) ClearPathReservation(v, tile, td); free_tile = true; } } /** Check for station tiles */ struct TrainTrackFollowerData { TileIndex dest_coords; StationID station_index; ///< station index we're heading for uint best_bird_dist; uint best_track_dist; TrackdirByte best_track; }; static bool NtpCallbFindStation(TileIndex tile, TrainTrackFollowerData *ttfd, Trackdir track, uint length) { /* heading for nowhere? */ if (ttfd->dest_coords == 0) return false; /* did we reach the final station? */ if ((ttfd->station_index == INVALID_STATION && tile == ttfd->dest_coords) || ( IsRailStationTile(tile) && GetStationIndex(tile) == ttfd->station_index )) { /* We do not check for dest_coords if we have a station_index, * because in that case the dest_coords are just an * approximation of where the station is */ /* found station */ ttfd->best_track = track; ttfd->best_bird_dist = 0; return true; } else { /* didn't find station, keep track of the best path so far. */ uint dist = DistanceManhattan(tile, ttfd->dest_coords); if (dist < ttfd->best_bird_dist) { ttfd->best_bird_dist = dist; ttfd->best_track = track; } return false; } } static void FillWithStationData(TrainTrackFollowerData *fd, const Vehicle *v) { fd->dest_coords = v->dest_tile; fd->station_index = v->current_order.IsType(OT_GOTO_STATION) ? v->current_order.GetDestination() : INVALID_STATION; } static const byte _initial_tile_subcoord[6][4][3] = { {{ 15, 8, 1 }, { 0, 0, 0 }, { 0, 8, 5 }, { 0, 0, 0 }}, {{ 0, 0, 0 }, { 8, 0, 3 }, { 0, 0, 0 }, { 8, 15, 7 }}, {{ 0, 0, 0 }, { 7, 0, 2 }, { 0, 7, 6 }, { 0, 0, 0 }}, {{ 15, 8, 2 }, { 0, 0, 0 }, { 0, 0, 0 }, { 8, 15, 6 }}, {{ 15, 7, 0 }, { 8, 0, 4 }, { 0, 0, 0 }, { 0, 0, 0 }}, {{ 0, 0, 0 }, { 0, 0, 0 }, { 0, 8, 4 }, { 7, 15, 0 }}, }; static const byte _search_directions[6][4] = { { 0, 9, 2, 9 }, ///< track 1 { 9, 1, 9, 3 }, ///< track 2 { 9, 0, 3, 9 }, ///< track upper { 1, 9, 9, 2 }, ///< track lower { 3, 2, 9, 9 }, ///< track left { 9, 9, 1, 0 }, ///< track right }; static const byte _pick_track_table[6] = {1, 3, 2, 2, 0, 0}; /** * Perform pathfinding for a train. * * @param v The train * @param tile The tile the train is about to enter * @param enterdir Diagonal direction the train is coming from * @param tracks Usable tracks on the new tile * @param path_not_found [out] Set to false if the pathfinder couldn't find a way to the destination * @param do_track_reservation Path reservation is requested * @param dest [out] State and destination of the requested path * @return The best track the train should follow */ static Track DoTrainPathfind(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool *path_not_found, bool do_track_reservation, PBSTileInfo *dest) { Track best_track; #ifdef PF_BENCHMARK TIC() #endif if (path_not_found) *path_not_found = false; uint8 pathfinder = _settings_game.pf.pathfinder_for_trains; if (do_track_reservation && pathfinder == VPF_NTP) pathfinder = VPF_NPF; switch (pathfinder) { case VPF_YAPF: { // YAPF Trackdir trackdir = YapfChooseRailTrack(v, tile, enterdir, tracks, path_not_found, do_track_reservation, dest); if (trackdir != INVALID_TRACKDIR) { best_track = TrackdirToTrack(trackdir); } else { best_track = FindFirstTrack(tracks); } } break; case VPF_NPF: { // NPF void *perf = NpfBeginInterval(); NPFFindStationOrTileData fstd; NPFFillWithOrderData(&fstd, v, do_track_reservation); PBSTileInfo origin = FollowTrainReservation(v); assert(IsValidTrackdir(origin.trackdir)); NPFFoundTargetData ftd = NPFRouteToStationOrTile(origin.tile, origin.trackdir, true, &fstd, TRANSPORT_RAIL, 0, v->owner, v->compatible_railtypes); if (dest != NULL) { dest->tile = ftd.node.tile; dest->trackdir = (Trackdir)ftd.node.direction; dest->okay = ftd.res_okay; } if (ftd.best_trackdir == INVALID_TRACKDIR) { /* We are already at our target. Just do something * @todo maybe display error? * @todo: go straight ahead if possible? */ best_track = FindFirstTrack(tracks); } else { /* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains * the direction we need to take to get there, if ftd.best_bird_dist is not 0, * we did not find our target, but ftd.best_trackdir contains the direction leading * to the tile closest to our target. */ if (ftd.best_bird_dist != 0 && path_not_found != NULL) *path_not_found = true; /* Discard enterdir information, making it a normal track */ best_track = TrackdirToTrack(ftd.best_trackdir); } int time = NpfEndInterval(perf); DEBUG(yapf, 4, "[NPFT] %d us - %d rounds - %d open - %d closed -- ", time, 0, _aystar_stats_open_size, _aystar_stats_closed_size); } break; default: case VPF_NTP: { // NTP void *perf = NpfBeginInterval(); TrainTrackFollowerData fd; FillWithStationData(&fd, v); /* New train pathfinding */ fd.best_bird_dist = UINT_MAX; fd.best_track_dist = UINT_MAX; fd.best_track = INVALID_TRACKDIR; NewTrainPathfind(tile - TileOffsByDiagDir(enterdir), v->dest_tile, v->compatible_railtypes, enterdir, (NTPEnumProc*)NtpCallbFindStation, &fd); /* check whether the path was found or only 'guessed' */ if (fd.best_bird_dist != 0 && path_not_found != NULL) *path_not_found = true; if (fd.best_track == INVALID_TRACKDIR) { /* blaha */ best_track = FindFirstTrack(tracks); } else { best_track = TrackdirToTrack(fd.best_track); } int time = NpfEndInterval(perf); DEBUG(yapf, 4, "[NTPT] %d us - %d rounds - %d open - %d closed -- ", time, 0, 0, 0); } break; } #ifdef PF_BENCHMARK TOC("PF time = ", 1) #endif return best_track; } /** * Extend a train path as far as possible. Stops on encountering a safe tile, * another reservation or a track choice. * @return INVALID_TILE indicates that the reservation failed. */ static PBSTileInfo ExtendTrainReservation(const Train *v, TrackBits *new_tracks, DiagDirection *enterdir) { bool no_90deg_turns = _settings_game.pf.pathfinder_for_trains != VPF_NTP && _settings_game.pf.forbid_90_deg; PBSTileInfo origin = FollowTrainReservation(v); CFollowTrackRail ft(v); TileIndex tile = origin.tile; Trackdir cur_td = origin.trackdir; while (ft.Follow(tile, cur_td)) { if (KillFirstBit(ft.m_new_td_bits) == TRACKDIR_BIT_NONE) { /* Possible signal tile. */ if (HasOnewaySignalBlockingTrackdir(ft.m_new_tile, FindFirstTrackdir(ft.m_new_td_bits))) break; } if (no_90deg_turns) { ft.m_new_td_bits &= ~TrackdirCrossesTrackdirs(ft.m_old_td); if (ft.m_new_td_bits == TRACKDIR_BIT_NONE) break; } /* Station, depot or waypoint are a possible target. */ bool target_seen = ft.m_is_station || (IsTileType(ft.m_new_tile, MP_RAILWAY) && !IsPlainRail(ft.m_new_tile)); if (target_seen || KillFirstBit(ft.m_new_td_bits) != TRACKDIR_BIT_NONE) { /* Choice found or possible target encountered. * On finding a possible target, we need to stop and let the pathfinder handle the * remaining path. This is because we don't know if this target is in one of our * orders, so we might cause pathfinding to fail later on if we find a choice. * This failure would cause a bogous call to TryReserveSafePath which might reserve * a wrong path not leading to our next destination. */ if (HasReservedTracks(ft.m_new_tile, TrackdirBitsToTrackBits(TrackdirReachesTrackdirs(ft.m_old_td)))) break; /* If we did skip some tiles, backtrack to the first skipped tile so the pathfinder * actually starts its search at the first unreserved tile. */ if (ft.m_tiles_skipped != 0) ft.m_new_tile -= TileOffsByDiagDir(ft.m_exitdir) * ft.m_tiles_skipped; /* Choice found, path valid but not okay. Save info about the choice tile as well. */ if (new_tracks) *new_tracks = TrackdirBitsToTrackBits(ft.m_new_td_bits); if (enterdir) *enterdir = ft.m_exitdir; return PBSTileInfo(ft.m_new_tile, ft.m_old_td, false); } tile = ft.m_new_tile; cur_td = FindFirstTrackdir(ft.m_new_td_bits); if (IsSafeWaitingPosition(v, tile, cur_td, true, no_90deg_turns)) { bool wp_free = IsWaitingPositionFree(v, tile, cur_td, no_90deg_turns); if (!(wp_free && TryReserveRailTrack(tile, TrackdirToTrack(cur_td)))) break; /* Safe position is all good, path valid and okay. */ return PBSTileInfo(tile, cur_td, true); } if (!TryReserveRailTrack(tile, TrackdirToTrack(cur_td))) break; } if (ft.m_err == CFollowTrackRail::EC_OWNER || ft.m_err == CFollowTrackRail::EC_NO_WAY) { /* End of line, path valid and okay. */ return PBSTileInfo(ft.m_old_tile, ft.m_old_td, true); } /* Sorry, can't reserve path, back out. */ tile = origin.tile; cur_td = origin.trackdir; TileIndex stopped = ft.m_old_tile; Trackdir stopped_td = ft.m_old_td; while (tile != stopped || cur_td != stopped_td) { if (!ft.Follow(tile, cur_td)) break; if (no_90deg_turns) { ft.m_new_td_bits &= ~TrackdirCrossesTrackdirs(ft.m_old_td); assert(ft.m_new_td_bits != TRACKDIR_BIT_NONE); } assert(KillFirstBit(ft.m_new_td_bits) == TRACKDIR_BIT_NONE); tile = ft.m_new_tile; cur_td = FindFirstTrackdir(ft.m_new_td_bits); UnreserveRailTrack(tile, TrackdirToTrack(cur_td)); } /* Path invalid. */ return PBSTileInfo(); } /** * Try to reserve any path to a safe tile, ignoring the vehicle's destination. * Safe tiles are tiles in front of a signal, depots and station tiles at end of line. * * @param v The vehicle. * @param tile The tile the search should start from. * @param td The trackdir the search should start from. * @param override_tailtype Whether all physically compatible railtypes should be followed. * @return True if a path to a safe stopping tile could be reserved. */ static bool TryReserveSafeTrack(const Train *v, TileIndex tile, Trackdir td, bool override_tailtype) { if (_settings_game.pf.pathfinder_for_trains == VPF_YAPF) { return YapfRailFindNearestSafeTile(v, tile, td, override_tailtype); } else { return NPFRouteToSafeTile(v, tile, td, override_tailtype).res_okay; } } /** This class will save the current order of a vehicle and restore it on destruction. */ class VehicleOrderSaver { private: Vehicle *v; Order old_order; TileIndex old_dest_tile; StationID old_last_station_visited; VehicleOrderID index; public: VehicleOrderSaver(Vehicle *_v) : v(_v), old_order(_v->current_order), old_dest_tile(_v->dest_tile), old_last_station_visited(_v->last_station_visited), index(_v->cur_order_index) { } ~VehicleOrderSaver() { this->v->current_order = this->old_order; this->v->dest_tile = this->old_dest_tile; this->v->last_station_visited = this->old_last_station_visited; } /** * Set the current vehicle order to the next order in the order list. * @param skip_first Shall the first (i.e. active) order be skipped? * @return True if a suitable next order could be found. */ bool SwitchToNextOrder(bool skip_first) { if (this->v->GetNumOrders() == 0) return false; if (skip_first) ++this->index; int conditional_depth = 0; do { /* Wrap around. */ if (this->index >= this->v->GetNumOrders()) this->index = 0; Order *order = this->v->GetOrder(this->index); assert(order != NULL); switch (order->GetType()) { case OT_GOTO_DEPOT: /* Skip service in depot orders when the train doesn't need service. */ if ((order->GetDepotOrderType() & ODTFB_SERVICE) && !this->v->NeedsServicing()) break; case OT_GOTO_STATION: case OT_GOTO_WAYPOINT: this->v->current_order = *order; UpdateOrderDest(this->v, order); return true; case OT_CONDITIONAL: { if (conditional_depth > this->v->GetNumOrders()) return false; VehicleOrderID next = ProcessConditionalOrder(order, this->v); if (next != INVALID_VEH_ORDER_ID) { conditional_depth++; this->index = next; /* Don't increment next, so no break here. */ continue; } break; } default: break; } /* Don't increment inside the while because otherwise conditional * orders can lead to an infinite loop. */ ++this->index; } while (this->index != this->v->cur_order_index); return false; } }; /* choose a track */ static Track ChooseTrainTrack(Train *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool force_res, bool *got_reservation, bool mark_stuck) { Track best_track = INVALID_TRACK; bool do_track_reservation = _settings_game.pf.reserve_paths || force_res; bool changed_signal = false; assert((tracks & ~TRACK_BIT_MASK) == 0); if (got_reservation != NULL) *got_reservation = false; /* Don't use tracks here as the setting to forbid 90 deg turns might have been switched between reservation and now. */ TrackBits res_tracks = (TrackBits)(GetReservedTrackbits(tile) & DiagdirReachesTracks(enterdir)); /* Do we have a suitable reserved track? */ if (res_tracks != TRACK_BIT_NONE) return FindFirstTrack(res_tracks); /* Quick return in case only one possible track is available */ if (KillFirstBit(tracks) == TRACK_BIT_NONE) { Track track = FindFirstTrack(tracks); /* We need to check for signals only here, as a junction tile can't have signals. */ if (track != INVALID_TRACK && HasPbsSignalOnTrackdir(tile, TrackEnterdirToTrackdir(track, enterdir))) { do_track_reservation = true; changed_signal = true; SetSignalStateByTrackdir(tile, TrackEnterdirToTrackdir(track, enterdir), SIGNAL_STATE_GREEN); } else if (!do_track_reservation) { return track; } best_track = track; } PBSTileInfo res_dest(tile, INVALID_TRACKDIR, false); DiagDirection dest_enterdir = enterdir; if (do_track_reservation) { /* Check if the train needs service here, so it has a chance to always find a depot. * Also check if the current order is a service order so we don't reserve a path to * the destination but instead to the next one if service isn't needed. */ CheckIfTrainNeedsService(v); if (v->current_order.IsType(OT_DUMMY) || v->current_order.IsType(OT_CONDITIONAL) || v->current_order.IsType(OT_GOTO_DEPOT)) ProcessOrders(v); res_dest = ExtendTrainReservation(v, &tracks, &dest_enterdir); if (res_dest.tile == INVALID_TILE) { /* Reservation failed? */ if (mark_stuck) MarkTrainAsStuck(v); if (changed_signal) SetSignalStateByTrackdir(tile, TrackEnterdirToTrackdir(best_track, enterdir), SIGNAL_STATE_RED); return FindFirstTrack(tracks); } } /* Save the current train order. The destructor will restore the old order on function exit. */ VehicleOrderSaver orders(v); /* If the current tile is the destination of the current order and * a reservation was requested, advance to the next order. * Don't advance on a depot order as depots are always safe end points * for a path and no look-ahead is necessary. This also avoids a * problem with depot orders not part of the order list when the * order list itself is empty. */ if (v->current_order.IsType(OT_LEAVESTATION)) { orders.SwitchToNextOrder(false); } else if (v->current_order.IsType(OT_LOADING) || (!v->current_order.IsType(OT_GOTO_DEPOT) && ( v->current_order.IsType(OT_GOTO_STATION) ? IsRailStationTile(v->tile) && v->current_order.GetDestination() == GetStationIndex(v->tile) : v->tile == v->dest_tile))) { orders.SwitchToNextOrder(true); } if (res_dest.tile != INVALID_TILE && !res_dest.okay) { /* Pathfinders are able to tell that route was only 'guessed'. */ bool path_not_found = false; TileIndex new_tile = res_dest.tile; Track next_track = DoTrainPathfind(v, new_tile, dest_enterdir, tracks, &path_not_found, do_track_reservation, &res_dest); if (new_tile == tile) best_track = next_track; /* handle "path not found" state */ if (path_not_found) { /* PF didn't find the route */ if (!HasBit(v->flags, VRF_NO_PATH_TO_DESTINATION)) { /* it is first time the problem occurred, set the "path not found" flag */ SetBit(v->flags, VRF_NO_PATH_TO_DESTINATION); /* and notify user about the event */ AI::NewEvent(v->owner, new AIEventVehicleLost(v->index)); if (_settings_client.gui.lost_train_warn && v->owner == _local_company) { SetDParam(0, v->index); AddVehicleNewsItem( STR_NEWS_TRAIN_IS_LOST, NS_ADVICE, v->index ); } } } else { /* route found, is the train marked with "path not found" flag? */ if (HasBit(v->flags, VRF_NO_PATH_TO_DESTINATION)) { /* clear the flag as the PF's problem was solved */ ClrBit(v->flags, VRF_NO_PATH_TO_DESTINATION); /* can we also delete the "News" item somehow? */ } } } /* No track reservation requested -> finished. */ if (!do_track_reservation) return best_track; /* A path was found, but could not be reserved. */ if (res_dest.tile != INVALID_TILE && !res_dest.okay) { if (mark_stuck) MarkTrainAsStuck(v); FreeTrainTrackReservation(v); return best_track; } /* No possible reservation target found, we are probably lost. */ if (res_dest.tile == INVALID_TILE) { /* Try to find any safe destination. */ PBSTileInfo origin = FollowTrainReservation(v); if (TryReserveSafeTrack(v, origin.tile, origin.trackdir, false)) { TrackBits res = GetReservedTrackbits(tile) & DiagdirReachesTracks(enterdir); best_track = FindFirstTrack(res); TryReserveRailTrack(v->tile, TrackdirToTrack(v->GetVehicleTrackdir())); if (got_reservation != NULL) *got_reservation = true; if (changed_signal) MarkTileDirtyByTile(tile); } else { FreeTrainTrackReservation(v); if (mark_stuck) MarkTrainAsStuck(v); } return best_track; } if (got_reservation != NULL) *got_reservation = true; /* Reservation target found and free, check if it is safe. */ while (!IsSafeWaitingPosition(v, res_dest.tile, res_dest.trackdir, true, _settings_game.pf.forbid_90_deg)) { /* Extend reservation until we have found a safe position. */ DiagDirection exitdir = TrackdirToExitdir(res_dest.trackdir); TileIndex next_tile = TileAddByDiagDir(res_dest.tile, exitdir); TrackBits reachable = TrackdirBitsToTrackBits((TrackdirBits)(GetTileTrackStatus(next_tile, TRANSPORT_RAIL, 0))) & DiagdirReachesTracks(exitdir); if (_settings_game.pf.pathfinder_for_trains != VPF_NTP && _settings_game.pf.forbid_90_deg) { reachable &= ~TrackCrossesTracks(TrackdirToTrack(res_dest.trackdir)); } /* Get next order with destination. */ if (orders.SwitchToNextOrder(true)) { PBSTileInfo cur_dest; DoTrainPathfind(v, next_tile, exitdir, reachable, NULL, true, &cur_dest); if (cur_dest.tile != INVALID_TILE) { res_dest = cur_dest; if (res_dest.okay) continue; /* Path found, but could not be reserved. */ FreeTrainTrackReservation(v); if (mark_stuck) MarkTrainAsStuck(v); if (got_reservation != NULL) *got_reservation = false; changed_signal = false; break; } } /* No order or no safe position found, try any position. */ if (!TryReserveSafeTrack(v, res_dest.tile, res_dest.trackdir, true)) { FreeTrainTrackReservation(v); if (mark_stuck) MarkTrainAsStuck(v); if (got_reservation != NULL) *got_reservation = false; changed_signal = false; } break; } TryReserveRailTrack(v->tile, TrackdirToTrack(v->GetVehicleTrackdir())); if (changed_signal) MarkTileDirtyByTile(tile); return best_track; } /** * Try to reserve a path to a safe position. * * @param v The vehicle * @param mark_as_stuck Should the train be marked as stuck on a failed reservation? * @param first_tile_okay True if no path should be reserved if the current tile is a safe position. * @return True if a path could be reserved. */ bool TryPathReserve(Train *v, bool mark_as_stuck, bool first_tile_okay) { assert(v->IsFrontEngine()); /* We have to handle depots specially as the track follower won't look * at the depot tile itself but starts from the next tile. If we are still * inside the depot, a depot reservation can never be ours. */ if (v->track == TRACK_BIT_DEPOT) { if (HasDepotReservation(v->tile)) { if (mark_as_stuck) MarkTrainAsStuck(v); return false; } else { /* Depot not reserved, but the next tile might be. */ TileIndex next_tile = TileAddByDiagDir(v->tile, GetRailDepotDirection(v->tile)); if (HasReservedTracks(next_tile, DiagdirReachesTracks(GetRailDepotDirection(v->tile)))) return false; } } /* Special check if we are in front of a two-sided conventional signal. */ DiagDirection dir = TrainExitDir(v->direction, v->track); TileIndex next_tile = TileAddByDiagDir(v->tile, dir); if (IsTileType(next_tile, MP_RAILWAY) && HasReservedTracks(next_tile, DiagdirReachesTracks(dir))) { /* Can have only one reserved trackdir. */ Trackdir td = FindFirstTrackdir(TrackBitsToTrackdirBits(GetReservedTrackbits(next_tile)) & DiagdirReachesTrackdirs(dir)); if (HasSignalOnTrackdir(next_tile, td) && HasSignalOnTrackdir(next_tile, ReverseTrackdir(td)) && !IsPbsSignal(GetSignalType(next_tile, TrackdirToTrack(td)))) { /* Signal already reserved, is not ours. */ if (mark_as_stuck) MarkTrainAsStuck(v); return false; } } bool other_train = false; PBSTileInfo origin = FollowTrainReservation(v, &other_train); /* The path we are driving on is alread blocked by some other train. * This can only happen in certain situations when mixing path and * block signals or when changing tracks and/or signals. * Exit here as doing any further reservations will probably just * make matters worse. */ if (other_train && v->tile != origin.tile) { if (mark_as_stuck) MarkTrainAsStuck(v); return false; } /* If we have a reserved path and the path ends at a safe tile, we are finished already. */ if (origin.okay && (v->tile != origin.tile || first_tile_okay)) { /* Can't be stuck then. */ if (HasBit(v->flags, VRF_TRAIN_STUCK)) SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); ClrBit(v->flags, VRF_TRAIN_STUCK); return true; } /* If we are in a depot, tentativly reserve the depot. */ if (v->track == TRACK_BIT_DEPOT) { SetDepotReservation(v->tile, true); if (_settings_client.gui.show_track_reservation) MarkTileDirtyByTile(v->tile); } DiagDirection exitdir = TrackdirToExitdir(origin.trackdir); TileIndex new_tile = TileAddByDiagDir(origin.tile, exitdir); TrackBits reachable = TrackdirBitsToTrackBits(TrackStatusToTrackdirBits(GetTileTrackStatus(new_tile, TRANSPORT_RAIL, 0)) & DiagdirReachesTrackdirs(exitdir)); if (_settings_game.pf.pathfinder_for_trains != VPF_NTP && _settings_game.pf.forbid_90_deg) reachable &= ~TrackCrossesTracks(TrackdirToTrack(origin.trackdir)); bool res_made = false; ChooseTrainTrack(v, new_tile, exitdir, reachable, true, &res_made, mark_as_stuck); if (!res_made) { /* Free the depot reservation as well. */ if (v->track == TRACK_BIT_DEPOT) SetDepotReservation(v->tile, false); return false; } if (HasBit(v->flags, VRF_TRAIN_STUCK)) { v->time_counter = 0; SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } ClrBit(v->flags, VRF_TRAIN_STUCK); return true; } static bool CheckReverseTrain(Train *v) { if (_settings_game.difficulty.line_reverse_mode != 0 || v->track == TRACK_BIT_DEPOT || v->track == TRACK_BIT_WORMHOLE || !(v->direction & 1)) { return false; } uint reverse_best = 0; assert(v->track); switch (_settings_game.pf.pathfinder_for_trains) { case VPF_YAPF: // YAPF reverse_best = YapfCheckReverseTrain(v); break; case VPF_NPF: { // NPF NPFFindStationOrTileData fstd; NPFFoundTargetData ftd; Vehicle *last = v->Last(); NPFFillWithOrderData(&fstd, v); Trackdir trackdir = v->GetVehicleTrackdir(); Trackdir trackdir_rev = ReverseTrackdir(last->GetVehicleTrackdir()); assert(trackdir != INVALID_TRACKDIR); assert(trackdir_rev != INVALID_TRACKDIR); ftd = NPFRouteToStationOrTileTwoWay(v->tile, trackdir, false, last->tile, trackdir_rev, false, &fstd, TRANSPORT_RAIL, 0, v->owner, v->compatible_railtypes); if (ftd.best_bird_dist != 0) { /* We didn't find anything, just keep on going straight ahead */ reverse_best = false; } else { if (NPFGetFlag(&ftd.node, NPF_FLAG_REVERSE)) { reverse_best = true; } else { reverse_best = false; } } } break; default: case VPF_NTP: { // NTP TrainTrackFollowerData fd; FillWithStationData(&fd, v); int i = _search_directions[FindFirstTrack(v->track)][DirToDiagDir(v->direction)]; int best_track = -1; uint reverse = 0; uint best_bird_dist = 0; uint best_track_dist = 0; for (;;) { fd.best_bird_dist = UINT_MAX; fd.best_track_dist = UINT_MAX; NewTrainPathfind(v->tile, v->dest_tile, v->compatible_railtypes, (DiagDirection)(reverse ^ i), (NTPEnumProc*)NtpCallbFindStation, &fd); if (best_track != -1) { if (best_bird_dist != 0) { if (fd.best_bird_dist != 0) { /* neither reached the destination, pick the one with the smallest bird dist */ if (fd.best_bird_dist > best_bird_dist) goto bad; if (fd.best_bird_dist < best_bird_dist) goto good; } else { /* we found the destination for the first time */ goto good; } } else { if (fd.best_bird_dist != 0) { /* didn't find destination, but we've found the destination previously */ goto bad; } else { /* both old & new reached the destination, compare track length */ if (fd.best_track_dist > best_track_dist) goto bad; if (fd.best_track_dist < best_track_dist) goto good; } } /* if we reach this position, there's two paths of equal value so far. * pick one randomly. */ int r = GB(Random(), 0, 8); if (_pick_track_table[i] == (v->direction & 3)) r += 80; if (_pick_track_table[best_track] == (v->direction & 3)) r -= 80; if (r <= 127) goto bad; } good:; best_track = i; best_bird_dist = fd.best_bird_dist; best_track_dist = fd.best_track_dist; reverse_best = reverse; bad:; if (reverse != 0) break; reverse = 2; } } break; } return reverse_best != 0; } TileIndex Train::GetOrderStationLocation(StationID station) { if (station == this->last_station_visited) this->last_station_visited = INVALID_STATION; const Station *st = Station::Get(station); if (!(st->facilities & FACIL_TRAIN)) { /* The destination station has no trainstation tiles. */ this->IncrementOrderIndex(); return 0; } return st->xy; } void Train::MarkDirty() { Vehicle *v = this; do { v->UpdateViewport(false, false); } while ((v = v->Next()) != NULL); /* need to update acceleration and cached values since the goods on the train changed. */ TrainCargoChanged(this); UpdateTrainAcceleration(this); } /** * This function looks at the vehicle and updates it's speed (cur_speed * and subspeed) variables. Furthermore, it returns the distance that * the train can drive this tick. This distance is expressed as 256 * n, * where n is the number of straight (long) tracks the train can * traverse. This means that moving along a straight track costs 256 * "speed" and a diagonal track costs 192 "speed". * @param v The vehicle to update the speed of. * @return distance to drive. */ static int UpdateTrainSpeed(Train *v) { uint accel; if ((v->vehstatus & VS_STOPPED) || HasBit(v->flags, VRF_REVERSING) || HasBit(v->flags, VRF_TRAIN_STUCK)) { switch (_settings_game.vehicle.train_acceleration_model) { default: NOT_REACHED(); case TAM_ORIGINAL: accel = v->acceleration * -4; break; case TAM_REALISTIC: accel = GetTrainAcceleration(v, AM_BRAKE); break; } } else { switch (_settings_game.vehicle.train_acceleration_model) { default: NOT_REACHED(); case TAM_ORIGINAL: accel = v->acceleration * 2; break; case TAM_REALISTIC: accel = GetTrainAcceleration(v, AM_ACCEL); break; } } uint spd = v->subspeed + accel; v->subspeed = (byte)spd; { int tempmax = v->max_speed; if (v->cur_speed > v->max_speed) tempmax = v->cur_speed - (v->cur_speed / 10) - 1; v->cur_speed = spd = Clamp(v->cur_speed + ((int)spd >> 8), 0, tempmax); } /* Scale speed by 3/4. Previously this was only done when the train was * facing diagonally and would apply to however many moves the train made * regardless the of direction actually moved in. Now it is always scaled, * 256 spd is used to go straight and 192 is used to go diagonally * (3/4 of 256). This results in the same effect, but without the error the * previous method caused. * * The scaling is done in this direction and not by multiplying the amount * to be subtracted by 4/3 so that the leftover speed can be saved in a * byte in v->progress. */ int scaled_spd = spd * 3 >> 2; scaled_spd += v->progress; v->progress = 0; // set later in TrainLocoHandler or TrainController return scaled_spd; } static void TrainEnterStation(Train *v, StationID station) { v->last_station_visited = station; /* check if a train ever visited this station before */ Station *st = Station::Get(station); if (!(st->had_vehicle_of_type & HVOT_TRAIN)) { st->had_vehicle_of_type |= HVOT_TRAIN; SetDParam(0, st->index); AddVehicleNewsItem( STR_NEWS_FIRST_TRAIN_ARRIVAL, v->owner == _local_company ? NS_ARRIVAL_COMPANY : NS_ARRIVAL_OTHER, v->index, st->index ); AI::NewEvent(v->owner, new AIEventStationFirstVehicle(st->index, v->index)); } v->BeginLoading(); StationAnimationTrigger(st, v->tile, STAT_ANIM_TRAIN_ARRIVES); } static byte AfterSetTrainPos(Train *v, bool new_tile) { byte old_z = v->z_pos; v->z_pos = GetSlopeZ(v->x_pos, v->y_pos); if (new_tile) { ClrBit(v->flags, VRF_GOINGUP); ClrBit(v->flags, VRF_GOINGDOWN); if (v->track == TRACK_BIT_X || v->track == TRACK_BIT_Y) { /* Any track that isn't TRACK_BIT_X or TRACK_BIT_Y cannot be sloped. * To check whether the current tile is sloped, and in which * direction it is sloped, we get the 'z' at the center of * the tile (middle_z) and the edge of the tile (old_z), * which we then can compare. */ static const int HALF_TILE_SIZE = TILE_SIZE / 2; static const int INV_TILE_SIZE_MASK = ~(TILE_SIZE - 1); byte middle_z = GetSlopeZ((v->x_pos & INV_TILE_SIZE_MASK) | HALF_TILE_SIZE, (v->y_pos & INV_TILE_SIZE_MASK) | HALF_TILE_SIZE); if (middle_z != v->z_pos) { SetBit(v->flags, (middle_z > old_z) ? VRF_GOINGUP : VRF_GOINGDOWN); } } } VehicleMove(v, true); return old_z; } /* Check if the vehicle is compatible with the specified tile */ static inline bool CheckCompatibleRail(const Train *v, TileIndex tile) { return IsTileOwner(tile, v->owner) && ( !v->IsFrontEngine() || HasBit(v->compatible_railtypes, GetRailType(tile)) ); } struct RailtypeSlowdownParams { byte small_turn, large_turn; byte z_up; // fraction to remove when moving up byte z_down; // fraction to remove when moving down }; static const RailtypeSlowdownParams _railtype_slowdown[] = { /* normal accel */ {256 / 4, 256 / 2, 256 / 4, 2}, ///< normal {256 / 4, 256 / 2, 256 / 4, 2}, ///< electrified {256 / 4, 256 / 2, 256 / 4, 2}, ///< monorail {0, 256 / 2, 256 / 4, 2}, ///< maglev }; /** Modify the speed of the vehicle due to a change in altitude */ static inline void AffectSpeedByZChange(Train *v, byte old_z) { if (old_z == v->z_pos || _settings_game.vehicle.train_acceleration_model != TAM_ORIGINAL) return; const RailtypeSlowdownParams *rsp = &_railtype_slowdown[v->railtype]; if (old_z < v->z_pos) { v->cur_speed -= (v->cur_speed * rsp->z_up >> 8); } else { uint16 spd = v->cur_speed + rsp->z_down; if (spd <= v->max_speed) v->cur_speed = spd; } } static bool TrainMovedChangeSignals(TileIndex tile, DiagDirection dir) { if (IsTileType(tile, MP_RAILWAY) && GetRailTileType(tile) == RAIL_TILE_SIGNALS) { TrackdirBits tracks = TrackBitsToTrackdirBits(GetTrackBits(tile)) & DiagdirReachesTrackdirs(dir); Trackdir trackdir = FindFirstTrackdir(tracks); if (UpdateSignalsOnSegment(tile, TrackdirToExitdir(trackdir), GetTileOwner(tile)) == SIGSEG_PBS && HasSignalOnTrackdir(tile, trackdir)) { /* A PBS block with a non-PBS signal facing us? */ if (!IsPbsSignal(GetSignalType(tile, TrackdirToTrack(trackdir)))) return true; } } return false; } /** * Tries to reserve track under whole train consist */ void Train::ReserveTrackUnderConsist() const { for (const Train *u = this; u != NULL; u = u->Next()) { switch (u->track) { case TRACK_BIT_WORMHOLE: TryReserveRailTrack(u->tile, DiagDirToDiagTrack(GetTunnelBridgeDirection(u->tile))); break; case TRACK_BIT_DEPOT: break; default: TryReserveRailTrack(u->tile, TrackBitsToTrack(u->track)); break; } } } static void SetVehicleCrashed(Train *v) { if (v->crash_anim_pos != 0) return; if (v->IsFrontEngine()) { /* Remove the reserved path in front of the train if it is not stuck. * Also clear all reserved tracks the train is currently on. */ if (!HasBit(v->flags, VRF_TRAIN_STUCK)) FreeTrainTrackReservation(v); for (const Train *u = v; u != NULL; u = u->Next()) { ClearPathReservation(u, u->tile, u->GetVehicleTrackdir()); if (IsTileType(u->tile, MP_TUNNELBRIDGE)) { /* ClearPathReservation will not free the wormhole exit * if the train has just entered the wormhole. */ SetTunnelBridgeReservation(GetOtherTunnelBridgeEnd(u->tile), false); } } } /* we may need to update crossing we were approaching */ TileIndex crossing = TrainApproachingCrossingTile(v); v->crash_anim_pos++; SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); SetWindowDirty(WC_VEHICLE_DETAILS, v->index); if (v->track == TRACK_BIT_DEPOT) { SetWindowDirty(WC_VEHICLE_DEPOT, v->tile); } InvalidateWindowClassesData(WC_TRAINS_LIST, 0); for (; v != NULL; v = v->Next()) { v->vehstatus |= VS_CRASHED; MarkSingleVehicleDirty(v); } /* must be updated after the train has been marked crashed */ if (crossing != INVALID_TILE) UpdateLevelCrossing(crossing); } static uint CountPassengersInTrain(const Train *v) { uint num = 0; for (; v != NULL; v = v->Next()) { if (IsCargoInClass(v->cargo_type, CC_PASSENGERS)) num += v->cargo.Count(); } return num; } /** * Marks train as crashed and creates an AI event. * Doesn't do anything if the train is crashed already. * @param v first vehicle of chain * @return number of victims (including 2 drivers; zero if train was already crashed) */ static uint TrainCrashed(Train *v) { uint num = 0; /* do not crash train twice */ if (!(v->vehstatus & VS_CRASHED)) { /* two drivers + passengers */ num = 2 + CountPassengersInTrain(v); SetVehicleCrashed(v); AI::NewEvent(v->owner, new AIEventVehicleCrashed(v->index, v->tile, AIEventVehicleCrashed::CRASH_TRAIN)); } /* Try to re-reserve track under already crashed train too. * SetVehicleCrashed() clears the reservation! */ v->ReserveTrackUnderConsist(); return num; } struct TrainCollideChecker { Train *v; ///< vehicle we are testing for collision uint num; ///< number of victims if train collided }; static Vehicle *FindTrainCollideEnum(Vehicle *v, void *data) { TrainCollideChecker *tcc = (TrainCollideChecker*)data; /* not a train or in depot */ if (v->type != VEH_TRAIN || Train::From(v)->track == TRACK_BIT_DEPOT) return NULL; /* get first vehicle now to make most usual checks faster */ Train *coll = Train::From(v)->First(); /* can't collide with own wagons */ if (coll == tcc->v) return NULL; int x_diff = v->x_pos - tcc->v->x_pos; int y_diff = v->y_pos - tcc->v->y_pos; /* Do fast calculation to check whether trains are not in close vicinity * and quickly reject trains distant enough for any collision. * Differences are shifted by 7, mapping range [-7 .. 8] into [0 .. 15] * Differences are then ORed and then we check for any higher bits */ uint hash = (y_diff + 7) | (x_diff + 7); if (hash & ~15) return NULL; /* Slower check using multiplication */ if (x_diff * x_diff + y_diff * y_diff > 25) return NULL; /* Happens when there is a train under bridge next to bridge head */ if (abs(v->z_pos - tcc->v->z_pos) > 5) return NULL; /* crash both trains */ tcc->num += TrainCrashed(tcc->v); tcc->num += TrainCrashed(coll); return NULL; // continue searching } /** * Checks whether the specified train has a collision with another vehicle. If * so, destroys this vehicle, and the other vehicle if its subtype has TS_Front. * Reports the incident in a flashy news item, modifies station ratings and * plays a sound. */ static bool CheckTrainCollision(Train *v) { /* can't collide in depot */ if (v->track == TRACK_BIT_DEPOT) return false; assert(v->track == TRACK_BIT_WORMHOLE || TileVirtXY(v->x_pos, v->y_pos) == v->tile); TrainCollideChecker tcc; tcc.v = v; tcc.num = 0; /* find colliding vehicles */ if (v->track == TRACK_BIT_WORMHOLE) { FindVehicleOnPos(v->tile, &tcc, FindTrainCollideEnum); FindVehicleOnPos(GetOtherTunnelBridgeEnd(v->tile), &tcc, FindTrainCollideEnum); } else { FindVehicleOnPosXY(v->x_pos, v->y_pos, &tcc, FindTrainCollideEnum); } /* any dead -> no crash */ if (tcc.num == 0) return false; SetDParam(0, tcc.num); AddVehicleNewsItem(STR_NEWS_TRAIN_CRASH, NS_ACCIDENT, v->index ); ModifyStationRatingAround(v->tile, v->owner, -160, 30); SndPlayVehicleFx(SND_13_BIG_CRASH, v); return true; } static Vehicle *CheckTrainAtSignal(Vehicle *v, void *data) { if (v->type != VEH_TRAIN || (v->vehstatus & VS_CRASHED)) return NULL; Train *t = Train::From(v); DiagDirection exitdir = *(DiagDirection *)data; /* not front engine of a train, inside wormhole or depot, crashed */ if (!t->IsFrontEngine() || !(t->track & TRACK_BIT_MASK)) return NULL; if (t->cur_speed > 5 || TrainExitDir(t->direction, t->track) != exitdir) return NULL; return t; } static void TrainController(Train *v, Vehicle *nomove) { Train *first = v->First(); Train *prev; bool direction_changed = false; // has direction of any part changed? /* For every vehicle after and including the given vehicle */ for (prev = v->Previous(); v != nomove; prev = v, v = v->Next()) { DiagDirection enterdir = DIAGDIR_BEGIN; bool update_signals_crossing = false; // will we update signals or crossing state? GetNewVehiclePosResult gp = GetNewVehiclePos(v); if (v->track != TRACK_BIT_WORMHOLE) { /* Not inside tunnel */ if (gp.old_tile == gp.new_tile) { /* Staying in the old tile */ if (v->track == TRACK_BIT_DEPOT) { /* Inside depot */ gp.x = v->x_pos; gp.y = v->y_pos; } else { /* Not inside depot */ /* Reverse when we are at the end of the track already, do not move to the new position */ if (v->IsFrontEngine() && !TrainCheckIfLineEnds(v)) return; uint32 r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y); if (HasBit(r, VETS_CANNOT_ENTER)) { goto invalid_rail; } if (HasBit(r, VETS_ENTERED_STATION)) { /* The new position is the end of the platform */ TrainEnterStation(v, r >> VETS_STATION_ID_OFFSET); } } } else { /* A new tile is about to be entered. */ /* Determine what direction we're entering the new tile from */ enterdir = DiagdirBetweenTiles(gp.old_tile, gp.new_tile); assert(IsValidDiagDirection(enterdir)); /* Get the status of the tracks in the new tile and mask * away the bits that aren't reachable. */ TrackStatus ts = GetTileTrackStatus(gp.new_tile, TRANSPORT_RAIL, 0, ReverseDiagDir(enterdir)); TrackdirBits reachable_trackdirs = DiagdirReachesTrackdirs(enterdir); TrackdirBits trackdirbits = TrackStatusToTrackdirBits(ts) & reachable_trackdirs; TrackBits red_signals = TrackdirBitsToTrackBits(TrackStatusToRedSignals(ts) & reachable_trackdirs); TrackBits bits = TrackdirBitsToTrackBits(trackdirbits); if (_settings_game.pf.pathfinder_for_trains != VPF_NTP && _settings_game.pf.forbid_90_deg && prev == NULL) { /* We allow wagons to make 90 deg turns, because forbid_90_deg * can be switched on halfway a turn */ bits &= ~TrackCrossesTracks(FindFirstTrack(v->track)); } if (bits == TRACK_BIT_NONE) goto invalid_rail; /* Check if the new tile contrains tracks that are compatible * with the current train, if not, bail out. */ if (!CheckCompatibleRail(v, gp.new_tile)) goto invalid_rail; TrackBits chosen_track; if (prev == NULL) { /* Currently the locomotive is active. Determine which one of the * available tracks to choose */ chosen_track = TrackToTrackBits(ChooseTrainTrack(v, gp.new_tile, enterdir, bits, false, NULL, true)); assert(chosen_track & (bits | GetReservedTrackbits(gp.new_tile))); /* Check if it's a red signal and that force proceed is not clicked. */ if ((red_signals & chosen_track) && v->force_proceed == 0) { /* In front of a red signal */ Trackdir i = FindFirstTrackdir(trackdirbits); /* Don't handle stuck trains here. */ if (HasBit(v->flags, VRF_TRAIN_STUCK)) return; if (!HasSignalOnTrackdir(gp.new_tile, ReverseTrackdir(i))) { v->cur_speed = 0; v->subspeed = 0; v->progress = 255 - 100; if (_settings_game.pf.wait_oneway_signal == 255 || ++v->time_counter < _settings_game.pf.wait_oneway_signal * 20) return; } else if (HasSignalOnTrackdir(gp.new_tile, i)) { v->cur_speed = 0; v->subspeed = 0; v->progress = 255 - 10; if (_settings_game.pf.wait_twoway_signal == 255 || ++v->time_counter < _settings_game.pf.wait_twoway_signal * 73) { DiagDirection exitdir = TrackdirToExitdir(i); TileIndex o_tile = TileAddByDiagDir(gp.new_tile, exitdir); exitdir = ReverseDiagDir(exitdir); /* check if a train is waiting on the other side */ if (!HasVehicleOnPos(o_tile, &exitdir, &CheckTrainAtSignal)) return; } } /* If we would reverse but are currently in a PBS block and * reversing of stuck trains is disabled, don't reverse. */ if (_settings_game.pf.wait_for_pbs_path == 255 && UpdateSignalsOnSegment(v->tile, enterdir, v->owner) == SIGSEG_PBS) { v->time_counter = 0; return; } goto reverse_train_direction; } else { TryReserveRailTrack(gp.new_tile, TrackBitsToTrack(chosen_track)); } } else { /* The wagon is active, simply follow the prev vehicle. */ if (prev->tile == gp.new_tile) { /* Choose the same track as prev */ if (prev->track == TRACK_BIT_WORMHOLE) { /* Vehicles entering tunnels enter the wormhole earlier than for bridges. * However, just choose the track into the wormhole. */ assert(IsTunnel(prev->tile)); chosen_track = bits; } else { chosen_track = prev->track; } } else { /* Choose the track that leads to the tile where prev is. * This case is active if 'prev' is already on the second next tile, when 'v' just enters the next tile. * I.e. when the tile between them has only space for a single vehicle like * 1) horizontal/vertical track tiles and * 2) some orientations of tunnelentries, where the vehicle is already inside the wormhole at 8/16 from the tileedge. * Is also the train just reversing, the wagon inside the tunnel is 'on' the tile of the opposite tunnelentry. */ static const TrackBits _connecting_track[DIAGDIR_END][DIAGDIR_END] = { {TRACK_BIT_X, TRACK_BIT_LOWER, TRACK_BIT_NONE, TRACK_BIT_LEFT }, {TRACK_BIT_UPPER, TRACK_BIT_Y, TRACK_BIT_LEFT, TRACK_BIT_NONE }, {TRACK_BIT_NONE, TRACK_BIT_RIGHT, TRACK_BIT_X, TRACK_BIT_UPPER}, {TRACK_BIT_RIGHT, TRACK_BIT_NONE, TRACK_BIT_LOWER, TRACK_BIT_Y } }; DiagDirection exitdir = DiagdirBetweenTiles(gp.new_tile, prev->tile); assert(IsValidDiagDirection(exitdir)); chosen_track = _connecting_track[enterdir][exitdir]; } chosen_track &= bits; } /* Make sure chosen track is a valid track */ assert( chosen_track == TRACK_BIT_X || chosen_track == TRACK_BIT_Y || chosen_track == TRACK_BIT_UPPER || chosen_track == TRACK_BIT_LOWER || chosen_track == TRACK_BIT_LEFT || chosen_track == TRACK_BIT_RIGHT); /* Update XY to reflect the entrance to the new tile, and select the direction to use */ const byte *b = _initial_tile_subcoord[FIND_FIRST_BIT(chosen_track)][enterdir]; gp.x = (gp.x & ~0xF) | b[0]; gp.y = (gp.y & ~0xF) | b[1]; Direction chosen_dir = (Direction)b[2]; /* Call the landscape function and tell it that the vehicle entered the tile */ uint32 r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y); if (HasBit(r, VETS_CANNOT_ENTER)) { goto invalid_rail; } if (!HasBit(r, VETS_ENTERED_WORMHOLE)) { Track track = FindFirstTrack(chosen_track); Trackdir tdir = TrackDirectionToTrackdir(track, chosen_dir); if (v->IsFrontEngine() && HasPbsSignalOnTrackdir(gp.new_tile, tdir)) { SetSignalStateByTrackdir(gp.new_tile, tdir, SIGNAL_STATE_RED); MarkTileDirtyByTile(gp.new_tile); } /* Clear any track reservation when the last vehicle leaves the tile */ if (v->Next() == NULL) ClearPathReservation(v, v->tile, v->GetVehicleTrackdir()); v->tile = gp.new_tile; if (GetTileRailType(gp.new_tile) != GetTileRailType(gp.old_tile)) { TrainPowerChanged(v->First()); } v->track = chosen_track; assert(v->track); } /* We need to update signal status, but after the vehicle position hash * has been updated by AfterSetTrainPos() */ update_signals_crossing = true; if (chosen_dir != v->direction) { if (prev == NULL && _settings_game.vehicle.train_acceleration_model == TAM_ORIGINAL) { const RailtypeSlowdownParams *rsp = &_railtype_slowdown[v->railtype]; DirDiff diff = DirDifference(v->direction, chosen_dir); v->cur_speed -= (diff == DIRDIFF_45RIGHT || diff == DIRDIFF_45LEFT ? rsp->small_turn : rsp->large_turn) * v->cur_speed >> 8; } direction_changed = true; v->direction = chosen_dir; } if (v->IsFrontEngine()) { v->time_counter = 0; /* If we are approching a crossing that is reserved, play the sound now. */ TileIndex crossing = TrainApproachingCrossingTile(v); if (crossing != INVALID_TILE && HasCrossingReservation(crossing)) SndPlayTileFx(SND_0E_LEVEL_CROSSING, crossing); /* Always try to extend the reservation when entering a tile. */ CheckNextTrainTile(v); } if (HasBit(r, VETS_ENTERED_STATION)) { /* The new position is the location where we want to stop */ TrainEnterStation(v, r >> VETS_STATION_ID_OFFSET); } } } else { /* In a tunnel or on a bridge * - for tunnels, only the part when the vehicle is not visible (part of enter/exit tile too) * - for bridges, only the middle part - without the bridge heads */ if (!(v->vehstatus & VS_HIDDEN)) { v->cur_speed = min(v->cur_speed, GetBridgeSpec(GetBridgeType(v->tile))->speed); } if (IsTileType(gp.new_tile, MP_TUNNELBRIDGE) && HasBit(VehicleEnterTile(v, gp.new_tile, gp.x, gp.y), VETS_ENTERED_WORMHOLE)) { /* Perform look-ahead on tunnel exit. */ if (v->IsFrontEngine()) { TryReserveRailTrack(gp.new_tile, DiagDirToDiagTrack(GetTunnelBridgeDirection(gp.new_tile))); CheckNextTrainTile(v); } } else { v->x_pos = gp.x; v->y_pos = gp.y; VehicleMove(v, !(v->vehstatus & VS_HIDDEN)); continue; } } /* update image of train, as well as delta XY */ v->UpdateDeltaXY(v->direction); v->x_pos = gp.x; v->y_pos = gp.y; /* update the Z position of the vehicle */ byte old_z = AfterSetTrainPos(v, (gp.new_tile != gp.old_tile)); if (prev == NULL) { /* This is the first vehicle in the train */ AffectSpeedByZChange(v, old_z); } if (update_signals_crossing) { if (v->IsFrontEngine()) { if (TrainMovedChangeSignals(gp.new_tile, enterdir)) { /* We are entering a block with PBS signals right now, but * not through a PBS signal. This means we don't have a * reservation right now. As a conventional signal will only * ever be green if no other train is in the block, getting * a path should always be possible. If the player built * such a strange network that it is not possible, the train * will be marked as stuck and the player has to deal with * the problem. */ if ((!HasReservedTracks(gp.new_tile, v->track) && !TryReserveRailTrack(gp.new_tile, FindFirstTrack(v->track))) || !TryPathReserve(v)) { MarkTrainAsStuck(v); } } } /* Signals can only change when the first * (above) or the last vehicle moves. */ if (v->Next() == NULL) { TrainMovedChangeSignals(gp.old_tile, ReverseDiagDir(enterdir)); if (IsLevelCrossingTile(gp.old_tile)) UpdateLevelCrossing(gp.old_tile); } } /* Do not check on every tick to save some computing time. */ if (v->IsFrontEngine() && v->tick_counter % _settings_game.pf.path_backoff_interval == 0) CheckNextTrainTile(v); } if (direction_changed) first->tcache.cached_max_curve_speed = GetTrainCurveSpeedLimit(first); return; invalid_rail: /* We've reached end of line?? */ if (prev != NULL) error("Disconnecting train"); reverse_train_direction: v->time_counter = 0; v->cur_speed = 0; v->subspeed = 0; ReverseTrainDirection(v); } /** Collect trackbits of all crashed train vehicles on a tile * @param v Vehicle passed from Find/HasVehicleOnPos() * @param data trackdirbits for the result * @return NULL to iterate over all vehicles on the tile. */ static Vehicle *CollectTrackbitsFromCrashedVehiclesEnum(Vehicle *v, void *data) { TrackBits *trackbits = (TrackBits *)data; if (v->type == VEH_TRAIN && (v->vehstatus & VS_CRASHED) != 0) { if (Train::From(v)->track == TRACK_BIT_WORMHOLE) { /* Vehicle is inside a wormhole, v->track contains no useful value then. */ *trackbits |= DiagDirToDiagTrackBits(GetTunnelBridgeDirection(v->tile)); } else { *trackbits |= Train::From(v)->track; } } return NULL; } /** * Deletes/Clears the last wagon of a crashed train. It takes the engine of the * train, then goes to the last wagon and deletes that. Each call to this function * will remove the last wagon of a crashed train. If this wagon was on a crossing, * or inside a tunnel/bridge, recalculate the signals as they might need updating * @param v the Vehicle of which last wagon is to be removed */ static void DeleteLastWagon(Train *v) { Train *first = v->First(); /* Go to the last wagon and delete the link pointing there * *u is then the one-before-last wagon, and *v the last * one which will physicially be removed */ Train *u = v; for (; v->Next() != NULL; v = v->Next()) u = v; u->SetNext(NULL); if (first != v) { /* Recalculate cached train properties */ TrainConsistChanged(first, false); /* Update the depot window if the first vehicle is in depot - * if v == first, then it is updated in PreDestructor() */ if (first->track == TRACK_BIT_DEPOT) { SetWindowDirty(WC_VEHICLE_DEPOT, first->tile); } } /* 'v' shouldn't be accessed after it has been deleted */ TrackBits trackbits = v->track; TileIndex tile = v->tile; Owner owner = v->owner; delete v; v = NULL; // make sure nobody will try to read 'v' anymore if (trackbits == TRACK_BIT_WORMHOLE) { /* Vehicle is inside a wormhole, v->track contains no useful value then. */ trackbits = DiagDirToDiagTrackBits(GetTunnelBridgeDirection(tile)); } Track track = TrackBitsToTrack(trackbits); if (HasReservedTracks(tile, trackbits)) { UnreserveRailTrack(tile, track); /* If there are still crashed vehicles on the tile, give the track reservation to them */ TrackBits remaining_trackbits = TRACK_BIT_NONE; FindVehicleOnPos(tile, &remaining_trackbits, CollectTrackbitsFromCrashedVehiclesEnum); /* It is important that these two are the first in the loop, as reservation cannot deal with every trackbit combination */ assert(TRACK_BEGIN == TRACK_X && TRACK_Y == TRACK_BEGIN + 1); for (Track t = TRACK_BEGIN; t < TRACK_END; t++) { if (HasBit(remaining_trackbits, t)) { TryReserveRailTrack(tile, t); } } } /* check if the wagon was on a road/rail-crossing */ if (IsLevelCrossingTile(tile)) UpdateLevelCrossing(tile); /* Update signals */ if (IsTileType(tile, MP_TUNNELBRIDGE) || IsRailDepotTile(tile)) { UpdateSignalsOnSegment(tile, INVALID_DIAGDIR, owner); } else { SetSignalsOnBothDir(tile, track, owner); } } static void ChangeTrainDirRandomly(Train *v) { static const DirDiff delta[] = { DIRDIFF_45LEFT, DIRDIFF_SAME, DIRDIFF_SAME, DIRDIFF_45RIGHT }; do { /* We don't need to twist around vehicles if they're not visible */ if (!(v->vehstatus & VS_HIDDEN)) { v->direction = ChangeDir(v->direction, delta[GB(Random(), 0, 2)]); v->UpdateDeltaXY(v->direction); v->cur_image = v->GetImage(v->direction); /* Refrain from updating the z position of the vehicle when on * a bridge, because AfterSetTrainPos will put the vehicle under * the bridge in that case */ if (v->track != TRACK_BIT_WORMHOLE) AfterSetTrainPos(v, false); } } while ((v = v->Next()) != NULL); } static bool HandleCrashedTrain(Train *v) { int state = ++v->crash_anim_pos; if (state == 4 && !(v->vehstatus & VS_HIDDEN)) { CreateEffectVehicleRel(v, 4, 4, 8, EV_EXPLOSION_LARGE); } uint32 r; if (state <= 200 && Chance16R(1, 7, r)) { int index = (r * 10 >> 16); Vehicle *u = v; do { if (--index < 0) { r = Random(); CreateEffectVehicleRel(u, GB(r, 8, 3) + 2, GB(r, 16, 3) + 2, GB(r, 0, 3) + 5, EV_EXPLOSION_SMALL); break; } } while ((u = u->Next()) != NULL); } if (state <= 240 && !(v->tick_counter & 3)) ChangeTrainDirRandomly(v); if (state >= 4440 && !(v->tick_counter & 0x1F)) { bool ret = v->Next() != NULL; DeleteLastWagon(v); SetWindowDirty(WC_REPLACE_VEHICLE, (v->group_id << 16) | VEH_TRAIN); return ret; } return true; } static void HandleBrokenTrain(Train *v) { if (v->breakdown_ctr != 1) { v->breakdown_ctr = 1; v->cur_speed = 0; if (v->breakdowns_since_last_service != 255) v->breakdowns_since_last_service++; v->MarkDirty(); SetWindowDirty(WC_VEHICLE_VIEW, v->index); SetWindowDirty(WC_VEHICLE_DETAILS, v->index); if (!PlayVehicleSound(v, VSE_BREAKDOWN)) { SndPlayVehicleFx((_settings_game.game_creation.landscape != LT_TOYLAND) ? SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v); } if (!(v->vehstatus & VS_HIDDEN)) { EffectVehicle *u = CreateEffectVehicleRel(v, 4, 4, 5, EV_BREAKDOWN_SMOKE); if (u != NULL) u->animation_state = v->breakdown_delay * 2; } } if (!(v->tick_counter & 3)) { if (!--v->breakdown_delay) { v->breakdown_ctr = 0; v->MarkDirty(); SetWindowDirty(WC_VEHICLE_VIEW, v->index); } } } /** Maximum speeds for train that is broken down or approaching line end */ static const uint16 _breakdown_speeds[16] = { 225, 210, 195, 180, 165, 150, 135, 120, 105, 90, 75, 60, 45, 30, 15, 15 }; /** * Train is approaching line end, slow down and possibly reverse * * @param v front train engine * @param signal not line end, just a red signal * @return true iff we did NOT have to reverse */ static bool TrainApproachingLineEnd(Train *v, bool signal) { /* Calc position within the current tile */ uint x = v->x_pos & 0xF; uint y = v->y_pos & 0xF; /* for diagonal directions, 'x' will be 0..15 - * for other directions, it will be 1, 3, 5, ..., 15 */ switch (v->direction) { case DIR_N : x = ~x + ~y + 25; break; case DIR_NW: x = y; // FALLTHROUGH case DIR_NE: x = ~x + 16; break; case DIR_E : x = ~x + y + 9; break; case DIR_SE: x = y; break; case DIR_S : x = x + y - 7; break; case DIR_W : x = ~y + x + 9; break; default: break; } /* do not reverse when approaching red signal */ if (!signal && x + (v->tcache.cached_veh_length + 1) / 2 >= TILE_SIZE) { /* we are too near the tile end, reverse now */ v->cur_speed = 0; ReverseTrainDirection(v); return false; } /* slow down */ v->vehstatus |= VS_TRAIN_SLOWING; uint16 break_speed = _breakdown_speeds[x & 0xF]; if (break_speed < v->cur_speed) v->cur_speed = break_speed; return true; } /** * Determines whether train would like to leave the tile * @param v train to test * @return true iff vehicle is NOT entering or inside a depot or tunnel/bridge */ static bool TrainCanLeaveTile(const Train *v) { /* Exit if inside a tunnel/bridge or a depot */ if (v->track == TRACK_BIT_WORMHOLE || v->track == TRACK_BIT_DEPOT) return false; TileIndex tile = v->tile; /* entering a tunnel/bridge? */ if (IsTileType(tile, MP_TUNNELBRIDGE)) { DiagDirection dir = GetTunnelBridgeDirection(tile); if (DiagDirToDir(dir) == v->direction) return false; } /* entering a depot? */ if (IsRailDepotTile(tile)) { DiagDirection dir = ReverseDiagDir(GetRailDepotDirection(tile)); if (DiagDirToDir(dir) == v->direction) return false; } return true; } /** * Determines whether train is approaching a rail-road crossing * (thus making it barred) * @param v front engine of train * @return TileIndex of crossing the train is approaching, else INVALID_TILE * @pre v in non-crashed front engine */ static TileIndex TrainApproachingCrossingTile(const Train *v) { assert(v->IsFrontEngine()); assert(!(v->vehstatus & VS_CRASHED)); if (!TrainCanLeaveTile(v)) return INVALID_TILE; DiagDirection dir = TrainExitDir(v->direction, v->track); TileIndex tile = v->tile + TileOffsByDiagDir(dir); /* not a crossing || wrong axis || unusable rail (wrong type or owner) */ if (!IsLevelCrossingTile(tile) || DiagDirToAxis(dir) == GetCrossingRoadAxis(tile) || !CheckCompatibleRail(v, tile)) { return INVALID_TILE; } return tile; } /** * Checks for line end. Also, bars crossing at next tile if needed * * @param v vehicle we are checking * @return true iff we did NOT have to reverse */ static bool TrainCheckIfLineEnds(Train *v) { /* First, handle broken down train */ int t = v->breakdown_ctr; if (t > 1) { v->vehstatus |= VS_TRAIN_SLOWING; uint16 break_speed = _breakdown_speeds[GB(~t, 4, 4)]; if (break_speed < v->cur_speed) v->cur_speed = break_speed; } else { v->vehstatus &= ~VS_TRAIN_SLOWING; } if (!TrainCanLeaveTile(v)) return true; /* Determine the non-diagonal direction in which we will exit this tile */ DiagDirection dir = TrainExitDir(v->direction, v->track); /* Calculate next tile */ TileIndex tile = v->tile + TileOffsByDiagDir(dir); /* Determine the track status on the next tile */ TrackStatus ts = GetTileTrackStatus(tile, TRANSPORT_RAIL, 0, ReverseDiagDir(dir)); TrackdirBits reachable_trackdirs = DiagdirReachesTrackdirs(dir); TrackdirBits trackdirbits = TrackStatusToTrackdirBits(ts) & reachable_trackdirs; TrackdirBits red_signals = TrackStatusToRedSignals(ts) & reachable_trackdirs; /* We are sure the train is not entering a depot, it is detected above */ /* mask unreachable track bits if we are forbidden to do 90deg turns */ TrackBits bits = TrackdirBitsToTrackBits(trackdirbits); if (_settings_game.pf.pathfinder_for_trains != VPF_NTP && _settings_game.pf.forbid_90_deg) { bits &= ~TrackCrossesTracks(FindFirstTrack(v->track)); } /* no suitable trackbits at all || unusable rail (wrong type or owner) */ if (bits == TRACK_BIT_NONE || !CheckCompatibleRail(v, tile)) { return TrainApproachingLineEnd(v, false); } /* approaching red signal */ if ((trackdirbits & red_signals) != 0) return TrainApproachingLineEnd(v, true); /* approaching a rail/road crossing? then make it red */ if (IsLevelCrossingTile(tile)) MaybeBarCrossingWithSound(tile); return true; } static bool TrainLocoHandler(Train *v, bool mode) { /* train has crashed? */ if (v->vehstatus & VS_CRASHED) { return mode ? true : HandleCrashedTrain(v); // 'this' can be deleted here } if (v->force_proceed != 0) { v->force_proceed--; ClrBit(v->flags, VRF_TRAIN_STUCK); SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } /* train is broken down? */ if (v->breakdown_ctr != 0) { if (v->breakdown_ctr <= 2) { HandleBrokenTrain(v); return true; } if (!v->current_order.IsType(OT_LOADING)) v->breakdown_ctr--; } if (HasBit(v->flags, VRF_REVERSING) && v->cur_speed == 0) { ReverseTrainDirection(v); } /* exit if train is stopped */ if ((v->vehstatus & VS_STOPPED) && v->cur_speed == 0) return true; bool valid_order = !v->current_order.IsType(OT_NOTHING) && v->current_order.GetType() != OT_CONDITIONAL; if (ProcessOrders(v) && CheckReverseTrain(v)) { v->time_counter = 0; v->cur_speed = 0; v->subspeed = 0; ReverseTrainDirection(v); return true; } v->HandleLoading(mode); if (v->current_order.IsType(OT_LOADING)) return true; if (CheckTrainStayInDepot(v)) return true; if (!mode) HandleLocomotiveSmokeCloud(v); /* We had no order but have an order now, do look ahead. */ if (!valid_order && !v->current_order.IsType(OT_NOTHING)) { CheckNextTrainTile(v); } /* Handle stuck trains. */ if (!mode && HasBit(v->flags, VRF_TRAIN_STUCK)) { ++v->time_counter; /* Should we try reversing this tick if still stuck? */ bool turn_around = v->time_counter % (_settings_game.pf.wait_for_pbs_path * DAY_TICKS) == 0 && _settings_game.pf.wait_for_pbs_path < 255; if (!turn_around && v->time_counter % _settings_game.pf.path_backoff_interval != 0 && v->force_proceed == 0) return true; if (!TryPathReserve(v)) { /* Still stuck. */ if (turn_around) ReverseTrainDirection(v); if (HasBit(v->flags, VRF_TRAIN_STUCK) && v->time_counter > 2 * _settings_game.pf.wait_for_pbs_path * DAY_TICKS) { /* Show message to player. */ if (_settings_client.gui.lost_train_warn && v->owner == _local_company) { SetDParam(0, v->index); AddVehicleNewsItem( STR_NEWS_TRAIN_IS_STUCK, NS_ADVICE, v->index ); } v->time_counter = 0; } /* Exit if force proceed not pressed, else reset stuck flag anyway. */ if (v->force_proceed == 0) return true; ClrBit(v->flags, VRF_TRAIN_STUCK); v->time_counter = 0; SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } } if (v->current_order.IsType(OT_LEAVESTATION)) { v->current_order.Free(); SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); return true; } int j = UpdateTrainSpeed(v); /* we need to invalidate the widget if we are stopping from 'Stopping 0 km/h' to 'Stopped' */ if (v->cur_speed == 0 && v->tcache.last_speed == 0 && (v->vehstatus & VS_STOPPED)) { SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } int adv_spd = (v->direction & 1) ? 192 : 256; if (j < adv_spd) { /* if the vehicle has speed 0, update the last_speed field. */ if (v->cur_speed == 0) SetLastSpeed(v, v->cur_speed); } else { TrainCheckIfLineEnds(v); /* Loop until the train has finished moving. */ for (;;) { j -= adv_spd; TrainController(v, NULL); /* Don't continue to move if the train crashed. */ if (CheckTrainCollision(v)) break; /* 192 spd used for going straight, 256 for going diagonally. */ adv_spd = (v->direction & 1) ? 192 : 256; /* No more moving this tick */ if (j < adv_spd || v->cur_speed == 0) break; OrderType order_type = v->current_order.GetType(); /* Do not skip waypoints (incl. 'via' stations) when passing through at full speed. */ if ((order_type == OT_GOTO_WAYPOINT || order_type == OT_GOTO_STATION) && (v->current_order.GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) && IsTileType(v->tile, MP_STATION) && v->current_order.GetDestination() == GetStationIndex(v->tile)) { ProcessOrders(v); } } SetLastSpeed(v, v->cur_speed); } for (Train *u = v; u != NULL; u = u->Next()) { if ((u->vehstatus & VS_HIDDEN) != 0) continue; u->UpdateViewport(false, false); } if (v->progress == 0) v->progress = j; // Save unused spd for next time, if TrainController didn't set progress return true; } Money Train::GetRunningCost() const { Money cost = 0; const Train *v = this; do { const RailVehicleInfo *rvi = RailVehInfo(v->engine_type); if (rvi->running_cost_class == INVALID_PRICE) continue; uint cost_factor = GetVehicleProperty(v, PROP_TRAIN_RUNNING_COST_FACTOR, rvi->running_cost); if (cost_factor == 0) continue; /* Halve running cost for multiheaded parts */ if (v->IsMultiheaded()) cost_factor /= 2; cost += cost_factor * GetPriceByIndex(rvi->running_cost_class); } while ((v = v->GetNextVehicle()) != NULL); return cost; } bool Train::Tick() { this->tick_counter++; if (this->IsFrontEngine()) { if (!(this->vehstatus & VS_STOPPED)) this->running_ticks++; this->current_order_time++; if (!TrainLocoHandler(this, false)) return false; return TrainLocoHandler(this, true); } else if (this->IsFreeWagon() && (this->vehstatus & VS_CRASHED)) { /* Delete flooded standalone wagon chain */ if (++this->crash_anim_pos >= 4400) { delete this; return false; } } return true; } static void CheckIfTrainNeedsService(Train *v) { static const uint MAX_ACCEPTABLE_DEPOT_DIST = 16; if (Company::Get(v->owner)->settings.vehicle.servint_trains == 0 || !v->NeedsAutomaticServicing()) return; if (v->IsInDepot()) { VehicleServiceInDepot(v); return; } TrainFindDepotData tfdd = FindClosestTrainDepot(v, MAX_ACCEPTABLE_DEPOT_DIST); /* Only go to the depot if it is not too far out of our way. */ if (tfdd.best_length == UINT_MAX || tfdd.best_length > MAX_ACCEPTABLE_DEPOT_DIST) { if (v->current_order.IsType(OT_GOTO_DEPOT)) { /* If we were already heading for a depot but it has * suddenly moved farther away, we continue our normal * schedule? */ v->current_order.MakeDummy(); SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } return; } DepotID depot = GetDepotIndex(tfdd.tile); if (v->current_order.IsType(OT_GOTO_DEPOT) && v->current_order.GetDestination() != depot && !Chance16(3, 16)) { return; } v->current_order.MakeGoToDepot(depot, ODTFB_SERVICE); v->dest_tile = tfdd.tile; SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH); } void Train::OnNewDay() { if ((++this->day_counter & 7) == 0) DecreaseVehicleValue(this); if (this->IsFrontEngine()) { CheckVehicleBreakdown(this); AgeVehicle(this); CheckIfTrainNeedsService(this); CheckOrders(this); /* update destination */ if (this->current_order.IsType(OT_GOTO_STATION)) { TileIndex tile = Station::Get(this->current_order.GetDestination())->train_station.tile; if (tile != INVALID_TILE) this->dest_tile = tile; } if (this->running_ticks != 0) { /* running costs */ CommandCost cost(EXPENSES_TRAIN_RUN, this->GetRunningCost() * this->running_ticks / (DAYS_IN_YEAR * DAY_TICKS)); this->profit_this_year -= cost.GetCost(); this->running_ticks = 0; SubtractMoneyFromCompanyFract(this->owner, cost); SetWindowDirty(WC_VEHICLE_DETAILS, this->index); SetWindowClassesDirty(WC_TRAINS_LIST); } } else if (this->IsEngine()) { /* Also age engines that aren't front engines */ AgeVehicle(this); } } Trackdir Train::GetVehicleTrackdir() const { if (this->vehstatus & VS_CRASHED) return INVALID_TRACKDIR; if (this->track == TRACK_BIT_DEPOT) { /* We'll assume the train is facing outwards */ return DiagDirToDiagTrackdir(GetRailDepotDirection(this->tile)); // Train in depot } if (this->track == TRACK_BIT_WORMHOLE) { /* train in tunnel or on bridge, so just use his direction and assume a diagonal track */ return DiagDirToDiagTrackdir(DirToDiagDir(this->direction)); } return TrackDirectionToTrackdir(FindFirstTrack(this->track), this->direction); }