Vehicle data structure. More...
#include <vehicle_base.h>
Public Member Functions | |
Vehicle (VehicleType type=VEH_INVALID) | |
Create a new vehicle. | |
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 () |
void | LeaveStation () |
GroundVehicleCache * | GetGroundVehicleCache () |
Access the ground vehicle cache of the vehicle. | |
const GroundVehicleCache * | GetGroundVehicleCache () const |
Access the ground vehicle cache of the vehicle. | |
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. | |
virtual const char * | GetTypeString () const |
Get a string 'representation' of the vehicle type. | |
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. | |
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 |
void | IncrementOrderIndex () |
Increments cur_order_index, keeps care of the wrap-around and invalidates the GUI. | |
Order * | GetOrder (int index) const |
Returns order 'index' of a vehicle or NULL when it doesn't exists. | |
Order * | GetNextManualOrder (int index) const |
Get the next manual (not OT_AUTOMATIC) order after the one at the given index. | |
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. | |
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. | |
int32 | lateness_counter |
How many ticks late (or early if negative) this vehicle is. | |
Date | timetable_start |
When the vehicle is supposed to start the timetable. | |
Rect | coord |
Vehicle * | next_hash |
Vehicle ** | prev_hash |
Vehicle * | next_new_hash |
Vehicle ** | prev_new_hash |
Vehicle ** | old_new_hash |
SpriteID | colourmap |
NOSAVE: cached colour mapping. | |
Year | build_year |
Date | age |
Age in days. | |
Date | max_age |
Maximum age. | |
Date | date_of_last_service |
Date | service_interval |
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 |
byte | breakdown_chance |
int32 | x_pos |
x coordinate. | |
int32 | y_pos |
y coordinate. | |
byte | 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 | |
uint16 | 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 |
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 |
byte | progress |
byte | random_bits |
byte | waiting_triggers |
triggers to be yet matched | |
StationID | last_station_visited |
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. | |
byte | 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_order_index |
The index to the current order. | |
union { | |
OrderList * list | |
Pointer to the order list for this vehicle. | |
Order * old | |
Only used during conversion of old save games. | |
} | orders |
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 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. | |
Friends | |
const SaveLoad * | GetVehicleDescription (VehicleType vt) |
So we can use private/protected variables in the saveload code. | |
bool | AfterLoadGame () |
void | FixOldVehicles () |
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 109 of file vehicle_base.h.
Vehicle::Vehicle | ( | VehicleType | type = VEH_INVALID |
) |
Create a new vehicle.
Vehicle constructor.
type | Type of the new vehicle. |
Definition at line 231 of file vehicle.cpp.
References colourmap, DEFAULT_GROUP, fill_percent_te_id, first, and group_id.
Vehicle::~Vehicle | ( | ) | [virtual] |
We want to 'destruct' the right class.
Definition at line 725 of file vehicle.cpp.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::CleaningPool(), DeleteNewGRFInspectWindow(), DeleteVehicleNews(), GetGrfSpecFeature(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, INVALID_STRING_ID, MarkSingleVehicleDirty(), name, Next(), SetNext(), BaseVehicle::type, vehstatus, and VS_HIDDEN.
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 2111 of file vehicle.cpp.
References OrderList::AddVehicle(), list, next_shared, and previous_shared.
Referenced by AfterLoadVehicles(), CmdCloneOrder(), and CmdSellRailWagon().
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 563 of file vehicle_base.h.
References cur_order_index, current_order, current_order_time, dest_tile, HasBit(), lateness_counter, profit_last_year, profit_this_year, 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, RoadVehicle, and Train.
Definition at line 168 of file vehicle.cpp.
References CC_PASSENGERS, GetWindowClassForVehicleType(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, InvalidateWindowClassesData(), IsCargoInClass(), IsPrimaryVehicle(), MarkSingleVehicleDirty(), Previous(), SetWindowDirty(), SetWindowWidgetDirty(), tile, BaseVehicle::type, vehstatus, VS_CRASHED, and VS_STOPPED.
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 628 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 479 of file vehicle_base.h.
References first.
Referenced by AfterLoadVehicles(), RefitWindow::BuildRefitList(), CheckCaches(), CmdRefitVehicle(), CmdSellVehicle(), FirstShared(), FloodVehicleProc(), GetBestFittingSubType(), GetEngineLiveryScheme(), GetNewCargoTypeForReplace(), PositionHelper(), RefitVehicle(), ReplaceChain(), VehicleClicked(), and VerifyAutoreplaceRefitForOrders().
Vehicle* Vehicle::FirstShared | ( | ) | const [inline] |
Get the first vehicle of this vehicle chain.
Definition at line 537 of file vehicle_base.h.
References First().
Referenced by CheckOrders(), OrderBackup::ClearVehicle(), CmdAddSharedVehicleGroup(), CmdAutofillTimetable(), CmdCloneOrder(), CmdInsertOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdOrderRefit(), DeleteOrder(), InsertOrder(), OrderBackup::OrderBackup(), OrdersWindow::OrderClick_StopSharing(), RemoveFromShared(), and RemoveOrderFromAllVehicles().
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 318 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 306 of file vehicle_base.h.
Referenced by RoadVehAccelerate(), and Train::UpdateSpeed().
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 385 of file vehicle_base.h.
Referenced by 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 453 of file vehicle_base.h.
References profit_last_year.
Referenced by BaseVehicleListWindow::DrawVehicleListItems(), DrawVehicleProfitButton(), and VehicleDetailsWindow::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 447 of file vehicle_base.h.
References profit_this_year.
Referenced by BaseVehicleListWindow::DrawVehicleListItems(), and VehicleDetailsWindow::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 441 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 379 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 327 of file vehicle_base.h.
References EXPENSES_OTHER.
Referenced by RefitVehicle().
Order* Vehicle::GetFirstOrder | ( | ) | const [inline] |
Get the first order of the vehicles order list.
Definition at line 507 of file vehicle_base.h.
Referenced by AIStationList_Vehicle::AIStationList_Vehicle(), and AIWaypointList_Vehicle::AIWaypointList_Vehicle().
const GroundVehicleCache * Vehicle::GetGroundVehicleCache | ( | ) | const |
Access the ground vehicle cache of the vehicle.
Definition at line 2286 of file vehicle.cpp.
References SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), GroundVehicle< T, Type >::gcache, IsGroundVehicle(), BaseVehicle::type, and VEH_TRAIN.
GroundVehicleCache * Vehicle::GetGroundVehicleCache | ( | ) |
Access the ground vehicle cache of the vehicle.
Definition at line 2271 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 AfterLoadVehicles(), DepotWindow::DepotClick(), VehicleDetailsWindow::DrawWidget(), AIVehicle::GetLength(), GetVehiclePalette(), GetVehicleSpriteGroup(), and LoadUnloadVehicle().
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 344 of file vehicle_base.h.
Referenced by AfterLoadVehicles(), DepotWindow::DepotClick(), DrawAircraftImage(), DrawShipImage(), DepotWindow::DrawVehicleInDepot(), VehicleDetailsWindow::DrawWidget(), GetVehicleWidth(), and VehicleGroupWindow::OnClick().
Order* Vehicle::GetLastOrder | ( | ) | const [inline] |
Returns the last order of a vehicle, or NULL if it doesn't exists.
Definition at line 677 of file vehicle_base.h.
Referenced by CheckOrders().
Order * Vehicle::GetNextManualOrder | ( | int | index | ) | const |
Get the next manual (not OT_AUTOMATIC) order after the one at the given index.
index | The index to start searching at. |
Definition at line 2167 of file vehicle.cpp.
References GetOrder(), Order::IsType(), and Order::next.
Referenced by ProcessOrders(), and UpdateOrderDest().
VehicleOrderID Vehicle::GetNumManualOrders | ( | ) | const [inline] |
Get the number of manually added orders this vehicle has.
Definition at line 555 of file vehicle_base.h.
Referenced by VehicleViewWindow::DrawWidget().
VehicleOrderID Vehicle::GetNumOrders | ( | ) | const [inline] |
Get the number of orders this vehicle has.
Definition at line 549 of file vehicle_base.h.
Referenced by TimetableWindow::BuildArrivalDepartureList(), CheckNextTrainTile(), CheckOrders(), CmdCloneOrder(), CmdDeleteOrder(), CmdInsertOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdSkipToOrder(), DeleteOrder(), OrderBackup::DoRestore(), TimetableWindow::DrawWidget(), FillTimetableArrivalDepartureTable(), IncrementOrderIndex(), InsertOrder(), TimetableWindow::OnClick(), OrdersWindow::OnClick(), OrdersWindow::OnDragDrop(), TimetableWindow::OnInvalidateData(), OrdersWindow::OnInvalidateData(), OrdersWindow::OnMouseDrag(), TimetableWindow::OnPaint(), OrdersWindow::OrderClick_Delete(), OrdersWindow::OrderClick_Skip(), OrdersWindow::OrderClick_StopSharing(), OrdersWindow::OrderGetSel(), ProcessOrders(), VehicleOrderSaver::SwitchToNextOrder(), and UpdateOrderDest().
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 289 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 666 of file vehicle_base.h.
Referenced by CmdChangeTimetable(), CmdDeleteOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdOrderRefit(), TimetableWindow::DrawWidget(), OrdersWindow::DrawWidget(), FillTimetableArrivalDepartureTable(), GetNextManualOrder(), TimetableWindow::OnClick(), OrdersWindow::OnClick(), TimetableWindow::OnPaint(), OrdersWindow::OnQueryTextFinished(), OrdersWindow::OrderClick_FullLoad(), OrdersWindow::OrderClick_Nonstop(), OrdersWindow::OrderClick_Service(), OrdersWindow::OrderClick_Unload(), ResolveOrder(), OrdersWindow::SetStringParameters(), VehicleOrderSaver::SwitchToNextOrder(), and UpdateOrderDest().
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 618 of file vehicle_base.h.
References INVALID_TILE.
Referenced by UpdateOrderDest().
virtual Money Vehicle::GetRunningCost | ( | ) | const [inline, virtual] |
Gets the running cost of a vehicle.
Reimplemented in Aircraft, RoadVehicle, Ship, and Train.
Definition at line 391 of file vehicle_base.h.
Referenced by GetDisplayRunningCost().
virtual const char* Vehicle::GetTypeString | ( | ) | const [inline, virtual] |
Get a string 'representation' of the vehicle type.
Reimplemented in Aircraft, EffectVehicle, RoadVehicle, Ship, Train, and DisasterVehicle.
Definition at line 257 of file vehicle_base.h.
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 435 of file vehicle_base.h.
References INVALID_TRACKDIR.
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 1030 of file vehicle.cpp.
References _settings_game, breakdown_ctr, breakdown_delay, cur_speed, current_order, GameSettings::game_creation, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, Order::IsType(), GameCreationSettings::landscape, MarkDirty(), SetWindowDirty(), tick_counter, BaseVehicle::type, VEH_AIRCRAFT, VEH_TRAIN, vehstatus, VS_AIRCRAFT_BROKEN, VS_HIDDEN, and VSE_BREAKDOWN.
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 1818 of file vehicle.cpp.
References _settings_game, current_order, Order::GetType(), HasBit(), IncrementOrderIndex(), max(), GameSettings::order, PlayLeaveStationSound(), OrderSettings::timetabling, 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 635 of file vehicle.cpp.
References _local_company, _settings_client, AddVehicleNewsItem(), ClrBit(), DeleteVehicleNews(), ClientSettings::gui, HasBit(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, 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().
bool Vehicle::HasDepotOrder | ( | ) | const |
Checks if a vehicle has a depot in its order list.
Definition at line 1495 of file order_cmd.cpp.
References Order::IsType().
void Vehicle::IncrementOrderIndex | ( | ) | [inline] |
Increments cur_order_index, keeps care of the wrap-around and invalidates the GUI.
Note: current_order is not invalidated.
Definition at line 654 of file vehicle_base.h.
References cur_order_index, GetNumOrders(), and InvalidateVehicleOrder().
Referenced by Train::GetOrderStationLocation(), Ship::GetOrderStationLocation(), RoadVehicle::GetOrderStationLocation(), HandleLoading(), ProcessOrders(), SendToDepot(), and UpdateOrderDest().
FORCEINLINE void Vehicle::InvalidateNewGRFCache | ( | ) | [inline] |
Invalidates cached NewGRF variables.
Definition at line 350 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 359 of file vehicle_base.h.
Referenced by CmdBuildAircraft(), CmdBuildRoadVehicle(), CmdBuildShip(), CmdRefitVehicle(), and RefitVehicle().
bool Vehicle::IsEngineCountable | ( | ) | const |
Check if a vehicle is counted in num_engines in each company struct.
Definition at line 615 of file vehicle.cpp.
References SpecializedVehicle< RoadVehicle, Type >::From(), SpecializedVehicle< Train, Type >::From(), SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), Train::IsArticulatedPart(), Aircraft::IsNormalAircraft(), Train::IsRearDualheaded(), RoadVehicle::IsRoadVehFront(), BaseVehicle::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.
Referenced by CmdAddVehicleGroup(), PreDestructor(), and SetCachedEngineCounts().
FORCEINLINE bool Vehicle::IsGroundVehicle | ( | ) | const [inline] |
Check if the vehicle is a ground vehicle.
Definition at line 370 of file vehicle_base.h.
References BaseVehicle::type, VEH_ROAD, and VEH_TRAIN.
Referenced by AfterLoadVehicles(), RefitWindow::BuildRefitList(), CmdInsertOrder(), CmdModifyOrder(), DepotWindow::DepotClick(), DisasterTick_Big_Ufo(), DrawOrderString(), DepotWindow::DrawVehicleInDepot(), GetGroundVehicleCache(), AIVehicle::GetLength(), GetVehiclePalette(), GetVehicleSpriteGroup(), IsVehicleRefitable(), VehicleViewWindow::OnClick(), VehicleViewWindow::OnTick(), and OrdersWindow::OrderClick_Nonstop().
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 397 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 543 of file vehicle_base.h.
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 403 of file vehicle_base.h.
References IsInDepot(), vehstatus, and VS_STOPPED.
Referenced by CmdAutoreplaceVehicle(), CmdRefitVehicle(), CmdSellVehicle(), CmdStartStopVehicle(), AIVehicle::GetState(), IsVehicleRefitable(), VehicleViewWindow::OnTick(), and SendToDepot().
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 496 of file vehicle_base.h.
References Next().
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 485 of file vehicle_base.h.
References Next().
Referenced by DepotWindow::OnMouseDrag().
bool Vehicle::NeedsAutomaticServicing | ( | ) | const |
Checks if the current order should be interupted for a service-in-depot-order.
Definition at line 160 of file vehicle.cpp.
References _settings_game, current_order, Order::GetDepotOrderType(), OrderSettings::gotodepot, Order::IsType(), NeedsServicing(), ODTFB_SERVICE, 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 77 of file vehicle.cpp.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, 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 100 of file vehicle.cpp.
References _date, _settings_game, cargo_type, CT_INVALID, GameSettings::difficulty, CompanySettings::engine_renew_money, EngineReplacementForCompany(), SpecializedVehicle< Train, Type >::From(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), GetArticulatedRefitMasks(), Train::GetNextUnit(), HasBit(), IsArticulatedVehicleCarryingDifferentCargos(), CompanyProperties::money, OrderSettings::no_servicing_if_no_breakdowns, GameSettings::order, owner, VehicleDefaultSettings::servint_ispercent, Company::settings, VEH_TRAIN, CompanySettings::vehicle, DifficultySettings::vehicle_breakdowns, vehstatus, 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 466 of file vehicle_base.h.
References next.
Referenced by AfterLoadVehicles(), RefitWindow::BuildRefitList(), CalcPercentVehicleFilled(), CheckCaches(), CheckConsistencyOfArticulatedVehicle(), CmdCloneVehicle(), CmdReverseTrainDirection(), CmdSellRailWagon(), DrawRoadVehDetails(), GetNewCargoTypeForReplace(), IsArticulatedVehicleCarryingDifferentCargos(), IsVehicleRefitable(), Last(), LoadUnloadVehicle(), DepotWindow::OnRightClick(), PositionHelper(), PrepareUnload(), RefitVehicle(), RemoveFromRailBaseStation(), SetNext(), TransferCargo(), VehicleCargoSorter(), VehicleValueSorter(), WhoCanServiceIndustry(), and ~Vehicle().
Vehicle* Vehicle::NextShared | ( | ) | const [inline] |
Get the next vehicle of the shared vehicle chain.
Definition at line 525 of file vehicle_base.h.
References next_shared.
Referenced by AfterLoadVehicles(), AIVehicleList_SharedOrders::AIVehicleList_SharedOrders(), OrderBackup::ClearVehicle(), CmdAddSharedVehicleGroup(), CmdAutofillTimetable(), CmdInsertOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdOrderRefit(), OrderList::DebugCheckSanity(), DeleteOrder(), GenerateVehicleSortList(), OrderList::Initialize(), InsertOrder(), OrderList::IsVehicleInSharedOrdersList(), OrderBackup::OrderBackup(), OrdersWindow::OrderClick_StopSharing(), RemoveFromShared(), RemoveOrderFromAllVehicles(), and OrderList::RemoveVehicle().
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 473 of file vehicle_base.h.
References previous.
Referenced by AfterLoadVehicles(), AgeVehicle(), Crash(), DepotWindow::OnMouseDrag(), and PreDestructor().
Vehicle* Vehicle::PreviousShared | ( | ) | const [inline] |
Get the previous vehicle of the shared vehicle chain.
Definition at line 531 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 1843 of file vehicle.cpp.
References AircraftNextAirportPos_and_Order(), CheckOwnership(), 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(), IncrementOrderIndex(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::index, IsStoppedInDepot(), Order::IsType(), Order::MakeDummy(), Order::MakeGoToDepot(), ODATF_SERVICE_ONLY, ODATFB_HALT, ODTF_MANUAL, ODTFB_PART_OF_ORDERS, owner, return_cmd_error, Order::SetDepotActionType(), Order::SetDepotOrderType(), SetWindowWidgetDirty(), Aircraft::state, Aircraft::targetairport, tile, BaseVehicle::type, VEH_AIRCRAFT, VEH_TRAIN, and vehstatus.
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 2087 of file vehicle.cpp.
References first, next, Next(), and previous.
Referenced by CheckTrainAttachment(), CmdBuildAircraft(), DeleteLastWagon(), Disaster_Helicopter_Init(), Disaster_Small_Ufo_Init(), Disaster_Zeppeliner_Init(), DisasterTick_Big_Ufo(), InsertInConsist(), RemoveFromConsist(), RestoreTrainBackup(), and ~Vehicle().
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 409 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 274 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 1908 of file vehicle.cpp.
References VehicleCache::cached_vis_effect, CALLBACK_FAILED, EngineInfo::callback_mask, CBID_VEHICLE_VISUAL_EFFECT, CBM_VEHICLE_VISUAL_EFFECT, RailVehicleInfo::engclass, GB(), GBUG_VEH_POWERED_WAGON, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, 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_OFFSET_START, 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.
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.
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 417 of file vehicle_sl.cpp.
Counter for managing breakdown events.
Definition at line 163 of file vehicle_base.h.
Referenced by CmdReverseTrainDirection(), CmdTurnRoadVeh(), DisasterTick_Big_Ufo(), DisasterTick_Ufo(), VehicleViewWindow::DrawWidget(), AIVehicle::GetState(), HandleBreakdown(), and TrainCheckIfLineEnds().
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 heuristical purposes to estimate the distance.
Definition at line 133 of file vehicle_base.h.
Referenced by CheckNextTrainTile(), CopyVehicleConfigAndStatistics(), Disaster_Small_Ufo_Init(), DisasterTick_Aircraft(), DisasterTick_Big_Ufo(), DisasterTick_Ufo(), Train::OnNewDay(), OPFShipChooseTrack(), ProcessOrders(), ReleaseDisastersTargetingIndustry(), ReleaseDisastersTargetingVehicle(), RemoveRoadStop(), RoadFindPathToDest(), SendToDepot(), and UpdateOrderDest().
uint16 Vehicle::load_unload_ticks |
Ticks to wait before starting next cycle.
Definition at line 223 of file vehicle_base.h.
Referenced by LoadUnloadStation(), LoadUnloadVehicle(), and PrepareUnload().
Used for gradual loading and other miscellaneous things (.
Definition at line 220 of file vehicle_base.h.
Referenced by TimetableWindow::BuildArrivalDepartureList(), CalcPercentVehicleFilled(), CmdAutofillTimetable(), CmdBuildAircraft(), CmdBuildRailVehicle(), CmdBuildRoadVehicle(), CmdBuildShip(), CmdSetTimetableStart(), CopyVehicleConfigAndStatistics(), TimetableWindow::DrawWidget(), HandleLoading(), HandlePathfindingResult(), LoadUnloadVehicle(), TimetableWindow::OnClick(), TimetableWindow::OnPaint(), OPFShipChooseTrack(), and PrepareUnload().