OpenTTD Source 20241224-master-gf74b0cf984
ship_cmd.cpp File Reference

Handling of ships. More...

#include "stdafx.h"
#include "ship.h"
#include "landscape.h"
#include "timetable.h"
#include "news_func.h"
#include "company_func.h"
#include "depot_base.h"
#include "station_base.h"
#include "newgrf_engine.h"
#include "pathfinder/yapf/yapf.h"
#include "pathfinder/yapf/yapf_ship_regions.h"
#include "newgrf_sound.h"
#include "spritecache.h"
#include "strings_func.h"
#include "window_func.h"
#include "timer/timer_game_calendar.h"
#include "timer/timer_game_economy.h"
#include "vehicle_func.h"
#include "sound_func.h"
#include "ai/ai.hpp"
#include "game/game.hpp"
#include "engine_base.h"
#include "company_base.h"
#include "tunnelbridge_map.h"
#include "zoom_func.h"
#include "framerate_type.h"
#include "industry.h"
#include "industry_map.h"
#include "ship_cmd.h"
#include "table/strings.h"
#include <unordered_set>
#include "safeguards.h"

Go to the source code of this file.

Data Structures

struct  ShipSubcoordData
 Structure for ship sub-coordinate data for moving into a new tile via a Diagdir onto a Track. More...
 

Functions

WaterClass GetEffectiveWaterClass (TileIndex tile)
 Determine the effective WaterClass for a ship travelling on a tile.
 
template<>
bool IsValidImageIndex< VEH_SHIP > (uint8_t image_index)
 
static TrackBits GetTileShipTrackStatus (TileIndex tile)
 
static void GetShipIcon (EngineID engine, EngineImageType image_type, VehicleSpriteSeq *result)
 
