00001
00002
00003
00004
00005
00006
00007
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);
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
00058
00059
00060
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
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
00180
00181
00182
00183
00184
00185 if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT;
00186
00187
00188
00189 if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER;
00190
00191
00192
00193 if (amdflag & AMED_EXACTPOS) return AMS_TTDP_HANGAR;
00194
00195
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
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
00220 if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT;
00221 if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER;
00222 return AMS_TTDP_TO_JUNCTION;
00223
00224 case TAKEOFF:
00225 return AMS_TTDP_TO_OUTWAY;
00226
00227 case STARTTAKEOFF:
00228 return AMS_TTDP_TAKEOFF;
00229
00230 case ENDTAKEOFF:
00231 return AMS_TTDP_CLIMBING;
00232
00233 case HELITAKEOFF:
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:
00245 return AMS_TTDP_FLIGHT_DESCENT;
00246
00247 case ENDLANDING:
00248 if (amdflag & AMED_BRAKE) return AMS_TTDP_BRAKING;
00249
00250 return AMS_TTDP_TO_INWAY;
00251
00252 case HELILANDING:
00253 case HELIENDLANDING:
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
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:
00320 case STARTTAKEOFF:
00321 case ENDTAKEOFF:
00322 case HELITAKEOFF:
00323
00324 return AMA_TTDP_PAD1_TO_TAKEOFF;
00325
00326 case FLYING:
00327 return AMA_TTDP_IN_FLIGHT;
00328
00329 case LANDING:
00330 case ENDLANDING:
00331 case HELILANDING:
00332 case HELIENDLANDING:
00333
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
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:
00356 case 0x01:
00357 v = object->u.vehicle.self;
00358 break;
00359 case 0x02:
00360 v = object->u.vehicle.parent;
00361 break;
00362 case 0x03: {
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
00399
00400
00401
00402 Vehicle *v = const_cast<Vehicle *>(GRV(object));
00403
00404
00405
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
00466 switch (variable) {
00467 case 0x25:
00468 return v->GetGRFID();
00469
00470 case 0x40:
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:
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:
00485 if (!HasBit(v->grf_cache.cache_valid, NCVV_CONSIST_CARGO_INFORMATION)) {
00486 const Vehicle *u;
00487 byte cargo_classes = 0;
00488 uint8 common_cargos[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;
00493
00494
00495 memset(common_cargos, 0, sizeof(common_cargos));
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
00502 if (u->cargo_cap == 0) continue;
00503
00504 cargo_classes |= CargoSpec::Get(u->cargo_type)->classes;
00505 common_cargos[u->cargo_type]++;
00506 }
00507
00508
00509 uint common_cargo_best_amount = 0;
00510 for (CargoID cargo = 0; cargo < NUM_CARGO; cargo++) {
00511 if (common_cargos[cargo] > common_cargo_best_amount) {
00512 common_cargo_best_amount = common_cargos[cargo];
00513 common_cargo_type = cargo;
00514 }
00515 }
00516
00517
00518 for (u = v; u != NULL; u = u->Next()) {
00519
00520 if (u->cargo_cap == 0 || u->cargo_type != common_cargo_type) continue;
00521
00522 common_subtypes[u->cargo_subtype]++;
00523 }
00524
00525
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
00535 const GRFFile *grffile = v->GetGRF();
00536 uint8 common_bitnum = (common_cargo_type == CT_INVALID) ? 0xFF :
00537 (grffile->grf_version < 8) ? CargoSpec::Get(common_cargo_type)->bitnum : grffile->cargo_map[common_cargo_type];
00538 v->grf_cache.consist_cargo_information = cargo_classes | (common_bitnum << 8) | (common_subtype << 16) | (user_def_data << 24);
00539 SetBit(v->grf_cache.cache_valid, NCVV_CONSIST_CARGO_INFORMATION);
00540 }
00541 return v->grf_cache.consist_cargo_information;
00542
00543 case 0x43:
00544 if (!HasBit(v->grf_cache.cache_valid, NCVV_COMPANY_INFORMATION)) {
00545 v->grf_cache.company_information = GetCompanyInfo(v->owner, LiveryHelper(v->engine_type, v));
00546 SetBit(v->grf_cache.cache_valid, NCVV_COMPANY_INFORMATION);
00547 }
00548 return v->grf_cache.company_information;
00549
00550 case 0x44:
00551 if (v->type != VEH_AIRCRAFT || !Aircraft::From(v)->IsNormalAircraft()) return UINT_MAX;
00552
00553 {
00554 const Vehicle *w = v->Next();
00555 uint16 altitude = v->z_pos - w->z_pos;
00556 byte airporttype = ATP_TTDP_LARGE;
00557
00558 const Station *st = GetTargetAirportIfValid(Aircraft::From(v));
00559
00560 if (st != NULL && st->airport.tile != INVALID_TILE) {
00561 airporttype = st->airport.GetSpec()->ttd_airport_type;
00562 }
00563
00564 return (Clamp(altitude, 0, 0xFF) << 8) | airporttype;
00565 }
00566
00567 case 0x45: {
00568
00569
00570
00571
00572
00573 if (!v->IsGroundVehicle()) return 0;
00574
00575 const Vehicle *u_p = v->Previous();
00576 const Vehicle *u_n = v->Next();
00577 DirDiff f = (u_p == NULL) ? DIRDIFF_SAME : DirDifference(u_p->direction, v->direction);
00578 DirDiff b = (u_n == NULL) ? DIRDIFF_SAME : DirDifference(v->direction, u_n->direction);
00579 DirDiff t = ChangeDirDiff(f, b);
00580
00581 return ((t > DIRDIFF_REVERSE ? t | 8 : t) << 16) |
00582 ((b > DIRDIFF_REVERSE ? b | 8 : b) << 8) |
00583 ( f > DIRDIFF_REVERSE ? f | 8 : f);
00584 }
00585
00586 case 0x46:
00587 return v->motion_counter;
00588
00589 case 0x47: {
00590
00591
00592
00593
00594
00595
00596 const CargoSpec *cs = CargoSpec::Get(v->cargo_type);
00597
00598 return (cs->classes << 16) | (cs->weight << 8) | v->GetGRF()->cargo_map[v->cargo_type];
00599 }
00600
00601 case 0x48: return v->GetEngine()->flags;
00602 case 0x49: return v->build_year;
00603
00604 case 0x4A: {
00605 if (v->type != VEH_TRAIN) return 0;
00606 RailType rt = GetTileRailType(v->tile);
00607 return (HasPowerOnRail(Train::From(v)->railtype, rt) ? 0x100 : 0) | GetReverseRailTypeTranslation(rt, object->grffile);
00608 }
00609
00610 case 0x4B:
00611 return v->date_of_last_service;
00612
00613
00614 case 0x60:
00615 if (v->type != VEH_TRAIN) return v->GetEngine()->grf_prop.local_id == parameter ? 1 : 0;
00616
00617 {
00618 uint count = 0;
00619 for (; v != NULL; v = v->Next()) {
00620 if (v->GetEngine()->grf_prop.local_id == parameter) count++;
00621 }
00622 return count;
00623 }
00624
00625 case 0x61:
00626 if (!v->IsGroundVehicle() || parameter == 0x61) return 0;
00627
00628
00629 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) {
00630 Vehicle *u = v->Move((int32)GetRegister(0x10F));
00631 if (u == NULL) return 0;
00632
00633 return VehicleGetVariable(u, object, parameter, GetRegister(0x10E), available);
00634 }
00635 return 0;
00636
00637 case 0x62: {
00638
00639
00640
00641
00642
00643
00644
00645 if (!v->IsGroundVehicle()) return 0;
00646
00647 const Vehicle *u = v->Move((int8)parameter);
00648 if (u == NULL) return 0;
00649
00650
00651 bool prev = (int8)parameter < 0;
00652 uint32 ret = prev ? DirDifference(u->direction, v->direction) : DirDifference(v->direction, u->direction);
00653 if (ret > DIRDIFF_REVERSE) ret |= 0x08;
00654
00655 if (u->vehstatus & VS_HIDDEN) ret |= 0x80;
00656
00657
00658 ret |= ((prev ? u->x_pos - v->x_pos : v->x_pos - u->x_pos) & 0xFF) << 8;
00659 ret |= ((prev ? u->y_pos - v->y_pos : v->y_pos - u->y_pos) & 0xFF) << 16;
00660 ret |= ((prev ? u->z_pos - v->z_pos : v->z_pos - u->z_pos) & 0xFF) << 24;
00661
00662 return ret;
00663 }
00664
00665 case 0xFE:
00666 case 0xFF: {
00667 uint16 modflags = 0;
00668
00669 if (v->type == VEH_TRAIN) {
00670 const Train *t = Train::From(v);
00671 bool is_powered_wagon = HasBit(t->flags, VRF_POWEREDWAGON);
00672 const Train *u = is_powered_wagon ? t->First() : t;
00673 RailType railtype = GetRailType(v->tile);
00674 bool powered = t->IsEngine() || is_powered_wagon;
00675 bool has_power = HasPowerOnRail(u->railtype, railtype);
00676
00677 if (powered && has_power) SetBit(modflags, 5);
00678 if (powered && !has_power) SetBit(modflags, 6);
00679 if (HasBit(t->flags, VRF_TOGGLE_REVERSE)) SetBit(modflags, 8);
00680 }
00681 if (HasBit(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE)) SetBit(modflags, 10);
00682
00683 return variable == 0xFE ? modflags : GB(modflags, 8, 8);
00684 }
00685 }
00686
00687
00688 switch (variable - 0x80) {
00689 case 0x00: return v->type + 0x10;
00690 case 0x01: return MapOldSubType(v);
00691 case 0x04: return v->index;
00692 case 0x05: return GB(v->index, 8, 8);
00693 case 0x0A: return v->current_order.MapOldOrder();
00694 case 0x0B: return v->current_order.GetDestination();
00695 case 0x0C: return v->GetNumOrders();
00696 case 0x0D: return v->cur_real_order_index;
00697 case 0x10:
00698 case 0x11: {
00699 uint ticks;
00700 if (v->current_order.IsType(OT_LOADING)) {
00701 ticks = v->load_unload_ticks;
00702 } else {
00703 switch (v->type) {
00704 case VEH_TRAIN: ticks = Train::From(v)->wait_counter; break;
00705 case VEH_AIRCRAFT: ticks = Aircraft::From(v)->turn_counter; break;
00706 default: ticks = 0; break;
00707 }
00708 }
00709 return (variable - 0x80) == 0x10 ? ticks : GB(ticks, 8, 8);
00710 }
00711 case 0x12: return Clamp(v->date_of_last_service - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF);
00712 case 0x13: return GB(Clamp(v->date_of_last_service - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF), 8, 8);
00713 case 0x14: return v->service_interval;
00714 case 0x15: return GB(v->service_interval, 8, 8);
00715 case 0x16: return v->last_station_visited;
00716 case 0x17: return v->tick_counter;
00717 case 0x18:
00718 case 0x19: {
00719 uint max_speed;
00720 switch (v->type) {
00721 case VEH_AIRCRAFT:
00722 max_speed = Aircraft::From(v)->GetSpeedOldUnits();
00723 break;
00724
00725 default:
00726 max_speed = v->vcache.cached_max_speed;
00727 break;
00728 }
00729 return (variable - 0x80) == 0x18 ? max_speed : GB(max_speed, 8, 8);
00730 }
00731 case 0x1A: return v->x_pos;
00732 case 0x1B: return GB(v->x_pos, 8, 8);
00733 case 0x1C: return v->y_pos;
00734 case 0x1D: return GB(v->y_pos, 8, 8);
00735 case 0x1E: return v->z_pos;
00736 case 0x1F: return object->u.vehicle.info_view ? DIR_W : v->direction;
00737 case 0x28: return v->cur_image;
00738 case 0x29: return GB(v->cur_image, 8, 8);
00739 case 0x32: return v->vehstatus;
00740 case 0x33: return 0;
00741 case 0x34: return v->type == VEH_AIRCRAFT ? (v->cur_speed * 10) / 128 : v->cur_speed;
00742 case 0x35: return GB(v->type == VEH_AIRCRAFT ? (v->cur_speed * 10) / 128 : v->cur_speed, 8, 8);
00743 case 0x36: return v->subspeed;
00744 case 0x37: return v->acceleration;
00745 case 0x39: return v->cargo_type;
00746 case 0x3A: return v->cargo_cap;
00747 case 0x3B: return GB(v->cargo_cap, 8, 8);
00748 case 0x3C: return ClampToU16(v->cargo.Count());
00749 case 0x3D: return GB(ClampToU16(v->cargo.Count()), 8, 8);
00750 case 0x3E: return v->cargo.Source();
00751 case 0x3F: return ClampU(v->cargo.DaysInTransit(), 0, 0xFF);
00752 case 0x40: return ClampToU16(v->age);
00753 case 0x41: return GB(ClampToU16(v->age), 8, 8);
00754 case 0x42: return ClampToU16(v->max_age);
00755 case 0x43: return GB(ClampToU16(v->max_age), 8, 8);
00756 case 0x44: return Clamp(v->build_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;
00757 case 0x45: return v->unitnumber;
00758 case 0x46: return v->GetEngine()->grf_prop.local_id;
00759 case 0x47: return GB(v->GetEngine()->grf_prop.local_id, 8, 8);
00760 case 0x48:
00761 if (v->type != VEH_TRAIN || v->spritenum != 0xFD) return v->spritenum;
00762 return HasBit(Train::From(v)->flags, VRF_REVERSE_DIRECTION) ? 0xFE : 0xFD;
00763
00764 case 0x49: return v->day_counter;
00765 case 0x4A: return v->breakdowns_since_last_service;
00766 case 0x4B: return v->breakdown_ctr;
00767 case 0x4C: return v->breakdown_delay;
00768 case 0x4D: return v->breakdown_chance;
00769 case 0x4E: return v->reliability;
00770 case 0x4F: return GB(v->reliability, 8, 8);
00771 case 0x50: return v->reliability_spd_dec;
00772 case 0x51: return GB(v->reliability_spd_dec, 8, 8);
00773 case 0x52: return ClampToI32(v->GetDisplayProfitThisYear());
00774 case 0x53: return GB(ClampToI32(v->GetDisplayProfitThisYear()), 8, 24);
00775 case 0x54: return GB(ClampToI32(v->GetDisplayProfitThisYear()), 16, 16);
00776 case 0x55: return GB(ClampToI32(v->GetDisplayProfitThisYear()), 24, 8);
00777 case 0x56: return ClampToI32(v->GetDisplayProfitLastYear());
00778 case 0x57: return GB(ClampToI32(v->GetDisplayProfitLastYear()), 8, 24);
00779 case 0x58: return GB(ClampToI32(v->GetDisplayProfitLastYear()), 16, 16);
00780 case 0x59: return GB(ClampToI32(v->GetDisplayProfitLastYear()), 24, 8);
00781 case 0x5A: return v->Next() == NULL ? INVALID_VEHICLE : v->Next()->index;
00782 case 0x5C: return ClampToI32(v->value);
00783 case 0x5D: return GB(ClampToI32(v->value), 8, 24);
00784 case 0x5E: return GB(ClampToI32(v->value), 16, 16);
00785 case 0x5F: return GB(ClampToI32(v->value), 24, 8);
00786 case 0x72: return v->cargo_subtype;
00787 case 0x7A: return v->random_bits;
00788 case 0x7B: return v->waiting_triggers;
00789 }
00790
00791
00792 switch (v->type) {
00793 case VEH_TRAIN: {
00794 Train *t = Train::From(v);
00795 switch (variable - 0x80) {
00796 case 0x62: return t->track;
00797 case 0x66: return t->railtype;
00798 case 0x73: return 0x80 + VEHICLE_LENGTH - t->gcache.cached_veh_length;
00799 case 0x74: return t->gcache.cached_power;
00800 case 0x75: return GB(t->gcache.cached_power, 8, 24);
00801 case 0x76: return GB(t->gcache.cached_power, 16, 16);
00802 case 0x77: return GB(t->gcache.cached_power, 24, 8);
00803 case 0x7C: return t->First()->index;
00804 case 0x7D: return GB(t->First()->index, 8, 8);
00805 case 0x7F: return 0;
00806 }
00807 break;
00808 }
00809
00810 case VEH_ROAD: {
00811 RoadVehicle *rv = RoadVehicle::From(v);
00812 switch (variable - 0x80) {
00813 case 0x62: return rv->state;
00814 case 0x64: return rv->blocked_ctr;
00815 case 0x65: return GB(rv->blocked_ctr, 8, 8);
00816 case 0x66: return rv->overtaking;
00817 case 0x67: return rv->overtaking_ctr;
00818 case 0x68: return rv->crashed_ctr;
00819 case 0x69: return GB(rv->crashed_ctr, 8, 8);
00820 }
00821 break;
00822 }
00823
00824 case VEH_AIRCRAFT: {
00825 Aircraft *a = Aircraft::From(v);
00826 switch (variable - 0x80) {
00827 case 0x62: return MapAircraftMovementState(a);
00828 case 0x63: return a->targetairport;
00829 case 0x66: return MapAircraftMovementAction(a);
00830 }
00831 break;
00832 }
00833
00834 default: break;
00835 }
00836
00837 DEBUG(grf, 1, "Unhandled vehicle variable 0x%X, type 0x%X", variable, (uint)v->type);
00838
00839 *available = false;
00840 return UINT_MAX;
00841 }
00842
00843 static uint32 VehicleGetVariable(const ResolverObject *object, byte variable, uint32 parameter, bool *available)
00844 {
00845 Vehicle *v = const_cast<Vehicle*>(GRV(object));
00846
00847 if (v == NULL) {
00848
00849 switch (variable) {
00850 case 0x43: return GetCompanyInfo(_current_company, LiveryHelper(object->u.vehicle.self_type, NULL));
00851 case 0x46: return 0;
00852 case 0x47: {
00853 const Engine *e = Engine::Get(object->u.vehicle.self_type);
00854 CargoID cargo_type = e->GetDefaultCargoType();
00855 if (cargo_type != CT_INVALID) {
00856 const CargoSpec *cs = CargoSpec::Get(cargo_type);
00857 return (cs->classes << 16) | (cs->weight << 8) | e->GetGRF()->cargo_map[cargo_type];
00858 } else {
00859 return 0x000000FF;
00860 }
00861 }
00862 case 0x48: return Engine::Get(object->u.vehicle.self_type)->flags;
00863 case 0x49: return _cur_year;
00864 case 0x4B: return _date;
00865 case 0x92: return Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF);
00866 case 0x93: return GB(Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF), 8, 8);
00867 case 0xC4: return Clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;
00868 case 0xDA: return INVALID_VEHICLE;
00869 case 0xF2: return 0;
00870 }
00871
00872 *available = false;
00873 return UINT_MAX;
00874 }
00875
00876 return VehicleGetVariable(v, object, variable, parameter, available);
00877 }
00878
00879
00880 static const SpriteGroup *VehicleResolveReal(const ResolverObject *object, const RealSpriteGroup *group)
00881 {
00882 const Vehicle *v = object->u.vehicle.self;
00883
00884 if (v == NULL) {
00885 if (group->num_loading > 0) return group->loading[0];
00886 if (group->num_loaded > 0) return group->loaded[0];
00887 return NULL;
00888 }
00889
00890 bool in_motion = !v->First()->current_order.IsType(OT_LOADING);
00891
00892 uint totalsets = in_motion ? group->num_loaded : group->num_loading;
00893
00894 if (totalsets == 0) return NULL;
00895
00896 uint set = (v->cargo.Count() * totalsets) / max((uint16)1, v->cargo_cap);
00897 set = min(set, totalsets - 1);
00898
00899 return in_motion ? group->loaded[set] : group->loading[set];
00900 }
00901
00902
00903 static inline void NewVehicleResolver(ResolverObject *res, EngineID engine_type, const Vehicle *v)
00904 {
00905 res->GetRandomBits = &VehicleGetRandomBits;
00906 res->GetTriggers = &VehicleGetTriggers;
00907 res->SetTriggers = &VehicleSetTriggers;
00908 res->GetVariable = &VehicleGetVariable;
00909 res->ResolveReal = &VehicleResolveReal;
00910
00911 res->u.vehicle.self = v;
00912 res->u.vehicle.parent = (v != NULL) ? v->First() : v;
00913
00914 res->u.vehicle.self_type = engine_type;
00915 res->u.vehicle.info_view = false;
00916
00917 res->callback = CBID_NO_CALLBACK;
00918 res->callback_param1 = 0;
00919 res->callback_param2 = 0;
00920 res->ResetState();
00921
00922 const Engine *e = Engine::Get(engine_type);
00923 res->grffile = (e != NULL ? e->GetGRF() : NULL);
00924 }
00925
00926
00936 static const SpriteGroup *GetVehicleSpriteGroup(EngineID engine, const Vehicle *v, bool use_cache = true)
00937 {
00938 const SpriteGroup *group;
00939 CargoID cargo;
00940
00941 if (v == NULL) {
00942 cargo = CT_PURCHASE;
00943 } else {
00944 cargo = v->cargo_type;
00945
00946 if (v->IsGroundVehicle()) {
00947
00948
00949
00950 if (use_cache && v->type == VEH_TRAIN) {
00951 group = Train::From(v)->tcache.cached_override;
00952 } else {
00953 group = GetWagonOverrideSpriteSet(v->engine_type, v->cargo_type, v->GetGroundVehicleCache()->first_engine);
00954 }
00955 if (group != NULL) return group;
00956 }
00957 }
00958
00959 const Engine *e = Engine::Get(engine);
00960
00961 assert(cargo < lengthof(e->grf_prop.spritegroup));
00962 group = e->grf_prop.spritegroup[cargo];
00963 if (group != NULL) return group;
00964
00965
00966 return e->grf_prop.spritegroup[CT_DEFAULT];
00967 }
00968
00969
00970 SpriteID GetCustomEngineSprite(EngineID engine, const Vehicle *v, Direction direction, EngineImageType image_type)
00971 {
00972 const SpriteGroup *group;
00973 ResolverObject object;
00974
00975 NewVehicleResolver(&object, engine, v);
00976
00977 object.callback_param1 = image_type;
00978
00979 group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v), &object);
00980 if (group == NULL || group->GetNumResults() == 0) return 0;
00981
00982 return group->GetResult() + (direction % group->GetNumResults());
00983 }
00984
00985
00986 SpriteID GetRotorOverrideSprite(EngineID engine, const Aircraft *v, bool info_view, EngineImageType image_type)
00987 {
00988 const Engine *e = Engine::Get(engine);
00989
00990
00991 assert(e->type == VEH_AIRCRAFT);
00992 assert(!(e->u.air.subtype & AIR_CTOL));
00993
00994 ResolverObject object;
00995
00996 NewVehicleResolver(&object, engine, v);
00997
00998 object.callback_param1 = image_type;
00999 object.u.vehicle.info_view = info_view;
01000
01001 const SpriteGroup *group = GetWagonOverrideSpriteSet(engine, CT_DEFAULT, engine);
01002 group = SpriteGroup::Resolve(group, &object);
01003
01004 if (group == NULL || group->GetNumResults() == 0) return 0;
01005
01006 if (v == NULL) return group->GetResult();
01007
01008 return group->GetResult() + (info_view ? 0 : (v->Next()->Next()->state % group->GetNumResults()));
01009 }
01010
01011
01017 bool UsesWagonOverride(const Vehicle *v)
01018 {
01019 assert(v->type == VEH_TRAIN);
01020 return Train::From(v)->tcache.cached_override != NULL;
01021 }
01022
01032 uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v)
01033 {
01034 const SpriteGroup *group;
01035 ResolverObject object;
01036
01037 NewVehicleResolver(&object, engine, v);
01038
01039 object.callback = callback;
01040 object.callback_param1 = param1;
01041 object.callback_param2 = param2;
01042
01043 group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v, false), &object);
01044 if (group == NULL) return CALLBACK_FAILED;
01045
01046 return group->GetCallbackResult();
01047 }
01048
01059 uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent)
01060 {
01061 const SpriteGroup *group;
01062 ResolverObject object;
01063
01064 NewVehicleResolver(&object, engine, v);
01065
01066 object.callback = callback;
01067 object.callback_param1 = param1;
01068 object.callback_param2 = param2;
01069
01070 object.u.vehicle.parent = parent;
01071
01072 group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v, false), &object);
01073 if (group == NULL) return CALLBACK_FAILED;
01074
01075 return group->GetCallbackResult();
01076 }
01077
01078
01079
01080 uint GetVehicleProperty(const Vehicle *v, PropertyID property, uint orig_value)
01081 {
01082 return GetEngineProperty(v->engine_type, property, orig_value, v);
01083 }
01084
01085
01086 uint GetEngineProperty(EngineID engine, PropertyID property, uint orig_value, const Vehicle *v)
01087 {
01088 uint16 callback = GetVehicleCallback(CBID_VEHICLE_MODIFY_PROPERTY, property, 0, engine, v);
01089 if (callback != CALLBACK_FAILED) return callback;
01090
01091 return orig_value;
01092 }
01093
01094
01095 static void DoTriggerVehicle(Vehicle *v, VehicleTrigger trigger, byte base_random_bits, bool first)
01096 {
01097 const SpriteGroup *group;
01098 ResolverObject object;
01099 byte new_random_bits;
01100
01101
01102 assert(v != NULL);
01103
01104 NewVehicleResolver(&object, v->engine_type, v);
01105 object.callback = CBID_RANDOM_TRIGGER;
01106 object.trigger = trigger;
01107
01108 group = SpriteGroup::Resolve(GetVehicleSpriteGroup(v->engine_type, v), &object);
01109 if (group == NULL) return;
01110
01111 new_random_bits = Random();
01112 uint32 reseed = object.GetReseedSum();
01113 v->random_bits &= ~reseed;
01114 v->random_bits |= (first ? new_random_bits : base_random_bits) & reseed;
01115
01116 switch (trigger) {
01117 case VEHICLE_TRIGGER_NEW_CARGO:
01118
01119
01120
01121
01122
01123
01124
01125 assert(first);
01126 DoTriggerVehicle(v->First(), VEHICLE_TRIGGER_ANY_NEW_CARGO, new_random_bits, false);
01127 break;
01128
01129 case VEHICLE_TRIGGER_DEPOT:
01130
01131
01132
01133 if (v->Next() != NULL) DoTriggerVehicle(v->Next(), trigger, 0, true);
01134 break;
01135
01136 case VEHICLE_TRIGGER_EMPTY:
01137
01138
01139
01140
01141 if (v->Next() != NULL) DoTriggerVehicle(v->Next(), trigger, first ? new_random_bits : base_random_bits, false);
01142 break;
01143
01144 case VEHICLE_TRIGGER_ANY_NEW_CARGO:
01145
01146
01147 assert(!first);
01148 if (v->Next() != NULL) DoTriggerVehicle(v->Next(), VEHICLE_TRIGGER_ANY_NEW_CARGO, base_random_bits, false);
01149 break;
01150
01151 case VEHICLE_TRIGGER_CALLBACK_32:
01152
01153 break;
01154 }
01155 }
01156
01157 void TriggerVehicle(Vehicle *v, VehicleTrigger trigger)
01158 {
01159 if (trigger == VEHICLE_TRIGGER_DEPOT) {
01160
01161 VehicleEnteredDepotThisTick(v);
01162 }
01163
01164 v->InvalidateNewGRFCacheOfChain();
01165 DoTriggerVehicle(v, trigger, 0, true);
01166 v->InvalidateNewGRFCacheOfChain();
01167 }
01168
01169
01170
01171
01178 uint ListPositionOfEngine(EngineID engine)
01179 {
01180 const Engine *e = Engine::Get(engine);
01181
01182 return (e->GetGRFID() * 256) + e->list_position;
01183 }
01184
01185 struct ListOrderChange {
01186 EngineID engine;
01187 EngineID target;
01188 };
01189
01190 static SmallVector<ListOrderChange, 16> _list_order_changes;
01191
01192 void AlterVehicleListOrder(EngineID engine, EngineID target)
01193 {
01194
01195 ListOrderChange *loc = _list_order_changes.Append();
01196 loc->engine = engine;
01197 loc->target = target;
01198 }
01199
01200 void CommitVehicleListOrderChanges()
01201 {
01202
01203 typedef SmallMap<uint16, Engine *, 16> ListPositionMap;
01204 ListPositionMap lptr_map;
01205
01206 const ListOrderChange *end = _list_order_changes.End();
01207 for (const ListOrderChange *it = _list_order_changes.Begin(); it != end; ++it) {
01208 EngineID engine = it->engine;
01209 EngineID target = it->target;
01210
01211 if (engine == target) continue;
01212
01213 Engine *source_e = Engine::Get(engine);
01214 Engine *target_e = NULL;
01215
01216
01217 Engine *e;
01218 FOR_ALL_ENGINES_OF_TYPE(e, source_e->type) {
01219 if (!_settings_game.vehicle.dynamic_engines || e->GetGRF() == source_e->GetGRF()) {
01220 if (e->grf_prop.local_id == target) target_e = e;
01221 lptr_map[e->list_position] = e;
01222 }
01223 }
01224
01225
01226 lptr_map.SortByKey();
01227
01228
01229 if (target_e != NULL) {
01230 uint16 target_position = target_e->list_position;
01231
01232 bool moving = false;
01233 const ListPositionMap::Pair *end = lptr_map.End();
01234 for (ListPositionMap::Pair *it = lptr_map.Begin(); it != end; ++it) {
01235 if (it->first == target_position) moving = true;
01236 if (moving) it->second->list_position++;
01237 }
01238
01239 source_e->list_position = target_position;
01240 }
01241
01242 lptr_map.Clear();
01243 }
01244
01245
01246 _list_order_changes.Reset();
01247 }
01248
01254 void GetVehicleResolver(ResolverObject *ro, uint index)
01255 {
01256 Vehicle *v = Vehicle::Get(index);
01257 NewVehicleResolver(ro, v->engine_type, v);
01258 }
01259
01264 void FillNewGRFVehicleCache(const Vehicle *v)
01265 {
01266 ResolverObject ro;
01267 memset(&ro, 0, sizeof(ro));
01268 GetVehicleResolver(&ro, v->index);
01269
01270
01271 static const int cache_entries[][2] = {
01272 { 0x40, NCVV_POSITION_CONSIST_LENGTH },
01273 { 0x41, NCVV_POSITION_SAME_ID_LENGTH },
01274 { 0x42, NCVV_CONSIST_CARGO_INFORMATION },
01275 { 0x43, NCVV_COMPANY_INFORMATION },
01276 };
01277 assert_compile(NCVV_END == lengthof(cache_entries));
01278
01279
01280 for (size_t i = 0; i < lengthof(cache_entries); i++) {
01281
01282 if (HasBit(v->grf_cache.cache_valid, cache_entries[i][1])) continue;
01283 bool stub;
01284 ro.GetVariable(&ro, cache_entries[i][0], 0, &stub);
01285 }
01286
01287
01288 assert(v->grf_cache.cache_valid == (1 << NCVV_END) - 1);
01289 }