1

/* $Id$ */

     2

     3

/** @vehicle.h Functions related to vehicles. */

     4

     5

#ifndef VEHICLE_FUNC_H

     6

#define VEHICLE_FUNC_H

     7

     8

#include "tile_type.h"

     9

#include "strings_type.h"

    10

#include "gfx_type.h"

    11

#include "direction_type.h"

    12

#include "cargo_type.h"

    13

#include "command_type.h"

    14

#include "vehicle_type.h"

    15

#include "engine_type.h"

    16

    17

#define is_custom_sprite(x) (x >= 0xFD)

    18

#define IS_CUSTOM_FIRSTHEAD_SPRITE(x) (x == 0xFD)

    19

#define IS_CUSTOM_SECONDHEAD_SPRITE(x) (x == 0xFE)

    20

    21

typedef void *VehicleFromPosProc(Vehicle *v, void *data);

    22

    23

void VehicleServiceInDepot(Vehicle *v);

    24

void VehiclePositionChanged(Vehicle *v);

    25

Vehicle *GetLastVehicleInChain(Vehicle *v);

    26

uint CountVehiclesInChain(const Vehicle *v);

    27

bool IsEngineCountable(const Vehicle *v);

    28

void DeleteVehicleChain(Vehicle *v);

    29

void *VehicleFromPos(TileIndex tile, void *data, VehicleFromPosProc *proc);

    30

void *VehicleFromPosXY(int x, int y, void *data, VehicleFromPosProc *proc);

    31

void CallVehicleTicks();

    32

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

    33

uint8 CalcPercentVehicleFilled(Vehicle *v, StringID *color);

    34

    35

void InitializeTrains();

    36

byte VehicleRandomBits();

    37

void ResetVehiclePosHash();

    38

void ResetVehicleColorMap();

    39

    40

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

    41

CargoID FindFirstRefittableCargo(EngineID engine_type);

    42

CommandCost GetRefitCost(EngineID engine_type);

    43

    44

void ViewportAddVehicles(DrawPixelInfo *dpi);

    45

    46

SpriteID GetRotorImage(const Vehicle *v);

    47

    48

uint32 VehicleEnterTile(Vehicle *v, TileIndex tile, int x, int y);

    49

    50

StringID VehicleInTheWayErrMsg(const Vehicle* v);

    51

Vehicle *FindVehicleBetween(TileIndex from, TileIndex to, byte z, bool without_crashed = false);

    52

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile);

    53

    54

void DecreaseVehicleValue(Vehicle *v);

    55

void CheckVehicleBreakdown(Vehicle *v);

    56

void AgeVehicle(Vehicle *v);

    57

void VehicleEnteredDepotThisTick(Vehicle *v);

    58

    59

void BeginVehicleMove(const Vehicle *v);

    60

void EndVehicleMove(const Vehicle *v);

    61

void MarkSingleVehicleDirty(const Vehicle *v);

    62

    63

UnitID GetFreeUnitNumber(VehicleType type);

    64

    65

void TrainConsistChanged(Vehicle *v);

    66

void TrainPowerChanged(Vehicle *v);

    67

Money GetTrainRunningCost(const Vehicle *v);

    68

    69

bool VehicleNeedsService(const Vehicle *v);

    70

    71

uint GenerateVehicleSortList(const Vehicle*** sort_list, uint16 *length_of_array, VehicleType type, PlayerID owner, uint32 index, uint16 window_type);

    72

void BuildDepotVehicleList(VehicleType type, TileIndex tile, Vehicle ***engine_list, uint16 *engine_list_length, uint16 *engine_count, Vehicle ***wagon_list, uint16 *wagon_list_length, uint16 *wagon_count);

    73

CommandCost SendAllVehiclesToDepot(VehicleType type, uint32 flags, bool service, PlayerID owner, uint16 vlw_flag, uint32 id);

    74

void VehicleEnterDepot(Vehicle *v);

    75

    76

CommandCost MaybeReplaceVehicle(Vehicle *v, bool check, bool display_costs);

    77

bool CanBuildVehicleInfrastructure(VehicleType type);

    78

    79

void CcCloneVehicle(bool success, TileIndex tile, uint32 p1, uint32 p2);

    80

    81

/* Flags to add to p2 for goto depot commands */

    82

/* Note: bits 8-10 are used for VLW flags */

    83

enum {

    84

	DEPOT_SERVICE       = (1 << 0), // The vehicle will leave the depot right after arrival (serivce only)

