tron@3962: /* $Id$ */
tron@3962: 
rubidium@10455: /** @file ship.h Base for ships. */
glx@9574: 
peter1138@4666: #ifndef SHIP_H
peter1138@4666: #define SHIP_H
peter1138@4666: 
rubidium@9723: #include "vehicle_base.h"
rubidium@9837: #include "engine_func.h"
rubidium@10455: #include "engine_base.h"
rubidium@9723: #include "economy_func.h"
tron@3962: 
bjarni@6034: void CcBuildShip(bool success, TileIndex tile, uint32 p1, uint32 p2);
bjarni@4725: void RecalcShipStuff(Vehicle *v);
bjarni@6223: void GetShipSpriteSize(EngineID engine, uint &width, uint &height);
tron@3962: 
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) Ship();
rubidium@9620:  *
rubidium@9620:  * As side-effect the vehicle type is set correctly.
rubidium@9620:  */
rubidium@9620: struct Ship: public Vehicle {
rubidium@9620: 	/** Initializes the Vehicle to a ship */
rubidium@9620: 	Ship() { this->type = VEH_SHIP; }
rubidium@9620: 
rubidium@9620: 	/** We want to 'destruct' the right class. */
rubidium@9701: 	virtual ~Ship() { this->PreDestructor(); }
rubidium@9620: 
rubidium@9620: 	const char *GetTypeString() const { return "ship"; }
rubidium@9620: 	void MarkDirty();
rubidium@9620: 	void UpdateDeltaXY(Direction direction);
rubidium@9620: 	ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_SHIP_INC : EXPENSES_SHIP_RUN; }
rubidium@9620: 	void PlayLeaveStationSound() const;
rubidium@9625: 	bool IsPrimaryVehicle() const { return true; }
glx@10294: 	SpriteID 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; }
rubidium@9701: 	Money GetRunningCost() const { return ShipVehInfo(this->engine_type)->running_cost * _price.ship_running; }
rubidium@10355: 	bool IsInDepot() const { return this->u.ship.state == TRACK_BIT_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 /* SHIP_H */