OpenTTD Source
20241108-master-g80f628063a
|
NewGRF handling of engines. More...
#include "stdafx.h"
#include "debug.h"
#include "train.h"
#include "roadveh.h"
#include "company_func.h"
#include "newgrf_cargo.h"
#include "newgrf_spritegroup.h"
#include "timer/timer_game_calendar.h"
#include "vehicle_func.h"
#include "core/random_func.hpp"
#include "core/container_func.hpp"
#include "aircraft.h"
#include "station_base.h"
#include "company_base.h"
#include "newgrf_railtype.h"
#include "newgrf_roadtype.h"
#include "ship.h"
#include "safeguards.h"
Go to the source code of this file.
Data Structures | |
struct | ListOrderChange |
Functions | |
void | SetWagonOverrideSprites (EngineID engine, CargoID cargo, const SpriteGroup *group, std::span< EngineID > engine_ids) |
const SpriteGroup * | GetWagonOverrideSpriteSet (EngineID engine, CargoID cargo, EngineID overriding_engine) |
void | SetCustomEngineSprites (EngineID engine, uint8_t cargo, const SpriteGroup *group) |
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. More... | |
static int | MapOldSubType (const Vehicle *v) |
static uint8_t | MapAircraftMovementState (const Aircraft *v) |
Map OTTD aircraft movement states to TTDPatch style movement states (VarAction 2 Variable 0xE2) | |
static uint8_t | MapAircraftMovementAction (const Aircraft *v) |
Map OTTD aircraft movement states to TTDPatch style movement actions (VarAction 2 Variable 0xE6) This is not fully supported yet but it's enough for Planeset. | |
static const Livery * | LiveryHelper (EngineID engine, const Vehicle *v) |
Determines the livery of an engine. More... | |
static uint32_t | PositionHelper (const Vehicle *v, bool consecutive) |
Helper to get the position of a vehicle within a chain of vehicles. More... | |
static uint32_t | VehicleGetVariable (Vehicle *v, const VehicleScopeResolver *object, uint8_t variable, uint32_t parameter, bool &available) |
static const GRFFile * | GetEngineGrfFile (EngineID engine_type) |
Get the grf file associated with an engine type. More... | |
void | GetCustomEngineSprite (EngineID engine, const Vehicle *v, Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) |
void | GetRotorOverrideSprite (EngineID engine, const struct Aircraft *v, EngineImageType image_type, VehicleSpriteSeq *result) |
bool | UsesWagonOverride (const Vehicle *v) |
Check if a wagon is currently using a wagon override. More... | |
uint16_t | GetVehicleCallback (CallbackID callback, uint32_t param1, uint32_t param2, EngineID engine, const Vehicle *v) |
Evaluate a newgrf callback for vehicles. More... | |
uint16_t | GetVehicleCallbackParent (CallbackID callback, uint32_t param1, uint32_t param2, EngineID engine, const Vehicle *v, const Vehicle *parent) |
Evaluate a newgrf callback for vehicles with a different vehicle for parent scope. More... | |
int | GetVehicleProperty (const Vehicle *v, PropertyID property, int orig_value, bool is_signed) |
int | GetEngineProperty (EngineID engine, PropertyID property, int orig_value, const Vehicle *v, bool is_signed) |
bool | TestVehicleBuildProbability (Vehicle *v, EngineID engine, BuildProbabilityType type) |
Test for vehicle build probablity type. More... | |
static void | DoTriggerVehicle (Vehicle *v, VehicleTrigger trigger, uint16_t base_random_bits, bool first) |
void | TriggerVehicle (Vehicle *v, VehicleTrigger trigger) |
void | AlterVehicleListOrder (EngineID engine, uint target) |
Record a vehicle ListOrderChange. More... | |
static bool | EnginePreSort (const EngineID &a, const EngineID &b) |
Comparator function to sort engines via scope-GRFID and local ID. More... | |
void | CommitVehicleListOrderChanges () |
Deternine default engine sorting and execute recorded ListOrderChanges from AlterVehicleListOrder. | |
void | FillNewGRFVehicleCache (const Vehicle *v) |
Fill the grf_cache of the given vehicle. More... | |
Variables | |
static std::vector< ListOrderChange > | _list_order_changes |
NewGRF handling of engines.
Definition in file newgrf_engine.cpp.
void AlterVehicleListOrder | ( | EngineID | engine, |
uint | target | ||
) |
Record a vehicle ListOrderChange.
engine | Engine to move |
target | Local engine ID to move engine in front of |
Definition at line 1299 of file newgrf_engine.cpp.
Comparator function to sort engines via scope-GRFID and local ID.
a | left side |
b | right side |
Definition at line 1311 of file newgrf_engine.cpp.
Referenced by CommitVehicleListOrderChanges().
void FillNewGRFVehicleCache | ( | const Vehicle * | v | ) |
Fill the grf_cache of the given vehicle.
v | The vehicle to fill the cache for. |
Definition at line 1382 of file newgrf_engine.cpp.
References NewGRFCache::cache_valid, Vehicle::engine_type, VehicleResolverObject::GetScope(), ScopeResolver::GetVariable(), Vehicle::grf_cache, HasBit(), lengthof, NCVV_COMPANY_INFORMATION, NCVV_CONSIST_CARGO_INFORMATION, NCVV_END, NCVV_POSITION_CONSIST_LENGTH, NCVV_POSITION_IN_VEHICLE, NCVV_POSITION_SAME_ID_LENGTH, VSG_SCOPE_SELF, and VehicleResolverObject::WO_NONE.
Get the grf file associated with an engine type.
engine_type | Engine to query. |
Definition at line 1022 of file newgrf_engine.cpp.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), and Engine::GetGRF().
uint16_t GetVehicleCallback | ( | CallbackID | callback, |
uint32_t | param1, | ||
uint32_t | param2, | ||
EngineID | engine, | ||
const Vehicle * | v | ||
) |
Evaluate a newgrf callback for vehicles.
callback | The callback to evaluate |
param1 | First parameter of the callback |
param2 | Second parameter of the callback |
engine | Engine type of the vehicle to evaluate the callback for |
v | The vehicle to evaluate the callback for, or nullptr if it doesn't exist yet |
Definition at line 1149 of file newgrf_engine.cpp.
uint16_t GetVehicleCallbackParent | ( | CallbackID | callback, |
uint32_t | param1, | ||
uint32_t | param2, | ||
EngineID | engine, | ||
const Vehicle * | v, | ||
const Vehicle * | parent | ||
) |
Evaluate a newgrf callback for vehicles with a different vehicle for parent scope.
callback | The callback to evaluate |
param1 | First parameter of the callback |
param2 | Second parameter of the callback |
engine | Engine type of the vehicle to evaluate the callback for |
v | The vehicle to evaluate the callback for, or nullptr if it doesn't exist yet |
parent | The vehicle to use for parent scope |
Definition at line 1165 of file newgrf_engine.cpp.
Determines the livery of an engine.
This always uses dual company colours independent of GUI settings. So it is desync-safe.
Definition at line 373 of file newgrf_engine.cpp.
References _current_company, Vehicle::engine_type, GroundVehicleCache::first_engine, GetEngineLivery(), Vehicle::GetGroundVehicleCache(), INVALID_ENGINE, Vehicle::IsGroundVehicle(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), LIT_ALL, and Vehicle::owner.
Referenced by VehicleScopeResolver::GetVariable().
|
static |
Helper to get the position of a vehicle within a chain of vehicles.
v | the vehicle to get the position of. |
consecutive | whether to look at the whole chain or the vehicles with the same 'engine type'. |
Definition at line 396 of file newgrf_engine.cpp.
References Vehicle::engine_type, Vehicle::First(), and Vehicle::Next().
Tie a GRFFile entry to an engine, to allow us to retrieve GRF parameters etc during a game.
Definition at line 71 of file newgrf_engine.cpp.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), Engine::grf_prop, and GRFFilePropsBase< Tcnt >::grffile.
Test for vehicle build probablity type.
v | Vehicle whose build probability to test. |
type | Build probability type to test for. |
Definition at line 1201 of file newgrf_engine.cpp.
bool UsesWagonOverride | ( | const Vehicle * | v | ) |
Check if a wagon is currently using a wagon override.
v | The wagon to check |
Definition at line 1134 of file newgrf_engine.cpp.
References SpecializedVehicle< T, Type >::From(), BaseVehicle::type, and VEH_TRAIN.