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_cargo.h"
00018 #include "newgrf_spritegroup.h"
00019 #include "date_func.h"
00020 #include "vehicle_func.h"
00021 #include "core/random_func.hpp"
00022 #include "aircraft.h"
00023 #include "station_base.h"
00024 #include "company_base.h"
00025 #include "newgrf_railtype.h"
00026 #include "ship.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 uint32 VehicleScopeResolver::GetRandomBits() const
00344 {
00345 return this->v == NULL ? 0 : this->v->random_bits;
00346 }
00347
00348 uint32 VehicleScopeResolver::GetTriggers() const
00349 {
00350 return this->v == NULL ? 0 : this->v->waiting_triggers;
00351 }
00352
00353 void VehicleScopeResolver::SetTriggers(int triggers) const
00354 {
00355
00356
00357
00358
00359 Vehicle *v = const_cast<Vehicle *>(this->v);
00360
00361
00362
00363 assert(this->ro->trigger != 0);
00364
00365 if (v != NULL) v->waiting_triggers = triggers;
00366 }
00367
00368
00369 ScopeResolver *VehicleResolverObject::GetScope(VarSpriteGroupScope scope, byte relative)
00370 {
00371 switch (scope) {
00372 case VSG_SCOPE_SELF: return &this->self_scope;
00373 case VSG_SCOPE_PARENT: return &this->parent_scope;
00374 case VSG_SCOPE_RELATIVE: {
00375 int32 count = GB(relative, 0, 4);
00376 if (this->self_scope.v != NULL && (relative != this->cached_relative_count || count == 0)) {
00377
00378
00379 if (count == 0) count = GetRegister(0x100);
00380
00381 const Vehicle *v = NULL;
00382 switch (GB(relative, 6, 2)) {
00383 default: NOT_REACHED();
00384 case 0x00:
00385 v = this->self_scope.v;
00386 break;
00387 case 0x01:
00388 v = this->self_scope.v;
00389 count = -count;
00390 break;
00391 case 0x02:
00392 v = this->parent_scope.v;
00393 break;
00394 case 0x03: {
00395 const Vehicle *self = this->self_scope.v;
00396 for (const Vehicle *u = self->First(); u != self; u = u->Next()) {
00397 if (u->engine_type != self->engine_type) {
00398 v = NULL;
00399 } else {
00400 if (v == NULL) v = u;
00401 }
00402 }
00403 if (v == NULL) v = self;
00404 break;
00405 }
00406 }
00407 this->relative_scope.SetVehicle(v->Move(count));
00408 }
00409 return &this->relative_scope;
00410 }
00411 default: return ResolverObject::GetScope(scope, relative);
00412 }
00413 }
00414
00424 static const Livery *LiveryHelper(EngineID engine, const Vehicle *v)
00425 {
00426 const Livery *l;
00427
00428 if (v == NULL) {
00429 if (!Company::IsValidID(_current_company)) return NULL;
00430 l = GetEngineLivery(engine, _current_company, INVALID_ENGINE, NULL, LIT_ALL);
00431 } else if (v->IsGroundVehicle()) {
00432 l = GetEngineLivery(v->engine_type, v->owner, v->GetGroundVehicleCache()->first_engine, v, LIT_ALL);
00433 } else {
00434 l = GetEngineLivery(v->engine_type, v->owner, INVALID_ENGINE, v, LIT_ALL);
00435 }
00436
00437 return l;
00438 }
00439
00447 static uint32 PositionHelper(const Vehicle *v, bool consecutive)
00448 {
00449 const Vehicle *u;
00450 byte chain_before = 0;
00451 byte chain_after = 0;
00452
00453 for (u = v->First(); u != v; u = u->Next()) {
00454 chain_before++;
00455 if (consecutive && u->engine_type != v->engine_type) chain_before = 0;
00456 }
00457
00458 while (u->Next() != NULL && (!consecutive || u->Next()->engine_type == v->engine_type)) {
00459 chain_after++;
00460 u = u->Next();
00461 }
00462
00463 return chain_before | chain_after << 8 | (chain_before + chain_after + consecutive) << 16;
00464 }
00465
00466 static uint32 VehicleGetVariable(Vehicle *v, const VehicleScopeResolver *object, byte variable, uint32 parameter, bool *available)
00467 {
00468
00469 switch (variable) {
00470 case 0x25:
00471 return v->GetGRFID();
00472
00473 case 0x40:
00474 if (!HasBit(v->grf_cache.cache_valid, NCVV_POSITION_CONSIST_LENGTH)) {
00475 v->grf_cache.position_consist_length = PositionHelper(v, false);
00476 SetBit(v->grf_cache.cache_valid, NCVV_POSITION_CONSIST_LENGTH);
00477 }
00478 return v->grf_cache.position_consist_length;
00479
00480 case 0x41:
00481 if (!HasBit(v->grf_cache.cache_valid, NCVV_POSITION_SAME_ID_LENGTH)) {
00482 v->grf_cache.position_same_id_length = PositionHelper(v, true);
00483 SetBit(v->grf_cache.cache_valid, NCVV_POSITION_SAME_ID_LENGTH);
00484 }
00485 return v->grf_cache.position_same_id_length;
00486
00487 case 0x42: {
00488 if (!HasBit(v->grf_cache.cache_valid, NCVV_CONSIST_CARGO_INFORMATION)) {
00489 const Vehicle *u;
00490 byte cargo_classes = 0;
00491 uint8 common_cargoes[NUM_CARGO];
00492 uint8 common_subtypes[256];
00493 byte user_def_data = 0;
00494 CargoID common_cargo_type = CT_INVALID;
00495 uint8 common_subtype = 0xFF;
00496
00497
00498 memset(common_cargoes, 0, sizeof(common_cargoes));
00499 memset(common_subtypes, 0, sizeof(common_subtypes));
00500
00501 for (u = v; u != NULL; u = u->Next()) {
00502 if (v->type == VEH_TRAIN) user_def_data |= Train::From(u)->tcache.user_def_data;
00503
00504
00505 if (!u->GetEngine()->CanCarryCargo()) continue;
00506
00507 cargo_classes |= CargoSpec::Get(u->cargo_type)->classes;
00508 common_cargoes[u->cargo_type]++;
00509 }
00510
00511
00512 uint common_cargo_best_amount = 0;
00513 for (CargoID cargo = 0; cargo < NUM_CARGO; cargo++) {
00514 if (common_cargoes[cargo] > common_cargo_best_amount) {
00515 common_cargo_best_amount = common_cargoes[cargo];
00516 common_cargo_type = cargo;
00517 }
00518 }
00519
00520
00521 for (u = v; u != NULL; u = u->Next()) {
00522
00523 if (u->cargo_type != common_cargo_type || !u->GetEngine()->CanCarryCargo()) continue;
00524
00525 common_subtypes[u->cargo_subtype]++;
00526 }
00527
00528
00529 uint common_subtype_best_amount = 0;
00530 for (uint i = 0; i < lengthof(common_subtypes); i++) {
00531 if (common_subtypes[i] > common_subtype_best_amount) {
00532 common_subtype_best_amount = common_subtypes[i];
00533 common_subtype = i;
00534 }
00535 }
00536
00537
00538
00539 v->grf_cache.consist_cargo_information = cargo_classes | (common_cargo_type << 8) | (common_subtype << 16) | (user_def_data << 24);
00540 SetBit(v->grf_cache.cache_valid, NCVV_CONSIST_CARGO_INFORMATION);
00541 }
00542
00543
00544 CargoID common_cargo_type = (v->grf_cache.consist_cargo_information >> 8) & 0xFF;
00545
00546
00547
00548
00549 const GRFFile *grffile = object->ro->grffile;
00550 uint8 common_bitnum = (common_cargo_type == CT_INVALID) ? 0xFF :
00551 (grffile == NULL || grffile->grf_version < 8) ? CargoSpec::Get(common_cargo_type)->bitnum : grffile->cargo_map[common_cargo_type];
00552
00553 return (v->grf_cache.consist_cargo_information & 0xFFFF00FF) | common_bitnum << 8;
00554 }
00555
00556 case 0x43:
00557 if (!HasBit(v->grf_cache.cache_valid, NCVV_COMPANY_INFORMATION)) {
00558 v->grf_cache.company_information = GetCompanyInfo(v->owner, LiveryHelper(v->engine_type, v));
00559 SetBit(v->grf_cache.cache_valid, NCVV_COMPANY_INFORMATION);
00560 }
00561 return v->grf_cache.company_information;
00562
00563 case 0x44:
00564 if (v->type != VEH_AIRCRAFT || !Aircraft::From(v)->IsNormalAircraft()) return UINT_MAX;
00565
00566 {
00567 const Vehicle *w = v->Next();
00568 uint16 altitude = v->z_pos - w->z_pos;
00569 byte airporttype = ATP_TTDP_LARGE;
00570
00571 const Station *st = GetTargetAirportIfValid(Aircraft::From(v));
00572
00573 if (st != NULL && st->airport.tile != INVALID_TILE) {
00574 airporttype = st->airport.GetSpec()->ttd_airport_type;
00575 }
00576
00577 return (Clamp(altitude, 0, 0xFF) << 8) | airporttype;
00578 }
00579
00580 case 0x45: {
00581
00582
00583
00584
00585
00586 if (!v->IsGroundVehicle()) return 0;
00587
00588 const Vehicle *u_p = v->Previous();
00589 const Vehicle *u_n = v->Next();
00590 DirDiff f = (u_p == NULL) ? DIRDIFF_SAME : DirDifference(u_p->direction, v->direction);
00591 DirDiff b = (u_n == NULL) ? DIRDIFF_SAME : DirDifference(v->direction, u_n->direction);
00592 DirDiff t = ChangeDirDiff(f, b);
00593
00594 return ((t > DIRDIFF_REVERSE ? t | 8 : t) << 16) |
00595 ((b > DIRDIFF_REVERSE ? b | 8 : b) << 8) |
00596 ( f > DIRDIFF_REVERSE ? f | 8 : f);
00597 }
00598
00599 case 0x46:
00600 return v->motion_counter;
00601
00602 case 0x47: {
00603
00604
00605
00606
00607
00608
00609 const CargoSpec *cs = CargoSpec::Get(v->cargo_type);
00610
00611 return (cs->classes << 16) | (cs->weight << 8) | v->GetGRF()->cargo_map[v->cargo_type];
00612 }
00613
00614 case 0x48: return v->GetEngine()->flags;
00615 case 0x49: return v->build_year;
00616
00617 case 0x4A: {
00618 if (v->type != VEH_TRAIN) return 0;
00619 RailType rt = GetTileRailType(v->tile);
00620 return (HasPowerOnRail(Train::From(v)->railtype, rt) ? 0x100 : 0) | GetReverseRailTypeTranslation(rt, object->ro->grffile);
00621 }
00622
00623 case 0x4B:
00624 return v->date_of_last_service;
00625
00626 case 0x4C:
00627 if (!v->IsPrimaryVehicle()) return 0;
00628 return v->GetCurrentMaxSpeed();
00629
00630
00631 case 0x60:
00632 if (v->type != VEH_TRAIN) return v->GetEngine()->grf_prop.local_id == parameter ? 1 : 0;
00633
00634 {
00635 uint count = 0;
00636 for (; v != NULL; v = v->Next()) {
00637 if (v->GetEngine()->grf_prop.local_id == parameter) count++;
00638 }
00639 return count;
00640 }
00641
00642 case 0x61:
00643 if (!v->IsGroundVehicle() || parameter == 0x61) return 0;
00644
00645
00646 if (object->ro->callback == CBID_NO_CALLBACK || object->ro->callback == CBID_RANDOM_TRIGGER || object->ro->callback == CBID_TRAIN_ALLOW_WAGON_ATTACH ||
00647 object->ro->callback == CBID_VEHICLE_START_STOP_CHECK || object->ro->callback == CBID_VEHICLE_32DAY_CALLBACK || object->ro->callback == CBID_VEHICLE_COLOUR_MAPPING) {
00648 Vehicle *u = v->Move((int32)GetRegister(0x10F));
00649 if (u == NULL) return 0;
00650
00651 if (parameter == 0x5F) {
00652
00653 return (u->random_bits << 8) | u->waiting_triggers;
00654 } else {
00655 return VehicleGetVariable(u, object, parameter, GetRegister(0x10E), available);
00656 }
00657 }
00658 return 0;
00659
00660 case 0x62: {
00661
00662
00663
00664
00665
00666
00667
00668 if (!v->IsGroundVehicle()) return 0;
00669
00670 const Vehicle *u = v->Move((int8)parameter);
00671 if (u == NULL) return 0;
00672
00673
00674 bool prev = (int8)parameter < 0;
00675 uint32 ret = prev ? DirDifference(u->direction, v->direction) : DirDifference(v->direction, u->direction);
00676 if (ret > DIRDIFF_REVERSE) ret |= 0x08;
00677
00678 if (u->vehstatus & VS_HIDDEN) ret |= 0x80;
00679
00680
00681 ret |= ((prev ? u->x_pos - v->x_pos : v->x_pos - u->x_pos) & 0xFF) << 8;
00682 ret |= ((prev ? u->y_pos - v->y_pos : v->y_pos - u->y_pos) & 0xFF) << 16;
00683 ret |= ((prev ? u->z_pos - v->z_pos : v->z_pos - u->z_pos) & 0xFF) << 24;
00684
00685 return ret;
00686 }
00687
00688 case 0xFE:
00689 case 0xFF: {
00690 uint16 modflags = 0;
00691
00692 if (v->type == VEH_TRAIN) {
00693 const Train *t = Train::From(v);
00694 bool is_powered_wagon = HasBit(t->flags, VRF_POWEREDWAGON);
00695 const Train *u = is_powered_wagon ? t->First() : t;
00696 RailType railtype = GetRailType(v->tile);
00697 bool powered = t->IsEngine() || is_powered_wagon;
00698 bool has_power = HasPowerOnRail(u->railtype, railtype);
00699
00700 if (powered && has_power) SetBit(modflags, 5);
00701 if (powered && !has_power) SetBit(modflags, 6);
00702 if (HasBit(t->flags, VRF_TOGGLE_REVERSE)) SetBit(modflags, 8);
00703 }
00704 if (HasBit(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE)) SetBit(modflags, 10);
00705
00706 return variable == 0xFE ? modflags : GB(modflags, 8, 8);
00707 }
00708 }
00709
00710
00711 switch (variable - 0x80) {
00712 case 0x00: return v->type + 0x10;
00713 case 0x01: return MapOldSubType(v);
00714 case 0x04: return v->index;
00715 case 0x05: return GB(v->index, 8, 8);
00716 case 0x0A: return v->current_order.MapOldOrder();
00717 case 0x0B: return v->current_order.GetDestination();
00718 case 0x0C: return v->GetNumOrders();
00719 case 0x0D: return v->cur_real_order_index;
00720 case 0x10:
00721 case 0x11: {
00722 uint ticks;
00723 if (v->current_order.IsType(OT_LOADING)) {
00724 ticks = v->load_unload_ticks;
00725 } else {
00726 switch (v->type) {
00727 case VEH_TRAIN: ticks = Train::From(v)->wait_counter; break;
00728 case VEH_AIRCRAFT: ticks = Aircraft::From(v)->turn_counter; break;
00729 default: ticks = 0; break;
00730 }
00731 }
00732 return (variable - 0x80) == 0x10 ? ticks : GB(ticks, 8, 8);
00733 }
00734 case 0x12: return Clamp(v->date_of_last_service - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF);
00735 case 0x13: return GB(Clamp(v->date_of_last_service - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF), 8, 8);
00736 case 0x14: return v->GetServiceInterval();
00737 case 0x15: return GB(v->GetServiceInterval(), 8, 8);
00738 case 0x16: return v->last_station_visited;
00739 case 0x17: return v->tick_counter;
00740 case 0x18:
00741 case 0x19: {
00742 uint max_speed;
00743 switch (v->type) {
00744 case VEH_AIRCRAFT:
00745 max_speed = Aircraft::From(v)->GetSpeedOldUnits();
00746 break;
00747
00748 default:
00749 max_speed = v->vcache.cached_max_speed;
00750 break;
00751 }
00752 return (variable - 0x80) == 0x18 ? max_speed : GB(max_speed, 8, 8);
00753 }
00754 case 0x1A: return v->x_pos;
00755 case 0x1B: return GB(v->x_pos, 8, 8);
00756 case 0x1C: return v->y_pos;
00757 case 0x1D: return GB(v->y_pos, 8, 8);
00758 case 0x1E: return v->z_pos;
00759 case 0x1F: return object->info_view ? DIR_W : v->direction;
00760 case 0x28: return 0;
00761 case 0x29: return 0;
00762 case 0x32: return v->vehstatus;
00763 case 0x33: return 0;
00764 case 0x34: return v->type == VEH_AIRCRAFT ? (v->cur_speed * 10) / 128 : v->cur_speed;
00765 case 0x35: return GB(v->type == VEH_AIRCRAFT ? (v->cur_speed * 10) / 128 : v->cur_speed, 8, 8);
00766 case 0x36: return v->subspeed;
00767 case 0x37: return v->acceleration;
00768 case 0x39: return v->cargo_type;
00769 case 0x3A: return v->cargo_cap;
00770 case 0x3B: return GB(v->cargo_cap, 8, 8);
00771 case 0x3C: return ClampToU16(v->cargo.StoredCount());
00772 case 0x3D: return GB(ClampToU16(v->cargo.StoredCount()), 8, 8);
00773 case 0x3E: return v->cargo.Source();
00774 case 0x3F: return ClampU(v->cargo.DaysInTransit(), 0, 0xFF);
00775 case 0x40: return ClampToU16(v->age);
00776 case 0x41: return GB(ClampToU16(v->age), 8, 8);
00777 case 0x42: return ClampToU16(v->max_age);
00778 case 0x43: return GB(ClampToU16(v->max_age), 8, 8);
00779 case 0x44: return Clamp(v->build_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;
00780 case 0x45: return v->unitnumber;
00781 case 0x46: return v->GetEngine()->grf_prop.local_id;
00782 case 0x47: return GB(v->GetEngine()->grf_prop.local_id, 8, 8);
00783 case 0x48:
00784 if (v->type != VEH_TRAIN || v->spritenum != 0xFD) return v->spritenum;
00785 return HasBit(Train::From(v)->flags, VRF_REVERSE_DIRECTION) ? 0xFE : 0xFD;
00786
00787 case 0x49: return v->day_counter;
00788 case 0x4A: return v->breakdowns_since_last_service;
00789 case 0x4B: return v->breakdown_ctr;
00790 case 0x4C: return v->breakdown_delay;
00791 case 0x4D: return v->breakdown_chance;
00792 case 0x4E: return v->reliability;
00793 case 0x4F: return GB(v->reliability, 8, 8);
00794 case 0x50: return v->reliability_spd_dec;
00795 case 0x51: return GB(v->reliability_spd_dec, 8, 8);
00796 case 0x52: return ClampToI32(v->GetDisplayProfitThisYear());
00797 case 0x53: return GB(ClampToI32(v->GetDisplayProfitThisYear()), 8, 24);
00798 case 0x54: return GB(ClampToI32(v->GetDisplayProfitThisYear()), 16, 16);
00799 case 0x55: return GB(ClampToI32(v->GetDisplayProfitThisYear()), 24, 8);
00800 case 0x56: return ClampToI32(v->GetDisplayProfitLastYear());
00801 case 0x57: return GB(ClampToI32(v->GetDisplayProfitLastYear()), 8, 24);
00802 case 0x58: return GB(ClampToI32(v->GetDisplayProfitLastYear()), 16, 16);
00803 case 0x59: return GB(ClampToI32(v->GetDisplayProfitLastYear()), 24, 8);
00804 case 0x5A: return v->Next() == NULL ? INVALID_VEHICLE : v->Next()->index;
00805 case 0x5C: return ClampToI32(v->value);
00806 case 0x5D: return GB(ClampToI32(v->value), 8, 24);
00807 case 0x5E: return GB(ClampToI32(v->value), 16, 16);
00808 case 0x5F: return GB(ClampToI32(v->value), 24, 8);
00809 case 0x72: return v->cargo_subtype;
00810 case 0x7A: return v->random_bits;
00811 case 0x7B: return v->waiting_triggers;
00812 }
00813
00814
00815 switch (v->type) {
00816 case VEH_TRAIN: {
00817 Train *t = Train::From(v);
00818 switch (variable - 0x80) {
00819 case 0x62: return t->track;
00820 case 0x66: return t->railtype;
00821 case 0x73: return 0x80 + VEHICLE_LENGTH - t->gcache.cached_veh_length;
00822 case 0x74: return t->gcache.cached_power;
00823 case 0x75: return GB(t->gcache.cached_power, 8, 24);
00824 case 0x76: return GB(t->gcache.cached_power, 16, 16);
00825 case 0x77: return GB(t->gcache.cached_power, 24, 8);
00826 case 0x7C: return t->First()->index;
00827 case 0x7D: return GB(t->First()->index, 8, 8);
00828 case 0x7F: return 0;
00829 }
00830 break;
00831 }
00832
00833 case VEH_ROAD: {
00834 RoadVehicle *rv = RoadVehicle::From(v);
00835 switch (variable - 0x80) {
00836 case 0x62: return rv->state;
00837 case 0x64: return rv->blocked_ctr;
00838 case 0x65: return GB(rv->blocked_ctr, 8, 8);
00839 case 0x66: return rv->overtaking;
00840 case 0x67: return rv->overtaking_ctr;
00841 case 0x68: return rv->crashed_ctr;
00842 case 0x69: return GB(rv->crashed_ctr, 8, 8);
00843 }
00844 break;
00845 }
00846
00847 case VEH_SHIP: {
00848 Ship *s = Ship::From(v);
00849 switch (variable - 0x80) {
00850 case 0x62: return s->state;
00851 }
00852 break;
00853 }
00854
00855 case VEH_AIRCRAFT: {
00856 Aircraft *a = Aircraft::From(v);
00857 switch (variable - 0x80) {
00858 case 0x62: return MapAircraftMovementState(a);
00859 case 0x63: return a->targetairport;
00860 case 0x66: return MapAircraftMovementAction(a);
00861 }
00862 break;
00863 }
00864
00865 default: break;
00866 }
00867
00868 DEBUG(grf, 1, "Unhandled vehicle variable 0x%X, type 0x%X", variable, (uint)v->type);
00869
00870 *available = false;
00871 return UINT_MAX;
00872 }
00873
00874 uint32 VehicleScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
00875 {
00876 if (this->v == NULL) {
00877
00878 switch (variable) {
00879 case 0x43: return GetCompanyInfo(_current_company, LiveryHelper(this->self_type, NULL));
00880 case 0x46: return 0;
00881 case 0x47: {
00882 const Engine *e = Engine::Get(this->self_type);
00883 CargoID cargo_type = e->GetDefaultCargoType();
00884 if (cargo_type != CT_INVALID) {
00885 const CargoSpec *cs = CargoSpec::Get(cargo_type);
00886 return (cs->classes << 16) | (cs->weight << 8) | e->GetGRF()->cargo_map[cargo_type];
00887 } else {
00888 return 0x000000FF;
00889 }
00890 }
00891 case 0x48: return Engine::Get(this->self_type)->flags;
00892 case 0x49: return _cur_year;
00893 case 0x4B: return _date;
00894 case 0x92: return Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF);
00895 case 0x93: return GB(Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 0xFFFF), 8, 8);
00896 case 0xC4: return Clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR;
00897 case 0xDA: return INVALID_VEHICLE;
00898 case 0xF2: return 0;
00899 }
00900
00901 *available = false;
00902 return UINT_MAX;
00903 }
00904
00905 return VehicleGetVariable(const_cast<Vehicle*>(this->v), this, variable, parameter, available);
00906 }
00907
00908
00909 const SpriteGroup *VehicleResolverObject::ResolveReal(const RealSpriteGroup *group) const
00910 {
00911 const Vehicle *v = this->self_scope.v;
00912
00913 if (v == NULL) {
00914 if (group->num_loading > 0) return group->loading[0];
00915 if (group->num_loaded > 0) return group->loaded[0];
00916 return NULL;
00917 }
00918
00919 bool in_motion = !v->First()->current_order.IsType(OT_LOADING);
00920
00921 uint totalsets = in_motion ? group->num_loaded : group->num_loading;
00922
00923 if (totalsets == 0) return NULL;
00924
00925 uint set = (v->cargo.StoredCount() * totalsets) / max((uint16)1, v->cargo_cap);
00926 set = min(set, totalsets - 1);
00927
00928 return in_motion ? group->loaded[set] : group->loading[set];
00929 }
00930
00938 VehicleScopeResolver::VehicleScopeResolver(ResolverObject *ro, EngineID engine_type, const Vehicle *v, bool info_view)
00939 : ScopeResolver(ro)
00940 {
00941 this->v = v;
00942 this->self_type = engine_type;
00943 this->info_view = info_view;
00944 }
00945
00951 static const GRFFile *GetEngineGrfFile(EngineID engine_type)
00952 {
00953 const Engine *e = Engine::Get(engine_type);
00954 return (e != NULL) ? e->GetGRF() : NULL;
00955 }
00956
00966 VehicleResolverObject::VehicleResolverObject(EngineID engine_type, const Vehicle *v, bool info_view,
00967 CallbackID callback, uint32 callback_param1, uint32 callback_param2)
00968 : ResolverObject(GetEngineGrfFile(engine_type), callback, callback_param1, callback_param2),
00969 self_scope(this, engine_type, v, info_view),
00970 parent_scope(this, engine_type, ((v != NULL) ? v->First() : v), info_view),
00971 relative_scope(this, engine_type, v, info_view),
00972 cached_relative_count(0)
00973 {
00974 }
00975
00985 static const SpriteGroup *GetVehicleSpriteGroup(EngineID engine, const Vehicle *v, bool use_cache = true)
00986 {
00987 const SpriteGroup *group;
00988 CargoID cargo;
00989
00990 if (v == NULL) {
00991 cargo = CT_PURCHASE;
00992 } else {
00993 cargo = v->cargo_type;
00994
00995 if (v->IsGroundVehicle()) {
00996
00997
00998
00999 if (use_cache && v->type == VEH_TRAIN) {
01000 group = Train::From(v)->tcache.cached_override;
01001 } else {
01002 group = GetWagonOverrideSpriteSet(v->engine_type, v->cargo_type, v->GetGroundVehicleCache()->first_engine);
01003 }
01004 if (group != NULL) return group;
01005 }
01006 }
01007
01008 const Engine *e = Engine::Get(engine);
01009
01010 assert(cargo < lengthof(e->grf_prop.spritegroup));
01011 group = e->grf_prop.spritegroup[cargo];
01012 if (group != NULL) return group;
01013
01014
01015 return e->grf_prop.spritegroup[CT_DEFAULT];
01016 }
01017
01018
01019 SpriteID GetCustomEngineSprite(EngineID engine, const Vehicle *v, Direction direction, EngineImageType image_type)
01020 {
01021 VehicleResolverObject object(engine, v, false, CBID_NO_CALLBACK, image_type);
01022 const SpriteGroup *group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v), &object);
01023 if (group == NULL || group->GetNumResults() == 0) return 0;
01024
01025 return group->GetResult() + (direction % group->GetNumResults());
01026 }
01027
01028
01029 SpriteID GetRotorOverrideSprite(EngineID engine, const Aircraft *v, bool info_view, EngineImageType image_type)
01030 {
01031 const Engine *e = Engine::Get(engine);
01032
01033
01034 assert(e->type == VEH_AIRCRAFT);
01035 assert(!(e->u.air.subtype & AIR_CTOL));
01036
01037 VehicleResolverObject object(engine, v, info_view, CBID_NO_CALLBACK, image_type);
01038 const SpriteGroup *group = GetWagonOverrideSpriteSet(engine, CT_DEFAULT, engine);
01039 group = SpriteGroup::Resolve(group, &object);
01040
01041 if (group == NULL || group->GetNumResults() == 0) return 0;
01042
01043 if (v == NULL) return group->GetResult();
01044
01045 return group->GetResult() + (info_view ? 0 : (v->Next()->Next()->state % group->GetNumResults()));
01046 }
01047
01048
01054 bool UsesWagonOverride(const Vehicle *v)
01055 {
01056 assert(v->type == VEH_TRAIN);
01057 return Train::From(v)->tcache.cached_override != NULL;
01058 }
01059
01069 uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v)
01070 {
01071 VehicleResolverObject object(engine, v, false, callback, param1, param2);
01072 const SpriteGroup *group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v, false), &object);
01073 if (group == NULL) return CALLBACK_FAILED;
01074
01075 return group->GetCallbackResult();
01076 }
01077
01088 uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent)
01089 {
01090 VehicleResolverObject object(engine, v, false, callback, param1, param2);
01091 object.parent_scope.SetVehicle(parent);
01092
01093 const SpriteGroup *group = SpriteGroup::Resolve(GetVehicleSpriteGroup(engine, v, false), &object);
01094 if (group == NULL) return CALLBACK_FAILED;
01095
01096 return group->GetCallbackResult();
01097 }
01098
01099
01100
01101 uint GetVehicleProperty(const Vehicle *v, PropertyID property, uint orig_value)
01102 {
01103 return GetEngineProperty(v->engine_type, property, orig_value, v);
01104 }
01105
01106
01107 uint GetEngineProperty(EngineID engine, PropertyID property, uint orig_value, const Vehicle *v)
01108 {
01109 uint16 callback = GetVehicleCallback(CBID_VEHICLE_MODIFY_PROPERTY, property, 0, engine, v);
01110 if (callback != CALLBACK_FAILED) return callback;
01111
01112 return orig_value;
01113 }
01114
01115
01116 static void DoTriggerVehicle(Vehicle *v, VehicleTrigger trigger, byte base_random_bits, bool first)
01117 {
01118
01119 assert(v != NULL);
01120
01121 VehicleResolverObject object(v->engine_type, v, false, CBID_RANDOM_TRIGGER);
01122 object.trigger = trigger;
01123
01124 const SpriteGroup *group = SpriteGroup::Resolve(GetVehicleSpriteGroup(v->engine_type, v), &object);
01125 if (group == NULL) return;
01126
01127 byte new_random_bits = Random();
01128 uint32 reseed = object.GetReseedSum();
01129 v->random_bits &= ~reseed;
01130 v->random_bits |= (first ? new_random_bits : base_random_bits) & reseed;
01131
01132 switch (trigger) {
01133 case VEHICLE_TRIGGER_NEW_CARGO:
01134
01135
01136
01137
01138
01139
01140
01141 assert(first);
01142 DoTriggerVehicle(v->First(), VEHICLE_TRIGGER_ANY_NEW_CARGO, new_random_bits, false);
01143 break;
01144
01145 case VEHICLE_TRIGGER_DEPOT:
01146
01147
01148
01149 if (v->Next() != NULL) DoTriggerVehicle(v->Next(), trigger, 0, true);
01150 break;
01151
01152 case VEHICLE_TRIGGER_EMPTY:
01153
01154
01155
01156
01157 if (v->Next() != NULL) DoTriggerVehicle(v->Next(), trigger, first ? new_random_bits : base_random_bits, false);
01158 break;
01159
01160 case VEHICLE_TRIGGER_ANY_NEW_CARGO:
01161
01162
01163 assert(!first);
01164 if (v->Next() != NULL) DoTriggerVehicle(v->Next(), VEHICLE_TRIGGER_ANY_NEW_CARGO, base_random_bits, false);
01165 break;
01166
01167 case VEHICLE_TRIGGER_CALLBACK_32:
01168
01169 break;
01170 }
01171 }
01172
01173 void TriggerVehicle(Vehicle *v, VehicleTrigger trigger)
01174 {
01175 if (trigger == VEHICLE_TRIGGER_DEPOT) {
01176
01177 VehicleEnteredDepotThisTick(v);
01178 }
01179
01180 v->InvalidateNewGRFCacheOfChain();
01181 DoTriggerVehicle(v, trigger, 0, true);
01182 v->InvalidateNewGRFCacheOfChain();
01183 }
01184
01185
01186
01187 struct ListOrderChange {
01188 EngineID engine;
01189 uint target;
01190 };
01191
01192 static SmallVector<ListOrderChange, 16> _list_order_changes;
01193
01200 void AlterVehicleListOrder(EngineID engine, uint target)
01201 {
01202
01203 ListOrderChange *loc = _list_order_changes.Append();
01204 loc->engine = engine;
01205 loc->target = target;
01206 }
01207
01214 static int CDECL EnginePreSort(const EngineID *a, const EngineID *b)
01215 {
01216 const EngineIDMapping *id_a = _engine_mngr.Get(*a);
01217 const EngineIDMapping *id_b = _engine_mngr.Get(*b);
01218
01219
01220 if (id_a->type != id_b->type) return (int)id_a->type - (int)id_b->type;
01221
01222
01223 if (id_a->grfid != id_b->grfid) return id_a->grfid < id_b->grfid ? -1 : 1;
01224
01225
01226 return (int)id_a->internal_id - (int)id_b->internal_id;
01227 }
01228
01232 void CommitVehicleListOrderChanges()
01233 {
01234
01235 SmallVector<EngineID, 16> ordering;
01236 Engine *e;
01237 FOR_ALL_ENGINES(e) {
01238 *ordering.Append() = e->index;
01239 }
01240 QSortT(ordering.Begin(), ordering.Length(), EnginePreSort);
01241
01242
01243 const ListOrderChange *end = _list_order_changes.End();
01244 for (const ListOrderChange *it = _list_order_changes.Begin(); it != end; ++it) {
01245 EngineID source = it->engine;
01246 uint local_target = it->target;
01247
01248 const EngineIDMapping *id_source = _engine_mngr.Get(source);
01249 if (id_source->internal_id == local_target) continue;
01250
01251 EngineID target = _engine_mngr.GetID(id_source->type, local_target, id_source->grfid);
01252 if (target == INVALID_ENGINE) continue;
01253
01254 int source_index = ordering.FindIndex(source);
01255 int target_index = ordering.FindIndex(target);
01256
01257 assert(source_index >= 0 && target_index >= 0);
01258 assert(source_index != target_index);
01259
01260 EngineID *list = ordering.Begin();
01261 if (source_index < target_index) {
01262 --target_index;
01263 for (int i = source_index; i < target_index; ++i) list[i] = list[i + 1];
01264 list[target_index] = source;
01265 } else {
01266 for (int i = source_index; i > target_index; --i) list[i] = list[i - 1];
01267 list[target_index] = source;
01268 }
01269 }
01270
01271
01272 const EngineID *idend = ordering.End();
01273 uint index = 0;
01274 for (const EngineID *it = ordering.Begin(); it != idend; ++it, ++index) {
01275 Engine::Get(*it)->list_position = index;
01276 }
01277
01278
01279 _list_order_changes.Reset();
01280 }
01281
01286 void FillNewGRFVehicleCache(const Vehicle *v)
01287 {
01288 VehicleResolverObject ro(v->engine_type, v);
01289
01290
01291 static const int cache_entries[][2] = {
01292 { 0x40, NCVV_POSITION_CONSIST_LENGTH },
01293 { 0x41, NCVV_POSITION_SAME_ID_LENGTH },
01294 { 0x42, NCVV_CONSIST_CARGO_INFORMATION },
01295 { 0x43, NCVV_COMPANY_INFORMATION },
01296 };
01297 assert_compile(NCVV_END == lengthof(cache_entries));
01298
01299
01300 for (size_t i = 0; i < lengthof(cache_entries); i++) {
01301
01302 if (HasBit(v->grf_cache.cache_valid, cache_entries[i][1])) continue;
01303 bool stub;
01304 ro.GetScope(VSG_SCOPE_SELF)->GetVariable(cache_entries[i][0], 0, &stub);
01305 }
01306
01307
01308 assert(v->grf_cache.cache_valid == (1 << NCVV_END) - 1);
01309 }