ship.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef SHIP_H
#define SHIP_H
 
#include "vehicle_base.h"
#include "water_map.h"
 
void GetShipSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type);
WaterClass GetEffectiveWaterClass(TileIndex tile);
 
struct ShipPathElement {
  Trackdir trackdir; 
 
  constexpr ShipPathElement() : trackdir(INVALID_TRACKDIR) {}
  constexpr ShipPathElement(Trackdir trackdir) : trackdir(trackdir) {}
};
 
using ShipPathCache = std::vector<ShipPathElement>;
 
struct Ship final : public SpecializedVehicle<Ship, VEH_SHIP> {
  ShipPathCache path;   
  TrackBits state;      
  Direction rotation;   
  int16_t rotation_x_pos; 
  int16_t rotation_y_pos; 
 
  Ship() : SpecializedVehicleBase() {}
  virtual ~Ship() { this->PreDestructor(); }
 
  void MarkDirty() override;
  void UpdateDeltaXY() override;
  ExpensesType GetExpenseType(bool income) const override { return income ? EXPENSES_SHIP_REVENUE : EXPENSES_SHIP_RUN; }
  void PlayLeaveStationSound(bool force = false) const override;
  bool IsPrimaryVehicle() const override { return true; }
  void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const override;
  int GetDisplaySpeed() const override { return this->cur_speed / 2; }
  int GetDisplayMaxSpeed() const override { return this->vcache.cached_max_speed / 2; }
  int GetCurrentMaxSpeed() const override { return std::min<int>(this->vcache.cached_max_speed, this->current_order.GetMaxSpeed() * 2); }
  Money GetRunningCost() const override;
  bool IsInDepot() const override { return this->state == TRACK_BIT_DEPOT; }
  bool Tick() override;
  void OnNewCalendarDay() override;
  void OnNewEconomyDay() override;
  Trackdir GetVehicleTrackdir() const override;
  TileIndex GetOrderStationLocation(StationID station) override;
  ClosestDepot FindClosestDepot() override;
  void UpdateCache();
  void SetDestTile(TileIndex tile) override;
};
 
bool IsShipDestinationTile(TileIndex tile, StationID station);
 
#endif /* SHIP_H */