OpenTTD Source
1.11.0-beta2
|
Go to the documentation of this file.
10 #ifndef NEWGRF_ENGINE_H
11 #define NEWGRF_ENGINE_H
39 void SetVehicle(
const Vehicle *
v) { this->v =
v; }
42 uint32
GetVariable(
byte variable, uint32 parameter,
bool *available)
const override;
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;
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)
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)
106 enum VehicleTrigger {
107 VEHICLE_TRIGGER_NEW_CARGO = 0x01,
109 VEHICLE_TRIGGER_DEPOT = 0x02,
111 VEHICLE_TRIGGER_EMPTY = 0x04,
113 VEHICLE_TRIGGER_ANY_NEW_CARGO = 0x08,
115 VEHICLE_TRIGGER_CALLBACK_32 = 0x10,
117 void TriggerVehicle(
Vehicle *veh, VehicleTrigger trigger);
const SpriteGroup * ResolveReal(const RealSpriteGroup *group) const override
Get the real sprites of the grf.
@ WO_CACHED
Resolve wagon overrides using TrainCache::cached_override.
uint32 callback_param1
First parameter (var 10) of the callback.
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Direction
Defines the 8 directions on the map.
uint32 GetRandomBits() const override
Get a few random bits.
Interface for SpriteGroup-s to access the gamestate.
byte cached_relative_count
Relative position of the other vehicle.
uint32 GetDebugID() const override
Get an identifier for the item being resolved.
void AlterVehicleListOrder(EngineID engine, uint target)
Record a vehicle ListOrderChange.
CallbackID
List of implemented NewGRF callbacks.
EngineImageType
Visualisation contexts of vehicles and engines.
EngineID self_type
Type of the vehicle.
VehicleScopeResolver relative_scope
Scope resolver for an other vehicle in the chain.
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
bool info_view
Indicates if the item is being drawn in an info window.
@ VSG_SCOPE_SELF
Resolved object itself.
@ WO_NONE
Resolve no wagon overrides.
void CommitVehicleListOrderChanges()
Deternine default engine sorting and execute recorded ListOrderChanges from AlterVehicleListOrder.
Aircraft, helicopters, rotors and their shadows belong to this class.
uint32 callback_param2
Second parameter (var 18) of the callback.
uint16 EngineID
Unique identification number of an engine.
uint32 GetTriggers() const override
Get the triggers.
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
EngineID engine_type
The type of engine used for this vehicle.
Sprite sequence for a vehicle part.
uint16 GetVehicleCallback(CallbackID callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v)
Evaluate a newgrf callback for vehicles.
@ WO_SELF
Resolve self-override (helicopter rotors and such).
VehicleType
Available vehicle types.
EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id)
Return the ID of a new engine.
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.
PropertyID
List of NewGRF properties used in Action 0 or Callback 0x36 (CBID_VEHICLE_MODIFY_PROPERTY).
bool UsesWagonOverride(const Vehicle *v)
Check if a wagon is currently using a wagon override.
const struct Vehicle * v
The vehicle being resolved.
VehicleScopeResolver(ResolverObject &ro, EngineID engine_type, const Vehicle *v, bool info_view)
Scope resolver of a single vehicle.
@ WO_UNCACHED
Resolve wagon overrides.
VehicleScopeResolver self_scope
Scope resolver for the indicated vehicle.
VehicleScopeResolver parent_scope
Scope resolver for its parent vehicle.
CallbackID callback
Callback being resolved.
Resolver for a vehicle (chain)
byte CargoID
Cargo slots to indicate a cargo type within a game.
ResolverObject & ro
Surrounding resolver object.
void UnloadWagonOverrides(Engine *e)
Unload all wagon override sprite groups.
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).
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override
Get a variable value.
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
Get a resolver for the scope.
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.
Dynamic data of a loaded NewGRF.
Resolver for a vehicle scope.