void DrawShipEngine (int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
 
void GetShipSpriteSize (EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
 Get the size of the sprite of a ship sprite heading west (used for lists).
 
static const DepotFindClosestShipDepot (const Vehicle *v, uint max_distance)
 
static void CheckIfShipNeedsService (Vehicle *v)
 
static VehicleEnsureNoMovingShipProc (Vehicle *v, void *)
 Test-procedure for HasVehicleOnPos to check for any ships which are moving.
 
static bool CheckReverseShip (const Ship *v, Trackdir *trackdir=nullptr)
 
static bool CheckShipLeaveDepot (Ship *v)
 
static uint ShipAccelerate (Vehicle *v)
 Accelerates the ship towards its target speed.
 
static void ShipArrivesAt (const Vehicle *v, Station *st)
 Ship arrives at a dock.
 
static Track ChooseShipTrack (Ship *v, TileIndex tile, TrackBits tracks)
 Runs the pathfinder to choose a track to continue along.
 
static TrackBits GetAvailShipTracks (TileIndex tile, DiagDirection dir)
 Get the available water tracks on a tile for a ship entering a tile.
 
static int ShipTestUpDownOnLock (const Ship *v)
 Test if a ship is in the centre of a lock and should move up or down.
 
static bool ShipMoveUpDownOnLock (Ship *v)
 Test and move a ship up or down in a lock.
 
bool IsShipDestinationTile (TileIndex tile, StationID station)
 Test if a tile is a docking tile for the given station.
 
static void ReverseShipIntoTrackdir (Ship *v, Trackdir trackdir)
 
static void ReverseShip (Ship *v)
 
static void ShipController (Ship *v)
 
CommandCost CmdBuildShip (DoCommandFlag flags, TileIndex tile, const Engine *e, Vehicle **ret)
 Build a ship.
 

Variables

constexpr int MAX_SHIP_DEPOT_SEARCH_DISTANCE = 80
 Max distance in tiles (as the crow flies) to search for depots when user clicks "go to depot".
 
static const uint16_t _ship_sprites [] = {0x0E5D, 0x0E55, 0x0E65, 0x0E6D}
 
static const ShipSubcoordData _ship_subcoord [DIAGDIR_END][TRACK_END]
 Ship sub-coordinate data for moving into a new tile via a Diagdir onto a Track.
 

Detailed Description

Handling of ships.

Definition in file ship_cmd.cpp.

Function Documentation

◆ CheckIfShipNeedsService()

static void CheckIfShipNeedsService ( Vehicle v)
static

Definition at line 204 of file ship_cmd.cpp.

◆ CheckReverseShip()

static bool CheckReverseShip ( const Ship v,
Trackdir trackdir = nullptr 
)
static

Definition at line 370 of file ship_cmd.cpp.

◆ CheckShipLeaveDepot()

static bool CheckShipLeaveDepot ( Ship v)
static

Definition at line 376 of file ship_cmd.cpp.

◆ ChooseShipTrack()

static Track ChooseShipTrack ( Ship v,
TileIndex  tile,
TrackBits  tracks 
)
static

Runs the pathfinder to choose a track to continue along.

Parameters
vShip to navigate
tileTile, the ship is about to enter
tracksAvailable track choices on tile
Returns
Track to choose, or INVALID_TRACK when to reverse.

Definition at line 495 of file ship_cmd.cpp.

References Vehicle::dest_tile, FindFirstTrack(), Vehicle::HandlePathfindingResult(), HasBit(), IsDiagonalTrack(), Ship::path, Ship::state, TrackBitsToTrack(), TrackdirToTrack(), TrackToOppositeTrack(), and YapfShipChooseTrack().

◆ CmdBuildShip()

CommandCost CmdBuildShip ( DoCommandFlag  flags,
TileIndex  tile,
const Engine e,
Vehicle **  ret 
)

Build a ship.

Parameters
flagstype of operation.
tiletile of the depot where ship is built.
ethe engine to build.
[out]retthe vehicle that has been built.
Returns
the cost of this operation or an error.

Definition at line 895 of file ship_cmd.cpp.

References _current_company, ShipVehicleInfo::acceleration, Vehicle::acceleration, Vehicle::build_year, Vehicle::cargo_cap, Vehicle::cargo_type, TimerGameCalendar::date, TimerGameEconomy::date, Vehicle::date_of_last_service, Vehicle::date_of_last_service_newgrf, DC_EXEC, Engine::DetermineCapacity(), ENGINE_EXCLUSIVE_PREVIEW, Vehicle::engine_type, Engine::flags, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), Engine::GetDefaultCargoType(), Engine::GetLifeLengthInDays(), GetShipDepotNorthTile(), GetSlopePixelZ(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Vehicle::InvalidateNewGRFCacheOfChain(), IsValidCargoID(), Vehicle::last_loading_station, Vehicle::last_station_visited, Vehicle::max_age, Vehicle::owner, Vehicle::random_bits, Vehicle::refit_cap, Engine::reliability, Vehicle::reliability, Engine::reliability_spd_dec, Vehicle::reliability_spd_dec, VehicleSpriteSeq::Set(), SetBit(), settings, Vehicle::sprite_cache, MutableSpriteCache::sprite_seq, Vehicle::spritenum, Ship::state, Vehicle::tile, TILE_SIZE, TileX(), TileY(), TRACK_BIT_DEPOT, Ship::UpdateCache(), Ship::UpdateDeltaXY(), Vehicle::UpdatePosition(), BaseConsist::vehicle_flags, Vehicle::vehstatus, VF_BUILT_AS_PROTOTYPE, VS_DEFPAL, VS_HIDDEN, VS_STOPPED, Vehicle::x_pos, Vehicle::y_pos, TimerGameCalendar::year, and Vehicle::z_pos.

Referenced by CmdBuildVehicle().

◆ DrawShipEngine()

void DrawShipEngine ( int  left,
int  right,
int  preferred_x,
int  y,
EngineID  engine,
PaletteID  pal,
EngineImageType  image_type 
)

Definition at line 97 of file ship_cmd.cpp.

◆ EnsureNoMovingShipProc()

static Vehicle * EnsureNoMovingShipProc ( Vehicle v,
void *   
)
static

Test-procedure for HasVehicleOnPos to check for any ships which are moving.

Definition at line 365 of file ship_cmd.cpp.

References Vehicle::cur_speed, BaseVehicle::type, and VEH_SHIP.

◆ FindClosestShipDepot()

static const Depot * FindClosestShipDepot ( const Vehicle v,
uint  max_distance 
)
static

Definition at line 151 of file ship_cmd.cpp.

◆ GetAvailShipTracks()

static TrackBits GetAvailShipTracks ( TileIndex  tile,
DiagDirection  dir 
)
inlinestatic

Get the available water tracks on a tile for a ship entering a tile.

Parameters
tileThe tile about to enter.
dirThe entry direction.
Returns
The available trackbits on the next tile.

Definition at line 534 of file ship_cmd.cpp.

References DiagdirReachesTracks().

◆ GetEffectiveWaterClass()

WaterClass GetEffectiveWaterClass ( TileIndex  tile)

Determine the effective WaterClass for a ship travelling on a tile.

Parameters
tileTile of interest
Returns
the waterclass to be used by the ship.

Definition at line 54 of file ship_cmd.cpp.

References GetTunnelBridgeTransportType(), GetWaterClass(), HasTileWaterClass(), IsTileType(), MP_RAILWAY, MP_TUNNELBRIDGE, RAIL_GROUND_WATER, TRANSPORT_WATER, WATER_CLASS_CANAL, and WATER_CLASS_SEA.

Referenced by CYapfCostShipT< Types >::PfCalcCost(), and Ship::UpdateCache().

◆ GetShipIcon()

static void GetShipIcon ( EngineID  engine,
EngineImageType  image_type,
VehicleSpriteSeq result 
)
static

Definition at line 81 of file ship_cmd.cpp.

◆ GetShipSpriteSize()

void GetShipSpriteSize ( EngineID  engine,
uint &  width,
uint &  height,
int &  xoffs,
int &  yoffs,
EngineImageType  image_type 
)

Get the size of the sprite of a ship sprite heading west (used for lists).

Parameters
engineThe engine to get the sprite from.
[out]widthThe width of the sprite.
[out]heightThe height of the sprite.
[out]xoffsNumber of pixels to shift the sprite to the right.
[out]yoffsNumber of pixels to shift the sprite downwards.
image_typeContext the sprite is used in.

Definition at line 120 of file ship_cmd.cpp.

References VehicleSpriteSeq::GetBounds(), Rect::Height(), UnScaleGUI(), and Rect::Width().

Referenced by EnginePreviewWindow::UpdateWidgetSize().

◆ GetTileShipTrackStatus()

static TrackBits GetTileShipTrackStatus ( TileIndex  tile)
inlinestatic

Definition at line 76 of file ship_cmd.cpp.

◆ IsShipDestinationTile()

bool IsShipDestinationTile ( TileIndex  tile,
StationID  station 
)

Test if a tile is a docking tile for the given station.

Parameters
tileDocking tile to test.
stationDestination station.
Returns
true iff docking tile is next to station.

Definition at line 647 of file ship_cmd.cpp.

References DIAGDIR_BEGIN, DIAGDIR_END, Industry::GetByTile(), GetStationIndex(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, IsDockingTile(), IsDockTile(), IsDockWaterPart(), IsOilRig(), IsTileType(), IsValidTile(), MP_INDUSTRY, MP_STATION, Industry::neutral_station, and TileOffsByDiagDir().

Referenced by RemoveDock().

◆ IsValidImageIndex< VEH_SHIP >()

template<>
bool IsValidImageIndex< VEH_SHIP > ( uint8_t  image_index)

Definition at line 71 of file ship_cmd.cpp.

◆ ReverseShip()

static void ReverseShip ( Ship v)
static

Definition at line 685 of file ship_cmd.cpp.

◆ ReverseShipIntoTrackdir()

static void ReverseShipIntoTrackdir ( Ship v,
Trackdir  trackdir 
)
static

Definition at line 664 of file ship_cmd.cpp.

◆ ShipAccelerate()

◆ ShipArrivesAt()

static void ShipArrivesAt ( const Vehicle v,
Station st 
)
static

Ship arrives at a dock.

If it is the first time, send out a news item.

Parameters
vShip that arrived.
stStation being visited.

Definition at line 468 of file ship_cmd.cpp.

References _local_company, AddVehicleNewsItem(), HVOT_SHIP, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Game::NewEvent(), AI::NewEvent(), NT_ARRIVAL_COMPANY, NT_ARRIVAL_OTHER, Vehicle::owner, and SetDParam().

◆ ShipController()

static void ShipController ( Ship v)
static

Definition at line 699 of file ship_cmd.cpp.

◆ ShipMoveUpDownOnLock()

static bool ShipMoveUpDownOnLock ( Ship v)
static

◆ ShipTestUpDownOnLock()

static int ShipTestUpDownOnLock ( const Ship v)
static

Test if a ship is in the centre of a lock and should move up or down.

Parameters
vShip being tested.
Returns
0 if ship is not moving in lock, or -1 to move down, 1 to move up.

Definition at line 596 of file ship_cmd.cpp.

References Vehicle::direction, DirToDiagDir(), GetInclinedSlopeDirection(), GetLockPart(), GetTileMaxZ(), GetTileSlope(), GetTileZ(), IsLock(), IsTileType(), IsValidDiagDirection(), LOCK_PART_MIDDLE, MP_WATER, Vehicle::tile, TILE_HEIGHT, Vehicle::x_pos, Vehicle::y_pos, and Vehicle::z_pos.

Referenced by ShipMoveUpDownOnLock().

Variable Documentation

◆ _ship_sprites

const uint16_t _ship_sprites[] = {0x0E5D, 0x0E55, 0x0E65, 0x0E6D}
static

Definition at line 68 of file ship_cmd.cpp.

◆ _ship_subcoord

const ShipSubcoordData _ship_subcoord[DIAGDIR_END][TRACK_END]
static

Ship sub-coordinate data for moving into a new tile via a Diagdir onto a Track.

Array indexes are Diagdir, Track. There will always be three possible tracks going into an adjacent tile via a Diagdir, so each Diagdir sub-array will have three valid and three invalid structures per Track.

Definition at line 552 of file ship_cmd.cpp.

◆ MAX_SHIP_DEPOT_SEARCH_DISTANCE

constexpr int MAX_SHIP_DEPOT_SEARCH_DISTANCE = 80
constexpr

Max distance in tiles (as the crow flies) to search for depots when user clicks "go to depot".

Definition at line 47 of file ship_cmd.cpp.

Referenced by Ship::FindClosestDepot().