OpenTTD Source: src/newgrf_engine.h Source File

OpenTTD Source 1.11.0-RC1

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
22 struct VehicleScopeResolver : public ScopeResolver {
23 const struct Vehicle *v;
24 EngineID self_type;
25 bool info_view;
26
34 VehicleScopeResolver(ResolverObject &ro, EngineID engine_type, const Vehicle *v, bool info_view)
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
47 struct VehicleResolverObject : public ResolverObject {
49 enum WagonOverride {
50 WO_NONE,
51 WO_UNCACHED,
52 WO_CACHED,
53 WO_SELF,
54 };
55
56 VehicleScopeResolver self_scope;
57 VehicleScopeResolver parent_scope;
58
59 VehicleScopeResolver relative_scope;
60 byte cached_relative_count;
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 GrfSpecFeature GetFeature() const override;
70 uint32 GetDebugID() const override;
71 };
72
73 static const uint TRAININFO_DEFAULT_VEHICLE_WIDTH = 29;
74 static const uint ROADVEHINFO_DEFAULT_VEHICLE_WIDTH = 32;
75 static const uint VEHICLEINFO_FULL_VEHICLE_WIDTH = 32;
76
77 struct VehicleSpriteSeq;
78
79 void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const struct SpriteGroup *group, EngineID *train_id, uint trains);
80 const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, EngineID overriding_engine);
81 void SetCustomEngineSprites(EngineID engine, byte cargo, const struct SpriteGroup *group);
82
83 void GetCustomEngineSprite(EngineID engine, const Vehicle *v, Direction direction, EngineImageType image_type, VehicleSpriteSeq *result);
84 #define GetCustomVehicleSprite(v, direction, image_type, result) GetCustomEngineSprite(v->engine_type, v, direction, image_type, result)
85 #define GetCustomVehicleIcon(et, direction, image_type, result) GetCustomEngineSprite(et, nullptr, direction, image_type, result)
86
87 void GetRotorOverrideSprite(EngineID engine, const struct Aircraft *v, bool info_view, EngineImageType image_type, VehicleSpriteSeq *result);
88 #define GetCustomRotorSprite(v, i, image_type, result) GetRotorOverrideSprite(v->engine_type, v, i, image_type, result)
89 #define GetCustomRotorIcon(et, image_type, result) GetRotorOverrideSprite(et, nullptr, true, image_type, result)
90
91 /* Forward declaration of GRFFile, to avoid unnecessary inclusion of newgrf.h
92 * elsewhere... */
93 struct GRFFile;
94
95 void SetEngineGRF(EngineID engine, const struct GRFFile *file);
96
97 uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v);
98 uint16 GetVehicleCallbackParent(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent);
99 bool UsesWagonOverride(const Vehicle *v);
100
101 /* Handler to Evaluate callback 36. If the callback fails (i.e. most of the
102 * time) orig_value is returned */
103 uint GetVehicleProperty(const Vehicle *v, PropertyID property, uint orig_value);
104 uint GetEngineProperty(EngineID engine, PropertyID property, uint orig_value, const Vehicle *v = nullptr);
105
106 enum VehicleTrigger {
107 VEHICLE_TRIGGER_NEW_CARGO = 0x01,
108 /* Externally triggered only for the first vehicle in chain */
109 VEHICLE_TRIGGER_DEPOT = 0x02,
110 /* Externally triggered only for the first vehicle in chain, only if whole chain is empty */
111 VEHICLE_TRIGGER_EMPTY = 0x04,
112 /* Not triggered externally (called for the whole chain if we got NEW_CARGO) */
113 VEHICLE_TRIGGER_ANY_NEW_CARGO = 0x08,
114 /* Externally triggered for each vehicle in chain */
115 VEHICLE_TRIGGER_CALLBACK_32 = 0x10,
116 };
117 void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);
118
119 void UnloadWagonOverrides(Engine *e);
120
121 void AlterVehicleListOrder(EngineID engine, uint target);
122 void CommitVehicleListOrderChanges();
123
124 EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id);
125
126 #endif /* NEWGRF_ENGINE_H */
VehicleResolverObject::ResolveReal
const SpriteGroup * ResolveReal(const RealSpriteGroup *group) const override
Get the real sprites of the grf.
Definition: newgrf_engine.cpp:1023
VarSpriteGroupScope
VarSpriteGroupScope
Definition: newgrf_spritegroup.h:100
VehicleResolverObject::WO_CACHED
@ WO_CACHED
Resolve wagon overrides using TrainCache::cached_override.
Definition: newgrf_engine.h:52
WagonOverride
Definition: newgrf_engine.cpp:29
ResolverObject::callback_param1
uint32 callback_param1
First parameter (var 10) of the callback.
Definition: newgrf_spritegroup.h:334
direction_type.h
VehicleResolverObject::GetFeature
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Definition: newgrf_engine.cpp:1045
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
VehicleScopeResolver::GetRandomBits
uint32 GetRandomBits() const override
Get a few random bits.
Definition: newgrf_engine.cpp:339
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition: newgrf_spritegroup.h:315
VehicleResolverObject::cached_relative_count
byte cached_relative_count
Relative position of the other vehicle.
Definition: newgrf_engine.h:60
newgrf_callbacks.h
VehicleResolverObject::GetDebugID
uint32 GetDebugID() const override
Get an identifier for the item being resolved.
Definition: newgrf_engine.cpp:1056
AlterVehicleListOrder
void AlterVehicleListOrder(EngineID engine, uint target)
Record a vehicle ListOrderChange.
Definition: newgrf_engine.cpp:1317
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition: newgrf_callbacks.h:20
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
Engine
Definition: engine_base.h:21
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:222
VehicleScopeResolver::self_type
EngineID self_type
Type of the vehicle.
Definition: newgrf_engine.h:24
VehicleResolverObject::relative_scope
VehicleScopeResolver relative_scope
Scope resolver for an other vehicle in the chain.
Definition: newgrf_engine.h:59
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition: newgrf_spritegroup.h:296
VehicleScopeResolver::info_view
bool info_view
Indicates if the item is being drawn in an info window.
Definition: newgrf_engine.h:25
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition: newgrf_spritegroup.h:103
VehicleResolverObject::WO_NONE
@ WO_NONE
Resolve no wagon overrides.
Definition: newgrf_engine.h:50
CommitVehicleListOrderChanges
void CommitVehicleListOrderChanges()
Deternine default engine sorting and execute recorded ListOrderChanges from AlterVehicleListOrder.
Definition: newgrf_engine.cpp:1347
Aircraft
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition: aircraft.h:74
ResolverObject::callback_param2
uint32 callback_param2
Second parameter (var 18) of the callback.
Definition: newgrf_spritegroup.h:335
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
VehicleScopeResolver::GetTriggers
uint32 GetTriggers() const override
Get the triggers.
Definition: newgrf_engine.cpp:344
CBID_NO_CALLBACK
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Definition: newgrf_callbacks.h:22
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:297
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:128
GetVehicleCallback
uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v)
Evaluate a newgrf callback for vehicles.
Definition: newgrf_engine.cpp:1188
VehicleResolverObject::WO_SELF
@ WO_SELF
Resolve self-override (helicopter rotors and such).
Definition: newgrf_engine.h:53
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
GetNewEngineID
EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id)
Return the ID of a new engine.
Definition: newgrf.cpp:695
GetVehicleCallbackParent
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.
Definition: newgrf_engine.cpp:1204
PropertyID
PropertyID
List of NewGRF properties used in Action 0 or Callback 0x36 (CBID_VEHICLE_MODIFY_PROPERTY).
Definition: newgrf_properties.h:18
UsesWagonOverride
bool UsesWagonOverride(const Vehicle *v)
Check if a wagon is currently using a wagon override.
Definition: newgrf_engine.cpp:1173
newgrf_spritegroup.h
VehicleScopeResolver::v
const struct Vehicle * v
The vehicle being resolved.
Definition: newgrf_engine.h:23
GrfSpecFeature
GrfSpecFeature
Definition: newgrf.h:66
VehicleScopeResolver::VehicleScopeResolver
VehicleScopeResolver(ResolverObject &ro, EngineID engine_type, const Vehicle *v, bool info_view)
Scope resolver of a single vehicle.
Definition: newgrf_engine.h:34
vehicle_type.h
VehicleResolverObject::WO_UNCACHED
@ WO_UNCACHED
Resolve wagon overrides.
Definition: newgrf_engine.h:51
engine_type.h
VehicleResolverObject::self_scope
VehicleScopeResolver self_scope
Scope resolver for the indicated vehicle.
Definition: newgrf_engine.h:56
RealSpriteGroup
Definition: newgrf_spritegroup.h:79
VehicleResolverObject::parent_scope
VehicleScopeResolver parent_scope
Scope resolver for its parent vehicle.
Definition: newgrf_engine.h:57
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition: newgrf_spritegroup.h:333
VehicleResolverObject
Resolver for a vehicle (chain)
Definition: newgrf_engine.h:47
newgrf_properties.h
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition: newgrf_spritegroup.h:297
UnloadWagonOverrides
void UnloadWagonOverrides(Engine *e)
Unload all wagon override sprite groups.
Definition: newgrf_engine.cpp:73
VehicleResolverObject::VehicleResolverObject
VehicleResolverObject(EngineID engine_type, const Vehicle *v, WagonOverride wagon_override, bool info_view=false, CallbackID callback=CBID_NO_CALLBACK, uint32 callback_param1=0, uint32 callback_param2=0)
Resolver of a vehicle (chain).
Definition: newgrf_engine.cpp:1082
gfx_type.h
VehicleScopeResolver::GetVariable
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override
Get a variable value.
Definition: newgrf_engine.cpp:988
VehicleResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
Get a resolver for the scope.
Definition: newgrf_engine.cpp:350
SpriteGroup
Definition: newgrf_spritegroup.h:57
SetEngineGRF
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.
Definition: newgrf_engine.cpp:103
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
VehicleScopeResolver
Resolver for a vehicle scope.
Definition: newgrf_engine.h:22