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

enum RailTypeFlag {

    17

	RTF_CATENARY = 0,  ///< Set if the rail type should have catenary drawn

    18

};

    19

    20

enum RailTypeFlags {

    21

	RTFB_NONE     = 0,

    22

	RTFB_CATENARY = 1 << RTF_CATENARY,

    23

};

    24

DECLARE_ENUM_AS_BIT_SET(RailTypeFlags);

    25

    26

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

    27

 */

    28

struct RailtypeInfo {

    29

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

    30

	 *  the ones used directly in the code */

    31

	struct {

    32

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

    33

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

    34

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

    35

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

    36

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

    37

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

    38

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

    39

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

    40

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

    41

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

    42

		SpriteID tunnel;       ///< tunnel sprites base

    43

	} base_sprites;

    44

    45

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

    46

	 * directly in the code are listed */

    47

	struct {

    48

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

    49

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

    50

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

    51

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

    52

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

    53

		SpriteID build_depot;        ///< button for building depots

    54

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

    55

		SpriteID convert_rail;       ///< button for converting rail

    56

	} gui_sprites;

    57

    58

	struct {

    59

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

    60

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

    61

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

    62

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

    63

		CursorID autorail;   ///< Cursor for autorail tool

    64

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

    65

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

    66

		CursorID convert;    ///< Cursor for converting track

    67

	} cursor;

    68

    69

	struct {

    70

		StringID toolbar_caption;

    71

	} strings;

    72

    73

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

    74

	SpriteID snow_offset;

    75

    76

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

    77

	RailTypes powered_railtypes;

    78

    79

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

    80

	RailTypes compatible_railtypes;

    81

    82

	/**

    83

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

    84

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

    85

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

    86

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

    87

	 *    the offset will fail.

    88

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

    89

	 */

    90

	SpriteID total_offset;

    91

    92

	/**

    93

	 * Bridge offset

    94

	 */

    95

	SpriteID bridge_offset;

    96

    97

	/**

    98

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

    99

	 */

   100

	byte custom_ground_offset;

   101

   102

	/**

   103

	 * Multiplier for curve maximum speed advantage

   104

	 */

   105

	byte curve_speed;

   106

   107

	/**

   108

	 * Bit mask of rail type flags

   109

	 */

   110

	RailTypeFlags flags;

   111

};

   112

   113

   114

/**

   115

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

   116

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

   117

 * @return The pointer to the RailtypeInfo

   118

 */

   119

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   120

{

   121

	extern RailtypeInfo _railtypes[RAILTYPE_END];

   122

	assert(railtype < RAILTYPE_END);

   123

	return &_railtypes[railtype];

   124

}

   125

   126

/**

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

 */

   134

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   135

{

   136

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

   137

}

   138

   139

/**

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   146

 */

   147

static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)

   148

{

   149

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

   150

}

   151

   152

   153

extern int _railtype_cost_multiplier[RAILTYPE_END];

   154

extern const int _default_railtype_cost_multiplier[RAILTYPE_END];

   155

   156

/**

   157

 * Returns the cost of building the specified railtype.

   158

 * @param railtype The railtype being built.

   159

 * @return The cost multiplier.

   160

 */

   161

static inline Money RailBuildCost(RailType railtype)

   162

{

   163

	assert(railtype < RAILTYPE_END);

   164

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

   165

}

   166

   167

/**

   168

 * Calculates the cost of rail conversion

   169

 * @param from The railtype we are converting from

   170

 * @param to   The railtype we are converting to

   171

 * @return Cost per TrackBit

   172

 */

   173

static inline Money RailConvertCost(RailType from, RailType to)

   174

{

   175

	/* rail -> el. rail

   176

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

   177

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

   178

	 */

   179

	if (HasPowerOnRail(from, to)) {

   180

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

   181

	}

   182

   183

	/* el. rail -> rail

   184

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

   185

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

   186

	 */

   187

	if (HasPowerOnRail(to, from)) {

   188

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

   189

	}

   190

   191

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

   192

	return RailBuildCost(to) + _price.remove_rail;

   193

}

   194

   195

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

   196

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

   197

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

   198

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

   199

int TicksToLeaveDepot(const Vehicle *v);

   200

   201

   202

/**

   203

 * Test if a rail type has catenary

   204

 * @param rt Rail type to test

   205

 */

   206

static inline bool HasCatenary(RailType rt)

   207

{

   208

	return HasBit(GetRailTypeInfo(rt)->flags, RTF_CATENARY);

   209

}

   210

   211

   212

/**

   213

 * Draws overhead wires and pylons for electric railways.

   214

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

   215

 * @see DrawCatenaryRailway

   216

 */

   217

void DrawCatenary(const TileInfo *ti);

   218

void DrawCatenaryOnTunnel(const TileInfo *ti);

   219

   220

Foundation GetRailFoundation(Slope tileh, TrackBits bits);

   221

   222

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

   223

   224

/**

   225

 * Finds out if a Player has a certain railtype available

   226

 * @param p Player in question

   227

 * @param railtype requested RailType

   228

 * @return true if player has requested RailType available

   229

 */

   230

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

   231

   232

/**

   233

 * Validate functions for rail building.

   234

 * @param rail the railtype to check.

   235

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

   236

 */

   237

bool ValParamRailtype(const RailType rail);

   238

   239

/**

   240

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

   241

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

   242

 * here. When adding new railtypes, modify this function

   243

 * @param p the player "in action"

   244

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

   245

 */

   246

RailType GetBestRailtype(const PlayerID p);

   247

   248

/**

   249

 * Get the rail types the given player can build.

   250

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

   251

 * @return the rail types.

   252

 */

   253

RailTypes GetPlayerRailtypes(const PlayerID p);

   254

   255

#endif /* RAIL_H */