OpenTTD Source  20241120-master-g6d3adc6169
GroundVehicle< T, Type > Struct Template Reference

Base class for all vehicles that move through ground. More...

#include <ground_vehicle.hpp>

Inheritance diagram for GroundVehicle< T, Type >:
SpecializedVehicle< T, Type > Vehicle Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool > BaseVehicle BaseConsist

Public Types

typedef GroundVehicle< T, Type > GroundVehicleBase
 Our type.
 
- Public Types inherited from SpecializedVehicle< T, Type >
typedef SpecializedVehicle< T, Type > SpecializedVehicleBase
 Our type.
 
- Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero > Pool
 Type of the pool this item is going to be part of.
 

Public Member Functions

 GroundVehicle ()
 The constructor at SpecializedVehicle must be called.
 
void PowerChanged ()
 Recalculates the cached total power of a vehicle. More...
 
void CargoChanged ()
 Recalculates the cached weight of a vehicle and its parts. More...
 
int GetAcceleration () const
 Calculates the acceleration of the vehicle under its current conditions. More...
 
bool IsChainInDepot () const override
 Check whether the whole vehicle chain is in the depot. More...
 
uint Crash (bool flooded) override
 Common code executed for crashed ground vehicles. More...
 
int64_t GetSlopeResistance () const
 Calculates the total slope resistance for this vehicle. More...
 
void UpdateZPositionAndInclination ()
 Updates vehicle's Z position and inclination. More...
 
void UpdateZPosition ()
 Updates vehicle's Z position. More...
 
int UpdateInclination (bool new_tile, bool update_delta)
 Checks if the vehicle is in a slope and sets the required flags in that case. More...
 
void SetFrontEngine ()
 Set front engine state.
 
void ClearFrontEngine ()
 Remove the front engine state.
 
void SetArticulatedPart ()
 Set a vehicle to be an articulated part.
 
void ClearArticulatedPart ()
 Clear a vehicle from being an articulated part.
 
void SetWagon ()
 Set a vehicle to be a wagon.
 
void ClearWagon ()
 Clear wagon property.
 
void SetEngine ()
 Set engine status.
 
void ClearEngine ()
 Clear engine status.
 
void SetFreeWagon ()
 Set a vehicle as a free wagon.
 
void ClearFreeWagon ()
 Clear a vehicle from being a free wagon.
 
void SetMultiheaded ()
 Set a vehicle as a multiheaded engine.
 
void ClearMultiheaded ()
 Clear multiheaded engine property.
 
bool IsFreeWagon () const
 Check if the vehicle is a free wagon (got no engine in front of it). More...
 
bool IsEngine () const
 Check if a vehicle is an engine (can be first in a consist). More...
 
bool IsWagon () const
 Check if a vehicle is a wagon. More...
 
bool IsMultiheaded () const
 Check if the vehicle is a multiheaded engine. More...
 
bool IsRearDualheaded () const
 Tell if we are dealing with the rear end of a multiheaded engine. More...
 
void SetLastSpeed ()
 Update the GUI variant of the current speed of the vehicle. More...
 
- Public Member Functions inherited from SpecializedVehicle< T, Type >
 SpecializedVehicle ()
 Set vehicle type correctly.
 
T * First () const
 Get the first vehicle in the chain. More...
 
T * Last ()
 Get the last vehicle in the chain. More...
 
const T * Last () const
 Get the last vehicle in the chain. More...
 
T * Next () const
 Get next vehicle in the chain. More...
 
T * Previous () const
 Get previous vehicle in the chain. More...
 
T * GetNextArticulatedPart ()
 Get the next part of an articulated engine. More...
 
T * GetNextArticulatedPart () const
 Get the next part of an articulated engine. More...
 
T * GetFirstEnginePart ()
 Get the first part of an articulated engine. More...
 
const T * GetFirstEnginePart () const
 Get the first part of an articulated engine. More...
 
T * GetLastEnginePart ()
 Get the last part of an articulated engine. More...
 
T * GetNextVehicle () const
 Get the next real (non-articulated part) vehicle in the consist. More...
 
T * GetPrevVehicle () const
 Get the previous real (non-articulated part) vehicle in the consist. More...
 
void UpdateViewport (bool force_update, bool update_delta)
 Update vehicle sprite- and position caches. More...
 
