src/newgrf_engine.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file newgrf_engine.h Functions for NewGRF engines. */
  11
  12 #ifndef NEWGRF_ENGINE_H
  13 #define NEWGRF_ENGINE_H
  14
  15 #include "direction_type.h"
  16 #include "newgrf_callbacks.h"
  17 #include "newgrf_properties.h"
  18 #include "vehicle_type.h"
  19 #include "engine_type.h"
  20 #include "gfx_type.h"
  21 #include "newgrf_spritegroup.h"
  22
  23 /** Resolver for a vehicle scope. */
  24 struct VehicleScopeResolver : public ScopeResolver {
  25         const struct Vehicle *v; ///< The vehicle being resolved.
  26         EngineID self_type;      ///< Type of the vehicle.
  27         bool info_view;          ///< Indicates if the item is being drawn in an info window.
  28
  29         VehicleScopeResolver(ResolverObject &ro, EngineID engine_type, const Vehicle *v, bool info_view);
  30
  31         void SetVehicle(const Vehicle *v) { this->v = v; }
  32
  33         /* virtual */ uint32 GetRandomBits() const;
  34         /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
  35         /* virtual */ uint32 GetTriggers() const;
  36 };
  37
  38 /** Resolver for a vehicle (chain) */
  39 struct VehicleResolverObject : public ResolverObject {
  40         /** Application of 'wagon overrides'. */
  41         enum WagonOverride {
  42                 WO_NONE,     //!< Resolve no wagon overrides.
  43                 WO_UNCACHED, //!< Resolve wagon overrides.
  44                 WO_CACHED,   //!< Resolve wagon overrides using TrainCache::cached_override.
  45                 WO_SELF,     //!< Resolve self-override (helicopter rotors and such).
  46         };
  47
  48         VehicleScopeResolver self_scope;     ///< Scope resolver for the indicated vehicle.
  49         VehicleScopeResolver parent_scope;   ///< Scope resolver for its parent vehicle.
  50
  51         VehicleScopeResolver relative_scope; ///< Scope resolver for an other vehicle in the chain.
  52         byte cached_relative_count;          ///< Relative position of the other vehicle.
  53
  54         VehicleResolverObject(EngineID engine_type, const Vehicle *v, WagonOverride wagon_override, bool info_view = false,
  55                         CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
  56
  57         /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0);
  58
  59         /* virtual */ const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
  60 };
  61
  62 static const uint TRAININFO_DEFAULT_VEHICLE_WIDTH   = 29;
  63 static const uint ROADVEHINFO_DEFAULT_VEHICLE_WIDTH = 32;
  64 static const uint VEHICLEINFO_FULL_VEHICLE_WIDTH    = 32;
  65
  66 struct VehicleSpriteSeq;
  67
  68 void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const struct SpriteGroup *group, EngineID *train_id, uint trains);
  69 const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, EngineID overriding_engine);
  70 void SetCustomEngineSprites(EngineID engine, byte cargo, const struct SpriteGroup *group);
  71
  72 void GetCustomEngineSprite(EngineID engine, const Vehicle *v, Direction direction, EngineImageType image_type, VehicleSpriteSeq *result);
  73 #define GetCustomVehicleSprite(v, direction, image_type, result) GetCustomEngineSprite(v->engine_type, v, direction, image_type, result)
  74 #define GetCustomVehicleIcon(et, direction, image_type, result) GetCustomEngineSprite(et, NULL, direction, image_type, result)
  75
  76 void GetRotorOverrideSprite(EngineID engine, const struct Aircraft *v, bool info_view, EngineImageType image_type, VehicleSpriteSeq *result);
  77 #define GetCustomRotorSprite(v, i, image_type, result) GetRotorOverrideSprite(v->engine_type, v, i, image_type, result)
  78 #define GetCustomRotorIcon(et, image_type, result) GetRotorOverrideSprite(et, NULL, true, image_type, result)
  79
  80 /* Forward declaration of GRFFile, to avoid unnecessary inclusion of newgrf.h
  81  * elsewhere... */
  82 struct GRFFile;
  83
  84 void SetEngineGRF(EngineID engine, const struct GRFFile *file);
  85
  86 uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v);
  87 uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent);
  88 bool UsesWagonOverride(const Vehicle *v);
  89
  90 /* Handler to Evaluate callback 36. If the callback fails (i.e. most of the
  91  * time) orig_value is returned */
  92 uint GetVehicleProperty(const Vehicle *v, PropertyID property, uint orig_value);
  93 uint GetEngineProperty(EngineID engine, PropertyID property, uint orig_value, const Vehicle *v = NULL);
  94
  95 enum VehicleTrigger {
  96         VEHICLE_TRIGGER_NEW_CARGO     = 0x01,
  97         /* Externally triggered only for the first vehicle in chain */
  98         VEHICLE_TRIGGER_DEPOT         = 0x02,
  99         /* Externally triggered only for the first vehicle in chain, only if whole chain is empty */
 100         VEHICLE_TRIGGER_EMPTY         = 0x04,
 101         /* Not triggered externally (called for the whole chain if we got NEW_CARGO) */
 102         VEHICLE_TRIGGER_ANY_NEW_CARGO = 0x08,
 103         /* Externally triggered for each vehicle in chain */
 104         VEHICLE_TRIGGER_CALLBACK_32   = 0x10,
 105 };
 106 void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);
 107
 108 void UnloadWagonOverrides(Engine *e);
 109
 110 void AlterVehicleListOrder(EngineID engine, uint target);
 111 void CommitVehicleListOrderChanges();
 112
 113 EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id);
 114
 115 #endif /* NEWGRF_ENGINE_H */