1

/* $Id$ */

     2

     3

/** @file rail.h */

     4

     5

#ifndef RAIL_H

     6

#define RAIL_H

     7

     8

#include "rail_type.h"

     9

#include "track_type.h"

    10

#include "vehicle_type.h"

    11

#include "gfx_type.h"

    12

#include "core/bitmath_func.hpp"

    13

#include "economy_func.h"

    14

#include "tile_cmd.h"

    15

    16

/** This struct contains all the info that is needed to draw and construct tracks.

    17

 */

    18

struct RailtypeInfo {

    19

	/** Struct containing the main sprites. @note not all sprites are listed, but only

    20

	 *  the ones used directly in the code */

    21

	struct {

    22

		SpriteID track_y;      ///< single piece of rail in Y direction, with ground

    23

		SpriteID track_ns;     ///< two pieces of rail in North and South corner (East-West direction)

    24

		SpriteID ground;       ///< ground sprite for a 3-way switch

    25

		SpriteID single_y;     ///< single piece of rail in Y direction, without ground

    26

		SpriteID single_x;     ///< single piece of rail in X direction

    27

		SpriteID single_n;     ///< single piece of rail in the northern corner

    28

		SpriteID single_s;     ///< single piece of rail in the southern corner

    29

		SpriteID single_e;     ///< single piece of rail in the eastern corner

    30

		SpriteID single_w;     ///< single piece of rail in the western corner

    31

		SpriteID crossing;     ///< level crossing, rail in X direction

    32

		SpriteID tunnel;       ///< tunnel sprites base

    33

	} base_sprites;

    34

    35

	/** struct containing the sprites for the rail GUI. @note only sprites referred to

    36

	 * directly in the code are listed */

    37

	struct {

    38

		SpriteID build_ns_rail;      ///< button for building single rail in N-S direction

    39

		SpriteID build_x_rail;       ///< button for building single rail in X direction

    40

		SpriteID build_ew_rail;      ///< button for building single rail in E-W direction

    41

		SpriteID build_y_rail;       ///< button for building single rail in Y direction

    42

		SpriteID auto_rail;          ///< button for the autorail construction

    43

		SpriteID build_depot;        ///< button for building depots

    44

		SpriteID build_tunnel;       ///< button for building a tunnel

    45

		SpriteID convert_rail;       ///< button for converting rail

    46

	} gui_sprites;

    47

    48

	struct {

    49

		CursorID rail_ns;    ///< Cursor for building rail in N-S direction

    50

		CursorID rail_swne;  ///< Cursor for building rail in X direction

    51

		CursorID rail_ew;    ///< Cursor for building rail in E-W direction

    52

		CursorID rail_nwse;  ///< Cursor for building rail in Y direction

    53

		CursorID autorail;   ///< Cursor for autorail tool

    54

		CursorID depot;      ///< Cursor for building a depot

    55

		CursorID tunnel;     ///< Cursor for building a tunnel

    56

		CursorID convert;    ///< Cursor for converting track

    57

	} cursor;

    58

    59

	struct {

    60

		StringID toolbar_caption;

    61

	} strings;

    62

    63

	/** sprite number difference between a piece of track on a snowy ground and the corresponding one on normal ground */

    64

	SpriteID snow_offset;

    65

    66

	/** bitmask to the OTHER railtypes on which an engine of THIS railtype generates power */

    67

	RailTypes powered_railtypes;

    68

    69

	/** bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel */

    70

	RailTypes compatible_railtypes;

    71

    72

	/**

    73

	 * Offset between the current railtype and normal rail. This means that:<p>

    74

	 * 1) All the sprites in a railset MUST be in the same order. This order

    75

	 *    is determined by normal rail. Check sprites 1005 and following for this order<p>

    76

	 * 2) The position where the railtype is loaded must always be the same, otherwise

    77

	 *    the offset will fail.

    78

	 * @note: Something more flexible might be desirable in the future.

    79

	 */

    80

	SpriteID total_offset;

    81

    82

	/**

    83

	 * Bridge offset

    84

	 */

    85

	SpriteID bridge_offset;

    86

    87

	/**

    88

	 * Offset to add to ground sprite when drawing custom waypoints / stations

    89

	 */

    90

	byte custom_ground_offset;

    91

    92

	/**

    93

	 * Multiplier for curve maximum speed advantage

    94

	 */

    95

	byte curve_speed;

    96

};

    97

    98

    99

/**

   100

 * Returns a pointer to the Railtype information for a given railtype

   101

 * @param railtype the rail type which the information is requested for

   102

 * @return The pointer to the RailtypeInfo

   103

 */

   104

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   105

{

   106

	extern RailtypeInfo _railtypes[RAILTYPE_END];

   107

	assert(railtype < RAILTYPE_END);

   108

	return &_railtypes[railtype];

   109

}

   110

   111

/**

   112

 * Checks if an engine of the given RailType can drive on a tile with a given

   113

 * RailType. This would normally just be an equality check, but for electric

   114

 * rails (which also support non-electric engines).

   115

 * @return Whether the engine can drive on this tile.

   116

 * @param  enginetype The RailType of the engine we are considering.

   117

 * @param  tiletype   The RailType of the tile we are considering.

   118

 */

   119

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   120