- Public Member Functions inherited from Vehicle
virtual uint16_t GetMaxWeight () const
 Calculates the weight value that this vehicle will have when fully loaded with its current cargo. More...
 
 Vehicle (VehicleType type=VEH_INVALID)
 Vehicle constructor. More...
 
void PreDestructor ()
 Destroy all stuff that (still) needs the virtual functions to work properly.
 
virtual ~Vehicle ()
 We want to 'destruct' the right class.
 
void BeginLoading ()
 Prepare everything to begin the loading when arriving at a station. More...
 
void CancelReservation (StationID next, Station *st)
 Return all reserved cargo packets to the station and reset all packets staged for transfer. More...
 
void LeaveStation ()
 Perform all actions when leaving a station. More...
 
GroundVehicleCacheGetGroundVehicleCache ()
 Access the ground vehicle cache of the vehicle. More...
 
const GroundVehicleCacheGetGroundVehicleCache () const
 Access the ground vehicle cache of the vehicle. More...
 
uint16_t & GetGroundVehicleFlags ()
 Access the ground vehicle flags of the vehicle. More...
 
const uint16_t & GetGroundVehicleFlags () const
 Access the ground vehicle flags of the vehicle. More...
 
void DeleteUnreachedImplicitOrders ()
 Delete all implicit orders which were not reached.
 
void HandleLoading (bool mode=false)
 Handle the loading of the vehicle; when not it skips through dummy orders and does nothing in all other cases. More...
 
virtual void MarkDirty ()
 Marks the vehicles to be redrawn and updates cached variables. More...
 
virtual void UpdateDeltaXY ()
 Updates the x and y offsets and the size of the sprite used for this vehicle.
 
uint GetOldAdvanceSpeed (uint speed)
 Determines the effective direction-specific vehicle movement speed. More...
 
uint GetAdvanceDistance ()
 Determines the vehicle "progress" needed for moving a step. More...
 
virtual ExpensesType GetExpenseType ([[maybe_unused]] bool income) const
 Sets the expense type associated to this vehicle type. More...
 
virtual void PlayLeaveStationSound ([[maybe_unused]] bool force=false) const
 Play the sound associated with leaving the station. More...
 
virtual bool IsPrimaryVehicle () const
 Whether this is the primary vehicle in the chain.
 
const EngineGetEngine () const
 Retrieves the engine of the vehicle. More...
 
virtual void GetImage ([[maybe_unused]] Direction direction, [[maybe_unused]] EngineImageType image_type, [[maybe_unused]] VehicleSpriteSeq *result) const
 Gets the sprite to show for the given direction. More...
 
const GRFFileGetGRF () const
 Retrieve the NewGRF the vehicle is tied to. More...
 
uint32_t GetGRFID () const
 Retrieve the GRF ID of the NewGRF the vehicle is tied to. More...
 
void InvalidateNewGRFCache ()
 Invalidates cached NewGRF variables. More...
 
void InvalidateNewGRFCacheOfChain ()
 Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle) More...
 
debug_inline bool IsGroundVehicle () const
 Check if the vehicle is a ground vehicle. More...
 
virtual int GetDisplaySpeed () const
 Gets the speed in km-ish/h that can be sent into SetDParam for string processing. More...
 
virtual int GetDisplayMaxSpeed () const
 Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing. More...
 
virtual int GetCurrentMaxSpeed () const
 Calculates the maximum speed of the vehicle under its current conditions. More...
 
virtual Money GetRunningCost () const
 Gets the running cost of a vehicle. More...
 
virtual bool IsInDepot () const
 Check whether the vehicle is in the depot. More...
 
bool IsStoppedInDepot () const
 Check whether the vehicle is in the depot and stopped. More...
 
virtual bool Tick ()
 Calls the tick handler of the vehicle. More...
 
virtual void OnNewCalendarDay ()
 Calls the new calendar day handler of the vehicle.
 
virtual void OnNewEconomyDay ()
 Calls the new economy day handler of the vehicle.
 
void ShiftDates (TimerGameEconomy::Date interval)
 Shift all dates by given interval. More...
 
virtual Trackdir GetVehicleTrackdir () const
 Returns the Trackdir on which the vehicle is currently located. More...
 
Money GetDisplayRunningCost () const
 Gets the running cost of a vehicle that can be sent into SetDParam for string processing. More...
 
Money GetDisplayProfitThisYear () const
 Gets the profit vehicle had this year. More...
 
Money GetDisplayProfitLastYear () const
 Gets the profit vehicle had last year. More...
 
