OpenTTD
newgrf_engine.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #ifndef NEWGRF_ENGINE_H
11 #define NEWGRF_ENGINE_H
12 
13 #include "direction_type.h"
14 #include "newgrf_callbacks.h"
15 #include "newgrf_properties.h"
16 #include "vehicle_type.h"
17 #include "engine_type.h"
18 #include "gfx_type.h"
19 #include "newgrf_spritegroup.h"
20 
23  const struct Vehicle *v;
25  bool info_view;
26 
35  : ScopeResolver(ro), v(v), self_type(engine_type), info_view(info_view)
36  {
37  }
38 
39  void SetVehicle(const Vehicle *v) { this->v = v; }
40 
41  uint32 GetRandomBits() const override;
42  uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override;
43  uint32 GetTriggers() const override;
44 };
45 
54  };
55 
58 
61 
62  VehicleResolverObject(EngineID engine_type, const Vehicle *v, WagonOverride wagon_override, bool info_view = false,
63  CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
64 
65  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override;
66 
67  const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const override;
68 };
69 
70 static const uint TRAININFO_DEFAULT_VEHICLE_WIDTH = 29;
71 static const uint ROADVEHINFO_DEFAULT_VEHICLE_WIDTH = 32;
72 static const uint VEHICLEINFO_FULL_VEHICLE_WIDTH = 32;
73 
74 struct VehicleSpriteSeq;
75 
76 void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const struct SpriteGroup *group, EngineID *train_id, uint trains);
77 const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, EngineID overriding_engine);
78 void SetCustomEngineSprites(EngineID engine, byte cargo, const struct SpriteGroup *group);
79 
80 void GetCustomEngineSprite(EngineID engine, const Vehicle *v, Direction direction, EngineImageType image_type, VehicleSpriteSeq *result);
81 #define GetCustomVehicleSprite(v, direction, image_type, result) GetCustomEngineSprite(v->engine_type, v, direction, image_type, result)
82 #define GetCustomVehicleIcon(et, direction, image_type, result) GetCustomEngineSprite(et, nullptr, direction, image_type, result)
83 
84 void GetRotorOverrideSprite(EngineID engine, const struct Aircraft *v, bool info_view, EngineImageType image_type, VehicleSpriteSeq *result);
85 #define GetCustomRotorSprite(v, i, image_type, result) GetRotorOverrideSprite(v->engine_type, v, i, image_type, result)
86 #define GetCustomRotorIcon(et, image_type, result) GetRotorOverrideSprite(et, nullptr, true, image_type, result)
87 
88 /* Forward declaration of GRFFile, to avoid unnecessary inclusion of newgrf.h
89  * elsewhere... */
90 struct GRFFile;
91 
92 void SetEngineGRF(EngineID engine, const struct GRFFile *file);
93 
94 uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v);
95 uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent);
96 bool UsesWagonOverride(const Vehicle *v);
97 
98 /* Handler to Evaluate callback 36. If the callback fails (i.e. most of the
99  * time) orig_value is returned */
100 uint GetVehicleProperty(const Vehicle *v, PropertyID property, uint orig_value);
101 uint GetEngineProperty(EngineID engine, PropertyID property, uint orig_value, const Vehicle *v = nullptr);
102 
103 enum VehicleTrigger {
104  VEHICLE_TRIGGER_NEW_CARGO = 0x01,
105  /* Externally triggered only for the first vehicle in chain */
106  VEHICLE_TRIGGER_DEPOT = 0x02,
107  /* Externally triggered only for the first vehicle in chain, only if whole chain is empty */
108  VEHICLE_TRIGGER_EMPTY = 0x04,
109  /* Not triggered externally (called for the whole chain if we got NEW_CARGO) */
110  VEHICLE_TRIGGER_ANY_NEW_CARGO = 0x08,
111  /* Externally triggered for each vehicle in chain */
112  VEHICLE_TRIGGER_CALLBACK_32 = 0x10,
113 };
114 void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);
115 
117 
118 void AlterVehicleListOrder(EngineID engine, uint target);
120 
121 EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id);
122 
123 #endif /* NEWGRF_ENGINE_H */
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope)...
Different types to &#39;show&#39; directions.
Resolver for a vehicle scope.
Definition: newgrf_engine.h:22
ResolverObject & ro
Surrounding resolver object.
uint32 GetTriggers() const override
Get the triggers.
VarSpriteGroupScope
byte cached_relative_count
Relative position of the other vehicle.
Definition: newgrf_engine.h:60
uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent)
Evaluate a newgrf callback for vehicles with a different vehicle for parent scope.
Interface for SpriteGroup-s to access the gamestate.
Types related to engines.
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition: aircraft.h:74
Vehicle data structure.
Definition: vehicle_base.h:210
Set when using the callback resolve system, but not to resolve a callback.
PropertyID
List of NewGRF properties used in Action 0 or Callback 0x36 (CBID_VEHICLE_MODIFY_PROPERTY).
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
uint32 GetRandomBits() const override
Get a few random bits.
Callbacks that NewGRFs could implement.
Resolve no wagon overrides.
Definition: newgrf_engine.h:50
Action 2 handling.
Resolve wagon overrides.
Definition: newgrf_engine.h:51
VehicleScopeResolver self_scope
Scope resolver for the indicated vehicle.
Definition: newgrf_engine.h:56
Resolver for a vehicle (chain)
Definition: newgrf_engine.h:47
void CommitVehicleListOrderChanges()
Deternine default engine sorting and execute recorded ListOrderChanges from AlterVehicleListOrder.
Direction
Defines the 8 directions on the map.
VehicleScopeResolver relative_scope
Scope resolver for an other vehicle in the chain.
Definition: newgrf_engine.h:59
EngineID self_type
Type of the vehicle.
Definition: newgrf_engine.h:24
bool UsesWagonOverride(const Vehicle *v)
Check if a wagon is currently using a wagon override.
void AlterVehicleListOrder(EngineID engine, uint target)
Record a vehicle ListOrderChange.
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:128
Resolved object itself.
VehicleScopeResolver parent_scope
Scope resolver for its parent vehicle.
Definition: newgrf_engine.h:57
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
VehicleScopeResolver(ResolverObject &ro, EngineID engine_type, const Vehicle *v, bool info_view)
Scope resolver of a single vehicle.
Definition: newgrf_engine.h:34
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override
Get a variable value.
Resolve self-override (helicopter rotors and such).
Definition: newgrf_engine.h:53
Types related to vehicles.
void UnloadWagonOverrides(Engine *e)
Unload all wagon override sprite groups.
uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v)
Evaluate a newgrf callback for vehicles.
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:286
CallbackID
List of implemented NewGRF callbacks.
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
const struct Vehicle * v
The vehicle being resolved.
Definition: newgrf_engine.h:23
bool info_view
Indicates if the item is being drawn in an info window.
Definition: newgrf_engine.h:25
EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id)
Return the ID of a new engine.
Definition: newgrf.cpp:691
Properties of NewGRF Action 0.
Types related to the graphics and/or input devices.
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
void SetEngineGRF(EngineID engine, const GRFFile *file)
Tie a GRFFile entry to an engine, to allow us to retrieve GRF parameters etc during a game...
Resolve wagon overrides using TrainCache::cached_override.
Definition: newgrf_engine.h:52