tron@3962: /* $Id$ */
tron@3962: 
rubidium@9111: /** @file ship.h Base for ships. */
belugas@6420: 
peter1138@4666: #ifndef SHIP_H
peter1138@4666: #define SHIP_H
peter1138@4666: 
rubidium@8144: #include "vehicle_base.h"
rubidium@8786: #include "engine_func.h"
peter1138@9070: #include "engine_base.h"
rubidium@8116: #include "economy_func.h"
tron@3962: 
bjarni@5783: void CcBuildShip(bool success, TileIndex tile, uint32 p1, uint32 p2);
bjarni@4725: void RecalcShipStuff(Vehicle *v);
bjarni@5972: void GetShipSpriteSize(EngineID engine, uint &width, uint &height);
tron@3962: 
rubidium@6552: /**
rubidium@6552:  * This class 'wraps' Vehicle; you do not actually instantiate this class.
rubidium@6552:  * You create a Vehicle using AllocateVehicle, so it is added to the pool
rubidium@6552:  * and you reinitialize that to a Train using:
rubidium@6552:  *   v = new (v) Ship();
rubidium@6552:  *
rubidium@6552:  * As side-effect the vehicle type is set correctly.
rubidium@6552:  */
rubidium@6552: struct Ship: public Vehicle {
rubidium@6552: 	/** Initializes the Vehicle to a ship */
rubidium@6552: 	Ship() { this->type = VEH_SHIP; }
rubidium@6552: 
rubidium@6552: 	/** We want to 'destruct' the right class. */
rubidium@7412: 	virtual ~Ship() { this->PreDestructor(); }
rubidium@6552: 
rubidium@6563: 	const char *GetTypeString() const { return "ship"; }
rubidium@6553: 	void MarkDirty();
rubidium@6558: 	void UpdateDeltaXY(Direction direction);
rubidium@6563: 	ExpensesType GetExpenseType(bool income) const { return income ? EXPENSES_SHIP_INC : EXPENSES_SHIP_RUN; }
rubidium@6593: 	void PlayLeaveStationSound() const;
maedhros@6773: 	bool IsPrimaryVehicle() const { return true; }
peter1138@9022: 	SpriteID GetImage(Direction direction) const;
rubidium@7477: 	int GetDisplaySpeed() const { return this->cur_speed * 10 / 32; }
rubidium@7484: 	int GetDisplayMaxSpeed() const { return this->max_speed * 10 / 32; }
rubidium@7488: 	Money GetRunningCost() const { return ShipVehInfo(this->engine_type)->running_cost * _price.ship_running; }
smatz@9045: 	bool IsInDepot() const { return this->u.ship.state == TRACK_BIT_DEPOT; }
rubidium@7135: 	void Tick();
glx@8467: 	void OnNewDay();
rubidium@8827: 	TileIndex GetOrderStationLocation(StationID station);
rubidium@8890: 	bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse);
rubidium@6552: };
rubidium@6552: 
peter1138@4666: #endif /* SHIP_H */