void SetNext (Vehicle *next)
 Set the next vehicle of this vehicle. More...
 
VehicleNext () const
 Get the next vehicle of this vehicle. More...
 
VehiclePrevious () const
 Get the previous vehicle of this vehicle. More...
 
VehicleFirst () const
 Get the first vehicle of this vehicle chain. More...
 
VehicleLast ()
 Get the last vehicle of this vehicle chain. More...
 
const VehicleLast () const
 Get the last vehicle of this vehicle chain. More...
 
VehicleMove (int n)
 Get the vehicle at offset n of this vehicle chain. More...
 
const VehicleMove (int n) const
 Get the vehicle at offset n of this vehicle chain. More...
 
OrderGetFirstOrder () const
 Get the first order of the vehicles order list. More...
 
void AddToShared (Vehicle *shared_chain)
 Adds this vehicle to a shared vehicle chain. More...
 
void RemoveFromShared ()
 Removes the vehicle from the shared order list.
 
VehicleNextShared () const
 Get the next vehicle of the shared vehicle chain. More...
 
VehiclePreviousShared () const
 Get the previous vehicle of the shared vehicle chain. More...
 
VehicleFirstShared () const
 Get the first vehicle of this vehicle chain. More...
 
bool IsOrderListShared () const
 Check if we share our orders with another vehicle. More...
 
VehicleOrderID GetNumOrders () const
 Get the number of orders this vehicle has. More...
 
VehicleOrderID GetNumManualOrders () const
 Get the number of manually added orders this vehicle has. More...
 
StationIDStack GetNextStoppingStation () const
 Get the next station the vehicle will stop at. More...
 
void ResetRefitCaps ()
 Reset all refit_cap in the consist to cargo_cap.
 
void ReleaseUnitNumber ()
 Release the vehicle's unit number.
 
void CopyVehicleConfigAndStatistics (Vehicle *src)
 Copy certain configurations and statistics of a vehicle after successful autoreplace/renew The function shall copy everything that cannot be copied by a command (like orders / group etc), and that shall not be resetted for the new vehicle. More...
 
bool HandleBreakdown ()
 Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds, and ending the breakdown when appropriate. More...
 
bool NeedsAutorenewing (const Company *c, bool use_renew_setting=true) const
 Function to tell if a vehicle needs to be autorenewed. More...
 
bool NeedsServicing () const
 Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for service or replacement. More...
 
bool NeedsAutomaticServicing () const
 Checks if the current order should be interrupted for a service-in-depot order. More...
 
virtual TileIndex GetOrderStationLocation ([[maybe_unused]] StationID station)
 Determine the location for the station where the vehicle goes to next. More...
 
virtual TileIndex GetCargoTile () const
 
virtual ClosestDepot FindClosestDepot ()
 Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should reverse. More...
 
virtual void SetDestTile (TileIndex tile)
 
CommandCost SendToDepot (DoCommandFlag flags, DepotCommand command)
 Send this vehicle to the depot using the given command(s). More...
 
void UpdateVisualEffect (bool allow_power_change=true)
 Update the cached visual effect. More...
 
void ShowVisualEffect () const
 Draw visual effects (smoke and/or sparks) for a vehicle chain. More...
 
void UpdatePosition ()
 Update the position of the vehicle. More...
 
void UpdateViewport (bool dirty)
 Update the vehicle on the viewport, updating the right hash and setting the new coordinates. More...
 
void UpdateBoundingBoxCoordinates (bool update_cache) const
 Update the bounding box co-ordinates of the vehicle. More...
 
void UpdatePositionAndViewport ()
 Update the position of the vehicle, and update the viewport.
 
bool MarkAllViewportsDirty () const
 Marks viewports dirty where the vehicle's image is. More...
 
uint16_t GetServiceInterval () const
 
void SetServiceInterval (uint16_t interval)
 
bool ServiceIntervalIsCustom () const
 
bool ServiceIntervalIsPercent () const
 
void SetServiceIntervalIsCustom (bool on)
 
void SetServiceIntervalIsPercent (bool on)
 
bool HasFullLoadOrder () const
 Check if the current vehicle has a full load order. More...
 
bool HasConditionalOrder () const
 Check if the current vehicle has a conditional order. More...
 
bool HasUnbunchingOrder () const
 Check if the current vehicle has an unbunching order. More...
 
void LeaveUnbunchingDepot ()
 Leave an unbunching depot and calculate the next departure time for shared order vehicles.
 
