tron@3959: /* $Id$ */
tron@3959: 
glx@9574: /** @file src/roadveh.h Road vehicle states */
glx@9574: 
peter1138@4666: #ifndef ROADVEH_H
peter1138@4666: #define ROADVEH_H
peter1138@4666: 
rubidium@9723: #include "vehicle_base.h"
rubidium@9837: #include "engine_func.h"
rubidium@9723: #include "economy_func.h"
tron@3959: 
glx@9627: enum RoadVehicleSubType {
glx@9627: 	RVST_FRONT,
glx@9627: 	RVST_ARTIC_PART,
glx@9627: };
glx@9627: 
glx@9627: static inline bool IsRoadVehFront(const Vehicle *v)
glx@9627: {
glx@9627: 	assert(v->type == VEH_ROAD);
glx@9627: 	return v->subtype == RVST_FRONT;
glx@9627: }
glx@9627: 
glx@9627: static inline void SetRoadVehFront(Vehicle *v)
glx@9627: {
glx@9627: 	assert(v->type == VEH_ROAD);
glx@9627: 	v->subtype = RVST_FRONT;
glx@9627: }
glx@9627: 
glx@9627: static inline bool IsRoadVehArticPart(const Vehicle *v)
glx@9627: {
glx@9627: 	assert(v->type == VEH_ROAD);
glx@9627: 	return v->subtype == RVST_ARTIC_PART;
glx@9627: }
glx@9627: 
glx@9627: static inline void SetRoadVehArticPart(Vehicle *v)
glx@9627: {
glx@9627: 	assert(v->type == VEH_ROAD);
glx@9627: 	v->subtype = RVST_ARTIC_PART;
glx@9627: }
glx@9627: 
glx@9627: static inline bool RoadVehHasArticPart(const Vehicle *v)
glx@9627: {
glx@9627: 	assert(v->type == VEH_ROAD);
rubidium@9701: 	return v->Next() != NULL && IsRoadVehArticPart(v->Next());
glx@9627: }
glx@9627: 
glx@9627: 
bjarni@6037: void CcBuildRoadVeh(bool success, TileIndex tile, uint32 p1, uint32 p2);
peter1138@4666: 
rubidium@10142: byte GetRoadVehLength(const Vehicle *v);
rubidium@10142: 
rubidium@10142: void RoadVehUpdateCache(Vehicle *v);
rubidium@10142: 
rubidium@9620: 
rubidium@9620: /**
rubidium@9620:  * This class 'wraps' Vehicle; you do not actually instantiate this class.
rubidium@9620:  * You create a Vehicle using AllocateVehicle, so it is added to the pool
rubidium@9620:  * and you reinitialize that to a Train using:
rubidium@9620:  *   v = new (v) RoadVehicle();
rubidium@9620:  *
rubidium@9620:  * As side-effect the vehicle type is set correctly.
rubidium@9620:  */
rubidium@9620: struct RoadVehicle : public Vehicle {
rubidium@9620: 	/** Initializes the Vehicle to a road vehicle */
rubidium@9620: 	RoadVehicle() { this->type = VEH_ROAD; }
rubidium@9620: 
rubidium@9620: 	/** We want to 'destruct' the right class. */
rubidium@9701: 	virtual ~RoadVehicle() { this->PreDestructor(); }
rubidium@9620: 
rubidium@9620: 	const char *GetTypeString() const { return "road vehicle"; }
rubidium@9620: 	void MarkDirty();
rubidium@9620: 	void UpdateDeltaXY(Direction direction);
rubidium@9620: 	ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_ROADVEH_INC : EXPENSES_ROADVEH_RUN; }
rubidium@9620: 	WindowClass GetVehicleListWindowClass() const { return WC_ROADVEH_LIST; }
glx@9627: 	bool IsPrimaryVehicle() const { return IsRoadVehFront(this); }
rubidium@9631: 	int GetImage(Direction direction) const;
rubidium@9701: 	int GetDisplaySpeed() const { return this->cur_speed * 10 / 32; }
rubidium@9701: 	int GetDisplayMaxSpeed() const { return this->max_speed * 10 / 32; }
glx@9732: 	Money GetRunningCost() const { return RoadVehInfo(this->engine_type)->running_cost * GetPriceByIndex(RoadVehInfo(this->engine_type)->running_cost_class); }
rubidium@9701: 	bool IsInDepot() const { return this->u.road.state == RVSB_IN_DEPOT; }
rubidium@9631: 	void Tick();
rubidium@9724: 	void OnNewDay();
rubidium@9869: 	TileIndex GetOrderStationLocation(StationID station);
rubidium@10142: 	bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
rubidium@9620: };
rubidium@9620: 
peter1138@4666: #endif /* ROADVEH_H */