tron@2186: /* $Id$ */ tron@2186: truelight@0: #include "stdafx.h" Darkvater@1891: #include "openttd.h" peter1138@3686: #include "variables.h" tron@1299: #include "debug.h" tron@2163: #include "functions.h" truelight@0: #include "engine.h" peter1138@3686: #include "train.h" peter1138@3686: #include "player.h" peter1138@3702: #include "station.h" peter1138@3702: #include "airport.h" peter1138@3924: #include "newgrf.h" peter1138@2982: #include "newgrf_callbacks.h" peter1138@2962: #include "newgrf_engine.h" peter1138@3686: #include "newgrf_station.h" peter1138@3686: #include "newgrf_spritegroup.h" belugas@3866: #include "newgrf_cargo.h" rubidium@4261: #include "date.h" truelight@0: peter1138@3843: peter1138@3843: peter1138@3843: /* Default cargo classes */ peter1138@3843: static const uint16 _cargo_classes[NUM_GLOBAL_CID] = { peter1138@3843: CC_PASSENGERS, peter1138@3843: CC_BULK, peter1138@3843: CC_MAIL, peter1138@3843: CC_LIQUID, peter1138@3843: CC_PIECE_GOODS, peter1138@3843: CC_EXPRESS, peter1138@3843: CC_BULK, peter1138@3843: CC_PIECE_GOODS, peter1138@3843: CC_BULK, peter1138@3843: CC_PIECE_GOODS, peter1138@3843: CC_ARMOURED, peter1138@3843: CC_PIECE_GOODS, peter1138@3843: CC_REFRIGERATED | CC_EXPRESS, peter1138@3843: CC_REFRIGERATED | CC_EXPRESS, peter1138@3843: CC_BULK, peter1138@3843: CC_LIQUID, peter1138@3843: CC_LIQUID, peter1138@3843: CC_BULK, peter1138@3843: CC_PIECE_GOODS, peter1138@3843: CC_PIECE_GOODS, peter1138@3843: CC_EXPRESS, peter1138@3843: CC_BULK, peter1138@3843: CC_LIQUID, peter1138@3843: CC_BULK, peter1138@3843: CC_PIECE_GOODS, peter1138@3843: CC_LIQUID, peter1138@3843: CC_PIECE_GOODS, peter1138@3843: CC_PIECE_GOODS, belugas@3866: CC_NOAVAILABLE, belugas@3866: CC_NOAVAILABLE, belugas@3866: CC_NOAVAILABLE, peter1138@3843: }; peter1138@3843: peter1138@3785: int _traininfo_vehicle_pitch = 0; peter1138@3845: int _traininfo_vehicle_width = 29; peter1138@3785: tron@1477: typedef struct WagonOverride { truelight@0: byte *train_id; truelight@0: int trains; peter1138@4869: CargoID cargo; peter1138@3693: const SpriteGroup *group; tron@1477: } WagonOverride; truelight@0: tron@1477: typedef struct WagonOverrides { truelight@0: int overrides_count; tron@1477: WagonOverride *overrides; tron@1477: } WagonOverrides; truelight@0: tron@1477: static WagonOverrides _engine_wagon_overrides[TOTAL_NUM_ENGINES]; tron@1477: peter1138@4869: void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const SpriteGroup *group, byte *train_id, int trains) truelight@0: { tron@1477: WagonOverrides *wos; tron@1477: WagonOverride *wo; truelight@0: peter1138@5338: assert(engine < TOTAL_NUM_ENGINES); peter1138@5338: assert(cargo < NUM_GLOBAL_CID); peter1138@5338: truelight@0: wos = &_engine_wagon_overrides[engine]; truelight@0: wos->overrides_count++; truelight@0: wos->overrides = realloc(wos->overrides, tron@1477: wos->overrides_count * sizeof(*wos->overrides)); truelight@193: truelight@0: wo = &wos->overrides[wos->overrides_count - 1]; darkvater@408: /* FIXME: If we are replacing an override, release original SpriteGroup darkvater@408: * to prevent leaks. But first we need to refcount the SpriteGroup. darkvater@408: * --pasky */ peter1138@2488: wo->group = group; peter1138@4869: wo->cargo = cargo; truelight@0: wo->trains = trains; truelight@0: wo->train_id = malloc(trains); truelight@0: memcpy(wo->train_id, train_id, trains); truelight@0: } truelight@0: peter1138@4869: static const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, byte overriding_engine) truelight@0: { tron@2242: const WagonOverrides *wos = &_engine_wagon_overrides[engine]; truelight@0: int i; truelight@0: darkvater@408: // XXX: This could turn out to be a timesink on profiles. We could darkvater@408: // always just dedicate 65535 bytes for an [engine][train] trampoline darkvater@408: // for O(1). Or O(logMlogN) and searching binary tree or smt. like darkvater@408: // that. --pasky truelight@0: truelight@0: for (i = 0; i < wos->overrides_count; i++) { tron@2242: const WagonOverride *wo = &wos->overrides[i]; truelight@0: int j; truelight@0: truelight@0: for (j = 0; j < wo->trains; j++) { peter1138@4869: if (wo->train_id[j] == overriding_engine && (wo->cargo == cargo || wo->cargo == GC_DEFAULT)) return wo->group; truelight@0: } truelight@0: } truelight@0: return NULL; truelight@0: } truelight@0: peter1138@2491: /** peter1138@2491: * Unload all wagon override sprite groups. peter1138@2491: */ peter1138@2491: void UnloadWagonOverrides(void) peter1138@2491: { peter1138@2491: WagonOverrides *wos; peter1138@2491: WagonOverride *wo; peter1138@2491: EngineID engine; peter1138@2491: int i; peter1138@2491: peter1138@2491: for (engine = 0; engine < TOTAL_NUM_ENGINES; engine++) { peter1138@2491: wos = &_engine_wagon_overrides[engine]; peter1138@2491: for (i = 0; i < wos->overrides_count; i++) { peter1138@2491: wo = &wos->overrides[i]; peter1138@3595: wo->group = NULL; peter1138@2491: free(wo->train_id); peter1138@2491: } peter1138@2491: free(wos->overrides); peter1138@2491: wos->overrides_count = 0; peter1138@2491: wos->overrides = NULL; peter1138@2491: } peter1138@2491: } truelight@0: truelight@0: // 0 - 28 are cargos, 29 is default, 30 is the advert (purchase list) truelight@0: // (It isn't and shouldn't be like this in the GRF files since new cargo types truelight@0: // may appear in future - however it's more convenient to store it like this in truelight@0: // memory. --pasky) peter1138@3693: static const SpriteGroup *engine_custom_sprites[TOTAL_NUM_ENGINES][NUM_GLOBAL_CID]; peter1138@3924: static const GRFFile *_engine_grf[TOTAL_NUM_ENGINES]; truelight@0: peter1138@3693: void SetCustomEngineSprites(EngineID engine, byte cargo, const SpriteGroup *group) truelight@0: { peter1138@3614: assert(engine < TOTAL_NUM_ENGINES); peter1138@5338: assert(cargo < NUM_GLOBAL_CID); peter1138@5338: peter1138@2491: if (engine_custom_sprites[engine][cargo] != NULL) { Darkvater@5568: grfmsg(6, "SetCustomEngineSprites: engine %d cargo %d already has group -- replacing", engine, cargo); peter1138@2491: } peter1138@2488: engine_custom_sprites[engine][cargo] = group; truelight@0: } truelight@0: peter1138@2491: /** peter1138@2491: * Unload all engine sprite groups. peter1138@2491: */ peter1138@2491: void UnloadCustomEngineSprites(void) peter1138@2491: { peter1138@2491: EngineID engine; peter1138@2491: CargoID cargo; peter1138@2491: peter1138@2491: for (engine = 0; engine < TOTAL_NUM_ENGINES; engine++) { peter1138@2491: for (cargo = 0; cargo < NUM_GLOBAL_CID; cargo++) { peter1138@3595: engine_custom_sprites[engine][cargo] = NULL; peter1138@2491: } peter1138@3648: _engine_grf[engine] = 0; peter1138@2491: } peter1138@2491: } peter1138@2491: peter1138@3695: static const SpriteGroup *heli_rotor_custom_sprites[NUM_AIRCRAFT_ENGINES]; peter1138@3695: peter1138@3695: /** Load a rotor override sprite group for an aircraft */ peter1138@3695: void SetRotorOverrideSprites(EngineID engine, const SpriteGroup *group) peter1138@3695: { peter1138@3695: assert(engine >= AIRCRAFT_ENGINES_INDEX); peter1138@3695: assert(engine < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES); peter1138@3695: peter1138@3695: if (heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] != NULL) { Darkvater@5568: grfmsg(6, "SetRotorOverrideSprites: engine %d already has group -- replacing.", engine); peter1138@3695: } peter1138@3695: heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = group; peter1138@3695: } peter1138@3695: peter1138@3695: /** Unload all rotor override sprite groups */ peter1138@3695: void UnloadRotorOverrideSprites(void) peter1138@3695: { peter1138@3695: EngineID engine; peter1138@3695: peter1138@3695: /* Starting at AIRCRAFT_ENGINES_INDEX may seem pointless, but it means peter1138@3695: * the context of EngineID is correct */ peter1138@3695: for (engine = AIRCRAFT_ENGINES_INDEX; engine < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES; engine++) { peter1138@3695: heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX] = NULL; peter1138@3695: } peter1138@3695: } peter1138@3695: peter1138@3924: peter1138@3924: /** peter1138@3924: * Tie a GRFFile entry to an engine, to allow us to retrieve GRF parameters peter1138@3924: * etc during a game. peter1138@3924: * @param engine Engine ID to tie the GRFFile to. peter1138@3924: * @param file Pointer of GRFFile to tie. peter1138@3924: */ peter1138@3924: void SetEngineGRF(EngineID engine, const GRFFile *file) peter1138@3648: { peter1138@3648: assert(engine < TOTAL_NUM_ENGINES); peter1138@3924: _engine_grf[engine] = file; peter1138@3648: } peter1138@3648: peter1138@3924: peter1138@3924: /** peter1138@3924: * Retrieve the GRFFile tied to an engine peter1138@3924: * @param engine Engine ID to retrieve. peter1138@3924: * @return Pointer to GRFFile. peter1138@3924: */ peter1138@3924: const GRFFile *GetEngineGRF(EngineID engine) peter1138@3924: { peter1138@3924: assert(engine < TOTAL_NUM_ENGINES); peter1138@3924: return _engine_grf[engine]; peter1138@3924: } peter1138@3924: peter1138@3924: peter1138@3924: /** peter1138@3924: * Retrieve the GRF ID of the GRFFile tied to an engine peter1138@3924: * @param engine Engine ID to retrieve. peter1138@3924: * @return 32 bit GRFID value. peter1138@3924: */ peter1138@3648: uint32 GetEngineGRFID(EngineID engine) peter1138@3648: { peter1138@3648: assert(engine < TOTAL_NUM_ENGINES); peter1138@3924: return _engine_grf[engine]->grfid; peter1138@3648: } peter1138@3648: peter1138@3648: peter1138@2708: static int MapOldSubType(const Vehicle *v) peter1138@2708: { peter1138@2708: if (v->type != VEH_Train) return v->subtype; peter1138@2708: if (IsTrainEngine(v)) return 0; peter1138@2708: if (IsFreeWagon(v)) return 4; peter1138@2708: return 2; peter1138@2708: } peter1138@2708: peter1138@3686: peter1138@3702: /* TTDP style aircraft movement states for GRF Action 2 Var 0xE2 */ peter1138@3702: enum { peter1138@4055: AMS_TTDP_HANGAR, peter1138@4055: AMS_TTDP_TO_HANGAR, peter1138@3702: AMS_TTDP_TO_PAD1, peter1138@3702: AMS_TTDP_TO_PAD2, peter1138@3702: AMS_TTDP_TO_PAD3, peter1138@3702: AMS_TTDP_TO_ENTRY_2_AND_3, peter1138@3702: AMS_TTDP_TO_ENTRY_2_AND_3_AND_H, peter1138@3702: AMS_TTDP_TO_JUNCTION, peter1138@3702: AMS_TTDP_LEAVE_RUNWAY, peter1138@3702: AMS_TTDP_TO_INWAY, peter1138@3702: AMS_TTDP_TO_RUNWAY, peter1138@3702: AMS_TTDP_TO_OUTWAY, peter1138@3702: AMS_TTDP_WAITING, peter1138@3702: AMS_TTDP_TAKEOFF, peter1138@3702: AMS_TTDP_TO_TAKEOFF, peter1138@3702: AMS_TTDP_CLIMBING, peter1138@3702: AMS_TTDP_FLIGHT_APPROACH, peter1138@3702: AMS_TTDP_UNUSED_0x11, peter1138@3702: AMS_TTDP_FLIGHT_TO_TOWER, peter1138@3702: AMS_TTDP_UNUSED_0x13, peter1138@3702: AMS_TTDP_FLIGHT_FINAL, peter1138@3702: AMS_TTDP_FLIGHT_DESCENT, peter1138@3702: AMS_TTDP_BRAKING, peter1138@3920: AMS_TTDP_HELI_TAKEOFF_AIRPORT, peter1138@3920: AMS_TTDP_HELI_TO_TAKEOFF_AIRPORT, peter1138@3920: AMS_TTDP_HELI_LAND_AIRPORT, peter1138@3702: AMS_TTDP_HELI_TAKEOFF_HELIPORT, peter1138@3702: AMS_TTDP_HELI_TO_TAKEOFF_HELIPORT, peter1138@3702: AMS_TTDP_HELI_LAND_HELIPORT, peter1138@3702: }; peter1138@3702: peter1138@3702: peter1138@3702: /** peter1138@3702: * Map OTTD aircraft movement states to TTDPatch style movement states peter1138@3702: * (VarAction 2 Variable 0xE2) peter1138@3702: */ peter1138@3702: static byte MapAircraftMovementState(const Vehicle *v) peter1138@3702: { peter1138@3702: const Station *st = GetStation(v->u.air.targetairport); peter1138@3702: byte amdflag = GetAirportMovingData(st->airport_type, v->u.air.pos)->flag; peter1138@3702: peter1138@3702: switch (v->u.air.state) { peter1138@3702: case HANGAR: peter1138@3702: /* The international airport is a special case as helicopters can land in peter1138@3702: * front of the hanger. Helicopters also change their air.state to peter1138@3702: * AMED_HELI_LOWER some time before actually descending. */ peter1138@3702: peter1138@3702: /* This condition only occurs for helicopters, during descent, peter1138@3702: * to a landing by the hanger of an international airport. */ peter1138@3920: if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT; peter1138@3702: peter1138@3702: /* This condition only occurs for helicopters, before starting descent, peter1138@3702: * to a landing by the hanger of an international airport. */ peter1138@3702: if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER; peter1138@3702: peter1138@3702: // The final two conditions apply to helicopters or aircraft. peter1138@3702: /* Has reached hanger? */ peter1138@4055: if (amdflag & AMED_EXACTPOS) return AMS_TTDP_HANGAR; peter1138@3702: peter1138@3702: // Still moving towards hanger. peter1138@4055: return AMS_TTDP_TO_HANGAR; peter1138@3702: peter1138@3702: case TERM1: peter1138@3702: if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD1; peter1138@3702: return AMS_TTDP_TO_JUNCTION; peter1138@3702: peter1138@3702: case TERM2: peter1138@3702: if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD2; peter1138@3702: return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H; peter1138@3702: peter1138@3702: case TERM3: peter1138@3702: case TERM4: peter1138@3702: case TERM5: peter1138@3702: case TERM6: richk@4059: case TERM7: richk@4059: case TERM8: peter1138@3702: /* TTDPatch only has 3 terminals, so treat these states the same */ peter1138@3702: if (amdflag & AMED_EXACTPOS) return AMS_TTDP_TO_PAD3; peter1138@3702: return AMS_TTDP_TO_ENTRY_2_AND_3_AND_H; peter1138@3702: peter1138@3702: case HELIPAD1: richk@4059: case HELIPAD2: richk@4059: case HELIPAD3: richk@4059: case HELIPAD4: // Will only occur for helicopters. peter1138@3920: if (amdflag & AMED_HELI_LOWER) return AMS_TTDP_HELI_LAND_AIRPORT; // Descending. peter1138@3702: if (amdflag & AMED_SLOWTURN) return AMS_TTDP_FLIGHT_TO_TOWER; // Still hasn't started descent. peter1138@3702: return AMS_TTDP_TO_JUNCTION; // On the ground. peter1138@3702: peter1138@3702: case TAKEOFF: // Moving to takeoff position. peter1138@3702: return AMS_TTDP_TO_OUTWAY; peter1138@3702: peter1138@3702: case STARTTAKEOFF: // Accelerating down runway. peter1138@3702: return AMS_TTDP_TAKEOFF; peter1138@3702: peter1138@3702: case ENDTAKEOFF: // Ascent peter1138@3702: return AMS_TTDP_CLIMBING; peter1138@3702: peter1138@3702: case HELITAKEOFF: // Helicopter is moving to take off position. peter1138@3702: switch (st->airport_type) { peter1138@3702: case AT_SMALL: peter1138@3702: case AT_LARGE: peter1138@3702: case AT_METROPOLITAN: peter1138@3702: case AT_INTERNATIONAL: richk@4059: case AT_COMMUTER: richk@4059: case AT_INTERCON: richk@4059: /* Note, Helidepot and Helistation are treated as airports as richk@4059: * helicopters are taking off from ground level. */ richk@4059: case AT_HELIDEPOT: richk@4059: case AT_HELISTATION: peter1138@3920: if (amdflag & AMED_HELI_RAISE) return AMS_TTDP_HELI_TAKEOFF_AIRPORT; peter1138@3702: return AMS_TTDP_TO_JUNCTION; peter1138@3702: peter1138@3702: case AT_HELIPORT: peter1138@3702: case AT_OILRIG: peter1138@3702: return AMS_TTDP_HELI_TAKEOFF_HELIPORT; peter1138@3702: peter1138@3702: default: peter1138@3920: return AMS_TTDP_HELI_TAKEOFF_AIRPORT; peter1138@3702: } peter1138@3702: peter1138@3702: case FLYING: peter1138@3702: return AMS_TTDP_FLIGHT_TO_TOWER; peter1138@3702: peter1138@3702: case LANDING: // Descent peter1138@3702: return AMS_TTDP_FLIGHT_DESCENT; peter1138@3702: peter1138@3702: case ENDLANDING: // On the runway braking peter1138@3702: if (amdflag & AMED_BRAKE) return AMS_TTDP_BRAKING; peter1138@3702: // Landed - moving off runway peter1138@3702: return AMS_TTDP_TO_INWAY; peter1138@3702: peter1138@3702: case HELILANDING: peter1138@3702: case HELIENDLANDING: // Helicoptor is decending. peter1138@3702: if (amdflag & AMED_HELI_LOWER) { peter1138@3702: switch (st->airport_type) { peter1138@3702: case AT_HELIPORT: peter1138@3702: case AT_OILRIG: peter1138@3702: return AMS_TTDP_HELI_LAND_HELIPORT; peter1138@3702: peter1138@3702: default: richk@4059: /* Note, Helidepot and Helistation are treated as airports as richk@4059: * helicopters are landing at ground level. */ peter1138@3920: return AMS_TTDP_HELI_LAND_AIRPORT; peter1138@3702: } peter1138@3702: } peter1138@3702: return AMS_TTDP_FLIGHT_TO_TOWER; peter1138@3702: peter1138@3702: default: peter1138@4055: return AMS_TTDP_HANGAR; peter1138@3702: } peter1138@3702: } peter1138@3702: peter1138@3702: peter1138@3702: /* TTDP style aircraft movement action for GRF Action 2 Var 0xE6 */ peter1138@3702: enum { peter1138@4055: AMA_TTDP_IN_HANGAR, peter1138@3702: AMA_TTDP_ON_PAD1, peter1138@3702: AMA_TTDP_ON_PAD2, peter1138@3702: AMA_TTDP_ON_PAD3, peter1138@4055: AMA_TTDP_HANGAR_TO_PAD1, peter1138@4055: AMA_TTDP_HANGAR_TO_PAD2, peter1138@4055: AMA_TTDP_HANGAR_TO_PAD3, peter1138@3702: AMA_TTDP_LANDING_TO_PAD1, peter1138@3702: AMA_TTDP_LANDING_TO_PAD2, peter1138@3702: AMA_TTDP_LANDING_TO_PAD3, peter1138@4055: AMA_TTDP_PAD1_TO_HANGAR, peter1138@4055: AMA_TTDP_PAD2_TO_HANGAR, peter1138@4055: AMA_TTDP_PAD3_TO_HANGAR, peter1138@3702: AMA_TTDP_PAD1_TO_TAKEOFF, peter1138@3702: AMA_TTDP_PAD2_TO_TAKEOFF, peter1138@3702: AMA_TTDP_PAD3_TO_TAKEOFF, peter1138@4055: AMA_TTDP_HANGAR_TO_TAKOFF, peter1138@4055: AMA_TTDP_LANDING_TO_HANGAR, peter1138@3702: AMA_TTDP_IN_FLIGHT, peter1138@3702: }; peter1138@3702: peter1138@3702: peter1138@3702: /** peter1138@3702: * Map OTTD aircraft movement states to TTDPatch style movement actions peter1138@3702: * (VarAction 2 Variable 0xE6) peter1138@3702: * This is not fully supported yet but it's enough for Planeset. peter1138@3702: */ peter1138@3702: static byte MapAircraftMovementAction(const Vehicle *v) peter1138@3702: { peter1138@3702: switch (v->u.air.state) { peter1138@3702: case HANGAR: peter1138@4055: return (v->cur_speed > 0) ? AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_IN_HANGAR; peter1138@3702: peter1138@3702: case TERM1: peter1138@3702: case HELIPAD1: peter1138@3702: return (v->current_order.type == OT_LOADING) ? AMA_TTDP_ON_PAD1 : AMA_TTDP_LANDING_TO_PAD1; peter1138@3702: peter1138@3702: case TERM2: peter1138@3702: case HELIPAD2: peter1138@3702: return (v->current_order.type == OT_LOADING) ? AMA_TTDP_ON_PAD2 : AMA_TTDP_LANDING_TO_PAD2; peter1138@3702: peter1138@3702: case TERM3: peter1138@3702: case TERM4: peter1138@3702: case TERM5: peter1138@3702: case TERM6: richk@4059: case TERM7: richk@4059: case TERM8: richk@4059: case HELIPAD3: richk@4059: case HELIPAD4: peter1138@3702: return (v->current_order.type == OT_LOADING) ? AMA_TTDP_ON_PAD3 : AMA_TTDP_LANDING_TO_PAD3; peter1138@3702: peter1138@3702: case TAKEOFF: // Moving to takeoff position peter1138@3702: case STARTTAKEOFF: // Accelerating down runway peter1138@3702: case ENDTAKEOFF: // Ascent peter1138@3702: case HELITAKEOFF: peter1138@3702: // TODO Need to find which terminal (or hanger) we've come from. How? peter1138@3702: return AMA_TTDP_PAD1_TO_TAKEOFF; peter1138@3702: peter1138@3702: case FLYING: peter1138@3702: return AMA_TTDP_IN_FLIGHT; peter1138@3702: peter1138@3702: case LANDING: // Descent peter1138@3702: case ENDLANDING: // On the runway braking peter1138@3702: case HELILANDING: peter1138@3702: case HELIENDLANDING: peter1138@3702: // TODO Need to check terminal we're landing to. Is it known yet? peter1138@3702: return (v->current_order.type == OT_GOTO_DEPOT) ? peter1138@4055: AMA_TTDP_LANDING_TO_HANGAR : AMA_TTDP_LANDING_TO_PAD1; peter1138@3702: peter1138@3702: default: peter1138@4055: return AMA_TTDP_IN_HANGAR; peter1138@3702: } peter1138@3702: } peter1138@3702: peter1138@3702: peter1138@3703: /* TTDP airport types. Used to map our types to TTDPatch's */ peter1138@3703: enum { peter1138@3703: ATP_TTDP_SMALL, peter1138@3703: ATP_TTDP_LARGE, peter1138@3703: ATP_TTDP_HELIPORT, peter1138@3703: ATP_TTDP_OILRIG, peter1138@3703: }; peter1138@3703: peter1138@3703: peter1138@3686: /* Vehicle Resolver Functions */ peter1138@3686: static inline const Vehicle *GRV(const ResolverObject *object) peter1138@3686: { peter1138@3720: return object->scope == VSG_SCOPE_SELF ? object->u.vehicle.self : object->u.vehicle.parent; peter1138@3686: } peter1138@3686: peter1138@3686: peter1138@3686: static uint32 VehicleGetRandomBits(const ResolverObject *object) peter1138@3686: { peter1138@3686: return GRV(object) == NULL ? 0 : GRV(object)->random_bits; peter1138@3686: } peter1138@3686: peter1138@3686: peter1138@3686: static uint32 VehicleGetTriggers(const ResolverObject *object) peter1138@3686: { peter1138@3686: return GRV(object) == NULL ? 0 : GRV(object)->waiting_triggers; peter1138@3686: } peter1138@3686: peter1138@3686: peter1138@3686: static void VehicleSetTriggers(const ResolverObject *object, int triggers) peter1138@3686: { peter1138@3686: /* Evil cast to get around const-ness. This used to be achieved by an peter1138@3686: * innocent looking function pointer cast... Currently I cannot see a peter1138@3686: * way of avoiding this without removing consts deep within gui code. peter1138@3686: */ peter1138@3686: Vehicle *v = (Vehicle*)GRV(object); peter1138@3686: peter1138@3686: /* This function must only be called when processing triggers -- any peter1138@3686: * other time is an error. */ peter1138@3686: assert(object->trigger != 0); peter1138@3686: peter1138@3686: if (v != NULL) v->waiting_triggers = triggers; peter1138@3686: } peter1138@3686: peter1138@3686: peter1138@4058: static uint32 GetVehicleTypeInfo(EngineID engine_type) peter1138@4058: { peter1138@4058: /* Bit 0 Vehicle type is available on the market peter1138@4058: * Bit 1 Vehicle type is in the testing phase peter1138@4058: * Bit 2 Exclusive testing offer for a human player active */ peter1138@4058: const Engine *e = GetEngine(engine_type); peter1138@4058: uint32 var = 0; peter1138@4058: peter1138@4058: if (e->player_avail == 0xFF) SETBIT(var, 0); peter1138@4058: if (e->age < e->duration_phase_1) SETBIT(var, 1); peter1138@4058: if (e->player_avail > 0 && e->player_avail != 0xFF) SETBIT(var, 2); peter1138@4058: return var; peter1138@4058: } peter1138@4058: peter1138@4058: peter1138@4057: static uint32 GetGRFParameter(EngineID engine_type, byte parameter) peter1138@4057: { peter1138@4057: const GRFFile *file = GetEngineGRF(engine_type); peter1138@4057: peter1138@4057: if (parameter >= file->param_end) return 0; peter1138@4057: return file->param[parameter]; peter1138@4057: } peter1138@4057: peter1138@4057: peter1138@3893: static uint32 VehicleGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) peter1138@3686: { peter1138@3686: const Vehicle *v = GRV(object); peter1138@3686: peter1138@3686: if (v == NULL) { peter1138@3686: /* Vehicle does not exist, so we're in a purchase list */ peter1138@3686: switch (variable) { peter1138@3686: case 0x43: return _current_player; /* Owner information */ peter1138@3686: case 0x46: return 0; /* Motion counter */ peter1138@4058: case 0x48: return GetVehicleTypeInfo(object->u.vehicle.self_type); /* Vehicle Type Info */ rubidium@4322: case 0xC4: return clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR; /* Build year */ peter1138@3686: case 0xDA: return INVALID_VEHICLE; /* Next vehicle */ peter1138@4057: case 0x7F: return GetGRFParameter(object->u.vehicle.self_type, parameter); /* Read GRF parameter */ peter1138@3686: } peter1138@3893: peter1138@3893: *available = false; peter1138@3893: return -1; peter1138@3686: } peter1138@3686: peter1138@3686: /* Calculated vehicle parameters */ peter1138@3686: switch (variable) { peter1138@3686: case 0x40: /* Get length of consist */ peter1138@3686: case 0x41: /* Get length of same consecutive wagons */ peter1138@3686: if (v->type != VEH_Train) return 1; peter1138@3686: peter1138@3686: { peter1138@3686: const Vehicle* u; peter1138@3686: byte chain_before = 0; peter1138@3686: byte chain_after = 0; peter1138@3686: peter1138@3686: for (u = GetFirstVehicleInChain(v); u != v; u = u->next) { peter1138@3686: chain_before++; peter1138@3686: if (variable == 0x41 && u->engine_type != v->engine_type) chain_before = 0; peter1138@3686: } peter1138@3686: peter1138@3686: while (u->next != NULL && (variable == 0x40 || u->next->engine_type == v->engine_type)) { peter1138@3686: chain_after++; peter1138@3686: u = u->next; peter1138@3686: } peter1138@3686: peter1138@5174: return chain_before | chain_after << 8 | (chain_before + chain_after + (variable == 0x41)) << 16; peter1138@3686: } peter1138@3686: peter1138@3843: case 0x42: { /* Consist cargo information */ peter1138@3843: /* XXX Missing support for common refit cycle and property 25 */ peter1138@3843: const Vehicle *u; peter1138@3843: byte cargo_classes = 0; peter1138@3843: uint common_cargo_best = 0; peter1138@3843: uint common_cargos[NUM_GLOBAL_CID]; peter1138@3862: byte user_def_data = 0; peter1138@3843: CargoID cargo; peter1138@3843: CargoID common_cargo_type = GC_PASSENGERS; peter1138@3843: peter1138@3843: /* Reset our arrays */ peter1138@3843: memset(common_cargos, 0, sizeof(common_cargos)); peter1138@3843: peter1138@3843: for (u = v; u != NULL; u = u->next) { peter1138@3843: /* Skip empty engines */ peter1138@3843: if (u->cargo_cap == 0) continue; peter1138@3843: /* Map from climate to global cargo ID */ peter1138@3843: cargo = _global_cargo_id[_opt.landscape][u->cargo_type]; peter1138@3843: cargo_classes |= _cargo_classes[cargo]; peter1138@3843: common_cargos[cargo]++; peter1138@3862: user_def_data |= RailVehInfo(u->engine_type)->user_def_data; peter1138@3843: } peter1138@3843: peter1138@3843: /* Pick the most common cargo type */ peter1138@3843: for (cargo = 0; cargo < NUM_GLOBAL_CID; cargo++) { peter1138@3843: if (common_cargos[cargo] > common_cargo_best) { peter1138@3843: common_cargo_best = common_cargos[cargo]; peter1138@3843: common_cargo_type = cargo; peter1138@3843: } peter1138@3843: } peter1138@3843: peter1138@3862: return cargo_classes | (common_cargo_type << 8) | (user_def_data << 24); peter1138@3843: } peter1138@3843: peter1138@3686: case 0x43: /* Player information */ peter1138@3686: return v->owner; peter1138@3686: peter1138@3703: case 0x44: /* Aircraft information */ peter1138@3703: if (v->type != VEH_Aircraft) return -1; peter1138@3703: peter1138@3703: { peter1138@3703: const Vehicle *w = v->next; peter1138@3703: uint16 altitude = v->z_pos - w->z_pos; /* Aircraft height - shadow height */ peter1138@3703: byte airporttype; peter1138@3703: peter1138@3703: switch (GetStation(v->u.air.targetairport)->airport_type) { richk@4059: /* Note, Helidepot and Helistation are treated as small airports richk@4059: * as they are at ground level. */ richk@4059: case AT_HELIDEPOT: richk@4059: case AT_HELISTATION: richk@4059: case AT_COMMUTER: richk@4059: case AT_SMALL: airporttype = ATP_TTDP_SMALL; break; peter1138@3703: case AT_METROPOLITAN: peter1138@3703: case AT_INTERNATIONAL: richk@4059: case AT_INTERCON: richk@4059: case AT_LARGE: airporttype = ATP_TTDP_LARGE; break; richk@4059: case AT_HELIPORT: airporttype = ATP_TTDP_HELIPORT; break; richk@4059: case AT_OILRIG: airporttype = ATP_TTDP_OILRIG; break; richk@4059: default: airporttype = ATP_TTDP_LARGE; break; peter1138@3703: } peter1138@3703: peter1138@3703: return (altitude << 8) | airporttype; peter1138@3703: } peter1138@3703: peter1138@3686: case 0x46: /* Motion counter */ peter1138@4656: return v->motion_counter; peter1138@3723: peter1138@3848: case 0x47: { /* Vehicle cargo info */ peter1138@3848: /* Format: ccccwwtt peter1138@3848: * tt - the cargo type transported by the vehicle, peter1138@3848: * translated if a translation table has been installed. peter1138@3848: * ww - cargo unit weight in 1/16 tons, same as cargo prop. 0F. peter1138@3848: * cccc - the cargo class value of the cargo transported by the vehicle. peter1138@3848: */ peter1138@3848: CargoID cid = _global_cargo_id[_opt.landscape][v->cargo_type]; peter1138@3848: peter1138@3848: return (_cargo_classes[cid] << 16) | (_cargoc.weights[v->cargo_type] << 8) | cid; peter1138@3848: } peter1138@3848: peter1138@4058: case 0x48: return GetVehicleTypeInfo(v->engine_type); /* Vehicle Type Info */ peter1138@4058: peter1138@3723: /* Variables which use the parameter */ peter1138@3723: case 0x60: /* Count consist's engine ID occurance */ peter1138@3723: if (v->type != VEH_Train) return v->engine_type == parameter; peter1138@3723: peter1138@3723: { peter1138@3723: uint count = 0; peter1138@3723: for (; v != NULL; v = v->next) { peter1138@3723: if (v->engine_type == parameter) count++; peter1138@3723: } peter1138@3723: return count; peter1138@3723: } peter1138@3925: peter1138@4057: case 0x7F: return GetGRFParameter(v->engine_type, parameter); /* Read GRF parameter */ peter1138@3686: } peter1138@3686: peter1138@3686: /* General vehicle properties */ peter1138@3686: switch (variable - 0x80) { peter1138@3686: case 0x00: return v->type; peter1138@3686: case 0x01: return MapOldSubType(v); peter1138@3686: case 0x04: return v->index; peter1138@5172: case 0x05: return GB(v->index, 8, 8); peter1138@3686: case 0x0A: return PackOrder(&v->current_order); peter1138@5172: case 0x0B: return GB(PackOrder(&v->current_order), 8, 8); peter1138@3686: case 0x0C: return v->num_orders; peter1138@3686: case 0x0D: return v->cur_order_index; peter1138@3686: case 0x10: return v->load_unload_time_rem; peter1138@5172: case 0x11: return GB(v->load_unload_time_rem, 8, 8); rubidium@4331: case 0x12: return max(v->date_of_last_service - DAYS_TILL_ORIGINAL_BASE_YEAR, 0); peter1138@5172: case 0x13: return GB(max(v->date_of_last_service - DAYS_TILL_ORIGINAL_BASE_YEAR, 0), 8, 8); peter1138@3686: case 0x14: return v->service_interval; peter1138@5172: case 0x15: return GB(v->service_interval, 8, 8); peter1138@3686: case 0x16: return v->last_station_visited; peter1138@3686: case 0x17: return v->tick_counter; peter1138@3686: case 0x18: return v->max_speed; peter1138@5172: case 0x19: return GB(v->max_speed, 8, 8); peter1138@3686: case 0x1A: return v->x_pos; peter1138@5172: case 0x1B: return GB(v->x_pos, 8, 8); peter1138@3686: case 0x1C: return v->y_pos; peter1138@5172: case 0x1D: return GB(v->y_pos, 8, 8); peter1138@3686: case 0x1E: return v->z_pos; peter1138@4056: case 0x1F: return object->info_view ? DIR_W : v->direction; peter1138@3686: case 0x28: return v->cur_image; peter1138@5172: case 0x29: return GB(v->cur_image, 8, 8); peter1138@3686: case 0x32: return v->vehstatus; peter1138@5175: case 0x33: return 0; // non-existent high byte of vehstatus peter1138@3686: case 0x34: return v->cur_speed; peter1138@5172: case 0x35: return GB(v->cur_speed, 8, 8); peter1138@3686: case 0x36: return v->subspeed; peter1138@3686: case 0x37: return v->acceleration; peter1138@3686: case 0x39: return v->cargo_type; peter1138@3686: case 0x3A: return v->cargo_cap; peter1138@5172: case 0x3B: return GB(v->cargo_cap, 8, 8); peter1138@3686: case 0x3C: return v->cargo_count; peter1138@5172: case 0x3D: return GB(v->cargo_count, 8, 8); peter1138@3686: case 0x3E: return v->cargo_source; peter1138@3686: case 0x3F: return v->cargo_days; peter1138@3686: case 0x40: return v->age; peter1138@5172: case 0x41: return GB(v->age, 8, 8); peter1138@3686: case 0x42: return v->max_age; peter1138@5172: case 0x43: return GB(v->max_age, 8, 8); rubidium@4331: case 0x44: return clamp(v->build_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR; peter1138@3686: case 0x45: return v->unitnumber; peter1138@3686: case 0x46: return v->engine_type; peter1138@5172: case 0x47: return GB(v->engine_type, 8, 8); peter1138@3686: case 0x48: return v->spritenum; peter1138@3686: case 0x49: return v->day_counter; peter1138@3686: case 0x4A: return v->breakdowns_since_last_service; peter1138@3686: case 0x4B: return v->breakdown_ctr; peter1138@3686: case 0x4C: return v->breakdown_delay; peter1138@3686: case 0x4D: return v->breakdown_chance; peter1138@3686: case 0x4E: return v->reliability; peter1138@5172: case 0x4F: return GB(v->reliability, 8, 8); peter1138@3686: case 0x50: return v->reliability_spd_dec; peter1138@5172: case 0x51: return GB(v->reliability_spd_dec, 8, 8); peter1138@3686: case 0x52: return v->profit_this_year; peter1138@5172: case 0x53: return GB(v->profit_this_year, 8, 24); peter1138@5172: case 0x54: return GB(v->profit_this_year, 16, 16); peter1138@5172: case 0x55: return GB(v->profit_this_year, 24, 8); peter1138@3686: case 0x56: return v->profit_last_year; peter1138@5172: case 0x57: return GB(v->profit_last_year, 8, 24); peter1138@5172: case 0x58: return GB(v->profit_last_year, 16, 16); peter1138@5172: case 0x59: return GB(v->profit_last_year, 24, 8); peter1138@3686: case 0x5A: return v->next == NULL ? INVALID_VEHICLE : v->next->index; peter1138@3686: case 0x5C: return v->value; peter1138@5172: case 0x5D: return GB(v->value, 8, 24); peter1138@5172: case 0x5E: return GB(v->value, 16, 16); peter1138@5172: case 0x5F: return GB(v->value, 24, 8); peter1138@3686: case 0x60: return v->string_id; peter1138@5172: case 0x61: return GB(v->string_id, 8, 8); peter1138@3870: case 0x72: return v->cargo_subtype; peter1138@3686: case 0x7A: return v->random_bits; peter1138@3686: case 0x7B: return v->waiting_triggers; peter1138@3686: } peter1138@3686: peter1138@3686: /* Vehicle specific properties */ peter1138@3014: switch (v->type) { peter1138@3014: case VEH_Train: peter1138@3686: switch (variable - 0x80) { peter1138@3014: case 0x62: return v->u.rail.track; peter1138@3014: case 0x66: return v->u.rail.railtype; peter1138@3014: case 0x73: return v->u.rail.cached_veh_length; peter1138@3014: case 0x74: return v->u.rail.cached_power; peter1138@5172: case 0x75: return GB(v->u.rail.cached_power, 8, 24); peter1138@5172: case 0x76: return GB(v->u.rail.cached_power, 16, 16); peter1138@5172: case 0x77: return GB(v->u.rail.cached_power, 24, 8); peter1138@3014: case 0x7C: return v->first->index; peter1138@5172: case 0x7D: return GB(v->first->index, 8, 8); peter1138@4050: case 0x7F: return 0; // Used for vehicle reversing hack in TTDP peter1138@3014: } peter1138@3014: break; peter1138@3014: peter1138@3014: case VEH_Road: peter1138@3686: switch (variable - 0x80) { peter1138@3014: case 0x62: return v->u.road.state; peter1138@3014: case 0x64: return v->u.road.blocked_ctr; peter1138@5172: case 0x65: return GB(v->u.road.blocked_ctr, 8, 8); peter1138@3014: case 0x66: return v->u.road.overtaking; peter1138@3014: case 0x67: return v->u.road.overtaking_ctr; peter1138@3014: case 0x68: return v->u.road.crashed_ctr; peter1138@5172: case 0x69: return GB(v->u.road.crashed_ctr, 8, 8); peter1138@3014: } peter1138@3014: break; peter1138@3014: peter1138@3014: case VEH_Aircraft: peter1138@3686: switch (variable - 0x80) { peter1138@3702: case 0x62: return MapAircraftMovementState(v); // Current movement state peter1138@3702: case 0x63: return v->u.air.targetairport; // Airport to which the action refers peter1138@3702: case 0x66: return MapAircraftMovementAction(v); // Current movement action peter1138@3014: } peter1138@3014: break; peter1138@3014: } peter1138@3014: Darkvater@5568: DEBUG(grf, 1, "Unhandled vehicle property 0x%X, type 0x%X", variable, v->type); peter1138@3014: peter1138@3893: *available = false; peter1138@3014: return -1; peter1138@3014: } peter1138@3014: tron@426: peter1138@3734: static const SpriteGroup *VehicleResolveReal(const ResolverObject *object, const SpriteGroup *group) peter1138@3686: { peter1138@3720: const Vehicle *v = object->u.vehicle.self; peter1138@3686: uint totalsets; peter1138@3686: uint set; peter1138@3734: bool in_motion; tron@426: peter1138@3739: if (v == NULL) return group->g.real.loading[0]; peter1138@3734: peter1138@3734: if (v->type == VEH_Train) { peter1138@3734: in_motion = GetFirstVehicleInChain(v)->current_order.type != OT_LOADING; peter1138@3734: } else { peter1138@3734: in_motion = v->current_order.type != OT_LOADING; peter1138@3686: } tron@445: peter1138@3734: totalsets = in_motion ? group->g.real.num_loaded : group->g.real.num_loading; tron@445: peter1138@3686: if (v->cargo_count == v->cargo_cap || totalsets == 1) { peter1138@3686: set = totalsets - 1; peter1138@3686: } else if (v->cargo_count == 0 || totalsets == 2) { peter1138@3686: set = 0; peter1138@3686: } else { peter1138@3686: set = v->cargo_count * (totalsets - 2) / max(1, v->cargo_cap) + 1; peter1138@3686: } tron@426: peter1138@3734: return in_motion ? group->g.real.loaded[set] : group->g.real.loading[set]; tron@426: } tron@426: peter1138@3686: peter1138@4057: static inline void NewVehicleResolver(ResolverObject *res, EngineID engine_type, const Vehicle *v) peter1138@3686: { peter1138@3686: res->GetRandomBits = &VehicleGetRandomBits; peter1138@3686: res->GetTriggers = &VehicleGetTriggers; peter1138@3686: res->SetTriggers = &VehicleSetTriggers; peter1138@3686: res->GetVariable = &VehicleGetVariable; peter1138@3686: res->ResolveReal = &VehicleResolveReal; peter1138@3686: peter1138@3720: res->u.vehicle.self = v; peter1138@3720: res->u.vehicle.parent = (v != NULL && v->type == VEH_Train) ? GetFirstVehicleInChain(v) : v; peter1138@3686: peter1138@4057: res->u.vehicle.self_type = engine_type; peter1138@4057: peter1138@4056: res->info_view = false; peter1138@4056: peter1138@3686: res->callback = 0; peter1138@3686: res->callback_param1 = 0; peter1138@3686: res->callback_param2 = 0; peter1138@3686: res->last_value = 0; peter1138@3686: res->trigger = 0; peter1138@3686: res->reseed = 0; peter1138@3686: } peter1138@3686: peter1138@3686: peter1138@4901: /** Retrieve the SpriteGroup for the specified vehicle. peter1138@4901: * If the vehicle is not specified, the purchase list group for the engine is peter1138@4901: * chosen. For trains, an additional engine override lookup is performed. peter1138@4901: * @param engine Engine type of the vehicle. peter1138@4901: * @param v The vehicle itself. peter1138@4901: * @returns The selected SpriteGroup for the vehicle. peter1138@4901: */ peter1138@4901: static const SpriteGroup *GetVehicleSpriteGroup(EngineID engine, const Vehicle *v) peter1138@4901: { peter1138@4901: const SpriteGroup *group; peter1138@4901: CargoID cargo; peter1138@4901: peter1138@4901: if (v == NULL) { peter1138@4901: cargo = GC_PURCHASE; peter1138@4901: } else { peter1138@4901: cargo = _global_cargo_id[_opt.landscape][v->cargo_type]; peter1138@4901: assert(cargo != GC_INVALID); peter1138@4901: peter1138@4901: if (v->type == VEH_Train) { peter1138@4901: group = GetWagonOverrideSpriteSet(engine, cargo, v->u.rail.first_engine); peter1138@4901: peter1138@4901: if (group != NULL) return group; peter1138@4901: } peter1138@4901: } peter1138@4901: peter1138@4901: group = engine_custom_sprites[engine][cargo]; peter1138@4901: if (group != NULL) return group; peter1138@4901: peter1138@4901: /* Fall back to the default set if the selected cargo type is not defined */ peter1138@4901: return engine_custom_sprites[engine][GC_DEFAULT]; peter1138@4901: } peter1138@4901: peter1138@4901: peter1138@3686: SpriteID GetCustomEngineSprite(EngineID engine, const Vehicle *v, Direction direction) truelight@0: { tron@2242: const SpriteGroup *group; peter1138@3686: ResolverObject object; truelight@0: peter1138@4057: NewVehicleResolver(&object, engine, v); peter1138@3686: peter1138@4901: group = Resolve(GetVehicleSpriteGroup(engine, v), &object); peter1138@3686: if (group == NULL || group->type != SGT_RESULT) return 0; peter1138@3668: peter1138@3668: return group->g.result.sprite + (direction % group->g.result.num_sprites); truelight@0: } truelight@0: peter1138@3686: peter1138@4056: SpriteID GetRotorOverrideSprite(EngineID engine, const Vehicle *v, bool info_view) peter1138@3695: { peter1138@3695: const SpriteGroup *group; peter1138@3695: ResolverObject object; peter1138@3695: peter1138@3695: assert(engine >= AIRCRAFT_ENGINES_INDEX); peter1138@3695: assert(engine < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES); peter1138@3695: peter1138@3695: /* Only valid for helicopters */ tron@4023: assert(!(AircraftVehInfo(engine)->subtype & AIR_CTOL)); peter1138@3695: peter1138@4057: NewVehicleResolver(&object, engine, v); peter1138@3695: peter1138@4056: object.info_view = info_view; peter1138@4056: peter1138@3695: group = heli_rotor_custom_sprites[engine - AIRCRAFT_ENGINES_INDEX]; peter1138@3695: group = Resolve(group, &object); peter1138@3695: peter1138@3695: if (group == NULL || group->type != SGT_RESULT) return 0; peter1138@3695: peter1138@3695: if (v == NULL) return group->g.result.sprite; peter1138@3695: peter1138@4056: return group->g.result.sprite + (info_view ? 0 : (v->next->next->u.air.state % group->g.result.num_sprites)); peter1138@3695: } peter1138@3695: peter1138@3695: hackykid@1883: /** hackykid@1908: * Check if a wagon is currently using a wagon override hackykid@1908: * @param v The wagon to check hackykid@1908: * @return true if it is using an override, false otherwise hackykid@1908: */ tron@2548: bool UsesWagonOverride(const Vehicle* v) tron@2548: { hackykid@1908: assert(v->type == VEH_Train); peter1138@4869: return GetWagonOverrideSpriteSet(v->engine_type, _global_cargo_id[_opt.landscape][v->cargo_type], v->u.rail.first_engine) != NULL; hackykid@1908: } hackykid@1908: hackykid@1908: /** peter1138@3390: * Evaluate a newgrf callback for vehicles peter1138@3390: * @param callback The callback to evalute peter1138@3390: * @param param1 First parameter of the callback peter1138@3390: * @param param2 Second parameter of the callback peter1138@3390: * @param engine Engine type of the vehicle to evaluate the callback for peter1138@3390: * @param vehicle The vehicle to evaluate the callback for, or NULL if it doesnt exist yet hackykid@1883: * @return The value the callback returned, or CALLBACK_FAILED if it failed hackykid@1883: */ peter1138@3724: uint16 GetVehicleCallback(uint16 callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v) hackykid@1883: { tron@2242: const SpriteGroup *group; peter1138@3686: ResolverObject object; peter1138@3686: peter1138@4057: NewVehicleResolver(&object, engine, v); peter1138@3686: peter1138@3686: object.callback = callback; peter1138@3686: object.callback_param1 = param1; peter1138@3686: object.callback_param2 = param2; hackykid@1883: peter1138@4901: group = Resolve(GetVehicleSpriteGroup(engine, v), &object); peter1138@4811: if (group == NULL || group->type != SGT_CALLBACK) return CALLBACK_FAILED; hackykid@1883: hackykid@1883: return group->g.callback.result; hackykid@1883: } hackykid@1883: peter1138@3726: /** peter1138@3726: * Evaluate a newgrf callback for vehicles with a different vehicle for parent scope. peter1138@3726: * @param callback The callback to evalute peter1138@3726: * @param param1 First parameter of the callback peter1138@3726: * @param param2 Second parameter of the callback peter1138@3726: * @param engine Engine type of the vehicle to evaluate the callback for peter1138@3726: * @param v The vehicle to evaluate the callback for, or NULL if it doesnt exist yet peter1138@3726: * @param parent The vehicle to use for parent scope peter1138@3726: * @return The value the callback returned, or CALLBACK_FAILED if it failed peter1138@3726: */ peter1138@3726: uint16 GetVehicleCallbackParent(uint16 callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent) peter1138@3726: { peter1138@3726: const SpriteGroup *group; peter1138@3726: ResolverObject object; peter1138@3726: peter1138@4057: NewVehicleResolver(&object, engine, v); peter1138@3726: peter1138@3726: object.callback = callback; peter1138@3726: object.callback_param1 = param1; peter1138@3726: object.callback_param2 = param2; peter1138@3726: peter1138@3726: object.u.vehicle.parent = parent; peter1138@3726: peter1138@4901: group = Resolve(GetVehicleSpriteGroup(engine, v), &object); peter1138@4811: if (group == NULL || group->type != SGT_CALLBACK) return CALLBACK_FAILED; peter1138@3726: peter1138@3726: return group->g.callback.result; peter1138@3726: } hackykid@1883: peter1138@3680: static void DoTriggerVehicle(Vehicle *v, VehicleTrigger trigger, byte base_random_bits, bool first) tron@445: { tron@2242: const SpriteGroup *group; peter1138@3686: ResolverObject object; tron@445: byte new_random_bits; tron@445: peter1138@3686: /* We can't trigger a non-existent vehicle... */ peter1138@3686: assert(v != NULL); hackykid@1883: peter1138@4057: NewVehicleResolver(&object, v->engine_type, v); peter1138@3686: peter1138@3686: object.trigger = trigger; peter1138@3686: peter1138@4901: group = Resolve(GetVehicleSpriteGroup(v->engine_type, v), &object); hackykid@1883: truelight@542: new_random_bits = Random(); peter1138@3686: v->random_bits &= ~object.reseed; peter1138@3686: v->random_bits |= (first ? new_random_bits : base_random_bits) & object.reseed; tron@445: tron@445: switch (trigger) { tron@445: case VEHICLE_TRIGGER_NEW_CARGO: tron@445: /* All vehicles in chain get ANY_NEW_CARGO trigger now. tron@445: * So we call it for the first one and they will recurse. */ tron@445: /* Indexing part of vehicle random bits needs to be tron@445: * same for all triggered vehicles in the chain (to get tron@445: * all the random-cargo wagons carry the same cargo, tron@445: * i.e.), so we give them all the NEW_CARGO triggered tron@445: * vehicle's portion of random bits. */ tron@445: assert(first); peter1138@3680: DoTriggerVehicle(GetFirstVehicleInChain(v), VEHICLE_TRIGGER_ANY_NEW_CARGO, new_random_bits, false); tron@445: break; peter1138@3680: tron@445: case VEHICLE_TRIGGER_DEPOT: tron@445: /* We now trigger the next vehicle in chain recursively. tron@445: * The random bits portions may be different for each tron@445: * vehicle in chain. */ peter1138@3680: if (v->next != NULL) DoTriggerVehicle(v->next, trigger, 0, true); tron@445: break; peter1138@3680: tron@445: case VEHICLE_TRIGGER_EMPTY: tron@445: /* We now trigger the next vehicle in chain tron@445: * recursively. The random bits portions must be same tron@445: * for each vehicle in chain, so we give them all tron@445: * first chained vehicle's portion of random bits. */ peter1138@3680: if (v->next != NULL) DoTriggerVehicle(v->next, trigger, first ? new_random_bits : base_random_bits, false); tron@445: break; peter1138@3680: tron@445: case VEHICLE_TRIGGER_ANY_NEW_CARGO: tron@445: /* Now pass the trigger recursively to the next vehicle tron@445: * in chain. */ tron@445: assert(!first); peter1138@3680: if (v->next != NULL) DoTriggerVehicle(v->next, VEHICLE_TRIGGER_ANY_NEW_CARGO, base_random_bits, false); tron@445: break; tron@445: } tron@445: } tron@445: peter1138@3680: void TriggerVehicle(Vehicle *v, VehicleTrigger trigger) tron@445: { peter1138@2589: if (trigger == VEHICLE_TRIGGER_DEPOT) { peter1138@2589: // store that the vehicle entered a depot this tick peter1138@3680: VehicleEnteredDepotThisTick(v); peter1138@2589: } peter1138@2589: peter1138@3680: DoTriggerVehicle(v, trigger, 0, true); tron@445: } tron@445: peter1138@3604: StringID _engine_custom_names[TOTAL_NUM_ENGINES]; truelight@0: peter1138@3604: void SetCustomEngineName(EngineID engine, StringID name) truelight@0: { peter1138@3614: assert(engine < lengthof(_engine_custom_names)); peter1138@3604: _engine_custom_names[engine] = name; truelight@0: } truelight@0: peter1138@2769: void UnloadCustomEngineNames(void) Darkvater@1474: { peter1138@3604: EngineID i; peter1138@3604: for (i = 0; i < TOTAL_NUM_ENGINES; i++) { peter1138@3604: _engine_custom_names[i] = 0; Darkvater@1474: } Darkvater@1474: } Darkvater@1474: tron@2477: StringID GetCustomEngineName(EngineID engine) truelight@0: { peter1138@3604: return _engine_custom_names[engine] == 0 ? _engine_name_strings[engine] : _engine_custom_names[engine]; truelight@0: } truelight@0: peter1138@2971: // Functions for changing the order of vehicle purchase lists peter1138@2971: // This is currently only implemented for rail vehicles. peter1138@4811: static EngineID _engine_list_order[NUM_TRAIN_ENGINES]; peter1138@4812: static byte _engine_list_position[NUM_TRAIN_ENGINES]; peter1138@2971: peter1138@2971: void ResetEngineListOrder(void) peter1138@2971: { peter1138@2971: EngineID i; peter1138@2971: peter1138@4811: for (i = 0; i < NUM_TRAIN_ENGINES; i++) { peter1138@4811: _engine_list_order[i] = i; peter1138@4812: _engine_list_position[i] = i; peter1138@4811: } peter1138@2971: } peter1138@2971: peter1138@4812: /** peter1138@4812: * Get the EngineID at position pos. peter1138@4812: * Used when drawing a(n unsorted) list of engines. peter1138@4812: * @param pos List position/ peter1138@4812: * @return The EngineID at the requested position. peter1138@4812: */ peter1138@2971: EngineID GetRailVehAtPosition(EngineID pos) peter1138@2971: { peter1138@4812: if (pos < NUM_TRAIN_ENGINES) return _engine_list_order[pos]; peter1138@4812: return pos; peter1138@4812: } peter1138@4812: peter1138@4812: /** peter1138@4812: * Get the list position of an engine. peter1138@4812: * Used when sorting a list of engines. peter1138@4812: * @param engine ID of the engine. peter1138@4812: * @return The list position of the engine. peter1138@4812: */ peter1138@4812: uint16 ListPositionOfEngine(EngineID engine) peter1138@4812: { peter1138@4812: if (engine < NUM_TRAIN_ENGINES) return _engine_list_position[engine]; peter1138@4812: return engine; peter1138@2971: } peter1138@2971: peter1138@2971: void AlterRailVehListOrder(EngineID engine, EngineID target) peter1138@2971: { peter1138@2971: EngineID i; peter1138@2971: bool moving = false; peter1138@2971: peter1138@2971: if (engine == target) return; peter1138@2971: peter1138@2971: // First, remove our ID from the list. peter1138@2971: for (i = 0; i < NUM_TRAIN_ENGINES - 1; i++) { peter1138@4811: if (_engine_list_order[i] == engine) moving = true; peter1138@4811: if (moving) _engine_list_order[i] = _engine_list_order[i + 1]; peter1138@2971: } peter1138@2971: peter1138@2971: // Now, insert it again, before the target engine. peter1138@2971: for (i = NUM_TRAIN_ENGINES - 1; i > 0; i--) { peter1138@4811: _engine_list_order[i] = _engine_list_order[i - 1]; peter1138@4811: if (_engine_list_order[i] == target) { peter1138@4811: _engine_list_order[i - 1] = engine; peter1138@2971: break; peter1138@2971: } peter1138@2971: } peter1138@4812: peter1138@4812: // Update the engine list position (a reverse of engine list order) peter1138@4812: for (i = 0; i < NUM_TRAIN_ENGINES; i++) { peter1138@4812: _engine_list_position[_engine_list_order[i]] = i; peter1138@4812: } peter1138@2971: }