bool IsWaitingForUnbunching () const
 Check whether a vehicle inside a depot is waiting for unbunching. More...
 
void IncrementImplicitOrderIndex ()
 Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI. More...
 
void IncrementRealOrderIndex ()
 Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates the GUI. More...
 
void UpdateRealOrderIndex ()
 Skip implicit orders until cur_real_order_index is a non-implicit order.
 
OrderGetOrder (int index) const
 Returns order 'index' of a vehicle or nullptr when it doesn't exists. More...
 
OrderGetLastOrder () const
 Returns the last order of a vehicle, or nullptr if it doesn't exists. More...
 
bool IsEngineCountable () const
 Check if a vehicle is counted in num_engines in each company struct. More...
 
bool HasEngineType () const
 Check whether Vehicle::engine_type has any meaning. More...
 
bool HasDepotOrder () const
 Checks if a vehicle has a depot in its order list. More...
 
void HandlePathfindingResult (bool path_found)
 Handle the pathfinding result, especially the lost status. More...
 
debug_inline bool IsFrontEngine () const
 Check if the vehicle is a front engine. More...
 
bool IsArticulatedPart () const
 Check if the vehicle is an articulated part of an engine. More...
 
bool HasArticulatedPart () const
 Check if an engine has an articulated part. More...
 
VehicleGetNextArticulatedPart () const
 Get the next part of an articulated engine. More...
 
VehicleGetFirstEnginePart ()
 Get the first part of an articulated engine. More...
 
const VehicleGetFirstEnginePart () const
 Get the first part of an articulated engine. More...
 
VehicleGetLastEnginePart ()
 Get the last part of an articulated engine. More...
 
VehicleGetNextVehicle () const
 Get the next real (non-articulated part) vehicle in the consist. More...
 
VehicleGetPrevVehicle () const
 Get the previous real (non-articulated part) vehicle in the consist. More...
 
IterateWrapper Orders () const
 Returns an iterable ensemble of orders of a vehicle. More...
 
uint32_t GetDisplayMaxWeight () const
 Calculates the maximum weight of the ground vehicle when loaded. More...
 
uint32_t GetDisplayMinPowerToWeight () const
 Calculates the minimum power-to-weight ratio using the maximum weight of the ground vehicle. More...
 
- Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
void * operator new (size_t size)
 Allocates space for new Titem. More...
 
void * operator new (size_t size, size_t index)
 Allocates space for new Titem with given index. More...
 
void * operator new (size_t, void *ptr)
 Allocates space for new Titem at given memory address. More...
 
void operator delete (void *p)
 Marks Titem as free. More...
 
- Public Member Functions inherited from BaseConsist
void CopyConsistPropertiesFrom (const BaseConsist *src)
 Copy properties of other BaseConsist. More...
 
void ResetDepotUnbunching ()
 Resets all the data used for depot unbunching.
 

Data Fields

GroundVehicleCache gcache
 Cache of often calculated values.
 
uint16_t gv_flags
 
- Data Fields inherited from Vehicle
TileIndex tile
 Current tile index.
 
TileIndex dest_tile
 Heading for this tile. More...
 
Money profit_this_year
 Profit this year << 8, low 8 bits are fract.
 
Money profit_last_year
 Profit last year << 8, low 8 bits are fract.
 
Money value
 Value of the vehicle.
 
CargoPaymentcargo_payment
 The cargo payment we're currently in.
 
Rect coord
 NOSAVE: Graphical bounding box of the vehicle, i.e. what to redraw on moves.
 
Vehiclehash_viewport_next
 NOSAVE: Next vehicle in the visual location hash.
 
Vehicle ** hash_viewport_prev
 NOSAVE: Previous vehicle in the visual location hash.
 
Vehiclehash_tile_next
 NOSAVE: Next vehicle in the tile location hash.
 
Vehicle ** hash_tile_prev
 NOSAVE: Previous vehicle in the tile location hash.
 
Vehicle ** hash_tile_current
 NOSAVE: Cache of the current hash chain.
 
SpriteID colourmap
 NOSAVE: cached colour mapping.
 
TimerGameCalendar::Year build_year
 Year the vehicle has been built.
 
TimerGameCalendar::Date age
 Age in calendar days.
 
TimerGameEconomy::Date economy_age
 Age in economy days.
 
TimerGameCalendar::Date max_age
 Maximum age.
 