{

   121

	return HasBit(GetRailTypeInfo(enginetype)->compatible_railtypes, tiletype);

   122

}

   123

   124

/**

   125

 * Checks if an engine of the given RailType got power on a tile with a given

   126

 * RailType. This would normally just be an equality check, but for electric

   127

 * rails (which also support non-electric engines).

   128

 * @return Whether the engine got power on this tile.

   129

 * @param  enginetype The RailType of the engine we are considering.

   130

 * @param  tiletype   The RailType of the tile we are considering.

   131

 */

   132

static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)

   133

{

   134

	return HasBit(GetRailTypeInfo(enginetype)->powered_railtypes, tiletype);

   135

}

   136

   137

   138

extern int _railtype_cost_multiplier[RAILTYPE_END];

   139

extern const int _default_railtype_cost_multiplier[RAILTYPE_END];

   140

   141

/**

   142

 * Returns the cost of building the specified railtype.

   143

 * @param railtype The railtype being built.

   144

 * @return The cost multiplier.

   145

 */

   146

static inline Money RailBuildCost(RailType railtype)

   147

{

   148

	assert(railtype < RAILTYPE_END);

   149

	return (_price.build_rail * _railtype_cost_multiplier[railtype]) >> 3;

   150

}

   151

   152

/**

   153

 * Calculates the cost of rail conversion

   154

 * @param from The railtype we are converting from

   155

 * @param to   The railtype we are converting to

   156

 * @return Cost per TrackBit

   157

 */

   158

static inline Money RailConvertCost(RailType from, RailType to)

   159

{

   160

	/* rail -> el. rail

   161

	 * calculate the price as 5 / 4 of (cost build el. rail) - (cost build rail)

   162

	 * (the price of workers to get to place is that 1/4)

   163

	 */

   164

	if (HasPowerOnRail(from, to)) {

   165

		return ((RailBuildCost(to) - RailBuildCost(from)) * 5) >> 2;

   166

	}

   167

   168

	/* el. rail -> rail

   169

	 * calculate the price as 1 / 4 of (cost build el. rail) - (cost build rail)

   170

	 * (the price of workers is 1 / 4 + price of copper sold to a recycle center)

   171

	 */

   172

	if (HasPowerOnRail(to, from)) {

   173

		return (RailBuildCost(from) - RailBuildCost(to)) >> 2;

   174

	}

   175

   176

	/* make the price the same as remove + build new type */

   177

	return RailBuildCost(to) + _price.remove_rail;

   178

}

   179

   180

void *UpdateTrainPowerProc(Vehicle *v, void *data);

   181

void DrawTrainDepotSprite(int x, int y, int image, RailType railtype);

   182

void DrawDefaultWaypointSprite(int x, int y, RailType railtype);

   183

void *EnsureNoTrainOnTrackProc(Vehicle *v, void *data);

   184

int TicksToLeaveDepot(const Vehicle *v);

   185

   186

   187

/**

   188

 * Test if a rail type has catenary

   189

 * @param rt Rail type to test

   190

 */

   191

static inline bool HasCatenary(RailType rt)

   192

{

   193

	return rt == RAILTYPE_ELECTRIC;

   194

}

   195

   196

   197

/**

   198

 * Draws overhead wires and pylons for electric railways.

   199

 * @param ti The TileInfo struct of the tile being drawn

   200

 * @see DrawCatenaryRailway

   201

 */

   202

void DrawCatenary(const TileInfo *ti);

   203

void DrawCatenaryOnTunnel(const TileInfo *ti);

   204

   205

Foundation GetRailFoundation(Slope tileh, TrackBits bits);

   206

   207

int32 SettingsDisableElrail(int32 p1); ///< _patches.disable_elrail callback

   208

   209

/**

   210

 * Finds out if a Player has a certain railtype available

   211

 * @param p Player in question

   212

 * @param railtype requested RailType

   213

 * @return true if player has requested RailType available

   214

 */

   215

bool HasRailtypeAvail(const PlayerID p, const RailType railtype);

   216

   217

/**

   218

 * Validate functions for rail building.

   219

 * @param rail the railtype to check.

   220

 * @return true if the current player may build the rail.

   221

 */

   222

bool ValParamRailtype(const RailType rail);

   223

   224

/**

   225

 * Returns the "best" railtype a player can build.

   226

 * As the AI doesn't know what the BEST one is, we have our own priority list

   227

 * here. When adding new railtypes, modify this function

   228

 * @param p the player "in action"

   229

 * @return The "best" railtype a player has available

   230

 */

   231

RailType GetBestRailtype(const PlayerID p);

   232

   233

/**

   234

 * Get the rail types the given player can build.

   235

 * @param p the player to get the rail types for.

   236

 * @return the rail types.

   237

 */

   238

RailTypes GetPlayerRailtypes(const PlayerID p);

   239

   240

#endif /* RAIL_H */