1

/* $Id$ */

     2

     3

/** @file vehicle_func.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

#include "transport_type.h"

    17

    18

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

    19

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

    20

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

    21

    22

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

    23

    24

void VehicleServiceInDepot(Vehicle *v);

    25

void VehiclePositionChanged(Vehicle *v);

    26

Vehicle *GetLastVehicleInChain(Vehicle *v);

    27

const Vehicle *GetLastVehicleInChain(const Vehicle *v);

    28

uint CountVehiclesInChain(const Vehicle *v);

    29

bool IsEngineCountable(const Vehicle *v);

    30

void DeleteVehicleChain(Vehicle *v);

    31

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

    32

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

    33

bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);

    34

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

    35

void CallVehicleTicks();

    36

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

    37

    38

void InitializeTrains();

    39

byte VehicleRandomBits();

    40

void ResetVehiclePosHash();

    41

void ResetVehicleColorMap();

    42

    43

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

    44

CargoID FindFirstRefittableCargo(EngineID engine_type);

    45

CommandCost GetRefitCost(EngineID engine_type);

    46

    47

void ViewportAddVehicles(DrawPixelInfo *dpi);

    48

    49

SpriteID GetRotorImage(const Vehicle *v);

    50

    51

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

    52

    53

StringID VehicleInTheWayErrMsg(const Vehicle* v);

    54

bool HasVehicleOnTunnelBridge(TileIndex tile, TileIndex endtile, const Vehicle *ignore = NULL);

    55

    56

void DecreaseVehicleValue(Vehicle *v);

    57

void CheckVehicleBreakdown(Vehicle *v);

    58

void AgeVehicle(Vehicle *v);

    59

void VehicleEnteredDepotThisTick(Vehicle *v);

    60

    61

void BeginVehicleMove(const Vehicle *v);

    62

void EndVehicleMove(const Vehicle *v);

    63

void MarkSingleVehicleDirty(const Vehicle *v);

    64

    65

UnitID GetFreeUnitNumber(VehicleType type);

    66

    67

void TrainConsistChanged(Vehicle *v, bool same_length);

    68

void TrainPowerChanged(Vehicle *v);

    69

Money GetTrainRunningCost(const Vehicle *v);

    70

    71

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

    72

void VehicleEnterDepot(Vehicle *v);

    73

    74

bool CanBuildVehicleInfrastructure(VehicleType type);

    75

    76

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

    77

    78

    79

struct GetNewVehiclePosResult {

    80

	int x, y;

    81

	TileIndex old_tile;

    82

	TileIndex new_tile;

    83

};

    84

    85

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

    86

GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);

    87

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

    88

    89

static inline bool IsPlayerBuildableVehicleType(VehicleType type)

    90

{

    91

	switch (type) {

    92

		case VEH_TRAIN:

    93

		case VEH_ROAD:

    94

		case VEH_SHIP:

    95

		case VEH_AIRCRAFT:

    96

			return true;

    97

    98

		default: return false;

    99

	}

   100

}

   101

   102

static inline bool IsPlayerBuildableVehicleType(const BaseVehicle *v)

   103

{

   104

	return IsPlayerBuildableVehicleType(v->type);

   105

}

   106

   107

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

   108

   109

/**

   110

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

   111

 * @param engine_type ID of engine

   112

 * @param player ID of player

   113

 * @return A ready-to-use palette modifier

   114

 */

   115

SpriteID GetEnginePalette(EngineID engine_type, PlayerID player);

   116

   117

/**

   118

 * Get the colour map for a vehicle.

   119

 * @param v Vehicle to get colour map for

   120

 * @return A ready-to-use palette modifier

   121

 */

   122

SpriteID GetVehiclePalette(const Vehicle *v);

   123

   124

extern const uint32 _veh_build_proc_table[];

   125

extern const uint32 _veh_sell_proc_table[];

   126

extern const uint32 _veh_refit_proc_table[];

   127

extern const uint32 _send_to_depot_proc_table[];

   128

   129

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

   130

static inline uint32 GetCmdBuildVeh(VehicleType type)

   131

{

   132

	return _veh_build_proc_table[type];

   133

}

   134

   135

static inline uint32 GetCmdBuildVeh(const BaseVehicle *v)

   136

{

   137

	return GetCmdBuildVeh(v->type);

   138

}

   139

   140

static inline uint32 GetCmdSellVeh(VehicleType type)

   141

{

   142

	return _veh_sell_proc_table[type];

   143

}

   144

   145

static inline uint32 GetCmdSellVeh(const BaseVehicle *v)

   146

{

   147

	return GetCmdSellVeh(v->type);

   148

}

   149

   150

static inline uint32 GetCmdRefitVeh(VehicleType type)

   151

{

   152

	return _veh_refit_proc_table[type];

   153

}

   154

   155

static inline uint32 GetCmdRefitVeh(const BaseVehicle *v)

   156

{

   157

	return GetCmdRefitVeh(v->type);

   158

}

   159

   160

static inline uint32 GetCmdSendToDepot(VehicleType type)

   161

{

   162

	return _send_to_depot_proc_table[type];

   163

}

   164

   165

static inline uint32 GetCmdSendToDepot(const BaseVehicle *v)

   166

{

   167

	return GetCmdSendToDepot(v->type);

   168

}

   169

   170

bool EnsureNoVehicleOnGround(TileIndex tile);

   171

void StopAllVehicles();

   172

   173

extern VehicleID _vehicle_id_ctr_day;

   174

extern const Vehicle *_place_clicked_vehicle;

   175

extern VehicleID _new_vehicle_id;

   176

extern uint16 _returned_refit_capacity;

   177

   178

#endif /* VEHICLE_FUNC_H */