TimerGameEconomy::Date date_of_last_service
 Last economy date the vehicle had a service at a depot.
 
TimerGameCalendar::Date date_of_last_service_newgrf
 Last calendar date the vehicle had a service at a depot, unchanged by the date cheat to protect against unsafe NewGRF behavior.
 
uint16_t reliability
 Reliability.
 
uint16_t reliability_spd_dec
 Reliability decrease speed.
 
uint8_t breakdown_ctr
 Counter for managing breakdown events. More...
 
uint8_t breakdown_delay
 Counter for managing breakdown length.
 
uint8_t breakdowns_since_last_service
 Counter for the amount of breakdowns.
 
uint8_t breakdown_chance
 Current chance of breakdowns.
 
int32_t x_pos
 x coordinate.
 
int32_t y_pos
 y coordinate.
 
int32_t z_pos
 z coordinate.
 
Direction direction
 facing
 
Owner owner
 Which company owns the vehicle?
 
uint8_t spritenum
 currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == reserved for another custom sprite
 
uint8_t x_extent
 x-extent of vehicle bounding box
 
uint8_t y_extent
 y-extent of vehicle bounding box
 
uint8_t z_extent
 z-extent of vehicle bounding box
 
int8_t x_bb_offs
 x offset of vehicle bounding box
 
int8_t y_bb_offs
 y offset of vehicle bounding box
 
int8_t x_offs
 x offset for vehicle sprite
 
int8_t y_offs
 y offset for vehicle sprite
 
EngineID engine_type
 The type of engine used for this vehicle.
 
TextEffectID fill_percent_te_id
 a text-effect id to a loading indicator object
 
UnitID unitnumber
 unit number, for display purposes only
 
uint16_t cur_speed
 current speed
 
uint8_t subspeed
 fractional speed
 
uint8_t acceleration
 used by train & aircraft
 
uint32_t motion_counter
 counter to occasionally play a vehicle sound.
 
uint8_t progress
 The percentage (if divided by 256) this vehicle already crossed the tile unit.
 
uint8_t waiting_triggers
 Triggers to be yet matched before rerandomizing the random bits.
 
uint16_t random_bits
 Bits used for randomized variational spritegroups.
 
StationID last_station_visited
 The last station we stopped at.
 
StationID last_loading_station
 Last station the vehicle has stopped at and could possibly leave from with any cargo loaded.
 
TimerGameTick::TickCounter last_loading_tick
 Last TimerGameTick::counter tick that the vehicle has stopped at a station and could possibly leave with any cargo loaded.
 
VehicleCargoList cargo
 The cargo this vehicle is carrying.
 
CargoID cargo_type
 type of cargo this vehicle is carrying
 
uint8_t cargo_subtype
 Used for livery refits (NewGRF variations)
 
uint16_t cargo_cap
 total capacity
 
uint16_t refit_cap
 Capacity left over from before last refit.
 
uint16_t cargo_age_counter
 Ticks till cargo is aged next.
 
int8_t trip_occupancy
 NOSAVE: Occupancy of vehicle of the current trip (updated after leaving a station).
 
uint8_t day_counter
 Increased by one for each day.
 
uint8_t tick_counter
 Increased by one for each tick.
 
uint8_t running_ticks
 Number of ticks this vehicle was not stopped this day.
 
uint16_t load_unload_ticks
 Ticks to wait before starting next cycle.
 
uint8_t vehstatus
 Status.
 
uint8_t subtype
 subtype (Filled with values from AircraftSubType/DisasterSubType/EffectVehicleType/GroundVehicleSubtypeFlags)
 
Order current_order
 The current order (+ status, like: loading)
 
union {
   OrderList *   orders
 Pointer to the order list for this vehicle.
 
   Order *   old_orders
 Only used during conversion of old save games.
 
}; 
 
NewGRFCache grf_cache
 Cache of often used calculated NewGRF values.
 
VehicleCache vcache
 Cache of often used vehicle values.
 
GroupID group_id
 Index of group Pool array.
 
MutableSpriteCache sprite_cache
 Cache of sprites and values related to recalculating them, see MutableSpriteCache.
 
- Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
Tindex index
 Index of this pool item.
 
- Data Fields inherited from BaseVehicle
VehicleType type
 Type of vehicle.
 
- Data Fields inherited from BaseConsist
std::string name
 Name of vehicle.
 
TimerGameTick::Ticks current_order_time
 How many ticks have passed since this order started.
 