    85

	DEPOT_MASS_SEND     = (1 << 1), // Tells that it's a mass send to depot command (type in VLW flag)

    86

	DEPOT_DONT_CANCEL   = (1 << 2), // Don't cancel current goto depot command if any

    87

	DEPOT_LOCATE_HANGAR = (1 << 3), // Find another airport if the target one lacks a hangar

    88

};

    89

    90

struct GetNewVehiclePosResult {

    91

	int x, y;

    92

	TileIndex old_tile;

    93

	TileIndex new_tile;

    94

};

    95

    96

/* returns true if staying in the same tile */

    97

GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);

    98

Direction GetDirectionTowards(const Vehicle *v, int x, int y);

    99

   100

static inline bool IsPlayerBuildableVehicleType(VehicleType type)

   101

{

   102

	switch (type) {

   103

		case VEH_TRAIN:

   104

		case VEH_ROAD:

   105

		case VEH_SHIP:

   106

		case VEH_AIRCRAFT:

   107

			return true;

   108

   109

		default: return false;

   110

	}

   111

}

   112

   113

static inline bool IsPlayerBuildableVehicleType(const BaseVehicle *v)

   114

{

   115

	return IsPlayerBuildableVehicleType(v->type);

   116

}

   117

   118

const struct Livery *GetEngineLivery(EngineID engine_type, PlayerID player, EngineID parent_engine_type, const Vehicle *v);

   119

   120

/**

   121

 * Get the colour map for an engine. This used for unbuilt engines in the user interface.

   122

 * @param engine_type ID of engine

   123

 * @param player ID of player

   124

 * @return A ready-to-use palette modifier

   125

 */

   126

SpriteID GetEnginePalette(EngineID engine_type, PlayerID player);

   127

   128

/**

   129

 * Get the colour map for a vehicle.

   130

 * @param v Vehicle to get colour map for

   131

 * @return A ready-to-use palette modifier

   132

 */

   133

SpriteID GetVehiclePalette(const Vehicle *v);

   134

   135

extern const uint32 _veh_build_proc_table[];

   136

extern const uint32 _veh_sell_proc_table[];

   137

extern const uint32 _veh_refit_proc_table[];

   138

extern const uint32 _send_to_depot_proc_table[];

   139

   140

/* Functions to find the right command for certain vehicle type */

   141

static inline uint32 GetCmdBuildVeh(VehicleType type)

   142

{

   143

	return _veh_build_proc_table[type];

   144

}

   145

   146

static inline uint32 GetCmdBuildVeh(const BaseVehicle *v)

   147

{

   148

	return GetCmdBuildVeh(v->type);

   149

}

   150

   151

static inline uint32 GetCmdSellVeh(VehicleType type)

   152

{

   153

	return _veh_sell_proc_table[type];

   154

}

   155

   156

static inline uint32 GetCmdSellVeh(const BaseVehicle *v)

   157

{

   158

	return GetCmdSellVeh(v->type);

   159

}

   160

   161

static inline uint32 GetCmdRefitVeh(VehicleType type)

   162

{

   163

	return _veh_refit_proc_table[type];

   164

}

   165

   166

static inline uint32 GetCmdRefitVeh(const BaseVehicle *v)

   167

{

   168

	return GetCmdRefitVeh(v->type);

   169

}

   170

   171

static inline uint32 GetCmdSendToDepot(VehicleType type)

   172

{

   173

	return _send_to_depot_proc_table[type];

   174

}

   175

   176

static inline uint32 GetCmdSendToDepot(const BaseVehicle *v)

   177

{

   178

	return GetCmdSendToDepot(v->type);

   179

}

   180

   181

bool EnsureNoVehicleOnGround(TileIndex tile);

   182

void StopAllVehicles();

   183

   184

Vehicle *CreateEffectVehicle(int x, int y, int z, EffectVehicle type);

   185

Vehicle *CreateEffectVehicleAbove(int x, int y, int z, EffectVehicle type);

   186

Vehicle *CreateEffectVehicleRel(const Vehicle *v, int x, int y, int z, EffectVehicle type);

   187

   188

extern VehicleID _vehicle_id_ctr_day;

   189

extern Vehicle *_place_clicked_vehicle;

   190

extern VehicleID _new_vehicle_id;

   191

extern uint16 _returned_refit_capacity;

   192

   193

#endif /* VEHICLE_H */