newgrf_engine.cpp

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00012 #include "stdafx.h"
00013 #include "debug.h"
00014 #include "train.h"
00015 #include "roadveh.h"
00016 #include "company_func.h"
00017 #include "newgrf.h"
00018 #include "newgrf_cargo.h"
00019 #include "newgrf_spritegroup.h"
00020 #include "date_func.h"
00021 #include "vehicle_func.h"
00022 #include "core/random_func.hpp"
00023 #include "aircraft.h"
00024 #include "station_base.h"
00025 #include "company_base.h"
00026 #include "newgrf_railtype.h"
00027 
00028 struct WagonOverride {
00029   EngineID *train_id;
00030   uint trains;
00031   CargoID cargo;
00032   const SpriteGroup *group;
00033 };
00034 
00035 void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const SpriteGroup *group, EngineID *train_id, uint trains)
00036 {
00037   Engine *e = Engine::Get(engine);
00038   WagonOverride *wo;
00039 
00040   assert(cargo < NUM_CARGO + 2); // Include CT_DEFAULT and CT_PURCHASE pseudo cargoes.
00041 
00042   e->overrides_count++;
00043   e->overrides = ReallocT(e->overrides, e->overrides_count);
00044 
00045   wo = &e->overrides[e->overrides_count - 1];
00046   wo->group = group;
00047   wo->cargo = cargo;
00048   wo->trains = trains;
00049   wo->train_id = MallocT<EngineID>(trains);
00050   memcpy(wo->train_id, train_id, trains * sizeof *train_id);
00051 }
00052 
00053 const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, EngineID overriding_engine)
00054 {
00055   const Engine *e = Engine::Get(engine);
00056 
00057   /* XXX: This could turn out to be a timesink on profiles. We could
00058    * always just dedicate 65535 bytes for an [engine][train] trampoline
00059    * for O(1). Or O(logMlogN) and searching binary tree or smt. like
00060    * that. --pasky */
00061 
00062   for (uint i = 0; i < e->overrides_count; i++) {
00063     const WagonOverride *wo = &e->overrides[i];
00064 
00065     if (wo->cargo != cargo && wo->cargo != CT_DEFAULT) continue;
00066 
00067     for (uint j = 0; j < wo->trains; j++) {
00068       if (wo->train_id[j] == overriding_engine) return wo->group;
00069     }
00070   }
00071   return NULL;
00072 }
00073 
00077 void UnloadWagonOverrides(Engine *e)
00078 {
00079   for (uint i = 0; i < e->overrides_count; i++) {
00080     WagonOverride *wo = &e->overrides[i];
00081     free(wo->train_id);
00082   }
00083   free(e->overrides);
00084   e->overrides_count = 0;
00085   e->overrides = NULL;
00086 }
00087 
00088 
00089 void SetCustomEngineSprites(EngineID engine, byte cargo, const SpriteGroup *group)
00090 {
00091   Engine *e = Engine::Get(engine);
00092   assert(cargo < lengthof(e->grf_prop.spritegroup));
00093 
00094   if (e->grf_prop.spritegroup[cargo] != NULL) {
00095     grfmsg(6, "SetCustomEngineSprites: engine %d cargo %d already has group -- replacing", engine, cargo);
00096   }
00097   e->grf_prop.spritegroup[cargo] = group;
00098 }
00099 
00100 
00107 void SetEngineGRF(EngineID engine, const GRFFile *file)
00108 {
00109   Engine *e = Engine::Get(engine);
00110   e->grf_prop.grffile = file;
00111 }
00112 
00113 
00114 static int MapOldSubType(const Vehicle *v)
00115 {
00116   switch (v->type) {
00117     case VEH_TRAIN:
00118       if (Train::From(v)->IsEngine()) return 0;
00119       if (Train::From(v)->IsFreeWagon()) return 4;
00120       return 2;
00121     case VEH_ROAD:
00122     case VEH_SHIP:     return 0;
00123     case VEH_AIRCRAFT:
00124     case VEH_DISASTER: return v->subtype;
00125     case VEH_EFFECT:   return v->subtype << 1;
00126     default: NOT_REACHED();
00127   }
00128 }
00129 
00130 
00131 /* TTDP style aircraft movement states for GRF Action 2 Var 0xE2 */
00132 enum TTDPAircraftMovementStates {
00133   AMS_TTDP_HANGAR,
00134   AMS_TTDP_TO_HANGAR,
00135   AMS_TTDP_TO_PAD1,
00136   AMS_TTDP_TO_PAD2,
00137   AMS_TTDP_TO_PAD3,
00138   AMS_TTDP_TO_ENTRY_2_AND_3,
00139   AMS_TTDP_TO_ENTRY_2_AND_3_AND_H,
00140   AMS_TTDP_TO_JUNCTION,
00141   AMS_TTDP_LEAVE_RUNWAY,
00142   AMS_TTDP_TO_INWAY,
00143   AMS_TTDP_TO_RUNWAY,
00144   AMS_TTDP_TO_OUTWAY,
00145   AMS_TTDP_WAITING,
00146   AMS_TTDP_TAKEOFF,
00147   AMS_TTDP_TO_TAKEOFF,
00148   AMS_TTDP_CLIMBING,
00149   AMS_TTDP_FLIGHT_APPROACH,
00150   AMS_TTDP_UNUSED_0x11,
00151   AMS_TTDP_FLIGHT_TO_TOWER,
00152   AMS_TTDP_UNUSED_0x13,
00153   AMS_TTDP_FLIGHT_FINAL,
00154   AMS_TTDP_FLIGHT_DESCENT,
00155   AMS_TTDP_BRAKING,
00156   AMS_TTDP_HELI_TAKEOFF_AIRPORT,
00157   AMS_TTDP_HELI_TO_TAKEOFF_AIRPORT,
00158   AMS_TTDP_HELI_LAND_AIRPORT,
00159   AMS_TTDP_HELI_TAKEOFF_HELIPORT,
00160   AMS_TTDP_HELI_TO_TAKEOFF_HELIPORT,
00161   AMS_TTDP_HELI_LAND_HELIPORT,
00162 };
00163 
00164 
00169 static byte MapAircraftMovementState(const Aircraft *v)
00170 {
00171   const Station *st = GetTargetAirportIfValid(v);
00172   if (st == NULL) return AMS_TTDP_FLIGHT_TO_TOWER;
00173 
00174   const AirportFTAClass *afc = st->airport.GetFTA();
00175   uint16 amdflag = afc->MovingData(v->pos)->flag;
00176 
00177   switch (v->state) {
00178     case HANGAR:
00179       /* The international airport is a special case as helicopters can land in
00180        * front of the hanger. Helicopters also change their air.state to
00181        * AMED_HELI_LOWER some time before actually descending. */
00182 
00183       /* This condition only occurs for helicopters, during descent,
00184        * to a landing by the hanger of an international airport. */
00185       if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT;
00186 
00187       /* This condition only occurs for helicopters, before starting descent,
00188        * to a landing by the hanger of an international airport. */
00189       if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER;
00190 
00191       /* The final two conditions apply to helicopters or aircraft.
00192        * Has reached hanger? */
00193       if (amdflag & AMED_EXACTPOS) return AMS_TTDP_HANGAR;
00194 
00195       /* Still moving towards hanger. */
00196       return AMS_TTDP_TO_HANGAR;
00197 
00198     case TERM1:
00199       if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD1;
00200       return AMS_TTDP_TO_JUNCTION;
00201 
00202     case TERM2:
00203       if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD2;
00204       return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;
00205 
00206     case TERM3:
00207     case TERM4:
00208     case TERM5:
00209     case TERM6:
00210     case TERM7:
00211     case TERM8:
00212       /* TTDPatch only has 3 terminals, so treat these states the same */
00213       if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD3;
00214       return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H;
00215 
00216     case HELIPAD1:
00217     case HELIPAD2:
00218     case HELIPAD3:
00219       /* Will only occur for helicopters.*/
00220       if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT; // Descending.
00221       if (amdflag & AMED_SLOWTURN)   return AMS_TTDP_FLIGHT_TO_TOWER;   // Still hasn't started descent.
00222       return AMS_TTDP_TO_JUNCTION; // On the ground.
00223 
00224     case TAKEOFF: // Moving to takeoff position.
00225       return AMS_TTDP_TO_OUTWAY;
00226 
00227     case STARTTAKEOFF: // Accelerating down runway.
00228       return AMS_TTDP_TAKEOFF;
00229 
00230     case ENDTAKEOFF: // Ascent
00231       return AMS_TTDP_CLIMBING;
00232 
00233     case HELITAKEOFF: // Helicopter is moving to take off position.
00234       if (afc->delta_z == 0) {
00235         return amdflag & AMED_HELI_RAISE ?
00236           AMS_TTDP_HELI_TAKEOFF_AIRPORT : AMS_TTDP_TO_JUNCTION;
00237       } else {
00238         return AMS_TTDP_HELI_TAKEOFF_HELIPORT;
00239       }
00240 
00241     case FLYING:
00242       return amdflag & AMED_HOLD ? AMS_TTDP_FLIGHT_APPROACH : AMS_TTDP_FLIGHT_TO_TOWER;
00243 
00244     case LANDING: // Descent
00245       return AMS_TTDP_FLIGHT_DESCENT;
00246 
00247     case ENDLANDING: // On the runway braking
00248       if (amdflag & AMED_BRAKE) return AMS_TTDP_BRAKING;
00249       /* Landed - moving off runway */
00250       return AMS_TTDP_TO_INWAY;
00251 
00252     case HELILANDING:
00253     case HELIENDLANDING: // Helicoptor is decending.
00254       if (amdflag & AMED_HELI_LOWER) {
00255         return afc->delta_z == 0 ?
00256           AMS_TTDP_HELI_LAND_AIRPORT : AMS_TTDP_HELI_LAND_HELIPORT;
00257       } else {
00258         return AMS_TTDP_FLIGHT_TO_TOWER;
00259       }
00260 
00261     default:
00262       return AMS_TTDP_HANGAR;
00263   }
00264 }
00265 
00266 
00267 /* TTDP style aircraft movement action for GRF Action 2 Var 0xE6 */
00268 enum TTDPAircraftMovementActions {
00269   AMA_TTDP_IN_HANGAR,
00270   AMA_TTDP_ON_PAD1,
00271   AMA_TTDP_ON_PAD2,
00272   AMA_TTDP_ON_PAD3,
00273   AMA_TTDP_HANGAR_TO_PAD1,
00274   AMA_TTDP_HANGAR_TO_PAD2,
00275   AMA_TTDP_HANGAR_TO_PAD3,
00276   AMA_TTDP_LANDING_TO_PAD1,
00277   AMA_TTDP_LANDING_TO_PAD2,
00278   AMA_TTDP_LANDING_TO_PAD3,
00279   AMA_TTDP_PAD1_TO_HANGAR,
00280   AMA_TTDP_PAD2_TO_HANGAR,
00281   AMA_TTDP_PAD3_TO_HANGAR,
00282   AMA_TTDP_PAD1_TO_TAKEOFF,
00283   AMA_TTDP_PAD2_TO_TAKEOFF,
00284   AMA_TTDP_PAD3_TO_TAKEOFF,
00285   AMA_TTDP_HANGAR_TO_TAKOFF,
00286   AMA_TTDP_LANDING_TO_HANGAR,
00287   AMA_TTDP_IN_FLIGHT,
00288 };
00289 
00290 
00296 static byte MapAircraftMovementAction(const Aircraft *v)
00297 {
00298   switch (v->state) {
00299     case HANGAR:
00300       return (v->cur_speed > 0) ? AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_IN_HANGAR;
00301 
00302     case TERM1:
00303     case HELIPAD1:
00304       return (v->current_order.IsType(OT_LOADING)) ? AMA_TTDP_ON_PAD1 : AMA_TTDP_LANDING_TO_PAD1;
00305 
00306     case TERM2:
00307     case HELIPAD2:
00308       return (v->current_order.IsType(OT_LOADING)) ? AMA_TTDP_ON_PAD2 : AMA_TTDP_LANDING_TO_PAD2;
00309 
00310     case TERM3:
00311     case TERM4:
00312     case TERM5:
00313     case TERM6:
00314     case TERM7:
00315     case TERM8:
00316     case HELIPAD3:
00317       return (v->current_order.IsType(OT_LOADING)) ? AMA_TTDP_ON_PAD3 : AMA_TTDP_LANDING_TO_PAD3;
00318 
00319     case TAKEOFF:      // Moving to takeoff position
00320     case STARTTAKEOFF: // Accelerating down runway
00321     case ENDTAKEOFF:   // Ascent
00322     case HELITAKEOFF:
00323       /* @todo Need to find which terminal (or hanger) we've come from. How? */
00324       return AMA_TTDP_PAD1_TO_TAKEOFF;
00325 
00326     case FLYING:
00327       return AMA_TTDP_IN_FLIGHT;
00328 
00329     case LANDING:    // Descent
00330     case ENDLANDING: // On the runway braking
00331     case HELILANDING:
00332     case HELIENDLANDING:
00333       /* @todo Need to check terminal we're landing to. Is it known yet? */
00334       return (v->current_order.IsType(OT_GOTO_DEPOT)) ?
00335         AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_LANDING_TO_PAD1;
00336 
00337     default:
00338       return AMA_TTDP_IN_HANGAR;
00339   }
00340 }
00341 
00342 
00343 /* Vehicle Resolver Functions */
00344 static inline const Vehicle *GRV(const ResolverObject *object)
00345 {
00346   switch (object->scope) {
00347     default: NOT_REACHED();
00348     case VSG_SCOPE_SELF: return object->u.vehicle.self;
00349     case VSG_SCOPE_PARENT: return object->u.vehicle.parent;
00350     case VSG_SCOPE_RELATIVE: {
00351       if (object->u.vehicle.self == NULL) return NULL;
00352       const Vehicle *v = NULL;
00353       switch (GB(object->count, 6, 2)) {
00354         default: NOT_REACHED();
00355         case 0x00: // count back (away from the engine), starting at this vehicle
00356         case 0x01: // count forward (toward the engine), starting at this vehicle
00357           v = object->u.vehicle.self;
00358           break;
00359         case 0x02: // count back, starting at the engine
00360           v = object->u.vehicle.parent;
00361           break;
00362         case 0x03: { // count back, starting at the first vehicle in this chain of vehicles with the same ID, as for vehicle variable 41
00363           const Vehicle *self = object->u.vehicle.self;
00364           for (const Vehicle *u = self->First(); u != self; u = u->Next()) {
00365             if (u->engine_type != self->engine_type) {
00366               v = NULL;
00367             } else {
00368               if (v == NULL) v = u;
00369             }
00370           }
00371           if (v == NULL) v = self;
00372           break;
00373         }
00374       }
00375       uint32 count = GB(object->count, 0, 4);
00376       if (count == 0) count = GetRegister(0x100);
00377       while (v != NULL && count-- != 0) v = (GB(object->count, 6, 2) == 0x01) ? v->Previous() : v->Next();
00378       return v;
00379     }
00380   }
00381 }
00382 
00383 
00384 static uint32 VehicleGetRandomBits(const ResolverObject *object)
00385 {
00386   return GRV(object) == NULL ? 0 : GRV(object)->random_bits;
00387 }
00388 
00389 
00390 static uint32 VehicleGetTriggers(const ResolverObject *object)
00391 {
00392   return GRV(object) == NULL ? 0 : GRV(object)->waiting_triggers;
00393 }
00394 
00395 
00396 static void VehicleSetTriggers(const ResolverObject *object, int triggers)
00397 {
00398   /* Evil cast to get around const-ness. This used to be achieved by an
00399    * innocent looking function pointer cast... Currently I cannot see a
00400    * way of avoiding this without removing consts deep within gui code.
00401    */
00402   Vehicle *v = const_cast<Vehicle *>(GRV(object));
00403 
00404   /* This function must only be called when processing triggers -- any
00405    * other time is an error. */
00406   assert(object->trigger != 0);
00407 
00408   if (v != NULL) v->waiting_triggers = triggers;
00409 }
00410 
00411 
00421 static const Livery *LiveryHelper(EngineID engine, const Vehicle *v)
00422 {
00423   const Livery *l;
00424 
00425   if (v == NULL) {
00426     if (!Company::IsValidID(_current_company)) return NULL;
00427     l = GetEngineLivery(engine, _current_company, INVALID_ENGINE, NULL, LIT_ALL);
00428   } else if (v->IsGroundVehicle()) {
00429     l = GetEngineLivery(v->engine_type, v->owner, v->GetGroundVehicleCache()->first_engine, v, LIT_ALL);
00430   } else {
00431     l = GetEngineLivery(v->engine_type, v->owner, INVALID_ENGINE, v, LIT_ALL);
00432   }
00433 
00434   return l;
00435 }
00436 
00444 static uint32 PositionHelper(const Vehicle *v, bool consecutive)
00445 {
00446   const Vehicle *u;
00447   byte chain_before = 0;
00448   byte chain_after  = 0;
00449 
00450   for (u = v->First(); u != v; u = u->Next()) {
00451     chain_before++;
00452     if (consecutive && u->engine_type != v->engine_type) chain_before = 0;
00453   }
00454 
00455   while (u->Next() != NULL && (!consecutive || u->Next()->engine_type == v->engine_type)) {
00456     chain_after++;
00457     u = u->Next();
00458   }
00459 
00460   return chain_before | chain_after << 8 | (chain_before + chain_after + consecutive) << 16;
00461 }
00462 
00463 static uint32 VehicleGetVariable(Vehicle *v, const ResolverObject *object, byte variable, uint32 parameter, bool *available)
00464 {
00465   /* Calculated vehicle parameters */
00466   switch (variable) {
00467     case 0x25: // Get engine GRF ID
00468       return v->GetGRFID();
00469 
00470     case 0x40: // Get length of consist
00471       if (!HasBit(v->grf_cache.cache_valid, NCVV_POSITION_CONSIST_LENGTH)) {
00472         v->grf_cache.position_consist_length = PositionHelper(v, false);
00473         SetBit(v->grf_cache.cache_valid, NCVV_POSITION_CONSIST_LENGTH);
00474       }
00475       return v->grf_cache.position_consist_length;
00476 
00477     case 0x41: // Get length of same consecutive wagons
00478       if (!HasBit(v->grf_cache.cache_valid, NCVV_POSITION_SAME_ID_LENGTH)) {
00479         v->grf_cache.position_same_id_length = PositionHelper(v, true);
00480         SetBit(v->grf_cache.cache_valid, NCVV_POSITION_SAME_ID_LENGTH);
00481       }
00482       return v->grf_cache.position_same_id_length;
00483 
00484     case 0x42: { // Consist cargo information
00485       if (!HasBit(v->grf_cache.cache_valid, NCVV_CONSIST_CARGO_INFORMATION)) {
00486         const Vehicle *u;
00487         byte cargo_classes = 0;
00488         uint8 common_cargoes[NUM_CARGO];
00489         uint8 common_subtypes[256];
00490         byte user_def_data = 0;
00491         CargoID common_cargo_type = CT_INVALID;
00492         uint8 common_subtype = 0xFF; // Return 0xFF if nothing is carried
00493 
00494         /* Reset our arrays */
00495         memset(common_cargoes, 0, sizeof(common_cargoes));
00496         memset(common_subtypes, 0, sizeof(common_subtypes));
00497 
00498         for (u = v; u != NULL; u = u->Next()) {
00499           if (v->type == VEH_TRAIN) user_def_data |= Train::From(u)->tcache.user_def_data;
00500 
00501           /* Skip empty engines */
00502           if (u->cargo_cap == 0) continue;
00503 
00504           cargo_classes |= CargoSpec::Get(u->cargo_type)->classes;
00505           common_cargoes[u->cargo_type]++;
00506         }
00507 
00508         /* Pick the most common cargo type */
00509         uint common_cargo_best_amount = 0;
00510         for (CargoID cargo = 0; cargo < NUM_CARGO; cargo++) {
00511           if (common_cargoes[cargo] > common_cargo_best_amount) {
00512             common_cargo_best_amount = common_cargoes[cargo];
00513             common_cargo_type = cargo;
00514           }
00515         }
00516 
00517         /* Count subcargo types of common_cargo_type */
00518         for (u = v; u != NULL; u = u->Next()) {
00519           /* Skip empty engines and engines not carrying common_cargo_type */
00520           if (u->cargo_cap == 0 || u->cargo_type != common_cargo_type) continue;
00521 
00522           common_subtypes[u->cargo_subtype]++;
00523         }
00524 
00525         /* Pick the most common subcargo type*/
00526         uint common_subtype_best_amount = 0;
00527         for (uint i = 0; i < lengthof(common_subtypes); i++) {
00528           if (common_subtypes[i] > common_subtype_best_amount) {
00529             common_subtype_best_amount = common_subtypes[i];
00530             common_subtype = i;
00531           }
00532         }
00533 
00534         /* Note: We have to store the untranslated cargotype in the cache as the cache can be read by different NewGRFs,
00535          *       which will need different translations */
00536         v->grf_cache.consist_cargo_information = cargo_classes | (common_cargo_type << 8) | (common_subtype << 16) | (user_def_data << 24);
00537         SetBit(v->grf_cache.cache_valid, NCVV_CONSIST_CARGO_INFORMATION);
00538       }
00539 
00540       /* The cargo translation is specific to the accessing GRF, and thus cannot be cached. */
00541       CargoID common_cargo_type = (v->grf_cache.consist_cargo_information >> 8) & 0xFF;
00542 
00543       /* Unlike everywhere else the cargo translation table is only used since grf version 8, not 7.
00544        * Note: The grffile == NULL case only happens if this function is called for default vehicles.
00545        *       And this is only done by CheckCaches(). */
00546       const GRFFile *grffile = object->grffile;
00547       uint8 common_bitnum = (common_cargo_type == CT_INVALID) ? 0xFF :
00548         (grffile == NULL || grffile->grf_version < 8) ? CargoSpec::Get(common_cargo_type)->bitnum : grffile->cargo_map[common_cargo_type];
00549 
00550       return (v->grf_cache.consist_cargo_information & 0xFFFF00FF) | common_bitnum << 8;
00551     }
00552 
00553     case 0x43: // Company information
00554       if (!HasBit(v->grf_cache.cache_valid, NCVV_COMPANY_INFORMATION)) {
00555         v->grf_cache.company_information = GetCompanyInfo(v->owner, LiveryHelper(v->engine_type, v));
00556         SetBit(v->grf_cache.cache_valid, NCVV_COMPANY_INFORMATION);
00557       }
00558       return v->grf_cache.company_information;
00559 
00560     case 0x44: // Aircraft information
00561       if (v->type != VEH_AIRCRAFT || !Aircraft::From(v)->IsNormalAircraft()) return UINT_MAX;
00562 
00563       {
00564         const Vehicle *w = v->Next();
00565         uint16 altitude = v->z_pos - w->z_pos; // Aircraft height - shadow height
00566         byte airporttype = ATP_TTDP_LARGE;
00567 
00568         const Station *st = GetTargetAirportIfValid(Aircraft::From(v));
00569 
00570         if (st != NULL && st->airport.tile != INVALID_TILE) {
00571           airporttype = st->airport.GetSpec()->ttd_airport_type;
00572         }
00573 
00574         return (Clamp(altitude, 0, 0xFF) << 8) | airporttype;
00575       }
00576 
00577     case 0x45: { // Curvature info
00578       /* Format: xxxTxBxF
00579        * F - previous wagon to current wagon, 0 if vehicle is first
00580        * B - current wagon to next wagon, 0 if wagon is last
00581        * T - previous wagon to next wagon, 0 in an S-bend
00582        */
00583       if (!v->IsGroundVehicle()) return 0;
00584 
00585       const Vehicle *u_p = v->Previous();
00586       const Vehicle *u_n = v->Next();
00587       DirDiff f = (u_p == NULL) ?  DIRDIFF_SAME : DirDifference(u_p->direction, v->direction);
00588       DirDiff b = (u_n == NULL) ?  DIRDIFF_SAME : DirDifference(v->direction, u_n->direction);
00589       DirDiff t = ChangeDirDiff(f, b);
00590 
00591       return ((t > DIRDIFF_REVERSE ? t | 8 : t) << 16) |
00592              ((b > DIRDIFF_REVERSE ? b | 8 : b) <<  8) |
00593              ( f > DIRDIFF_REVERSE ? f | 8 : f);
00594     }
00595 
00596     case 0x46: // Motion counter
00597       return v->motion_counter;
00598 
00599     case 0x47: { // Vehicle cargo info
00600       /* Format: ccccwwtt
00601        * tt - the cargo type transported by the vehicle,
00602        *     translated if a translation table has been installed.
00603        * ww - cargo unit weight in 1/16 tons, same as cargo prop. 0F.
00604        * cccc - the cargo class value of the cargo transported by the vehicle.
00605        */
00606       const CargoSpec *cs = CargoSpec::Get(v->cargo_type);
00607 
00608       return (cs->classes << 16) | (cs->weight << 8) | v->GetGRF()->cargo_map[v->cargo_type];
00609     }
00610 
00611     case 0x48: return v->GetEngine()->flags; // Vehicle Type Info
00612     case 0x49: return v->build_year;
00613 
00614     case 0x4A: {
00615       if (v->type != VEH_TRAIN) return 0;
00616       RailType rt = GetTileRailType(v->tile);
00617       return (HasPowerOnRail(Train::From(v)->railtype, rt) ? 0x100 : 0) | GetReverseRailTypeTranslation(rt, object->grffile);
00618     }
00619 
00620     case 0x4B: // Long date of last service
00621       return v->date_of_last_service;
00622 
00623     /* Variables which use the parameter */
00624     case 0x60: // Count consist's engine ID occurance
00625       if (v->type != VEH_TRAIN) return v->GetEngine()->grf_prop.local_id == parameter ? 1 : 0;
00626 
00627       {
00628         uint count = 0;
00629         for (; v != NULL; v = v->Next()) {
00630           if (v->GetEngine()->grf_prop.local_id == parameter) count++;
00631         }
00632         return count;
00633       }
00634 
00635     case 0x61: // Get variable of n-th vehicle in chain [signed number relative to vehicle]
00636       if (!v->IsGroundVehicle() || parameter == 0x61) return 0;
00637 
00638       /* Only allow callbacks that don't change properties to avoid circular dependencies. */
00639       if (object->callback == CBID_NO_CALLBACK || object->callback == CBID_TRAIN_ALLOW_WAGON_ATTACH || object->callback == CBID_VEHICLE_START_STOP_CHECK || object->callback == CBID_VEHICLE_32DAY_CALLBACK) {
00640         Vehicle *u = v->Move((int32)GetRegister(0x10F));
00641         if (u == NULL) return 0;
00642 
00643         return VehicleGetVariable(u, object, parameter, GetRegister(0x10E), available);
00644       }
00645       return 0;
00646 
00647     case 0x62: { // Curvature/position difference for n-th vehicle in chain [signed number relative to vehicle]
00648       /* Format: zzyyxxFD
00649        * zz - Signed difference of z position between the selected and this vehicle.
00650        * yy - Signed difference of y position between the selected and this vehicle.
00651        * xx - Signed difference of x position between the selected and this vehicle.
00652        * F  - Flags, bit 7 corresponds to VS_HIDDEN.
00653        * D  - Dir difference, like in 0x45.
00654        */
00655       if (!v->IsGroundVehicle()) return 0;
00656 
00657       const Vehicle *u = v->Move((int8)parameter);
00658       if (u == NULL) return 0;
00659 
00660       /* Get direction difference. */
00661       bool prev = (int8)parameter < 0;
00662       uint32 ret = prev ? DirDifference(u->direction, v->direction) : DirDifference(v->direction, u->direction);
00663       if (ret > DIRDIFF_REVERSE) ret |= 0x08;
00664 
00665       if (u->vehstatus & VS_HIDDEN) ret |= 0x80;
00666 
00667       /* Get position difference. */
00668       ret |= ((prev ? u->x_pos - v->x_pos : v->x_pos - u->x_pos) & 0xFF) << 8;
00669       ret |= ((prev ? u->y_pos - v->y_pos : v->y_pos - u->y_pos) & 0xFF) << 16;
00670       ret |= ((prev ? u->z_pos - v->z_pos : v->z_pos - u->z_pos) & 0xFF) << 24;
00671 
00672       return ret;
00673     }
00674 
00675     case 0xFE:
00676     case 0xFF: {
00677       uint16 modflags = 0;
00678 
00679       if (v->type == VEH_TRAIN) {
00680         const Train *t = Train::From(v);
00681         bool is_powered_wagon = HasBit(t->flags, VRF_POWEREDWAGON);
00682         const Train *u = is_powered_wagon ? t->First() : t; // for powered wagons the engine defines the type of engine (i.e. railtype)
00683         RailType railtype = GetRailType(v->tile);
00684         bool powered = t->IsEngine() || is_powered_wagon;
00685         bool has_power = HasPowerOnRail(u->railtype, railtype);
00686 
00687         if (powered && has_power) SetBit(modflags, 5);
00688         if (powered && !has_power) SetBit(modflags, 6);
00689         if (HasBit(t->flags, VRF_TOGGLE_REVERSE)) SetBit(modflags, 8);
00690       }
00691       if (HasBit(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE)) SetBit(modflags, 10);
00692 
00693       return variable == 0xFE ? modflags : GB(modflags, 8, 8);
00694     }
00695   }
00696 
00697   /* General vehicle properties */
00698   switch (variable - 0x80) {
00699     case 0x00: return v->type + 0x10;
00700     case 0x01: return MapOldSubType(v);
00701     case 0x04: return v->index;
00702     case 0x05: return GB(v->index, 8, 8);
00703     case 0x0A: return v->current_order.MapOldOrder();
00704     case 0x0B: return v->current_order.GetDestination();
00705     case 0x0C: return v->GetNumOrders();
00706     case 0x0D: return v->cur_real_order_index;
00707     case 0x10:
00708     case 0x11: {
00709       uint ticks;
00710       if (v->current_order.IsType(OT_LOADING)) {
00711         ticks = v->load_unload_ticks;
00712       } else {
00713         switch (v->type) {
00714           case VEH_TRAIN:    ticks = Train::From(v)->wait_counter; break;
00715           case VEH_AIRCRAFT: ticks = Aircraft::From(v)->turn_counter; break;
00716           default:           ticks = 0; break;
00717         }
00718       }
00719       return (variable - 0x80) == 0x10 ? ticks : GB(ticks, 8, 8);
00720     }
00721     case 0x12: return Clamp(v->date_of_last_service - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF);
00722     case 0x13: return GB(Clamp(v->date_of_last_service - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF), 8, 8);
00723     case 0x14: return v->service_interval;
00724     case 0x15: return GB(v->service_interval, 8, 8);
00725     case 0x16: return v->last_station_visited;
00726     case 0x17: return v->tick_counter;
00727     case 0x18:
00728     case 0x19: {
00729       uint max_speed;
00730       switch (v->type) {
00731         case VEH_AIRCRAFT:
00732           max_speed = Aircraft::From(v)->GetSpeedOldUnits(); // Convert to old units.
00733           break;
00734 
00735         default:
00736           max_speed = v->vcache.cached_max_speed;
00737           break;
00738       }
00739       return (variable - 0x80) == 0x18 ? max_speed : GB(max_speed, 8, 8);
00740     }
00741     case 0x1A: return v->x_pos;
00742     case 0x1B: return GB(v->x_pos, 8, 8);
00743     case 0x1C: return v->y_pos;
00744     case 0x1D: return GB(v->y_pos, 8, 8);
00745     case 0x1E: return v->z_pos;
00746     case 0x1F: return object->u.vehicle.info_view ? DIR_W : v->direction;
00747     case 0x28: return v->cur_image;
00748     case 0x29: return GB(v->cur_image, 8, 8);
00749     case 0x32: return v->vehstatus;
00750     case 0x33: return 0; // non-existent high byte of vehstatus
00751     case 0x34: return v->type == VEH_AIRCRAFT ? (v->cur_speed * 10) / 128 : v->cur_speed;
00752     case 0x35: return GB(v->type == VEH_AIRCRAFT ? (v->cur_speed * 10) / 128 : v->cur_speed, 8, 8);
00753     case 0x36: return v->subspeed;
00754     case 0x37: return v->acceleration;
00755     case 0x39: return v->cargo_type;
00756     case 0x3A: return v->cargo_cap;
00757     case 0x3B: return GB(v->cargo_cap, 8, 8);
00758     case 0x3C: return ClampToU16(v->cargo.Count());
00759     case 0x3D: return GB(ClampToU16(v->cargo.Count()), 8, 8);
00760     case 0x3E: return v->cargo.Source();
00761     case 0x3F: return ClampU(v->cargo.DaysInTransit(), 0, 0xFF);
00762     case 0x40: return ClampToU16(v->age);
00763     case 0x41: return GB(ClampToU16(v->age), 8, 8);
00764     case 0x42: return ClampToU16(v->max_age);
00765     case 0x43: return GB(ClampToU16(v->max_age), 8, 8);
00766     case 0x44: return Clamp(v->build_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;
00767     case 0x45: return v->unitnumber;
00768     case 0x46: return v->GetEngine()->grf_prop.local_id;
00769     case 0x47: return GB(v->GetEngine()->grf_prop.local_id, 8, 8);
00770     case 0x48:
00771       if (v->type != VEH_TRAIN || v->spritenum != 0xFD) return v->spritenum;
00772       return HasBit(Train::From(v)->flags, VRF_REVERSE_DIRECTION) ? 0xFE : 0xFD;
00773 
00774     case 0x49: return v->day_counter;
00775     case 0x4A: return v->breakdowns_since_last_service;
00776     case 0x4B: return v->breakdown_ctr;
00777     case 0x4C: return v->breakdown_delay;
00778     case 0x4D: return v->breakdown_chance;
00779     case 0x4E: return v->reliability;
00780     case 0x4F: return GB(v->reliability, 8, 8);
00781     case 0x50: return v->reliability_spd_dec;
00782     case 0x51: return GB(v->reliability_spd_dec, 8, 8);
00783     case 0x52: return ClampToI32(v->GetDisplayProfitThisYear());
00784     case 0x53: return GB(ClampToI32(v->GetDisplayProfitThisYear()),  8, 24);
00785     case 0x54: return GB(ClampToI32(v->GetDisplayProfitThisYear()), 16, 16);
00786     case 0x55: return GB(ClampToI32(v->GetDisplayProfitThisYear()), 24,  8);
00787     case 0x56: return ClampToI32(v->GetDisplayProfitLastYear());
00788     case 0x57: return GB(ClampToI32(v->GetDisplayProfitLastYear()),  8, 24);
00789     case 0x58: return GB(ClampToI32(v->GetDisplayProfitLastYear()), 16, 16);
00790     case 0x59: return GB(ClampToI32(v->GetDisplayProfitLastYear()), 24,  8);
00791     case 0x5A: return v->Next() == NULL ? INVALID_VEHICLE : v->Next()->index;
00792     case 0x5C: return ClampToI32(v->value);
00793     case 0x5D: return GB(ClampToI32(v->value),  8, 24);
00794     case 0x5E: return GB(ClampToI32(v->value), 16, 16);
00795     case 0x5F: return GB(ClampToI32(v->value), 24,  8);
00796     case 0x72: return v->cargo_subtype;
00797     case 0x7A: return v->random_bits;
00798     case 0x7B: return v->waiting_triggers;
00799   }
00800 
00801   /* Vehicle specific properties */
00802   switch (v->type) {
00803     case VEH_TRAIN: {
00804       Train *t = Train::From(v);
00805       switch (variable - 0x80) {
00806         case 0x62: return t->track;
00807         case 0x66: return t->railtype;
00808         case 0x73: return 0x80 + VEHICLE_LENGTH - t->gcache.cached_veh_length;
00809         case 0x74: return t->gcache.cached_power;
00810         case 0x75: return GB(t->gcache.cached_power,  8, 24);
00811         case 0x76: return GB(t->gcache.cached_power, 16, 16);
00812         case 0x77: return GB(t->gcache.cached_power, 24,  8);
00813         case 0x7C: return t->First()->index;
00814         case 0x7D: return GB(t->First()->index, 8, 8);
00815         case 0x7F: return 0; // Used for vehicle reversing hack in TTDP
00816       }
00817       break;
00818     }
00819 
00820     case VEH_ROAD: {
00821       RoadVehicle *rv = RoadVehicle::From(v);
00822       switch (variable - 0x80) {
00823         case 0x62: return rv->state;
00824         case 0x64: return rv->blocked_ctr;
00825         case 0x65: return GB(rv->blocked_ctr, 8, 8);
00826         case 0x66: return rv->overtaking;
00827         case 0x67: return rv->overtaking_ctr;
00828         case 0x68: return rv->crashed_ctr;
00829         case 0x69: return GB(rv->crashed_ctr, 8, 8);
00830       }
00831       break;
00832     }
00833 
00834     case VEH_AIRCRAFT: {
00835       Aircraft *a = Aircraft::From(v);
00836       switch (variable - 0x80) {
00837         case 0x62: return MapAircraftMovementState(a);  // Current movement state
00838         case 0x63: return a->targetairport;             // Airport to which the action refers
00839         case 0x66: return MapAircraftMovementAction(a); // Current movement action
00840       }
00841       break;
00842     }
00843 
00844     default: break;
00845   }
00846 
00847   DEBUG(grf, 1, "Unhandled vehicle variable 0x%X, type 0x%X", variable, (uint)v->type);
00848 
00849   *available = false;
00850   return UINT_MAX;
00851 }
00852 
00853 static uint32 VehicleGetVariable(const ResolverObject *object, byte variable, uint32 parameter, bool *available)
00854 {
00855   Vehicle *v = const_cast<Vehicle*>(GRV(object));
00856 
00857   if (v == NULL) {
00858     /* Vehicle does not exist, so we're in a purchase list */
00859     switch (variable) {
00860       case 0x43: return GetCompanyInfo(_current_company, LiveryHelper(object->u.vehicle.self_type, NULL)); // Owner information
00861       case 0x46: return 0;               // Motion counter
00862       case 0x47: { // Vehicle cargo info
00863         const Engine *e = Engine::Get(object->u.vehicle.self_type);
00864         CargoID cargo_type = e->GetDefaultCargoType();
00865         if (cargo_type != CT_INVALID) {
00866           const CargoSpec *cs = CargoSpec::Get(cargo_type);
00867           return (cs->classes << 16) | (cs->weight << 8) | e->GetGRF()->cargo_map[cargo_type];
00868         } else {
00869           return 0x000000FF;
00870         }
00871       }
00872       case 0x48: return Engine::Get(object->u.vehicle.self_type)->flags; // Vehicle Type Info
00873       case 0x49: return _cur_year; // 'Long' format build year
00874       case 0x4B: return _date; // Long date of last service
00875       case 0x92: return Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF); // Date of last service
00876       case 0x93: return GB(Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF), 8, 8);
00877       case 0xC4: return Clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR; // Build year
00878       case 0xDA: return INVALID_VEHICLE; // Next vehicle
00879       case 0xF2: return 0; // Cargo subtype
00880     }
00881 
00882     *available = false;
00883     return UINT_MAX;
00884   }
00885 
00886   return VehicleGetVariable(v, object, variable, parameter, available);
00887 }
00888 
00889 
00890 static const SpriteGroup *VehicleResolveReal(const ResolverObject *object, const RealSpriteGroup *group)
00891 {
00892   const Vehicle *v = object->u.vehicle.self;
00893 
00894   if (v == NULL) {
00895     if (group->num_loading > 0) return group->loading[0];
00896     if (group->num_loaded  > 0) return group->loaded[0];
00897     return NULL;
00898   }
00899 
00900   bool in_motion = !v->First()->current_order.IsType(OT_LOADING);
00901 
00902   uint totalsets = in_motion ? group->num_loaded : group->num_loading;
00903 
00904   if (totalsets == 0) return NULL;
00905 
00906   uint set = (v->cargo.Count() * totalsets) / max((uint16)1, v->cargo_cap);
00907   set = min(set, totalsets - 1);
00908 
00909   return in_motion ? group->loaded[set] : group->loading[set];
00910 }
00911 
00912 
00913 static inline void NewVehicleResolver(ResolverObject *res, EngineID engine_type, const Vehicle *v)
00914 {
00915   res->GetRandomBits = &VehicleGetRandomBits;
00916   res->GetTriggers   = &VehicleGetTriggers;
00917   res->SetTriggers   = &VehicleSetTriggers;
00918   res->GetVariable   = &VehicleGetVariable;
00919   res->ResolveReal   = &VehicleResolveReal;
00920 
00921   res->u.vehicle.self   = v;
00922   res->u.vehicle.parent = (v != NULL) ? v->First() : v;
00923 
00924   res->u.vehicle.self_type = engine_type;
00925   res->u.vehicle.info_view = false;
00926 
00927   res->callback        = CBID_NO_CALLBACK;
00928   res->callback_param1 = 0;
00929   res->callback_param2 = 0;
00930   res->ResetState();
00931 
00932   const Engine *e = Engine::Get(engine_type);
00933   res->grffile         = (e != NULL ? e->GetGRF() : NULL);
00934 }
00935 
00936 
00946 static const SpriteGroup *GetVehicleSpriteGroup(EngineID engine, const Vehicle *v, bool use_cache = true)
00947 {
00948   const SpriteGroup *group;
00949   CargoID cargo;
00950 
00951   if (v == NULL) {
00952     cargo = CT_PURCHASE;
00953   } else {
00954     cargo = v->cargo_type;
00955 
00956     if (v->IsGroundVehicle()) {
00957       /* For trains we always use cached value, except for callbacks because the override spriteset
00958        * to use may be different than the one cached. It happens for callback 0x15 (refit engine),
00959        * as v->cargo_type is temporary changed to the new type */
00960       if (use_cache && v->type == VEH_TRAIN) {
00961         group = Train::From(v)->tcache.cached_override;
00962       } else {
00963         group = GetWagonOverrideSpriteSet(v->engine_type, v->cargo_type, v->GetGroundVehicleCache()->first_engine);
00964       }
00965       if (group != NULL) return group;
00966     }
00967   }
00968 
00969   const Engine *e = Engine::Get(engine);
00970 
00971   assert(cargo < lengthof(e->grf_prop.spritegroup));
00972   group = e->grf_prop.spritegroup[cargo];
00973   if (group != NULL) return group;
00974 
00975   /* Fall back to the default set if the selected cargo type is not defined */
00976   return e->grf_prop.spritegroup[CT_DEFAULT];
00977 }
00978 
00979 
00980 SpriteID GetCustomEngineSprite(EngineID engine, const Vehicle *v, Direction direction, EngineImageType image_type)
00981 {
00982   const SpriteGroup *group;
00983   ResolverObject object;
00984 
00985   NewVehicleResolver(&object, engine, v);
00986 
00987   object.callback_param1 = image_type;
00988 
00989   group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v), &object);
00990   if (group == NULL || group->GetNumResults() == 0) return 0;
00991 
00992   return group->GetResult() + (direction % group->GetNumResults());
00993 }
00994 
00995 
00996 SpriteID GetRotorOverrideSprite(EngineID engine, const Aircraft *v, bool info_view, EngineImageType image_type)
00997 {
00998   const Engine *e = Engine::Get(engine);
00999 
01000   /* Only valid for helicopters */
01001   assert(e->type == VEH_AIRCRAFT);
01002   assert(!(e->u.air.subtype & AIR_CTOL));
01003 
01004   ResolverObject object;
01005 
01006   NewVehicleResolver(&object, engine, v);
01007 
01008   object.callback_param1 = image_type;
01009   object.u.vehicle.info_view = info_view;
01010 
01011   const SpriteGroup *group = GetWagonOverrideSpriteSet(engine, CT_DEFAULT, engine);
01012   group = SpriteGroup::Resolve(group, &object);
01013 
01014   if (group == NULL || group->GetNumResults() == 0) return 0;
01015 
01016   if (v == NULL) return group->GetResult();
01017 
01018   return group->GetResult() + (info_view ? 0 : (v->Next()->Next()->state % group->GetNumResults()));
01019 }
01020 
01021 
01027 bool UsesWagonOverride(const Vehicle *v)
01028 {
01029   assert(v->type == VEH_TRAIN);
01030   return Train::From(v)->tcache.cached_override != NULL;
01031 }
01032 
01042 uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v)
01043 {
01044   const SpriteGroup *group;
01045   ResolverObject object;
01046 
01047   NewVehicleResolver(&object, engine, v);
01048 
01049   object.callback        = callback;
01050   object.callback_param1 = param1;
01051   object.callback_param2 = param2;
01052 
01053   group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v, false), &object);
01054   if (group == NULL) return CALLBACK_FAILED;
01055 
01056   return group->GetCallbackResult();
01057 }
01058 
01069 uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent)
01070 {
01071   const SpriteGroup *group;
01072   ResolverObject object;
01073 
01074   NewVehicleResolver(&object, engine, v);
01075 
01076   object.callback        = callback;
01077   object.callback_param1 = param1;
01078   object.callback_param2 = param2;
01079 
01080   object.u.vehicle.parent = parent;
01081 
01082   group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v, false), &object);
01083   if (group == NULL) return CALLBACK_FAILED;
01084 
01085   return group->GetCallbackResult();
01086 }
01087 
01088 
01089 /* Callback 36 handlers */
01090 uint GetVehicleProperty(const Vehicle *v, PropertyID property, uint orig_value)
01091 {
01092   return GetEngineProperty(v->engine_type, property, orig_value, v);
01093 }
01094 
01095 
01096 uint GetEngineProperty(EngineID engine, PropertyID property, uint orig_value, const Vehicle *v)
01097 {
01098   uint16 callback = GetVehicleCallback(CBID_VEHICLE_MODIFY_PROPERTY, property, 0, engine, v);
01099   if (callback != CALLBACK_FAILED) return callback;
01100 
01101   return orig_value;
01102 }
01103 
01104 
01105 static void DoTriggerVehicle(Vehicle *v, VehicleTrigger trigger, byte base_random_bits, bool first)
01106 {
01107   const SpriteGroup *group;
01108   ResolverObject object;
01109   byte new_random_bits;
01110 
01111   /* We can't trigger a non-existent vehicle... */
01112   assert(v != NULL);
01113 
01114   NewVehicleResolver(&object, v->engine_type, v);
01115   object.callback = CBID_RANDOM_TRIGGER;
01116   object.trigger = trigger;
01117 
01118   group = SpriteGroup::Resolve(GetVehicleSpriteGroup(v->engine_type, v), &object);
01119   if (group == NULL) return;
01120 
01121   new_random_bits = Random();
01122   uint32 reseed = object.GetReseedSum(); // The scope only affects triggers, not the reseeding
01123   v->random_bits &= ~reseed;
01124   v->random_bits |= (first ? new_random_bits : base_random_bits) & reseed;
01125 
01126   switch (trigger) {
01127     case VEHICLE_TRIGGER_NEW_CARGO:
01128       /* All vehicles in chain get ANY_NEW_CARGO trigger now.
01129        * So we call it for the first one and they will recurse.
01130        * Indexing part of vehicle random bits needs to be
01131        * same for all triggered vehicles in the chain (to get
01132        * all the random-cargo wagons carry the same cargo,
01133        * i.e.), so we give them all the NEW_CARGO triggered
01134        * vehicle's portion of random bits. */
01135       assert(first);
01136       DoTriggerVehicle(v->First(), VEHICLE_TRIGGER_ANY_NEW_CARGO, new_random_bits, false);
01137       break;
01138 
01139     case VEHICLE_TRIGGER_DEPOT:
01140       /* We now trigger the next vehicle in chain recursively.
01141        * The random bits portions may be different for each
01142        * vehicle in chain. */
01143       if (v->Next() != NULL) DoTriggerVehicle(v->Next(), trigger, 0, true);
01144       break;
01145 
01146     case VEHICLE_TRIGGER_EMPTY:
01147       /* We now trigger the next vehicle in chain
01148        * recursively.  The random bits portions must be same
01149        * for each vehicle in chain, so we give them all
01150        * first chained vehicle's portion of random bits. */
01151       if (v->Next() != NULL) DoTriggerVehicle(v->Next(), trigger, first ? new_random_bits : base_random_bits, false);
01152       break;
01153 
01154     case VEHICLE_TRIGGER_ANY_NEW_CARGO:
01155       /* Now pass the trigger recursively to the next vehicle
01156        * in chain. */
01157       assert(!first);
01158       if (v->Next() != NULL) DoTriggerVehicle(v->Next(), VEHICLE_TRIGGER_ANY_NEW_CARGO, base_random_bits, false);
01159       break;
01160 
01161     case VEHICLE_TRIGGER_CALLBACK_32:
01162       /* Do not do any recursion */
01163       break;
01164   }
01165 }
01166 
01167 void TriggerVehicle(Vehicle *v, VehicleTrigger trigger)
01168 {
01169   if (trigger == VEHICLE_TRIGGER_DEPOT) {
01170     /* store that the vehicle entered a depot this tick */
01171     VehicleEnteredDepotThisTick(v);
01172   }
01173 
01174   v->InvalidateNewGRFCacheOfChain();
01175   DoTriggerVehicle(v, trigger, 0, true);
01176   v->InvalidateNewGRFCacheOfChain();
01177 }
01178 
01179 /* Functions for changing the order of vehicle purchase lists
01180  * This is currently only implemented for rail vehicles. */
01181 
01188 uint ListPositionOfEngine(EngineID engine)
01189 {
01190   const Engine *e = Engine::Get(engine);
01191   /* Crude sorting to group by GRF ID */
01192   return (e->GetGRFID() * 256) + e->list_position;
01193 }
01194 
01195 struct ListOrderChange {
01196   EngineID engine;
01197   EngineID target;
01198 };
01199 
01200 static SmallVector<ListOrderChange, 16> _list_order_changes;
01201 
01202 void AlterVehicleListOrder(EngineID engine, EngineID target)
01203 {
01204   /* Add the list order change to a queue */
01205   ListOrderChange *loc = _list_order_changes.Append();
01206   loc->engine = engine;
01207   loc->target = target;
01208 }
01209 
01210 void CommitVehicleListOrderChanges()
01211 {
01212   /* List position to Engine map */
01213   typedef SmallMap<uint16, Engine *, 16> ListPositionMap;
01214   ListPositionMap lptr_map;
01215 
01216   const ListOrderChange *end = _list_order_changes.End();
01217   for (const ListOrderChange *it = _list_order_changes.Begin(); it != end; ++it) {
01218     EngineID engine = it->engine;
01219     EngineID target = it->target;
01220 
01221     if (engine == target) continue;
01222 
01223     Engine *source_e = Engine::Get(engine);
01224     Engine *target_e = NULL;
01225 
01226     /* Populate map with current list positions */
01227     Engine *e;
01228     FOR_ALL_ENGINES_OF_TYPE(e, source_e->type) {
01229       if (!_settings_game.vehicle.dynamic_engines || e->GetGRF() == source_e->GetGRF()) {
01230         if (e->grf_prop.local_id == target) target_e = e;
01231         lptr_map[e->list_position] = e;
01232       }
01233     }
01234 
01235     /* std::map sorted by default, SmallMap does not */
01236     lptr_map.SortByKey();
01237 
01238     /* Get the target position, if it exists */
01239     if (target_e != NULL) {
01240       uint16 target_position = target_e->list_position;
01241 
01242       bool moving = false;
01243       const ListPositionMap::Pair *end = lptr_map.End();
01244       for (ListPositionMap::Pair *it = lptr_map.Begin(); it != end; ++it) {
01245         if (it->first == target_position) moving = true;
01246         if (moving) it->second->list_position++;
01247       }
01248 
01249       source_e->list_position = target_position;
01250     }
01251 
01252     lptr_map.Clear();
01253   }
01254 
01255   /* Clear out the queue */
01256   _list_order_changes.Reset();
01257 }
01258 
01264 void GetVehicleResolver(ResolverObject *ro, uint index)
01265 {
01266   Vehicle *v = Vehicle::Get(index);
01267   NewVehicleResolver(ro, v->engine_type, v);
01268 }
01269 
01274 void FillNewGRFVehicleCache(const Vehicle *v)
01275 {
01276   ResolverObject ro;
01277   memset(&ro, 0, sizeof(ro));
01278   GetVehicleResolver(&ro, v->index);
01279 
01280   /* These variables we have to check; these are the ones with a cache. */
01281   static const int cache_entries[][2] = {
01282     { 0x40, NCVV_POSITION_CONSIST_LENGTH },
01283     { 0x41, NCVV_POSITION_SAME_ID_LENGTH },
01284     { 0x42, NCVV_CONSIST_CARGO_INFORMATION },
01285     { 0x43, NCVV_COMPANY_INFORMATION },
01286   };
01287   assert_compile(NCVV_END == lengthof(cache_entries));
01288 
01289   /* Resolve all the variables, so their caches are set. */
01290   for (size_t i = 0; i < lengthof(cache_entries); i++) {
01291     /* Only resolve when the cache isn't valid. */
01292     if (HasBit(v->grf_cache.cache_valid, cache_entries[i][1])) continue;
01293     bool stub;
01294     ro.GetVariable(&ro, cache_entries[i][0], 0, &stub);
01295   }
01296 
01297   /* Make sure really all bits are set. */
01298   assert(v->grf_cache.cache_valid == (1 << NCVV_END) - 1);
01299 }