OpenTTD Source 20260208-master-g43af8e94d0
VehicleScopeResolver Struct Reference

Resolver for a vehicle scope. More...

#include <newgrf_engine.h>

Inheritance diagram for VehicleScopeResolver:
ScopeResolver

Public Member Functions

 VehicleScopeResolver (ResolverObject &ro, EngineID engine_type, const Vehicle *v, bool rotor_in_gui)
 Scope resolver of a single vehicle.
void SetVehicle (const Vehicle *v)
uint32_t GetRandomBits () const override
 Get a few random bits.
uint32_t GetVariable (uint8_t variable, uint32_t parameter, bool &available) const override
 Get a variable value.
uint32_t GetRandomTriggers () const override
 Get the triggers.
Public Member Functions inherited from ScopeResolver
 ScopeResolver (ResolverObject &ro)
virtual void StorePSA (uint reg, int32_t value)
 Store a value into the persistent storage area (PSA).

Data Fields

const struct Vehicle * v
 The vehicle being resolved.
EngineID self_type
 Type of the vehicle.
bool rotor_in_gui
 Helicopter rotor is drawn in GUI.
Data Fields inherited from ScopeResolver
ResolverObject & ro
 Surrounding resolver object.

Detailed Description

Resolver for a vehicle scope.

Definition at line 22 of file newgrf_engine.h.

Constructor & Destructor Documentation

◆ VehicleScopeResolver()

VehicleScopeResolver::VehicleScopeResolver ( ResolverObject & ro,
EngineID engine_type,
const Vehicle * v,
bool rotor_in_gui )
inline

Scope resolver of a single vehicle.

Parameters
roSurrounding resolver.
engine_typeEngine type
vVehicle being resolved.
rotor_in_guiHelicopter rotor is drawn in GUI.

Definition at line 34 of file newgrf_engine.h.

References ScopeResolver::ro, rotor_in_gui, self_type, and v.

Member Function Documentation

◆ GetRandomBits()

uint32_t VehicleScopeResolver::GetRandomBits ( ) const
overridevirtual

Get a few random bits.

Default implementation has no random bits.

Returns
Random bits.

Reimplemented from ScopeResolver.

Definition at line 307 of file newgrf_engine.cpp.

References Vehicle::random_bits.

◆ GetRandomTriggers()

uint32_t VehicleScopeResolver::GetRandomTriggers ( ) const
overridevirtual

Get the triggers.

Base class returns 0 to prevent trouble.

Returns
The triggers.

Reimplemented from ScopeResolver.

Definition at line 312 of file newgrf_engine.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), and Vehicle::waiting_random_triggers.

◆ GetVariable()

uint32_t VehicleScopeResolver::GetVariable ( uint8_t variable,
uint32_t parameter,
bool & available ) const
overridevirtual

Get a variable value.

Default implementation has no available variables.

Parameters
variableVariable to read
parameterParameter for 60+x variables
[out]availableSet to false, in case the variable does not exist.
Returns
Value

Reimplemented from ScopeResolver.

Definition at line 972 of file newgrf_engine.cpp.

References _current_company, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), Clamp(), ClampTo(), CargoSpec::classes, TimerGameCalendar::date, TimerGameConst< struct Calendar >::DAYS_TILL_ORIGINAL_BASE_YEAR, GB(), CargoSpec::Get(), GetBadgeVariableResult(), GetCompanyInfo(), Engine::GetDefaultCargoType(), IsValidCargoType(), LiveryHelper(), TimerGameConst< struct Calendar >::ORIGINAL_BASE_YEAR, TimerGameConst< struct Calendar >::ORIGINAL_MAX_YEAR, ScopeResolver::ro, self_type, CargoSpec::weight, and TimerGameCalendar::year.

◆ SetVehicle()

void VehicleScopeResolver::SetVehicle ( const Vehicle * v)
inline

Definition at line 39 of file newgrf_engine.h.

Field Documentation

◆ rotor_in_gui

bool VehicleScopeResolver::rotor_in_gui

Helicopter rotor is drawn in GUI.

Definition at line 25 of file newgrf_engine.h.

Referenced by VehicleScopeResolver().

◆ self_type

EngineID VehicleScopeResolver::self_type

Type of the vehicle.

Definition at line 24 of file newgrf_engine.h.

Referenced by GetVariable(), and VehicleScopeResolver().

◆ v

const struct Vehicle* VehicleScopeResolver::v

The vehicle being resolved.

Definition at line 23 of file newgrf_engine.h.

Referenced by VehicleScopeResolver().

The documentation for this struct was generated from the following files: