1

/* $Id$ */

     2

     3

/** @file rail.h Rail specific functions. */

     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 "slope_type.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

    42

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

    43

		SpriteID tunnel;       ///< tunnel sprites base

    44

	} base_sprites;

    45

    46

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

    47

	 * directly in the code are listed */

    48

	struct {

    49

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

    50

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

    51

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

    52

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

    53

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

    54

		SpriteID build_depot;        ///< button for building depots

    55

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

    56

		SpriteID convert_rail;       ///< button for converting rail

    57

	} gui_sprites;

    58

    59

	struct {

    60

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

    61

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

    62

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

    63

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

    64

		CursorID autorail;   ///< Cursor for autorail tool

    65

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

    66

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

    67

		CursorID convert;    ///< Cursor for converting track

    68

	} cursor;

    69

    70

	struct {

    71

		StringID toolbar_caption;

    72

	} strings;

    73

    74

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

    75

	SpriteID snow_offset;

    76

    77

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

    78

	RailTypes powered_railtypes;

    79

    80

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

    81

	RailTypes compatible_railtypes;

    82

    83

	/**

    84

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

    85

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

    86

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

    87

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

    88

	 *    the offset will fail.

    89

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

    90

	 */

    91

	SpriteID total_offset;

    92

    93

	/**

    94

	 * Bridge offset

    95

	 */

    96

	SpriteID bridge_offset;

    97

    98

	/**

    99

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

   100

	 */

   101

	byte custom_ground_offset;

   102

   103

	/**

   104

	 * Multiplier for curve maximum speed advantage

   105

	 */

   106

	byte curve_speed;

   107

   108

	/**

   109

	 * Bit mask of rail type flags

   110

	 */

   111

	RailTypeFlags flags;

   112

};

   113

   114

   115

/**

   116

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

   117

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

   118

 * @return The pointer to the RailtypeInfo

   119

 */

   120

static inline const RailtypeInfo *GetRailTypeInfo(RailType railtype)

   121

{

   122

	extern RailtypeInfo _railtypes[RAILTYPE_END];

   123

	assert(railtype < RAILTYPE_END);

   124

	return &_railtypes[railtype];

   125

}

   126

   127

/**

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

 */

   135

static inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)

   136

{

   137

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

   138

}

   139

   140

/**

   141

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

   142

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

   143

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

   144

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

   145

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

   146

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

   147

 */

   148

static inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)

   149

{

   150

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

   151

}

   152

   153

   154

extern int _railtype_cost_multiplier[RAILTYPE_END];

   155

extern const int _default_railtype_cost_multiplier[RAILTYPE_END];

   156

   157

/**

   158

 * Returns the cost of building the specified railtype.

   159

 * @param railtype The railtype being built.

   160

 * @return The cost multiplier.

   161

 */

   162

static inline Money RailBuildCost(RailType railtype)

   163

{

   164

	assert(railtype < RAILTYPE_END);

   165

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

   166

}

   167

   168

/**

   169

 * Calculates the cost of rail conversion

   170

 * @param from The railtype we are converting from

   171

 * @param to   The railtype we are converting to

   172

 * @return Cost per TrackBit

   173

 */

   174

static inline Money RailConvertCost(RailType from, RailType to)

   175

{

   176

	/* rail -> el. rail

   177

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

   178

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

   179

	 */

   180

	if (HasPowerOnRail(from, to)) {

   181

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

   182

	}

   183

   184

	/* el. rail -> rail

   185

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

   186

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

   187

	 */

   188

	if (HasPowerOnRail(to, from)) {

   189

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

   190

	}

   191

   192

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

   193

	return RailBuildCost(to) + _price.remove_rail;

   194

}

   195

   196

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

   197

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

   198

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

   199

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

   200

int TicksToLeaveDepot(const Vehicle *v);

   201

   202

Foundation GetRailFoundation(Slope tileh, TrackBits bits);

   203

   204

   205

/**

   206

 * Finds out if a Player has a certain railtype available

   207

 * @param p Player in question

   208

 * @param railtype requested RailType

   209

 * @return true if player has requested RailType available

   210

 */

   211

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

   212

   213

/**

   214

 * Validate functions for rail building.

   215

 * @param rail the railtype to check.

   216

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

   217

 */

   218

bool ValParamRailtype(const RailType rail);

   219

   220

/**

   221

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

   222

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

   223

 * here. When adding new railtypes, modify this function

   224

 * @param p the player "in action"

   225

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

   226

 */

   227

RailType GetBestRailtype(const PlayerID p);

   228

   229

/**

   230

 * Get the rail types the given player can build.

   231

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

   232

 * @return the rail types.

   233

 */

   234

RailTypes GetPlayerRailtypes(const PlayerID p);

   235

   236

#endif /* RAIL_H */