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