RoadVehicle Struct Referencefinal
Buses, trucks and trams belong to this class. More...
#include <roadveh.h>
Inheritance diagram for RoadVehicle:
Public Member Functions | |
| RoadVehicle () | |
| We don't want GCC to zero our struct! It already is zeroed and has an index! | |
| virtual | ~RoadVehicle () |
| We want to 'destruct' the right class. | |
| void | MarkDirty () override |
| Marks the vehicles to be redrawn and updates cached variables. More... | |
| void | UpdateDeltaXY () override |
| Updates the x and y offsets and the size of the sprite used for this vehicle. | |
| ExpensesType | GetExpenseType (bool income) const override |
| bool | IsPrimaryVehicle () const override |
| Whether this is the primary vehicle in the chain. | |
| void | GetImage (Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override |
| int | GetDisplaySpeed () const override |
| Gets the speed in km-ish/h that can be sent into SetDParam for string processing. More... | |
| int | GetDisplayMaxSpeed () const override |
| Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing. More... | |
| Money | GetRunningCost () const override |
| Gets the running cost of a vehicle. More... | |
| int | GetDisplayImageWidth (Point *offset=nullptr) const |
| Get the width of a road vehicle image in the GUI. More... | |
| bool | IsInDepot () const override |
| Check whether the vehicle is in the depot. More... | |
| bool | Tick () override |
| Calls the tick handler of the vehicle. More... | |
| void | OnNewCalendarDay () override |
| Calandar day handler. | |
| void | OnNewEconomyDay () override |
| Economy day handler. | |
| uint | Crash (bool flooded=false) override |
| Crash the (whole) vehicle chain. More... | |
| Trackdir | GetVehicleTrackdir () const override |
| Returns the Trackdir on which the vehicle is currently located. More... | |
| TileIndex | GetOrderStationLocation (StationID station) override |
| ClosestDepot | FindClosestDepot () override |
| Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should reverse. More... | |
| bool | IsBus () const |
| Check whether a roadvehicle is a bus. More... | |
| int | GetCurrentMaxSpeed () const override |
| Calculates the maximum speed of the vehicle under its current conditions. More... | |
| int | UpdateSpeed () |
| This function looks at the vehicle and updates its speed (cur_speed and subspeed) variables. More... | |
| void | SetDestTile (TileIndex tile) override |
 Public Member Functions inherited from GroundVehicle< RoadVehicle, VEH_ROAD > | |
| 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< RoadVehicle, Type > | |
| SpecializedVehicle () | |
| Set vehicle type correctly. | |
| RoadVehicle * | First () const |
| Get the first vehicle in the chain. More... | |
| RoadVehicle * | Last () |
| Get the last vehicle in the chain. More... | |
| const RoadVehicle * | Last () const |
| Get the last vehicle in the chain. More... | |
| RoadVehicle * | Next () const |
| Get next vehicle in the chain. More... | |
| RoadVehicle * | Previous () const |
| Get previous vehicle in the chain. More... | |
| RoadVehicle * | GetNextArticulatedPart () |
| Get the next part of an articulated engine. More... | |
| RoadVehicle * | GetNextArticulatedPart () const |
| Get the next part of an articulated engine. More... | |
| RoadVehicle * | GetFirstEnginePart () |
| Get the first part of an articulated engine. More... | |
| const RoadVehicle * | GetFirstEnginePart () const |
| Get the first part of an articulated engine. More... | |
| RoadVehicle * | GetLastEnginePart () |
| Get the last part of an articulated engine. More... | |
| RoadVehicle * | GetNextVehicle () const |
| Get the next real (non-articulated part) vehicle in the consist. More... | |
| RoadVehicle * | 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 | |
| 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... | |
| GroundVehicleCache * | GetGroundVehicleCache () |
| Access the ground vehicle cache of the vehicle. More... | |
| const GroundVehicleCache * | GetGroundVehicleCache () const |
| uint16_t & | GetGroundVehicleFlags () |
| Access the ground vehicle flags of the vehicle. More... | |
| const uint16_t & | GetGroundVehicleFlags () const |
| 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... | |
| 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... | |
| const Engine * | GetEngine () 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 GRFFile * | GetGRF () 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 bool | IsChainInDepot () const |
| Check whether the whole vehicle chain is in the depot. More... | |
| bool | IsStoppedInDepot () const |
| Check whether the vehicle is in the depot and stopped. More... | |
| void | ShiftDates (TimerGameEconomy::Date interval) |
| Shift all dates by given interval. 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... | |
| Vehicle * | Next () const |
| Get the next vehicle of this vehicle. More... | |
| Vehicle * | Previous () const |
| Get the previous vehicle of this vehicle. More... | |
| Vehicle * | First () const |
| Get the first vehicle of this vehicle chain. More... | |
| Vehicle * | Last () |
| Get the last vehicle of this vehicle chain. More... | |
| const Vehicle * | Last () const |
| Get the last vehicle of this vehicle chain. More... | |
| Vehicle * | Move (int n) |
| Get the vehicle at offset n of this vehicle chain. More... | |
| const Vehicle * | Move (int n) const |
| Get the vehicle at offset n of this vehicle chain. More... | |
| Order * | GetFirstOrder () 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. | |
| Vehicle * | NextShared () const |
| Get the next vehicle of the shared vehicle chain. More... | |
| Vehicle * | PreviousShared () const |
| Get the previous vehicle of the shared vehicle chain. More... | |
| Vehicle * | FirstShared () 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 |
| 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. | |
| Order * | GetOrder (int index) const |
| Returns order 'index' of a vehicle or nullptr when it doesn't exists. More... | |
| Order * | GetLastOrder () 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... | |
| Vehicle * | GetNextArticulatedPart () const |
| Get the next part of an articulated engine. More... | |
| Vehicle * | GetFirstEnginePart () |
| Get the first part of an articulated engine. More... | |
| const Vehicle * | GetFirstEnginePart () const |
| Get the first part of an articulated engine. More... | |
| Vehicle * | GetLastEnginePart () |
| Get the last part of an articulated engine. More... | |
| Vehicle * | GetNextVehicle () const |
| Get the next real (non-articulated part) vehicle in the consist. More... | |
| Vehicle * | GetPrevVehicle () 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 | |
| RoadVehPathCache | path |
| Cached path. | |
| uint8_t | state |
| uint8_t | frame |
| uint16_t | blocked_ctr |
| uint8_t | overtaking |
| Set to RVSB_DRIVE_SIDE when overtaking, otherwise 0. | |
| uint8_t | overtaking_ctr |
| The length of the current overtake attempt. | |
| uint16_t | crashed_ctr |
| Animation counter when the vehicle has crashed. More... | |
| uint8_t | reverse_ctr |
| RoadType | roadtype |
| NOSAVE: Roadtype of this vehicle. | |
| VehicleID | disaster_vehicle = INVALID_VEHICLE |
| NOSAVE: Disaster vehicle targetting this vehicle. | |
| RoadTypes | compatible_roadtypes |
| NOSAVE: Roadtypes this consist is powered on. | |
| Data Fields inherited from GroundVehicle< RoadVehicle, VEH_ROAD > | |
| 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. | |
| CargoPayment * | cargo_payment |
| The cargo payment we're currently in. | |
| Rect | coord |
| NOSAVE: Graphical bounding box of the vehicle, i.e. what to redraw on moves. | |
| Vehicle * | hash_viewport_next |
| NOSAVE: Next vehicle in the visual location hash. | |
| Vehicle ** | hash_viewport_prev |
| NOSAVE: Previous vehicle in the visual location hash. | |
| Vehicle * | hash_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 | |
| uint16_t | GetPower () const |
| Allows to know the power value that this vehicle will use. More... | |
| uint16_t | GetPoweredPartPower (const RoadVehicle *) const |
| Returns a value if this articulated part is powered. More... | |
| uint16_t | GetWeight () const |
| Allows to know the weight value that this vehicle will use. More... | |
| uint16_t | GetMaxWeight () const override |
| Calculates the weight value that this vehicle will have when fully loaded with its current cargo. More... | |
| uint8_t | GetTractiveEffort () const |
| Allows to know the tractive effort value that this vehicle will use. More... | |
| uint8_t | GetAirDragArea () const |
| Gets the area used for calculating air drag. More... | |
| uint8_t | GetAirDrag () const |
| Gets the air drag coefficient of this vehicle. More... | |
| AccelStatus | GetAccelerationStatus () const |
| Checks the current acceleration status of this vehicle. More... | |
| uint16_t | GetCurrentSpeed () const |
| Calculates the current speed of this vehicle. More... | |
| uint32_t | GetRollingFriction () const |
| Returns the rolling friction coefficient of this vehicle. More... | |
| int | GetAccelerationType () const |
| Allows to know the acceleration type of a vehicle. More... | |
| uint32_t | GetSlopeSteepness () const |
| Returns the slope steepness used by this vehicle. More... | |
| uint16_t | GetMaxTrackSpeed () const |
| Gets the maximum speed allowed by the track for this vehicle. More... | |
| bool | TileMayHaveSlopedTrack () const |
| Checks if the vehicle is at a tile that can be sloped. More... | |
| bool | HasToUseGetSlopePixelZ () |
| Road vehicles have to use GetSlopePixelZ() to compute their height if they are reversing because in that case, their direction is not parallel with the road. More... | |
| Protected Member Functions inherited from GroundVehicle< RoadVehicle, VEH_ROAD > | |
| uint | DoUpdateSpeed (uint accel, int min_speed, int max_speed) |
| Update the speed of the vehicle. More... | |
Friends | |
| struct | GroundVehicle< RoadVehicle, VEH_ROAD > |
Additional Inherited Members | |
| Public Types inherited from GroundVehicle< RoadVehicle, VEH_ROAD > | |
| typedef GroundVehicle< RoadVehicle, Type > | GroundVehicleBase |
| Our type. | |
| Public Types inherited from SpecializedVehicle< RoadVehicle, Type > | |
| typedef SpecializedVehicle< RoadVehicle, 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. | |
| Static Public Member Functions inherited from SpecializedVehicle< RoadVehicle, Type > | |
| static bool | IsValidID (size_t index) |
| Tests whether given index is a valid index for vehicle of this type. More... | |
| static RoadVehicle * | Get (size_t index) |
| Gets vehicle with given index. More... | |
| static RoadVehicle * | GetIfValid (size_t index) |
| Returns vehicle if the index is a valid index for this vehicle type. More... | |
| static RoadVehicle * | From (Vehicle *v) |
| Converts a Vehicle to SpecializedVehicle with type checking. More... | |
| static const RoadVehicle * | From (const Vehicle *v) |
| Converts a const Vehicle to const SpecializedVehicle with type checking. More... | |
| static Pool::IterateWrapper< RoadVehicle > | 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< RoadVehicle, Type > | |
| static const VehicleType | EXPECTED_TYPE |
| Specialized type. | |
Detailed Description
Member Function Documentation
◆ Crash()
|
overridevirtual |
Crash the (whole) vehicle chain.
- Parameters
-
flooded whether the cause of the crash is flooding or not.
- Returns
- the number of lost souls.
Reimplemented from Vehicle.
Definition at line 529 of file roadveh_cmd.cpp.
References GroundVehicle< T, Type >::Crash(), Vehicle::IsFrontEngine(), IsInsideMM(), RVSB_IN_DT_ROAD_STOP, and state.
◆ FindClosestDepot()
|
overridevirtual |
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should reverse.
- Returns
- A structure with information about the closest depot, if found.
Reimplemented from Vehicle.
Definition at line 347 of file roadveh_cmd.cpp.
◆ GetAccelerationStatus()
|
inlineprotected |
Checks the current acceleration status of this vehicle.
- Returns
- Acceleration status.
Definition at line 231 of file roadveh.h.
References AS_ACCEL, AS_BRAKE, Vehicle::vehstatus, and VS_STOPPED.
◆ GetAccelerationType()
|
inlineprotected |
◆ GetAirDrag()
|
inlineprotected |
◆ GetAirDragArea()
|
inlineprotected |
◆ GetCurrentMaxSpeed()
|
inlineoverridevirtual |
Calculates the maximum speed of the vehicle under its current conditions.
- Returns
- Maximum speed of the vehicle.
Reimplemented from Vehicle.
Definition at line 436 of file roadveh_cmd.cpp.
References _settings_game, GroundVehicleCache::cached_max_track_speed, GroundVehicle< RoadVehicle, VEH_ROAD >::gcache, SpecializedVehicle< T, Type >::Next(), VehicleSettings::roadveh_acceleration_model, and GameSettings::vehicle.
◆ GetCurrentSpeed()
|
inlineprotected |
◆ GetDisplayImageWidth()
| int RoadVehicle::GetDisplayImageWidth | ( | Point * | offset = nullptr | ) | const |
Get the width of a road vehicle image in the GUI.
- Parameters
-
offset Additional offset for positioning the sprite; set to nullptr if not needed
- Returns
- Width in pixels
Definition at line 93 of file roadveh_cmd.cpp.
Referenced by NewGRFInspectWindow::DrawVehicleChainWidget(), and GetSingleVehicleWidth().
◆ GetDisplayMaxSpeed()
|
inlineoverridevirtual |
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
- Returns
- the vehicle's maximum speed
Reimplemented from Vehicle.
Definition at line 133 of file roadveh.h.
References VehicleCache::cached_max_speed, and Vehicle::vcache.
◆ GetDisplaySpeed()
|
inlineoverridevirtual |
Gets the speed in km-ish/h that can be sent into SetDParam for string processing.
- Returns
- the vehicle's speed
Reimplemented from Vehicle.
Definition at line 132 of file roadveh.h.
References GroundVehicle< RoadVehicle, VEH_ROAD >::gcache, and GroundVehicleCache::last_speed.
◆ GetMaxTrackSpeed()
|
inlineprotected |
◆ GetMaxWeight()
|
overrideprotectedvirtual |
Calculates the weight value that this vehicle will have when fully loaded with its current cargo.
- Returns
- Weight value in tonnes.
Reimplemented from Vehicle.
Definition at line 1760 of file roadveh_cmd.cpp.
◆ GetPower()
|
inlineprotected |
◆ GetPoweredPartPower()
|
inlineprotected |
◆ GetRollingFriction()
|
inlineprotected |
◆ GetRunningCost()
|
overridevirtual |
Gets the running cost of a vehicle.
- Returns
- the vehicle's running cost
Reimplemented from Vehicle.
Definition at line 1635 of file roadveh_cmd.cpp.
References Vehicle::GetEngine().
◆ GetSlopeSteepness()
|
inlineprotected |
Returns the slope steepness used by this vehicle.
- Returns
- Slope steepness used by the vehicle.
Definition at line 272 of file roadveh.h.
References _settings_game, VehicleSettings::roadveh_slope_steepness, and GameSettings::vehicle.
◆ GetTractiveEffort()
|
inlineprotected |
◆ GetVehicleTrackdir()
|
overridevirtual |
Returns the Trackdir on which the vehicle is currently located.
Works for trains and ships. Currently works only sortof for road vehicles, since they have a fuzzy concept of being "on" a trackdir. Dunno really what it returns for a road vehicle that is halfway a tile, never really understood that part. For road vehicles that are at the beginning or end of the tile, should just return the diagonal trackdir on which they are driving. I think. For other vehicles types, or vehicles with no clear trackdir (such as those in depots), returns 0xFF.
- Returns
- the trackdir of the vehicle
Reimplemented from Vehicle.
Definition at line 1738 of file roadveh_cmd.cpp.
References DiagDirToDiagTrackdir(), DirToDiagDir(), GetRoadDepotDirection(), GetRoadStopDir(), INVALID_TRACKDIR, IsBayRoadStopTile(), IsInDepot(), IsReversingRoadTrackdir(), RVSB_TRACKDIR_MASK, state, Vehicle::vehstatus, and VS_CRASHED.
Referenced by CYapfFollowRoadT< Types >::SetOriginFromVehiclePos(), and YapfRoadVehicleFindNearestDepot().
◆ GetWeight()
|
inlineprotected |
◆ HasToUseGetSlopePixelZ()
|
inlineprotected |
Road vehicles have to use GetSlopePixelZ() to compute their height if they are reversing because in that case, their direction is not parallel with the road.
It is safe to return true even if it is not reversing.
- Returns
- are we (possibly) reversing?
Definition at line 305 of file roadveh.h.
References Vehicle::direction, SpecializedVehicle< RoadVehicle, Type >::First(), IsReversingRoadTrackdir(), SpecializedVehicle< T, Type >::Next(), RVSB_TRACKDIR_MASK, and state.
◆ IsBus()
| bool RoadVehicle::IsBus | ( | ) | const |
Check whether a roadvehicle is a bus.
- Returns
- true if bus
Definition at line 82 of file roadveh_cmd.cpp.
References Vehicle::cargo_type, CC_PASSENGERS, IsCargoInClass(), and Vehicle::IsFrontEngine().
Referenced by GetVehicleCannotUseStationReason(), and RoadVehArrivesAt().
◆ IsInDepot()
|
inlineoverridevirtual |
Check whether the vehicle is in the depot.
- Returns
- true if and only if the vehicle is in the depot.
Reimplemented from Vehicle.
Definition at line 136 of file roadveh.h.
References RVSB_IN_DEPOT.
Referenced by CmdTurnRoadVeh(), and GetVehicleTrackdir().
◆ MarkDirty()
|
overridevirtual |
Marks the vehicles to be redrawn and updates cached variables.
This method marks the area of the vehicle on the screen as dirty. It can be use to repaint the vehicle.
Reimplemented from Vehicle.
Definition at line 396 of file roadveh_cmd.cpp.
References Vehicle::colourmap, and SpecializedVehicle< T, Type >::Next().
◆ Tick()
|
overridevirtual |
Calls the tick handler of the vehicle.
- Returns
- is this vehicle still valid?
Reimplemented from Vehicle.
Definition at line 1646 of file roadveh_cmd.cpp.
References Vehicle::IsFrontEngine(), PFE_GL_ROADVEHS, Vehicle::running_ticks, Vehicle::tick_counter, Vehicle::vehstatus, and VS_STOPPED.
◆ TileMayHaveSlopedTrack()
|
inlineprotected |
Checks if the vehicle is at a tile that can be sloped.
- Returns
- True if the tile can be sloped.
Definition at line 290 of file roadveh.h.
References GetTileTrackStatus(), Vehicle::tile, and TRANSPORT_ROAD.
◆ UpdateSpeed()
| int RoadVehicle::UpdateSpeed | ( | ) |
This function looks at the vehicle and updates its speed (cur_speed and subspeed) variables.
Furthermore, it returns the distance that the vehicle can drive this tick. Vehicle::GetAdvanceDistance() determines the distance to drive before moving a step on the map.
- Returns
- distance to drive.
Definition at line 726 of file roadveh_cmd.cpp.
References _settings_game, VehicleSettings::roadveh_acceleration_model, and GameSettings::vehicle.
Field Documentation
◆ crashed_ctr
| uint16_t RoadVehicle::crashed_ctr |
Animation counter when the vehicle has crashed.
- See also
- RoadVehIsCrashed
Definition at line 113 of file roadveh.h.
Referenced by RoadVehIsCrashed().
◆ state
| uint8_t RoadVehicle::state |
- See also
- RoadVehicleStates
Definition at line 108 of file roadveh.h.
Referenced by CmdTurnRoadVeh(), Crash(), DeleteLastRoadVeh(), RoadStop::Enter(), FindVehiclesInRoadStop(), GetVehicleTrackdir(), HasToUseGetSlopePixelZ(), and RoadStop::Leave().
The documentation for this struct was generated from the following files:
- src/roadveh.h
- src/roadveh_cmd.cpp
