Vehicle data structure. More...
#include <vehicle_base.h>
Public Member Functions | |
Vehicle (VehicleType type=VEH_INVALID) | |
Vehicle constructor. | |
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. | |
void | CancelReservation (StationID next, Station *st) |
Return all reserved cargo packets to the station. | |
void | LeaveStation () |
Perform all actions when leaving a station. | |
GroundVehicleCache * | GetGroundVehicleCache () |
Access the ground vehicle cache of the vehicle. | |
const GroundVehicleCache * | GetGroundVehicleCache () const |
Access the ground vehicle cache of the vehicle. | |
uint16 & | GetGroundVehicleFlags () |
Access the ground vehicle flags of the vehicle. | |
const uint16 & | GetGroundVehicleFlags () const |
Access the ground vehicle flags of the vehicle. | |
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. | |
bool | IsDrawn () const |
Is this vehicle drawn? | |
virtual void | MarkDirty () |
Marks the vehicles to be redrawn and updates cached variables. | |
virtual void | UpdateDeltaXY (Direction direction) |
Updates the x and y offsets and the size of the sprite used for this vehicle. | |
FORCEINLINE uint | GetOldAdvanceSpeed (uint speed) |
Determines the effective direction-specific vehicle movement speed. | |
FORCEINLINE uint | GetAdvanceDistance () |
Determines the vehicle "progress" needed for moving a step. | |
virtual ExpensesType | GetExpenseType (bool income) const |
Sets the expense type associated to this vehicle type. | |
virtual void | PlayLeaveStationSound () const |
Play the sound associated with leaving the station. | |
virtual bool | IsPrimaryVehicle () const |
Whether this is the primary vehicle in the chain. | |
virtual SpriteID | GetImage (Direction direction) const |
Gets the sprite to show for the given direction. | |
FORCEINLINE void | InvalidateNewGRFCache () |
Invalidates cached NewGRF variables. | |
FORCEINLINE void | InvalidateNewGRFCacheOfChain () |
Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle). | |
FORCEINLINE bool | IsGroundVehicle () const |
Check if the vehicle is a ground vehicle. | |
virtual int | GetDisplaySpeed () const |
Gets the speed in km-ish/h that can be sent into SetDParam for string processing. | |
virtual int | GetDisplayMaxSpeed () const |
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing. | |
virtual Money | GetRunningCost () const |
Gets the running cost of a vehicle. | |
virtual bool | IsInDepot () const |
Check whether the vehicle is in the depot. | |
virtual bool | IsStoppedInDepot () const |
Check whether the vehicle is in the depot *and* stopped. | |
virtual bool | Tick () |
Calls the tick handler of the vehicle. | |
virtual void | OnNewDay () |
Calls the new day handler of the vehicle. | |
virtual uint | Crash (bool flooded=false) |
Crash the (whole) vehicle chain. | |
virtual Trackdir | GetVehicleTrackdir () const |
Returns the Trackdir on which the vehicle is currently located. | |
Money | GetDisplayRunningCost () const |
Gets the running cost of a vehicle that can be sent into SetDParam for string processing. | |
Money | GetDisplayProfitThisYear () const |
Gets the profit vehicle had this year. | |
Money | GetDisplayProfitLastYear () const |
Gets the profit vehicle had last year. | |
void | SetNext (Vehicle *next) |
Set the next vehicle of this vehicle. | |
Vehicle * | Next () const |
Get the next vehicle of this vehicle. | |
Vehicle * | Previous () const |
Get the previous vehicle of this vehicle. | |
Vehicle * | First () const |
Get the first vehicle of this vehicle chain. | |
Vehicle * | Last () |
Get the last vehicle of this vehicle chain. | |
const Vehicle * | Last () const |
Get the last vehicle of this vehicle chain. | |
Order * | GetFirstOrder () const |
Get the first order of the vehicles order list. | |
Vehicle * | AheadSeparation () const |
Get the vehicle ahead on track. | |
Vehicle * | BehindSeparation () const |
Get the vehicle behind on track. | |
void | ClearSeparation () |
Clears a vehicles separation status, removing it from any chain. | |
void | InitSeparation () |
Adds this vehicle to a shared vehicle separation chain. | |
void | AddToSeparationBehind (Vehicle *v_other) |
Adds this vehicle behind another in a separation chain. | |
void | AddToShared (Vehicle *shared_chain) |
Adds this vehicle to a shared vehicle chain. | |
void | RemoveFromShared () |
Removes the vehicle from the shared order list. | |
Vehicle * | NextShared () const |
Get the next vehicle of the shared vehicle chain. | |
Vehicle * | PreviousShared () const |
Get the previous vehicle of the shared vehicle chain. | |
Vehicle * | FirstShared () const |
Get the first vehicle of this vehicle chain. | |
bool | IsOrderListShared () const |
Check if we share our orders with another vehicle. | |
VehicleOrderID | GetNumOrders () const |
Get the number of orders this vehicle has. | |
VehicleOrderID | GetNumManualOrders () const |
Get the number of manually added orders this vehicle has. | |
void | CopyVehicleConfigAndStatistics (const 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. | |
bool | HandleBreakdown () |
Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds, and ending the breakdown when appropriate. | |
bool | NeedsAutorenewing (const Company *c) const |
Function to tell if a vehicle needs to be autorenewed. | |
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. | |
bool | NeedsAutomaticServicing () const |
Checks if the current order should be interupted for a service-in-depot-order. | |
virtual TileIndex | GetOrderStationLocation (StationID station) |
Determine the location for the station where the vehicle goes to next. | |
virtual bool | FindClosestDepot (TileIndex *location, DestinationID *destination, bool *reverse) |
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should reverse. | |
CommandCost | SendToDepot (DoCommandFlag flags, DepotCommand command) |
Send this vehicle to the depot using the given command(s). | |
void | UpdateVisualEffect (bool allow_power_change=true) |
Update the cached visual effect. | |
void | ShowVisualEffect () const |
Draw visual effects (smoke and/or sparks) for a vehicle chain. | |
void | IncrementImplicitOrderIndex () |
Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI. | |
void | IncrementRealOrderIndex () |
Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates the GUI. | |
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 NULL when it doesn't exists. | |
Order * | GetLastOrder () const |
Returns the last order of a vehicle, or NULL if it doesn't exists. | |
bool | IsEngineCountable () const |
Check if a vehicle is counted in num_engines in each company struct. | |
bool | HasDepotOrder () const |
Checks if a vehicle has a depot in its order list. | |
void | HandlePathfindingResult (bool path_found) |
Handle the pathfinding result, especially the lost status. | |
FORCEINLINE bool | IsFrontEngine () const |
Check if the vehicle is a front engine. | |
FORCEINLINE bool | IsArticulatedPart () const |
Check if the vehicle is an articulated part of an engine. | |
FORCEINLINE bool | HasArticulatedPart () const |
Check if an engine has an articulated part. | |
FORCEINLINE Vehicle * | GetNextArticulatedPart () const |
Get the next part of an articulated engine. | |
FORCEINLINE Vehicle * | GetFirstEnginePart () |
Get the first part of an articulated engine. | |
FORCEINLINE const Vehicle * | GetFirstEnginePart () const |
Get the first part of an articulated engine. | |
FORCEINLINE Vehicle * | GetLastEnginePart () |
Get the last part of an articulated engine. | |
FORCEINLINE Vehicle * | GetNextVehicle () const |
Get the next real (non-articulated part) vehicle in the consist. | |
FORCEINLINE Vehicle * | GetPrevVehicle () const |
Get the previous real (non-articulated part) vehicle in the consist. | |
Static Public Member Functions | |
static FORCEINLINE uint | GetAdvanceSpeed (uint speed) |
Determines the effective vehicle movement speed. | |
Data Fields | |
char * | name |
Name of vehicle. | |
TileIndex | tile |
Current tile index. | |
TileIndex | dest_tile |
Heading for this tile. | |
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. | |
uint32 | current_order_time |
How many ticks have passed since this order started. | |
uint32 | current_loading_time |
How long loading took. Less than current_order_time if vehicle is early. | |
int32 | lateness_counter |
How many ticks late (or early if negative) this vehicle is. | |
DateTicks | timetable_start |
When the vehicle is supposed to start the timetable. | |
Rect | coord |
NOSAVE: Graphical bounding box of the vehicle, i.e. what to redraw on moves. | |
Vehicle * | next_hash |
NOSAVE: Next vehicle in the visual location hash. | |
Vehicle ** | prev_hash |
NOSAVE: Previous vehicle in the visual location hash. | |
Vehicle * | next_new_hash |
NOSAVE: Next vehicle in the tile location hash. | |
Vehicle ** | prev_new_hash |
NOSAVE: Previous vehicle in the tile location hash. | |
Vehicle ** | old_new_hash |
NOSAVE: Cache of the current hash chain. | |
byte | breakdown_severity |
Severity of the breakdown. Note that lower means more severe. | |
BreakdownType | breakdown_type |
Type of breakdown. | |
SpriteID | colourmap |
NOSAVE: cached colour mapping. | |
Year | build_year |
Year the vehicle has been built. | |
Date | age |
Age in days. | |
Date | max_age |
Maximum age. | |
Date | date_of_last_service |
Last date the vehicle had a service at a depot. | |
Date | service_interval |
The interval for (automatic) servicing; either in days or %. | |
uint16 | reliability |
Reliability. | |
uint16 | reliability_spd_dec |
Reliability decrease speed. | |
byte | breakdown_ctr |
Counter for managing breakdown events. | |
byte | breakdown_delay |
Counter for managing breakdown length. | |
byte | breakdowns_since_last_service |
Counter for the amount of breakdowns. | |
byte | breakdown_chance |
Current chance of breakdowns. | |
int32 | x_pos |
x coordinate. | |
int32 | y_pos |
y coordinate. | |
int32 | z_pos |
z coordinate. | |
DirectionByte | direction |
facing | |
OwnerByte | owner |
Which company owns the vehicle? | |
byte | spritenum |
currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == reserved for another custom sprite | |
SpriteID | cur_image |
sprite number for this vehicle | |
byte | x_extent |
x-extent of vehicle bounding box | |
byte | y_extent |
y-extent of vehicle bounding box | |
byte | z_extent |
z-extent of vehicle bounding box | |
int8 | x_offs |
x offset for vehicle sprite | |
int8 | 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 | cur_speed |
current speed | |
byte | subspeed |
fractional speed | |
byte | acceleration |
used by train & aircraft | |
uint32 | motion_counter |
counter to occasionally play a vehicle sound. | |
byte | progress |
The percentage (if divided by 256) this vehicle already crossed the tile unit. | |
byte | random_bits |
Bits used for determining which randomized variational spritegroups to use when drawing. | |
byte | waiting_triggers |
Triggers to be yet matched before rerandomizing the random bits. | |
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. | |
CargoID | cargo_type |
type of cargo this vehicle is carrying | |
byte | cargo_subtype |
Used for livery refits (NewGRF variations). | |
uint16 | cargo_cap |
total capacity | |
VehicleCargoList | cargo |
The cargo this vehicle is carrying. | |
byte | day_counter |
Increased by one for each day. | |
byte | tick_counter |
Increased by one for each tick. | |
uint16 | running_ticks |
Number of ticks this vehicle was not stopped this day. | |
byte | vehstatus |
Status. | |
Order | current_order |
The current order (+ status, like: loading). | |
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. | |
union { | |
OrderList * list | |
Pointer to the order list for this vehicle. | |
Order * old | |
Only used during conversion of old save games. | |
} | orders |
The orders currently assigned to the vehicle. | |
byte | vehicle_flags |
Used for gradual loading and other miscellaneous things (. | |
uint16 | load_unload_ticks |
Ticks to wait before starting next cycle. | |
GroupID | group_id |
Index of group Pool array. | |
byte | subtype |
subtype (Filled with values from EffectVehicles/TrainSubTypes/AircraftSubTypes) | |
NewGRFCache | grf_cache |
Cache of often used calculated NewGRF values. | |
VehicleCache | vcache |
Cache of often used vehicle values. | |
Private Member Functions | |
bool | CanLeaveWithCargo () |
A vehicle can leave the current station with cargo if: 1. | |
void | SkipToNextRealOrderIndex () |
Advance cur_real_order_index to the next real order. | |
Private Attributes | |
Vehicle * | next |
pointer to the next vehicle in the chain | |
Vehicle * | previous |
NOSAVE: pointer to the previous vehicle in the chain. | |
Vehicle * | first |
NOSAVE: pointer to the first vehicle in the chain. | |
Vehicle * | next_shared |
pointer to the next vehicle that shares the order | |
Vehicle * | previous_shared |
NOSAVE: pointer to the previous vehicle in the shared order chain. | |
Vehicle * | ahead_separation |
pointer to the vehicle ahead in separation | |
Vehicle * | behind_separation |
pointer to the vehicle behind in separation | |
Friends | |
const SaveLoad * | GetVehicleDescription (VehicleType vt) |
So we can use private/protected variables in the saveload code. | |
void | FixOldVehicles () |
Convert the old style vehicles into something that resembles the old new style savegames. | |
void | AfterLoadVehicles (bool part_of_load) |
So we can set the previous and first pointers while loading. | |
bool | LoadOldVehicle (LoadgameState *ls, int num) |
So we can set the proper next pointer while loading. |
Vehicle data structure.
Definition at line 123 of file vehicle_base.h.
Vehicle::Vehicle | ( | VehicleType | type = VEH_INVALID |
) |
Vehicle constructor.
type | Type of the new vehicle. |
Definition at line 266 of file vehicle.cpp.
References colourmap, coord, DEFAULT_GROUP, fill_percent_te_id, first, group_id, and INVALID_COORD.
Vehicle::~Vehicle | ( | ) | [virtual] |
We want to 'destruct' the right class.
Definition at line 759 of file vehicle.cpp.
References cargo, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::CleaningPool(), DeleteNewGRFInspectWindow(), DeleteVehicleNews(), GetGrfSpecFeature(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, INVALID_COORD, INVALID_STRING_ID, IsDrawn(), MarkSingleVehicleDirty(), name, Next(), VehicleCargoList::OnCleanPool(), SetNext(), and BaseVehicle::type.
void Vehicle::AddToSeparationBehind | ( | Vehicle * | v_other | ) |
Adds this vehicle behind another in a separation chain.
v_other | a vehicle of the separation chain. |
Definition at line 2692 of file vehicle.cpp.
References ahead_separation, and behind_separation.
Referenced by InitSeparation().
void Vehicle::AddToShared | ( | Vehicle * | shared_chain | ) |
Adds this vehicle to a shared vehicle chain.
shared_chain | a vehicle of the chain with shared vehicles. |
Definition at line 2708 of file vehicle.cpp.
References OrderList::AddVehicle(), list, next_shared, orders, and previous_shared.
Referenced by AfterLoadVehicles(), CmdCloneOrder(), and CmdSellRailWagon().
Vehicle* Vehicle::AheadSeparation | ( | ) | const [inline] |
Get the vehicle ahead on track.
Definition at line 532 of file vehicle_base.h.
References ahead_separation.
void Vehicle::BeginLoading | ( | ) |
Prepare everything to begin the loading when arriving at a station.
Definition at line 2084 of file vehicle.cpp.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::CanAllocateItem(), CanLeaveWithCargo(), ClrBit(), cur_implicit_order_index, cur_real_order_index, cur_speed, current_order, DeleteOrder(), DeleteUnreachedImplicitOrders(), SpecializedStation< Station, false >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Order::GetDestination(), GetGroundVehicleFlags(), GetLastOrder(), OrderList::GetNextStoppingStation(), GetNumOrders(), GetOrder(), GetWindowClassForVehicleType(), GVF_SUPPRESS_IMPLICIT_ORDERS, HasBit(), IncreaseStats(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, InsertOrder(), InvalidateVehicleOrder(), IsGroundVehicle(), IsTileType(), Order::IsType(), last_loading_station, last_station_visited, Order::MakeImplicit(), Order::MakeLoading(), MarkDirty(), MAX_VEH_ORDER_ID, MP_STATION, Order::next, ONSF_NO_STOP_AT_ANY_STATION, orders, owner, PrepareUnload(), Order::SetNonStopType(), SetWindowDirty(), SetWindowWidgetDirty(), tile, BaseVehicle::type, UpdateVehicleTimetable(), and VEH_SHIP.
Referenced by AircraftEntersTerminal(), and TrainEnterStation().
Vehicle* Vehicle::BehindSeparation | ( | ) | const [inline] |
Get the vehicle behind on track.
Definition at line 538 of file vehicle_base.h.
References behind_separation.
Return all reserved cargo packets to the station.
st | the station where the reserved packets should go. |
Definition at line 2214 of file vehicle.cpp.
References GoodsEntry::acceptance_pickup, GoodsEntry::cargo, cargo, cargo_type, DEBUG, GoodsEntry::GES_PICKUP, Station::goods, next, VehicleCargoList::ReservedCount(), SetBit(), and VehicleCargoList::Unreserve().
Referenced by LeaveStation(), and PreDestructor().
bool Vehicle::CanLeaveWithCargo | ( | ) | [private] |
A vehicle can leave the current station with cargo if: 1.
it can load cargo here OR 2a. it could leave the last station with cargo AND 2b. it doesn't have to unload all cargo here.
Definition at line 2233 of file vehicle.cpp.
References current_order, Order::GetLoadType(), Order::GetUnloadType(), last_loading_station, and OUFB_UNLOAD.
Referenced by BeginLoading(), and LeaveStation().
void Vehicle::ClearSeparation | ( | ) |
Clears a vehicles separation status, removing it from any chain.
Definition at line 2644 of file vehicle.cpp.
References ahead_separation, behind_separation, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, and SetWindowDirty().
Referenced by CmdCloneOrder(), CmdSkipToOrder(), CmdStartStopVehicle(), Crash(), RemoveFromShared(), SendToDepot(), UpdateVehicleTimetable(), and VehicleEnterDepot().
void Vehicle::CopyVehicleConfigAndStatistics | ( | const Vehicle * | src | ) | [inline] |
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.
src | The old vehicle |
Definition at line 591 of file vehicle_base.h.
References cur_implicit_order_index, cur_real_order_index, current_loading_time, current_order, current_order_time, dest_tile, HasBit(), lateness_counter, profit_last_year, profit_this_year, service_interval, SetBit(), timetable_start, unitnumber, vehicle_flags, VF_AUTOFILL_PRES_WAIT_TIME, VF_AUTOFILL_TIMETABLE, and VF_TIMETABLE_STARTED.
Referenced by CmdSellRailWagon(), and CopyHeadSpecificThings().
uint Vehicle::Crash | ( | bool | flooded = false |
) | [virtual] |
Crash the (whole) vehicle chain.
flooded | whether the cause of the crash is flooding or not. |
Reimplemented in Aircraft, GroundVehicle< T, Type >, RoadVehicle, Train, GroundVehicle< Train, VEH_TRAIN >, and GroundVehicle< RoadVehicle, VEH_ROAD >.
Definition at line 193 of file vehicle.cpp.
References _settings_game, cargo, cargo_type, CC_PASSENGERS, ClearSeparation(), ClrBit(), CargoList< Tinst, Tcont >::Count(), GetWindowClassForVehicleType(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, InvalidateWindowClassesData(), IsCargoInClass(), IsPrimaryVehicle(), MarkSingleVehicleDirty(), Next(), GameSettings::order, Previous(), SetWindowDirty(), SetWindowWidgetDirty(), tile, OrderSettings::timetable_separation, BaseVehicle::type, vehicle_flags, vehstatus, VF_TIMETABLE_STARTED, and VS_CRASHED.
Referenced by FloodVehicle().
virtual bool Vehicle::FindClosestDepot | ( | TileIndex * | location, | |
DestinationID * | destination, | |||
bool * | reverse | |||
) | [inline, virtual] |
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should reverse.
location | where do we go to? | |
destination | what hangar do we go to? | |
reverse | should the vehicle be reversed? |
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 640 of file vehicle_base.h.
Referenced by SendToDepot(), and UpdateOrderDest().
Vehicle* Vehicle::First | ( | ) | const [inline] |
Get the first vehicle of this vehicle chain.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 498 of file vehicle_base.h.
References first.
Referenced by AfterLoadGame(), AfterLoadVehicles(), RefitWindow::BuildRefitList(), CheckCaches(), CheckVehicleBreakdown(), CmdRefitVehicle(), CmdSellVehicle(), VehicleViewWindow::DrawWidget(), FirstShared(), FloodVehicleProc(), GetBestFittingSubType(), GetEngineLiveryScheme(), GetNewCargoTypeForReplace(), HandleBreakdown(), PositionHelper(), RefitVehicle(), RemoveAndSellVehicle(), ReplaceChain(), VehicleClicked(), VehicleEnterDepot(), and VerifyAutoreplaceRefitForOrders().
Vehicle* Vehicle::FirstShared | ( | ) | const [inline] |
Get the first vehicle of this vehicle chain.
Definition at line 565 of file vehicle_base.h.
References First(), and orders.
Referenced by AfterLoadGame(), ChangeTimetable(), CheckOrders(), CheckSharingChangePossible(), OrderBackup::ClearVehicle(), CmdAddSharedVehicleGroup(), CmdAutofillTimetable(), CmdAutomateTimetable(), CmdCloneOrder(), CmdInsertOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdOrderRefit(), DeleteOrder(), HandleSharingCompanyDeletion(), InitSeparation(), InsertOrder(), OrderBackup::OrderBackup(), OrdersWindow::OrderClick_StopSharing(), RemoveFromShared(), RemoveOrderFromAllVehicles(), and UpdateVehicleTimetable().
FORCEINLINE uint Vehicle::GetAdvanceDistance | ( | ) | [inline] |
Determines the vehicle "progress" needed for moving a step.
Together with GetAdvanceSpeed() this function is a replacement for GetOldAdvanceSpeed().
Definition at line 341 of file vehicle_base.h.
References direction.
static FORCEINLINE uint Vehicle::GetAdvanceSpeed | ( | uint | speed | ) | [inline, static] |
Determines the effective vehicle movement speed.
Together with GetAdvanceDistance() this function is a replacement for GetOldAdvanceSpeed().
A vehicle progresses independent of it's movement direction. However different amounts of "progress" are needed for moving a step in a specific direction. That way the leftover progress does not need any adaption when changing movement direction.
speed | Direction-independent unscaled speed. |
Definition at line 329 of file vehicle_base.h.
Referenced by GroundVehicle< RoadVehicle, VEH_ROAD >::DoUpdateSpeed().
virtual int Vehicle::GetDisplayMaxSpeed | ( | ) | const [inline, virtual] |
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 408 of file vehicle_base.h.
Referenced by VehicleViewWindow::DrawWidget(), VehicleDetailsWindow::DrawWidget(), and ProcessConditionalOrder().
Money Vehicle::GetDisplayProfitLastYear | ( | ) | const [inline] |
Gets the profit vehicle had last year.
It can be sent into SetDParam for string processing.
Definition at line 476 of file vehicle_base.h.
References profit_last_year.
Referenced by VehicleGroupWindow::DrawGroupProfitButton(), BaseVehicleListWindow::DrawVehicleListItems(), DrawVehicleProfitButton(), VehicleDetailsWindow::DrawWidget(), and VehicleGroupWindow::DrawWidget().
Money Vehicle::GetDisplayProfitThisYear | ( | ) | const [inline] |
Gets the profit vehicle had this year.
It can be sent into SetDParam for string processing.
Definition at line 470 of file vehicle_base.h.
References profit_this_year.
Referenced by BaseVehicleListWindow::DrawVehicleListItems(), VehicleDetailsWindow::DrawWidget(), and VehicleGroupWindow::DrawWidget().
Money Vehicle::GetDisplayRunningCost | ( | ) | const [inline] |
Gets the running cost of a vehicle that can be sent into SetDParam for string processing.
Definition at line 464 of file vehicle_base.h.
References GetRunningCost().
Referenced by VehicleDetailsWindow::DrawWidget().
virtual int Vehicle::GetDisplaySpeed | ( | ) | const [inline, virtual] |
Gets the speed in km-ish/h that can be sent into SetDParam for string processing.
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 402 of file vehicle_base.h.
Referenced by VehicleViewWindow::DrawWidget().
virtual ExpensesType Vehicle::GetExpenseType | ( | bool | income | ) | const [inline, virtual] |
Sets the expense type associated to this vehicle type.
income | whether this is income or (running) expenses of the vehicle |
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 350 of file vehicle_base.h.
Referenced by RefitVehicle().
FORCEINLINE Vehicle* Vehicle::GetFirstEnginePart | ( | ) | [inline] |
Get the first part of an articulated engine.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 791 of file vehicle_base.h.
References IsArticulatedPart(), and Previous().
FORCEINLINE const Vehicle* Vehicle::GetFirstEnginePart | ( | ) | const [inline] |
Get the first part of an articulated engine.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 802 of file vehicle_base.h.
References IsArticulatedPart(), and Previous().
Order* Vehicle::GetFirstOrder | ( | ) | const [inline] |
Get the first order of the vehicles order list.
Definition at line 526 of file vehicle_base.h.
References orders.
Referenced by AIStationList_Vehicle::AIStationList_Vehicle(), AIWaypointList_Vehicle::AIWaypointList_Vehicle(), MakeDepartureList(), and UpdateVehicleTimetable().
GroundVehicleCache * Vehicle::GetGroundVehicleCache | ( | ) |
Access the ground vehicle cache of the vehicle.
Definition at line 2847 of file vehicle.cpp.
References SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), GroundVehicle< T, Type >::gcache, IsGroundVehicle(), BaseVehicle::type, and VEH_TRAIN.
Referenced by AddArticulatedParts(), AfterLoadVehicles(), DepotWindow::DepotClick(), VehicleDetailsWindow::DrawWidget(), AIVehicle::GetLength(), GetVehiclePalette(), GetVehicleSpriteGroup(), and LoadUnloadVehicle().
const GroundVehicleCache * Vehicle::GetGroundVehicleCache | ( | ) | const |
Access the ground vehicle cache of the vehicle.
Definition at line 2862 of file vehicle.cpp.
References SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), GroundVehicle< T, Type >::gcache, IsGroundVehicle(), BaseVehicle::type, and VEH_TRAIN.
uint16 & Vehicle::GetGroundVehicleFlags | ( | ) |
Access the ground vehicle flags of the vehicle.
Definition at line 2877 of file vehicle.cpp.
References SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), GroundVehicle< T, Type >::gv_flags, IsGroundVehicle(), BaseVehicle::type, and VEH_TRAIN.
Referenced by BeginLoading(), DeleteUnreachedImplicitOrders(), InsertOrder(), SendToDepot(), and UpdateOrderDest().
const uint16 & Vehicle::GetGroundVehicleFlags | ( | ) | const |
Access the ground vehicle flags of the vehicle.
Definition at line 2892 of file vehicle.cpp.
References SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), GroundVehicle< T, Type >::gv_flags, IsGroundVehicle(), BaseVehicle::type, and VEH_TRAIN.
Gets the sprite to show for the given direction.
direction | the direction the vehicle is facing |
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 367 of file vehicle_base.h.
Referenced by AfterLoadVehicles(), DepotWindow::DepotClick(), DrawAircraftImage(), DrawShipImage(), DepotWindow::DrawVehicleInDepot(), VehicleDetailsWindow::DrawWidget(), GetVehicleWidth(), and VehicleGroupWindow::OnClick().
FORCEINLINE Vehicle* Vehicle::GetLastEnginePart | ( | ) | [inline] |
Get the last part of an articulated engine.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 813 of file vehicle_base.h.
References GetNextArticulatedPart(), and HasArticulatedPart().
Order* Vehicle::GetLastOrder | ( | ) | const [inline] |
Returns the last order of a vehicle, or NULL if it doesn't exists.
Definition at line 740 of file vehicle_base.h.
References orders.
Referenced by BeginLoading(), and CheckOrders().
FORCEINLINE Vehicle* Vehicle::GetNextArticulatedPart | ( | ) | const [inline] |
Get the next part of an articulated engine.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 781 of file vehicle_base.h.
References HasArticulatedPart(), and Next().
Referenced by CheckConsistencyOfArticulatedVehicle(), CmdCloneVehicle(), GetLastEnginePart(), GetNextVehicle(), and IsArticulatedVehicleCarryingDifferentCargos().
FORCEINLINE Vehicle* Vehicle::GetNextVehicle | ( | ) | const [inline] |
Get the next real (non-articulated part) vehicle in the consist.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 824 of file vehicle_base.h.
References GetNextArticulatedPart(), HasArticulatedPart(), and Next().
Referenced by CmdCloneVehicle().
VehicleOrderID Vehicle::GetNumManualOrders | ( | ) | const [inline] |
Get the number of manually added orders this vehicle has.
Definition at line 583 of file vehicle_base.h.
References orders.
Referenced by VehicleViewWindow::DrawWidget(), ProcessOrders(), SkipToNextRealOrderIndex(), UpdateOrderDest(), and UpdateRealOrderIndex().
VehicleOrderID Vehicle::GetNumOrders | ( | ) | const [inline] |
Get the number of orders this vehicle has.
Definition at line 577 of file vehicle_base.h.
References orders.
Referenced by AfterLoadGame(), BeginLoading(), TimetableWindow::BuildArrivalDepartureList(), CheckNextTrainTile(), CheckOrders(), CmdCloneOrder(), CmdDeleteOrder(), CmdInsertOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdSkipToOrder(), DeleteOrder(), OrderBackup::DoRestore(), TimetableWindow::DrawWidget(), FillTimetableArrivalDepartureTable(), IncrementImplicitOrderIndex(), InsertOrder(), MakeDepartureList(), TimetableWindow::OnClick(), OrdersWindow::OnClick(), OrdersWindow::OnDragDrop(), TimetableWindow::OnInvalidateData(), OrdersWindow::OnInvalidateData(), OrdersWindow::OnMouseDrag(), TimetableWindow::OnPaint(), TimetableWindow::OnQueryTextFinished(), OrdersWindow::OrderClick_Delete(), OrdersWindow::OrderClick_Skip(), OrdersWindow::OrderClick_StopSharing(), OrdersWindow::OrderGetSel(), ProcessOrders(), SkipToNextRealOrderIndex(), VehicleOrderSaver::SwitchToNextOrder(), UpdateOrderDest(), and UpdateRealOrderIndex().
FORCEINLINE uint Vehicle::GetOldAdvanceSpeed | ( | uint | speed | ) | [inline] |
Determines the effective direction-specific vehicle movement speed.
This method belongs to the old vehicle movement method: A vehicle moves a step every 256 progress units. The vehicle speed is scaled by 3/4 when moving in X or Y direction due to the longer distance.
However, this method is slightly wrong in corners, as the leftover progress is not scaled correctly when changing movement direction. GetAdvanceSpeed() and GetAdvanceDistance() are better wrt. this.
speed | Direction-independent unscaled speed. |
Definition at line 312 of file vehicle_base.h.
References direction.
Referenced by UpdateAircraftSpeed().
Order* Vehicle::GetOrder | ( | int | index | ) | const [inline] |
Returns order 'index' of a vehicle or NULL when it doesn't exists.
index | the order to fetch |
Definition at line 731 of file vehicle_base.h.
References orders.
Referenced by BeginLoading(), ChangeTimetable(), CmdChangeTimetable(), CmdDeleteOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdOrderRefit(), DeleteOrder(), DeleteUnreachedImplicitOrders(), TimetableWindow::DrawWidget(), OrdersWindow::DrawWidget(), FillTimetableArrivalDepartureTable(), HandleLoading(), IncrementImplicitOrderIndex(), MakeDepartureList(), TimetableWindow::OnClick(), OrdersWindow::OnClick(), TimetableWindow::OnPaint(), TimetableWindow::OnQueryTextFinished(), OrdersWindow::OnQueryTextFinished(), OrdersWindow::OrderClick_FullLoad(), OrdersWindow::OrderClick_Nonstop(), OrdersWindow::OrderClick_Service(), OrdersWindow::OrderClick_Unload(), ProcessOrders(), OrdersWindow::SetStringParameters(), SkipToNextRealOrderIndex(), VehicleOrderSaver::SwitchToNextOrder(), UpdateOrderDest(), UpdateRealOrderIndex(), and VehicleEnterDepot().
Determine the location for the station where the vehicle goes to next.
Things done for example are allocating slots in a road stop or exact location of the platform is determined for ships.
station | the station to make the next location of the vehicle. |
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 630 of file vehicle_base.h.
References INVALID_TILE.
Referenced by UpdateOrderDest().
FORCEINLINE Vehicle* Vehicle::GetPrevVehicle | ( | ) | const [inline] |
Get the previous real (non-articulated part) vehicle in the consist.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 837 of file vehicle_base.h.
References IsArticulatedPart(), and Previous().
virtual Money Vehicle::GetRunningCost | ( | ) | const [inline, virtual] |
Gets the running cost of a vehicle.
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 414 of file vehicle_base.h.
Referenced by GetDisplayRunningCost().
virtual Trackdir Vehicle::GetVehicleTrackdir | ( | ) | const [inline, virtual] |
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.
Reimplemented in RoadVehicle, Ship, and Train.
Definition at line 458 of file vehicle_base.h.
Referenced by RemoveFromRailBaseStation().
bool Vehicle::HandleBreakdown | ( | ) |
Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds, and ending the breakdown when appropriate.
Definition at line 1211 of file vehicle.cpp.
References _settings_game, EffectVehicle::animation_state, BREAKDOWN_AIRCRAFT_EM_LANDING, BREAKDOWN_AIRCRAFT_SPEED, BREAKDOWN_CRITICAL, breakdown_ctr, breakdown_delay, BREAKDOWN_EM_STOP, BREAKDOWN_LOW_POWER, BREAKDOWN_LOW_SPEED, breakdown_severity, breakdown_type, breakdowns_since_last_service, VehicleCache::cached_max_speed, CheckBreakdownFlags(), Train::ConsistChanged(), CreateEffectVehicleRel(), cur_speed, current_order, engine_type, EV_BREAKDOWN_SMOKE, EV_CRASH_SMOKE, FindBreakdownDestination(), First(), SpecializedVehicle< Train, Type >::From(), SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), GameSettings::game_creation, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Order::GetDepotOrderType(), GetTargetAirportIfValid(), HasBit(), VehicleSettings::improved_breakdowns, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, Order::IsType(), GameCreationSettings::landscape, MarkDirty(), RailVehicleInfo::max_speed, min(), SetBit(), SetWindowDirty(), tick_counter, BaseVehicle::type, vcache, VEH_AIRCRAFT, VEH_TRAIN, GameSettings::vehicle, vehstatus, VRF_BREAKDOWN_BRAKING, VRF_BREAKDOWN_POWER, VRF_BREAKDOWN_SPEED, VRF_BREAKDOWN_STOPPED, VRF_NEED_REPAIR, VS_HIDDEN, and VSE_BREAKDOWN.
Referenced by HandlePossibleBreakdowns().
void Vehicle::HandleLoading | ( | bool | mode = false |
) |
Handle the loading of the vehicle; when not it skips through dummy orders and does nothing in all other cases.
mode | is the non-first call for this vehicle in this tick? |
Definition at line 2296 of file vehicle.cpp.
References _settings_game, cur_implicit_order_index, current_loading_time, current_order, current_order_time, SpecializedStation< Station, false >::Get(), Order::GetDestination(), GetOrder(), Order::GetType(), HasBit(), IncrementImplicitOrderIndex(), Order::IsType(), last_station_visited, LeaveStation(), max(), GameSettings::order, PayStationSharingFee(), PlayLeaveStationSound(), OrderSettings::timetabling, BaseVehicle::type, VEH_TRAIN, vehicle_flags, VF_LOADING_FINISHED, and Order::wait_time.
void Vehicle::HandlePathfindingResult | ( | bool | path_found | ) |
Handle the pathfinding result, especially the lost status.
If the vehicle is now lost and wasn't previously fire an event to the AIs and a news message to the user. If the vehicle is not lost anymore remove the news message.
path_found | Whether the vehicle has a path to its destination. |
Definition at line 667 of file vehicle.cpp.
References _local_company, _settings_client, AddVehicleNewsItem(), ClrBit(), DeleteVehicleNews(), ClientSettings::gui, HasBit(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, GUISettings::lost_vehicle_warn, AI::NewEvent(), NS_ADVICE, owner, SetBit(), SetDParam(), vehicle_flags, and VF_PATHFINDER_LOST.
Referenced by ChooseShipTrack(), and RoadFindPathToDest().
FORCEINLINE bool Vehicle::HasArticulatedPart | ( | ) | const [inline] |
Check if an engine has an articulated part.
Definition at line 771 of file vehicle_base.h.
References IsArticulatedPart(), and Next().
Referenced by CheckConsistencyOfArticulatedVehicle(), CmdCloneVehicle(), DrawRoadVehDetails(), VehicleDetailsWindow::DrawWidget(), RoadStop::Enter(), GetLastEnginePart(), GetNextArticulatedPart(), GetNextVehicle(), VehicleDetailsWindow::GetRoadVehDetailsHeight(), IsArticulatedVehicleCarryingDifferentCargos(), and RoadFindPathToDest().
bool Vehicle::HasDepotOrder | ( | ) | const |
Checks if a vehicle has a depot in its order list.
Definition at line 1763 of file order_cmd.cpp.
References Order::IsType().
void Vehicle::IncrementImplicitOrderIndex | ( | ) | [inline] |
Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI.
cur_real_order_index is incremented as well, if needed. Note: current_order is not invalidated.
Definition at line 671 of file vehicle_base.h.
References cur_implicit_order_index, cur_real_order_index, GetNumOrders(), GetOrder(), InvalidateVehicleOrder(), and SkipToNextRealOrderIndex().
Referenced by HandleLoading(), IncrementRealOrderIndex(), ProcessOrders(), and VehicleEnterDepot().
void Vehicle::IncrementRealOrderIndex | ( | ) | [inline] |
Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates the GUI.
cur_implicit_order_index is incremented as well, if it was equal to cur_real_order_index, i.e. cur_real_order_index is skipped but not any implicit orders. Note: current_order is not invalidated.
Definition at line 695 of file vehicle_base.h.
References cur_implicit_order_index, cur_real_order_index, IncrementImplicitOrderIndex(), InvalidateVehicleOrder(), and SkipToNextRealOrderIndex().
Referenced by Train::GetOrderStationLocation(), Ship::GetOrderStationLocation(), RoadVehicle::GetOrderStationLocation(), SendToDepot(), and UpdateOrderDest().
void Vehicle::InitSeparation | ( | ) |
Adds this vehicle to a shared vehicle separation chain.
v_other | a vehicle of the separation chain. |
Definition at line 2665 of file vehicle.cpp.
References AddToSeparationBehind(), ahead_separation, behind_separation, FirstShared(), HasBit(), NextShared(), and VF_TIMETABLE_STARTED.
FORCEINLINE void Vehicle::InvalidateNewGRFCache | ( | ) | [inline] |
Invalidates cached NewGRF variables.
Definition at line 373 of file vehicle_base.h.
References NewGRFCache::cache_valid, and grf_cache.
Referenced by RefitWindow::BuildRefitList(), CheckTrainAttachment(), CmdBuildRoadVehicle(), CmdSetCompanyColour(), Train::ConsistChanged(), and GetBestFittingSubType().
FORCEINLINE void Vehicle::InvalidateNewGRFCacheOfChain | ( | ) | [inline] |
Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle).
Definition at line 382 of file vehicle_base.h.
Referenced by CmdBuildAircraft(), CmdBuildRoadVehicle(), CmdBuildShip(), CmdRefitVehicle(), RefitVehicle(), and RoadVehUpdateCache().
FORCEINLINE bool Vehicle::IsArticulatedPart | ( | ) | const [inline] |
Check if the vehicle is an articulated part of an engine.
Definition at line 762 of file vehicle_base.h.
References GVSF_ARTICULATED_PART, HasBit(), IsGroundVehicle(), and subtype.
Referenced by BuildDepotVehicleList(), CheckTrainAttachment(), CmdAutoreplaceVehicle(), DrawTrainDetails(), GetCargoSummaryOfArticulatedVehicle(), GetEngineLiveryScheme(), GetFirstEnginePart(), GetLengthOfArticulatedVehicle(), GetNewEngineType(), Train::GetPower(), RoadVehicle::GetPower(), GetPrevVehicle(), GetVehicleSet(), Train::GetWeight(), RoadVehicle::GetWeight(), HasArticulatedPart(), InsertInConsist(), IsEngineCountable(), ReplaceFreeUnit(), and TransferCargo().
bool Vehicle::IsDrawn | ( | ) | const |
Is this vehicle drawn?
Definition at line 220 of file vehicle.cpp.
References SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), IsTransparencySet(), RoadVehicle::state, TO_TUNNELS, TRACK_BIT_WORMHOLE, BaseVehicle::type, VEH_ROAD, VEH_TRAIN, and vehstatus.
Referenced by ViewportAddVehicles(), and ~Vehicle().
bool Vehicle::IsEngineCountable | ( | ) | const |
Check if a vehicle is counted in num_engines in each company struct.
Definition at line 647 of file vehicle.cpp.
References SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), IsArticulatedPart(), IsFrontEngine(), Aircraft::IsNormalAircraft(), GroundVehicle< T, Type >::IsRearDualheaded(), BaseVehicle::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.
Referenced by ChangeOwnershipOfCompanyItems(), CmdAddVehicleGroup(), PreDestructor(), and SetCachedEngineCounts().
FORCEINLINE bool Vehicle::IsFrontEngine | ( | ) | const [inline] |
Check if the vehicle is a front engine.
Definition at line 753 of file vehicle_base.h.
References GVSF_FRONT, HasBit(), IsGroundVehicle(), and subtype.
Referenced by AfterLoadGame(), AfterLoadVehicles(), CcBuildWagon(), CheckBreakdownFlags(), CheckVehicleBreakdown(), CmdAutoreplaceVehicle(), CmdCloneVehicle(), CmdMoveRailVehicle(), CmdSellRailWagon(), ConnectMultiheadedTrains(), Train::ConsistChanged(), Train::Crash(), RoadVehicle::Crash(), DetermineBreakdownType(), DisasterTick_Ufo(), FreeTrainTrackReservation(), GroundVehicle< T, Type >::GetAcceleration(), Train::GetBreakdownSpeed(), GetMostSeverelyBrokenEngine(), HandlePossibleBreakdowns(), RoadVehicle::IsBus(), IsEngineCountable(), Train::IsPrimaryVehicle(), RoadVehicle::IsPrimaryVehicle(), Train::IsStoppedInDepot(), RoadVehicle::IsStoppedInDepot(), NormaliseTrainHead(), DepotWindow::OnDragDrop(), Train::OnNewDay(), RoadVehicle::OnNewDay(), Train::RailtypeChanged(), RemoveAndSellVehicle(), RoadVehAccelerationModelChanged(), RoadVehSlopeSteepnessChanged(), RoadVehUpdateCache(), SettingsDisableElrail(), SetTrainGroupID(), ShowVisualEffect(), Train::Tick(), RoadVehicle::Tick(), TrainApproachingCrossingEnum(), TrainApproachingCrossingTile(), TrainSlopeSteepnessChanged(), TryPathReserve(), UpdateTrainGroupID(), and WhoCanServiceIndustry().
FORCEINLINE bool Vehicle::IsGroundVehicle | ( | ) | const [inline] |
Check if the vehicle is a ground vehicle.
Definition at line 393 of file vehicle_base.h.
References BaseVehicle::type, and VEH_TRAIN.
Referenced by AfterLoadGame(), AfterLoadVehicles(), BeginLoading(), RefitWindow::BuildRefitList(), CmdCloneVehicle(), CmdInsertOrder(), CmdModifyOrder(), DeleteUnreachedImplicitOrders(), DepotWindow::DepotClick(), DisasterTick_Big_Ufo(), DrawOrderString(), DepotWindow::DrawVehicleInDepot(), GetGroundVehicleCache(), GetGroundVehicleFlags(), AIVehicle::GetLength(), GetVehiclePalette(), GetVehicleSpriteGroup(), InsertOrder(), IsArticulatedPart(), IsFrontEngine(), IsVehicleRefitable(), VehicleViewWindow::OnClick(), VehicleViewWindow::OnTick(), OrdersWindow::OrderClick_Nonstop(), SendToDepot(), and UpdateOrderDest().
virtual bool Vehicle::IsInDepot | ( | ) | const [inline, virtual] |
Check whether the vehicle is in the depot.
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 420 of file vehicle_base.h.
Referenced by BuildDepotVehicleList(), CmdAutoreplaceVehicle(), CmdDepotMassAutoReplace(), BaseVehicleListWindow::DrawVehicleListItems(), and IsStoppedInDepot().
bool Vehicle::IsOrderListShared | ( | ) | const [inline] |
Check if we share our orders with another vehicle.
Definition at line 571 of file vehicle_base.h.
References orders.
Referenced by CmdCloneOrder(), DeleteVehicleOrders(), OrdersWindow::DrawWidget(), TimetableWindow::OnPaint(), OrderBackup::OrderBackup(), and OrdersWindow::OrderClick_StopSharing().
virtual bool Vehicle::IsStoppedInDepot | ( | ) | const [inline, virtual] |
Check whether the vehicle is in the depot *and* stopped.
Reimplemented in RoadVehicle, and Train.
Definition at line 426 of file vehicle_base.h.
References IsInDepot(), and vehstatus.
Referenced by CmdAutoreplaceVehicle(), CmdRefitVehicle(), CmdSellVehicle(), CmdStartStopVehicle(), AIVehicle::GetState(), IsVehicleRefitable(), VehicleViewWindow::OnTick(), SendToDepot(), and VehiclePositionIsAllowed().
Vehicle* Vehicle::Last | ( | ) | [inline] |
Get the last vehicle of this vehicle chain.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 504 of file vehicle_base.h.
References Next().
Referenced by CcBuildWagon(), and DepotWindow::OnMouseDrag().
const Vehicle* Vehicle::Last | ( | ) | const [inline] |
Get the last vehicle of this vehicle chain.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 515 of file vehicle_base.h.
References Next().
void Vehicle::LeaveStation | ( | ) |
Perform all actions when leaving a station.
Definition at line 2244 of file vehicle.cpp.
References CancelReservation(), CanLeaveWithCargo(), cargo_payment, cur_implicit_order_index, current_order, DEBUG, DecreaseFrozen(), fill_percent_te_id, SpecializedVehicle< Train, Type >::From(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), OrderList::GetNextStoppingStation(), Order::GetNonStopType(), HideFillingPercent(), IsTileType(), Order::IsType(), last_loading_station, last_station_visited, Order::MakeLeaveStation(), MP_STATION, orders, RecalcFrozen(), SAT_TRAIN_DEPARTS, SetBit(), tile, BaseVehicle::type, UpdateVehicleTimetable(), VEH_TRAIN, vehstatus, VRF_LEAVING_STATION, and VS_CRASHED.
Referenced by CmdReverseTrainDirection(), CmdSkipToOrder(), HandleLoading(), HandleSharingCompanyDeletion(), and SendToDepot().
bool Vehicle::NeedsAutomaticServicing | ( | ) | const |
Checks if the current order should be interupted for a service-in-depot-order.
Definition at line 185 of file vehicle.cpp.
References _settings_game, current_order, Order::GetDepotOrderType(), OrderSettings::gotodepot, Order::IsType(), NeedsServicing(), and GameSettings::order.
bool Vehicle::NeedsAutorenewing | ( | const Company * | c | ) | const |
Function to tell if a vehicle needs to be autorenewed.
*c | The vehicle owner |
Definition at line 76 of file vehicle.cpp.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get().
Referenced by GetNewEngineType().
bool Vehicle::NeedsServicing | ( | ) | const |
Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for service or replacement.
Definition at line 119 of file vehicle.cpp.
References _date, _settings_game, cargo_type, CT_INVALID, GameSettings::difficulty, CompanySettings::engine_renew_money, engine_type, EngineReplacementForCompany(), SpecializedVehicle< Train, Type >::From(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), GetArticulatedRefitMasks(), Train::GetNextUnit(), group_id, HasBit(), INVALID_ENGINE, IsArticulatedVehicleCarryingDifferentCargos(), CompanyProperties::money, OrderSettings::no_servicing_if_no_breakdowns, GameSettings::order, owner, VehicleDefaultSettings::servint_ispercent, Company::settings, BaseVehicle::type, VEH_TRAIN, CompanySettings::vehicle, DifficultySettings::vehicle_breakdowns, vehstatus, VRF_NEED_REPAIR, VS_CRASHED, and VS_STOPPED.
Referenced by NeedsAutomaticServicing(), ProcessConditionalOrder(), VehicleOrderSaver::SwitchToNextOrder(), and UpdateOrderDest().
Vehicle* Vehicle::Next | ( | ) | const [inline] |
Get the next vehicle of this vehicle.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 485 of file vehicle_base.h.
References next.
Referenced by AfterLoadVehicles(), RefitWindow::BuildRefitList(), CalcPercentVehicleFilled(), CheckCaches(), CmdCloneVehicle(), CmdReverseTrainDirection(), CmdSellRailWagon(), Crash(), DecreaseFrozen(), DrawRoadVehDetails(), VehicleDetailsWindow::DrawWidget(), FindSpaceBetweenTrainsEnum(), GetNewCargoTypeForReplace(), GetNextArticulatedPart(), GetNextVehicle(), HandleCrashedTrain(), HasArticulatedPart(), IncreaseStats(), IsVehicleRefitable(), Last(), LoadUnloadVehicle(), MakeDepartureList(), DepotWindow::OnRightClick(), PositionHelper(), PrepareUnload(), RefitVehicle(), RemoveAndSellVehicle(), RemoveFromRailBaseStation(), ReserveConsist(), SetNext(), ShowVisualEffect(), TrainInWormholeTileEnum(), TransferCargo(), VehicleCargoSorter(), VehiclePositionIsAllowed(), VehicleValueSorter(), WhoCanServiceIndustry(), and ~Vehicle().
Vehicle* Vehicle::NextShared | ( | ) | const [inline] |
Get the next vehicle of the shared vehicle chain.
Definition at line 553 of file vehicle_base.h.
References next_shared.
Referenced by AfterLoadVehicles(), AIVehicleList_SharedOrders::AIVehicleList_SharedOrders(), ChangeTimetable(), OrderBackup::ClearVehicle(), CmdAddSharedVehicleGroup(), CmdAutofillTimetable(), CmdAutomateTimetable(), CmdInsertOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdOrderRefit(), OrderList::DebugCheckSanity(), DeleteOrder(), GenerateVehicleSortList(), HandleSharingCompanyDeletion(), OrderList::Initialize(), InitSeparation(), InsertOrder(), OrderList::IsVehicleInSharedOrdersList(), OrderBackup::OrderBackup(), OrdersWindow::OrderClick_StopSharing(), RemoveFromShared(), RemoveOrderFromAllVehicles(), OrderList::RemoveVehicle(), and UpdateVehicleTimetable().
Vehicle* Vehicle::Previous | ( | ) | const [inline] |
Get the previous vehicle of this vehicle.
Reimplemented in SpecializedVehicle< T, Type >, SpecializedVehicle< DisasterVehicle, VEH_DISASTER >, SpecializedVehicle< Ship, VEH_SHIP >, SpecializedVehicle< Train, Type >, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >, SpecializedVehicle< EffectVehicle, VEH_EFFECT >, and SpecializedVehicle< RoadVehicle, Type >.
Definition at line 492 of file vehicle_base.h.
References previous.
Referenced by AfterLoadVehicles(), AgeVehicle(), CheckSharingChangePossible(), Crash(), FindSpaceBetweenTrainsEnum(), GetFirstEnginePart(), GetPrevVehicle(), HandleSharingCompanyDeletion(), DepotWindow::OnMouseDrag(), PreDestructor(), RemoveAndSellVehicle(), and TrainInWormholeTileEnum().
Vehicle* Vehicle::PreviousShared | ( | ) | const [inline] |
Get the previous vehicle of the shared vehicle chain.
Definition at line 559 of file vehicle_base.h.
References previous_shared.
Referenced by AfterLoadVehicles(), OrderList::GetPositionInSharedOrderList(), OrderList::Initialize(), and OrdersWindow::OrderClick_StopSharing().
CommandCost Vehicle::SendToDepot | ( | DoCommandFlag | flags, | |
DepotCommand | command | |||
) |
Send this vehicle to the depot using the given command(s).
flags | the command flags (like execute and such). | |
command | the command to execute. |
Definition at line 2341 of file vehicle.cpp.
References _settings_game, AircraftNextAirportPos_and_Order(), CheckOwnership(), ClearSeparation(), ClrBit(), CMD_ERROR, CMD_REVERSE_TRAIN_DIRECTION, current_order, DC_EXEC, DEPOT_DONT_CANCEL, DEPOT_SERVICE, dest_tile, DoCommand(), CommandCost::Failed(), FindClosestDepot(), FLYING, SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), Order::GetDepotActionType(), Order::GetDepotOrderType(), GetGroundVehicleFlags(), GVF_SUPPRESS_IMPLICIT_ORDERS, IncrementRealOrderIndex(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, IsGroundVehicle(), IsStoppedInDepot(), Order::IsType(), LeaveStation(), Order::MakeDummy(), Order::MakeGoToDepot(), ODATF_SERVICE_ONLY, ODATFB_HALT, ODTF_MANUAL, GameSettings::order, owner, return_cmd_error, SetBit(), Order::SetDepotActionType(), Order::SetDepotOrderType(), SetWindowWidgetDirty(), Aircraft::state, Aircraft::targetairport, tile, OrderSettings::timetable_separation, BaseVehicle::type, VEH_AIRCRAFT, VEH_TRAIN, vehicle_flags, vehstatus, VF_TIMETABLE_STARTED, and VS_CRASHED.
Referenced by CmdSendVehicleToDepot().
void Vehicle::SetNext | ( | Vehicle * | next | ) |
Set the next vehicle of this vehicle.
next | the next vehicle. NULL removes the next vehicle. |
Definition at line 2619 of file vehicle.cpp.
References first, next, Next(), and previous.
Referenced by AddArticulatedParts(), CheckTrainAttachment(), CmdBuildAircraft(), DeleteLastRoadVeh(), DeleteLastWagon(), DeleteVisibleTrain(), Disaster_Helicopter_Init(), Disaster_Small_Ufo_Init(), Disaster_Zeppeliner_Init(), DisasterTick_Big_Ufo(), InsertInConsist(), RemoveFromConsist(), RestoreTrainBackup(), and ~Vehicle().
void Vehicle::ShowVisualEffect | ( | ) | const |
Draw visual effects (smoke and/or sparks) for a vehicle chain.
Definition at line 2496 of file vehicle.cpp.
References _settings_game, VehicleCache::cached_max_speed, GroundVehicleCache::cached_power, VehicleCache::cached_vis_effect, GroundVehicleCache::cached_weight, Chance16(), CreateEffectVehicleRel(), cur_speed, current_order, direction, EV_DIESEL_SMOKE, EV_ELECTRIC_SPARK, EV_STEAM_SMOKE, SpecializedVehicle< Train, Type >::From(), GB(), GroundVehicle< T, Type >::gcache, GetStationIndex(), GetTileRailType(), HasBit(), HasPowerOnRail(), IsBridgeAbove(), IsDepotTile(), IsFrontEngine(), IsPrimaryVehicle(), IsRailStationTile(), IsTunnelTile(), MayHaveBridgeAbove(), Next(), Order::ShouldStopAtStation(), VehicleSettings::smoke_amount, tick_counter, tile, BaseVehicle::type, vcache, VE_DISABLE_EFFECT, VE_OFFSET_COUNT, VE_OFFSET_START, VE_TYPE_COUNT, VE_TYPE_DIESEL, VE_TYPE_ELECTRIC, VE_TYPE_START, VE_TYPE_STEAM, VEH_TRAIN, GameSettings::vehicle, vehstatus, VRF_REVERSE_DIRECTION, VS_HIDDEN, VS_STOPPED, VS_TRAIN_SLOWING, and VSE_VISUAL_EFFECT.
void Vehicle::SkipToNextRealOrderIndex | ( | ) | [inline, private] |
Advance cur_real_order_index to the next real order.
cur_implicit_order_index is not touched.
Definition at line 652 of file vehicle_base.h.
References cur_real_order_index, GetNumManualOrders(), GetNumOrders(), and GetOrder().
Referenced by IncrementImplicitOrderIndex(), and IncrementRealOrderIndex().
virtual bool Vehicle::Tick | ( | ) | [inline, virtual] |
Calls the tick handler of the vehicle.
Reimplemented in Aircraft, EffectVehicle, RoadVehicle, Ship, Train, and DisasterVehicle.
Definition at line 432 of file vehicle_base.h.
virtual void Vehicle::UpdateDeltaXY | ( | Direction | direction | ) | [inline, virtual] |
Updates the x and y offsets and the size of the sprite used for this vehicle.
direction | the direction the vehicle is facing |
Reimplemented in Aircraft, EffectVehicle, RoadVehicle, Ship, Train, and DisasterVehicle.
Definition at line 297 of file vehicle_base.h.
Referenced by AfterLoadVehicles().
void Vehicle::UpdateVisualEffect | ( | bool | allow_power_change = true |
) |
Update the cached visual effect.
allow_power_change | true if the wagon-is-powered-state may change. |
Definition at line 2430 of file vehicle.cpp.
References VehicleCache::cached_vis_effect, CALLBACK_FAILED, EngineInfo::callback_mask, CBID_VEHICLE_VISUAL_EFFECT, CBM_VEHICLE_VISUAL_EFFECT, EC_MONORAIL, EC_STEAM, RailVehicleInfo::engclass, GB(), GBUG_VEH_POWERED_WAGON, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), GetVehicleCallback(), HasBit(), IsInsideMM(), RAILVEH_WAGON, SB(), SetBit(), ShowNewGrfVehicleError(), ToggleBit(), Engine::type, vcache, VE_DEFAULT, VE_DISABLE_EFFECT, VE_DISABLE_WAGON_POWER, VE_OFFSET_CENTRE, VE_TYPE_COUNT, VE_TYPE_DEFAULT, VE_TYPE_START, VE_TYPE_STEAM, VEH_ROAD, VEH_SHIP, VEH_TRAIN, ShipVehicleInfo::visual_effect, RoadVehicleInfo::visual_effect, and RailVehicleInfo::visual_effect.
Referenced by RoadVehUpdateCache(), and Ship::UpdateCache().
void AfterLoadVehicles | ( | bool | part_of_load | ) | [friend] |
So we can set the previous and first pointers while loading.
For instantiating the shared vehicle chain.
Definition at line 241 of file vehicle_sl.cpp.
void FixOldVehicles | ( | ) | [friend] |
Convert the old style vehicles into something that resembles the old new style savegames.
Then AfterLoadGame can handle the rest of the conversion.
Definition at line 171 of file oldloader_sl.cpp.
const SaveLoad* GetVehicleDescription | ( | VehicleType | vt | ) | [friend] |
So we can use private/protected variables in the saveload code.
Saving and loading the current order of vehicles.
The vehicles have a cargo list (and we want that saved).
vt | the vehicle type. Can be VEH_END for the common vehicle description data |
vt | the vehicle type. Can be VEH_END for the common vehicle description data |
Save and load of vehicles
Save and load of vehicles
Definition at line 454 of file vehicle_sl.cpp.
bool LoadOldVehicle | ( | LoadgameState * | ls, | |
int | num | |||
) | [friend] |
So we can set the proper next pointer while loading.
ls | State (buffer) of the currently loaded game. | |
num | The number of vehicles to load. |
Definition at line 1229 of file oldloader_sl.cpp.
Counter for managing breakdown events.
Definition at line 191 of file vehicle_base.h.
Referenced by AfterLoadGame(), CheckVehicleBreakdown(), DisasterTick_Big_Ufo(), DisasterTick_Ufo(), GroundVehicle< RoadVehicle, VEH_ROAD >::DoUpdateSpeed(), VehicleViewWindow::DrawWidget(), FindBreakdownDestination(), AIVehicle::GetState(), HandleBreakdown(), HandlePossibleBreakdowns(), MaybeCrashAirplane(), TrainDetailsInfoTab(), and UpdateAircraftSpeed().
Heading for this tile.
For airports and train stations this tile does not necessarily belong to the destination station, but it can be used for heuristic purposes to estimate the distance.
Definition at line 151 of file vehicle_base.h.
Referenced by AfterLoadGame(), CheckNextTrainTile(), CopyVehicleConfigAndStatistics(), Disaster_Small_Ufo_Init(), DisasterTick_Aircraft(), DisasterTick_Big_Ufo(), DisasterTick_Ufo(), Train::OnNewDay(), ProcessOrders(), ReleaseDisastersTargetingIndustry(), ReleaseDisastersTargetingVehicle(), RemoveRoadStop(), RoadFindPathToDest(), SendToDepot(), UpdateOrderDest(), and VehicleEnterDepot().
Used for gradual loading and other miscellaneous things (.
Definition at line 247 of file vehicle_base.h.
Referenced by AfterLoadGame(), TimetableWindow::BuildArrivalDepartureList(), CalcPercentVehicleFilled(), CmdAutofillTimetable(), CmdBuildAircraft(), CmdBuildRailVehicle(), CmdBuildRoadVehicle(), CmdBuildShip(), CmdCloneOrder(), CmdSetTimetableStart(), CmdSkipToOrder(), CmdStartStopVehicle(), CopyVehicleConfigAndStatistics(), Crash(), TimetableWindow::DrawWidget(), HandleLoading(), HandlePathfindingResult(), LoadUnloadVehicle(), TimetableWindow::OnClick(), TimetableWindow::OnPaint(), PrepareUnload(), RemoveFromShared(), SendToDepot(), UpdateVehicleTimetable(), and VehicleEnterDepot().