00001
00002
00003
00004
00005
00006
00007
00008
00009
00012 #ifndef NEWGRF_ENGINE_H
00013 #define NEWGRF_ENGINE_H
00014
00015 #include "direction_type.h"
00016 #include "newgrf_callbacks.h"
00017 #include "newgrf_properties.h"
00018 #include "vehicle_type.h"
00019 #include "engine_type.h"
00020 #include "gfx_type.h"
00021 #include "newgrf_spritegroup.h"
00022
00024 struct VehicleScopeResolver : public ScopeResolver {
00025 const struct Vehicle *v;
00026 EngineID self_type;
00027 bool info_view;
00028
00029 VehicleScopeResolver(ResolverObject &ro, EngineID engine_type, const Vehicle *v, bool info_view);
00030
00031 void SetVehicle(const Vehicle *v) { this->v = v; }
00032
00033 uint32 GetRandomBits() const;
00034 uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
00035 uint32 GetTriggers() const;
00036 void SetTriggers(int triggers) const;
00037 };
00038
00040 struct VehicleResolverObject : public ResolverObject {
00042 enum WagonOverride {
00043 WO_NONE,
00044 WO_UNCACHED,
00045 WO_CACHED,
00046 WO_SELF,
00047 };
00048
00049 VehicleScopeResolver self_scope;
00050 VehicleScopeResolver parent_scope;
00051
00052 VehicleScopeResolver relative_scope;
00053 byte cached_relative_count;
00054
00055 VehicleResolverObject(EngineID engine_type, const Vehicle *v, WagonOverride wagon_override, bool info_view = false,
00056 CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
00057
00058 ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0);
00059
00060 const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
00061 };
00062
00063 static const uint TRAININFO_DEFAULT_VEHICLE_WIDTH = 29;
00064 static const uint ROADVEHINFO_DEFAULT_VEHICLE_WIDTH = 32;
00065 static const uint VEHICLEINFO_FULL_VEHICLE_WIDTH = 32;
00066
00067 void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const struct SpriteGroup *group, EngineID *train_id, uint trains);
00068 const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, EngineID overriding_engine);
00069 void SetCustomEngineSprites(EngineID engine, byte cargo, const struct SpriteGroup *group);
00070 SpriteID GetCustomEngineSprite(EngineID engine, const Vehicle *v, Direction direction, EngineImageType image_type);
00071 SpriteID GetRotorOverrideSprite(EngineID engine, const struct Aircraft *v, bool info_view, EngineImageType image_type);
00072 #define GetCustomRotorSprite(v, i, image_type) GetRotorOverrideSprite(v->engine_type, v, i, image_type)
00073 #define GetCustomRotorIcon(et, image_type) GetRotorOverrideSprite(et, NULL, true, image_type)
00074
00075
00076
00077 struct GRFFile;
00078
00079 void SetEngineGRF(EngineID engine, const struct GRFFile *file);
00080
00081 uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v);
00082 uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent);
00083 bool UsesWagonOverride(const Vehicle *v);
00084 #define GetCustomVehicleSprite(v, direction, image_type) GetCustomEngineSprite(v->engine_type, v, direction, image_type)
00085 #define GetCustomVehicleIcon(et, direction, image_type) GetCustomEngineSprite(et, NULL, direction, image_type)
00086
00087
00088
00089 uint GetVehicleProperty(const Vehicle *v, PropertyID property, uint orig_value);
00090 uint GetEngineProperty(EngineID engine, PropertyID property, uint orig_value, const Vehicle *v = NULL);
00091
00092 enum VehicleTrigger {
00093 VEHICLE_TRIGGER_NEW_CARGO = 0x01,
00094
00095 VEHICLE_TRIGGER_DEPOT = 0x02,
00096
00097 VEHICLE_TRIGGER_EMPTY = 0x04,
00098
00099 VEHICLE_TRIGGER_ANY_NEW_CARGO = 0x08,
00100
00101 VEHICLE_TRIGGER_CALLBACK_32 = 0x10,
00102 };
00103 void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);
00104
00105 void UnloadWagonOverrides(Engine *e);
00106
00107 void AlterVehicleListOrder(EngineID engine, uint target);
00108 void CommitVehicleListOrderChanges();
00109
00110 EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id);
00111
00112 #endif