tron@2186: /* $Id$ */
tron@2186: 
rubidium@9111: /** @file newgrf_engine.h Functions for NewGRF engines. */
belugas@6348: 
peter1138@2962: #ifndef NEWGRF_ENGINE_H
peter1138@2962: #define NEWGRF_ENGINE_H
truelight@0: 
peter1138@4656: #include "newgrf.h"
rubidium@8100: #include "direction_type.h"
belugas@3866: #include "newgrf_cargo.h"
tron@3157: 
peter1138@3785: extern int _traininfo_vehicle_pitch;
peter1138@3845: extern int _traininfo_vehicle_width;
peter1138@3785: 
truelight@0: 
peter1138@8198: void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const struct SpriteGroup *group, EngineID *train_id, uint trains);
peter1138@8198: const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, EngineID overriding_engine);
peter1138@3693: void SetCustomEngineSprites(EngineID engine, byte cargo, const struct SpriteGroup *group);
peter1138@3684: SpriteID GetCustomEngineSprite(EngineID engine, const Vehicle* v, Direction direction);
peter1138@4056: SpriteID GetRotorOverrideSprite(EngineID engine, const Vehicle* v, bool info_view);
peter1138@4056: #define GetCustomRotorSprite(v, i) GetRotorOverrideSprite(v->engine_type, v, i)
peter1138@4056: #define GetCustomRotorIcon(et) GetRotorOverrideSprite(et, NULL, true)
peter1138@3648: 
peter1138@3924: /* Forward declaration of GRFFile, to avoid unnecessary inclusion of newgrf.h
peter1138@3924:  * elsewhere... */
peter1138@3924: struct GRFFile;
peter1138@3924: 
peter1138@3924: void SetEngineGRF(EngineID engine, const struct GRFFile *file);
peter1138@3924: const struct GRFFile *GetEngineGRF(EngineID engine);
peter1138@3648: uint32 GetEngineGRFID(EngineID engine);
peter1138@3648: 
rubidium@7327: uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v);
rubidium@7327: uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent);
hackykid@1908: bool UsesWagonOverride(const Vehicle *v);
darkvater@414: #define GetCustomVehicleSprite(v, direction) GetCustomEngineSprite(v->engine_type, v, direction)
darkvater@414: #define GetCustomVehicleIcon(et, direction) GetCustomEngineSprite(et, NULL, direction)
truelight@0: 
peter1138@6490: /* Handler to Evaluate callback 36. If the callback fails (i.e. most of the
peter1138@6490:  * time) orig_value is returned */
peter1138@6490: uint GetVehicleProperty(const Vehicle *v, uint8 property, uint orig_value);
peter1138@6517: uint GetEngineProperty(EngineID engine, uint8 property, uint orig_value);
peter1138@6490: 
rubidium@6248: enum VehicleTrigger {
rubidium@7856: 	VEHICLE_TRIGGER_NEW_CARGO     = 0x01,
belugas@6348: 	/* Externally triggered only for the first vehicle in chain */
rubidium@7856: 	VEHICLE_TRIGGER_DEPOT         = 0x02,
belugas@6348: 	/* Externally triggered only for the first vehicle in chain, only if whole chain is empty */
rubidium@7856: 	VEHICLE_TRIGGER_EMPTY         = 0x04,
belugas@6348: 	/* Not triggered externally (called for the whole chain if we got NEW_CARGO) */
rubidium@7856: 	VEHICLE_TRIGGER_ANY_NEW_CARGO = 0x08,
glx@7803: 	/* Externally triggered for each vehicle in chain */
rubidium@7856: 	VEHICLE_TRIGGER_CALLBACK_32   = 0x10,
rubidium@6248: };
tron@1477: void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);
tron@445: 
peter1138@9070: void UnloadWagonOverrides(Engine *e);
peter1138@2491: 
peter1138@9070: uint ListPositionOfEngine(EngineID engine);
peter1138@9672: void AlterVehicleListOrder(EngineID engine, EngineID target);
peter1138@9672: void CommitVehicleListOrderChanges();
peter1138@2971: 
peter1138@9073: EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id);
peter1138@9073: 
peter1138@2962: #endif /* NEWGRF_ENGINE_H */