TimerGameTick::Ticks lateness_counter
 How many ticks late (or early if negative) this vehicle is.
 
TimerGameTick::TickCounter timetable_start
 At what tick of TimerGameTick::counter the vehicle should start its timetable.
 
TimerGameTick::TickCounter depot_unbunching_last_departure
 When the vehicle last left its unbunching depot.
 
TimerGameTick::TickCounter depot_unbunching_next_departure
 When the vehicle will next try to leave its unbunching depot.
 
TimerGameTick::Ticks round_trip_time
 How many ticks for a single circumnavigation of the orders.
 
uint16_t service_interval
 The interval for (automatic) servicing; either in days or %.
 
VehicleOrderID cur_real_order_index
 The index to the current real (non-implicit) order.
 
VehicleOrderID cur_implicit_order_index
 The index to the current implicit order.
 
uint16_t vehicle_flags
 Used for gradual loading and other miscellaneous things (. More...
 

Protected Member Functions

uint DoUpdateSpeed (uint accel, int min_speed, int max_speed)
 Update the speed of the vehicle. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecializedVehicle< T, Type >
static bool IsValidID (size_t index)
 Tests whether given index is a valid index for vehicle of this type. More...
 
static T * Get (size_t index)
 Gets vehicle with given index. More...
 
static T * GetIfValid (size_t index)
 Returns vehicle if the index is a valid index for this vehicle type. More...
 
static T * From (Vehicle *v)
 Converts a Vehicle to SpecializedVehicle with type checking. More...
 
static const T * From (const Vehicle *v)
 Converts a const Vehicle to const SpecializedVehicle with type checking. More...
 
static Pool::IterateWrapper< T > Iterate (size_t from=0)
 Returns an iterable ensemble of all valid vehicles of type T. More...
 
- Static Public Member Functions inherited from Vehicle
static uint GetAdvanceSpeed (uint speed)
 Determines the effective vehicle movement speed. More...
 
- Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
static bool CanAllocateItem (size_t n=1)
 Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More...
 
static bool CleaningPool ()
 Returns current state of pool cleaning - yes or no. More...
 
static bool IsValidID (size_t index)
 Tests whether given index can be used to get valid (non-nullptr) Titem. More...
 
static Titem * Get (size_t index)
 Returns Titem with given index. More...
 
static Titem * GetIfValid (size_t index)
 Returns Titem with given index. More...
 
static size_t GetPoolSize ()
 Returns first unused index. More...
 
static size_t GetNumItems ()
 Returns number of valid items in the pool. More...
 
static void PostDestructor ([[maybe_unused]] size_t index)
 Dummy function called after destructor of each member. More...
 
static Pool::IterateWrapper< Titem > Iterate (size_t from=0)
 Returns an iterable ensemble of all valid Titem. More...
 
- Static Public Attributes inherited from SpecializedVehicle< T, Type >
static const VehicleType EXPECTED_TYPE = Type
 Specialized type.
 

Detailed Description

template<class T, VehicleType Type>
struct GroundVehicle< T, Type >

Base class for all vehicles that move through ground.

Child classes must define all of the following functions. These functions are not defined as pure virtual functions at this class to improve performance.

virtual uint16_t GetPower() const = 0; virtual uint16_t GetPoweredPartPower(const T *head) const = 0; virtual uint16_t GetWeight() const = 0; virtual uint8_t GetTractiveEffort() const = 0; virtual uint8_t GetAirDrag() const = 0; virtual uint8_t GetAirDragArea() const = 0; virtual AccelStatus GetAccelerationStatus() const = 0; virtual uint16_t GetCurrentSpeed() const = 0; virtual uint32_t GetRollingFriction() const = 0; virtual int GetAccelerationType() const = 0; virtual int32_t GetSlopeSteepness() const = 0; virtual int GetDisplayMaxSpeed() const = 0; virtual uint16_t GetMaxTrackSpeed() const = 0; virtual bool TileMayHaveSlopedTrack() const = 0;

Definition at line 82 of file ground_vehicle.hpp.

Member Function Documentation

◆ CargoChanged()

template<class T , VehicleType Type>
void GroundVehicle< T, Type >::CargoChanged

Recalculates the cached weight of a vehicle and its parts.

Should be called each time the cargo on the consist changes.

Definition at line 79 of file ground_vehicle.cpp.

◆ Crash()

template<class T , VehicleType Type>
uint GroundVehicle< T, Type >::Crash ( bool  flooded)
inlineoverridevirtual

Common code executed for crashed ground vehicles.

Parameters
floodedwas this vehicle flooded?
Returns
number of victims

Reimplemented from Vehicle.

Definition at line 103 of file ground_vehicle.hpp.

Referenced by RoadVehicle::Crash(), and Train::Crash().

◆ DoUpdateSpeed()

template<class T , VehicleType Type>
uint GroundVehicle< T, Type >::DoUpdateSpeed ( uint  accel,
int  min_speed,
int  max_speed 
)
inlineprotected

Update the speed of the vehicle.

It updates the cur_speed and subspeed variables depending on the state of the vehicle; in this case the current acceleration, minimum and maximum speeds of the vehicle. It returns the distance that that the vehicle can drive this tick. Vehicle::GetAdvanceDistance() determines the distance to drive before moving a step on the map.

Parameters
accelThe acceleration we would like to give this vehicle.
min_speedThe minimum speed here, in vehicle specific units.
max_speedThe maximum speed here, in vehicle specific units.
Returns
Distance to drive.

Definition at line 365 of file ground_vehicle.hpp.

References Vehicle::cur_speed, Vehicle::GetAdvanceSpeed(), Vehicle::progress, and Vehicle::subspeed.

◆ GetAcceleration()

template<class T , VehicleType Type>
int GroundVehicle< T, Type >::GetAcceleration

Calculates the acceleration of the vehicle under its current conditions.

Returns
Current acceleration of the vehicle.

Definition at line 105 of file ground_vehicle.cpp.

◆ GetSlopeResistance()

template<class T , VehicleType Type>
int64_t GroundVehicle< T, Type >::GetSlopeResistance ( ) const
inline

Calculates the total slope resistance for this vehicle.

Returns
Slope resistance.

Definition at line 117 of file ground_vehicle.hpp.

◆ IsChainInDepot()

template<class T , VehicleType Type>
bool GroundVehicle< T, Type >::IsChainInDepot
overridevirtual

Check whether the whole vehicle chain is in the depot.

Returns
true if and only if the whole chain is in the depot.

Reimplemented from Vehicle.

Definition at line 190 of file ground_vehicle.cpp.

Referenced by CheckIfTrainNeedsService(), and CmdForceTrainProceed().

◆ IsEngine()

template<class T , VehicleType Type>
bool GroundVehicle< T, Type >::IsEngine ( ) const
inline

Check if a vehicle is an engine (can be first in a consist).

Returns
Returns true if vehicle is an engine.

Definition at line 318 of file ground_vehicle.hpp.

References GVSF_ENGINE, HasBit(), and Vehicle::subtype.

Referenced by CheckNewTrain(), CheckTrainAttachment(), CmdMoveRailVehicle(), CmdSellRailWagon(), ConnectMultiheadedTrains(), GroundVehicle< T, Type >::IsRearDualheaded(), NormaliseDualHeads(), NormaliseSubtypes(), and NormalizeTrainVehInDepot().

◆ IsFreeWagon()

template<class T , VehicleType Type>
bool GroundVehicle< T, Type >::IsFreeWagon ( ) const
inline

Check if the vehicle is a free wagon (got no engine in front of it).

Returns
Returns true if the vehicle is a free wagon.

Definition at line 312 of file ground_vehicle.hpp.

References GVSF_FREE_WAGON, HasBit(), and Vehicle::subtype.

Referenced by AfterLoadVehiclesPhase2(), BuildDepotVehicleListProc(), DepotWindow::DrawVehicleInDepot(), and UpdateTrainGroupID().

◆ IsMultiheaded()

template<class T , VehicleType Type>
bool GroundVehicle< T, Type >::IsMultiheaded ( ) const
inline

Check if the vehicle is a multiheaded engine.

Returns
Returns true if the vehicle is a multiheaded engine.

Definition at line 330 of file ground_vehicle.hpp.

References GVSF_MULTIHEADED, HasBit(), and Vehicle::subtype.

Referenced by ArrangeTrains(), CmdReverseTrainDirection(), ConnectMultiheadedTrains(), GetVehicleSet(), GroundVehicle< T, Type >::IsRearDualheaded(), IterateVehicleParts(), and NormaliseDualHeads().

◆ IsRearDualheaded()

template<class T , VehicleType Type>
bool GroundVehicle< T, Type >::IsRearDualheaded ( ) const
inline

Tell if we are dealing with the rear end of a multiheaded engine.

Returns
True if the engine is the rear part of a dualheaded engine.

Definition at line 336 of file ground_vehicle.hpp.

References GroundVehicle< T, Type >::IsEngine(), and GroundVehicle< T, Type >::IsMultiheaded().

Referenced by BuildDepotVehicleListProc(), CheckTrainAttachment(), CmdAutoreplaceVehicle(), CmdSellRailWagon(), Train::GetNextUnit(), Train::GetPrevUnit(), and ReplaceFreeUnit().

◆ IsWagon()

template<class T , VehicleType Type>
bool GroundVehicle< T, Type >::IsWagon ( ) const
inline

Check if a vehicle is a wagon.

Returns
Returns true if vehicle is a wagon.

Definition at line 324 of file ground_vehicle.hpp.

References GVSF_WAGON, HasBit(), and Vehicle::subtype.

Referenced by NormaliseSubtypes().

◆ PowerChanged()

template<class T , VehicleType Type>
void GroundVehicle< T, Type >::PowerChanged

Recalculates the cached total power of a vehicle.

Should be called when the consist is changed.

Definition at line 21 of file ground_vehicle.cpp.

◆ SetLastSpeed()

template<class T , VehicleType Type>
void GroundVehicle< T, Type >::SetLastSpeed ( )
inline

Update the GUI variant of the current speed of the vehicle.

Also mark the widget dirty when that is needed, i.e. when the speed of this vehicle has changed.

Definition at line 343 of file ground_vehicle.hpp.

References Vehicle::cur_speed, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, GroundVehicleCache::last_speed, SetWindowWidgetDirty(), WC_VEHICLE_VIEW, and WID_VV_START_STOP.

Referenced by MarkTrainAsStuck().

◆ UpdateInclination()

template<class T , VehicleType Type>
int GroundVehicle< T, Type >::UpdateInclination ( bool  new_tile,
bool  update_delta 
)
inline

Checks if the vehicle is in a slope and sets the required flags in that case.

Parameters
new_tileTrue if the vehicle reached a new tile.
update_deltaIndicates to also update the delta.
Returns
Old height of the vehicle.

Definition at line 234 of file ground_vehicle.hpp.

References SpecializedVehicle< T, Type >::UpdateViewport(), GroundVehicle< T, Type >::UpdateZPosition(), GroundVehicle< T, Type >::UpdateZPositionAndInclination(), and Vehicle::z_pos.

Referenced by UpdateStatusAfterSwap().

◆ UpdateZPosition()

template<class T , VehicleType Type>
void GroundVehicle< T, Type >::UpdateZPosition ( )
inline

Updates vehicle's Z position.

Inclination can't change in the middle of a tile. The faster code is used for trains and road vehicles unless they are reversing on a sloped tile.

Definition at line 163 of file ground_vehicle.hpp.

References AXIS_X, DIAGDIR_NE, DIAGDIR_NW, DiagDirToAxis(), DIR_NE, DIR_NW, DIR_SE, DIR_SW, Vehicle::direction, DirToDiagDir(), GetSlopePixelZ(), GVF_GOINGDOWN_BIT, GVF_GOINGUP_BIT, HasBit(), Vehicle::x_pos, Vehicle::y_pos, and Vehicle::z_pos.

Referenced by GroundVehicle< T, Type >::UpdateInclination().

◆ UpdateZPositionAndInclination()

template<class T , VehicleType Type>
void GroundVehicle< T, Type >::UpdateZPositionAndInclination ( )
inline

Updates vehicle's Z position and inclination.

Used when the vehicle entered given tile.

Precondition
The vehicle has to be at (or near to) a border of the tile, directed towards tile centre

Definition at line 138 of file ground_vehicle.hpp.

References ClrBit(), GetSlopePixelZ(), GVF_GOINGDOWN_BIT, GVF_GOINGUP_BIT, SetBit(), TILE_SIZE, TILE_UNIT_MASK, Vehicle::x_pos, Vehicle::y_pos, and Vehicle::z_pos.

Referenced by GroundVehicle< T, Type >::UpdateInclination().

Field Documentation

◆ gv_flags

template<class T , VehicleType Type>
uint16_t GroundVehicle< T, Type >::gv_flags
See also
GroundVehicleFlags.

Definition at line 84 of file ground_vehicle.hpp.

Referenced by VehicleOrderSaver::Restore().


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