1

/* $Id$ */

     2

     3

/** @file newgrf_station.h Header file for NewGRF stations */

     4

     5

#ifndef NEWGRF_STATION_H

     6

#define NEWGRF_STATION_H

     7

     8

#include "engine.h"

     9

#include "newgrf_callbacks.h"

    10

#include "newgrf_cargo.h"

    11

#include "tile_type.h"

    12

#include "strings_type.h"

    13

    14

enum StationClassID {

    15

	STAT_CLASS_BEGIN = 0,    ///< the lowest valid value

    16

	STAT_CLASS_DFLT = 0,     ///< Default station class.

    17

	STAT_CLASS_WAYP,         ///< Waypoint class.

    18

	STAT_CLASS_MAX = 32,     ///< Maximum number of classes.

    19

};

    20

    21

/** Define basic enum properties */

    22

template <> struct EnumPropsT<StationClassID> : MakeEnumPropsT<StationClassID, byte, STAT_CLASS_BEGIN, STAT_CLASS_MAX, STAT_CLASS_MAX> {};

    23

typedef TinyEnumT<StationClassID> StationClassIDByte;

    24

    25

/** Allow incrementing of StationClassID variables */

    26

DECLARE_POSTFIX_INCREMENT(StationClassID);

    27

    28

/* Station layout for given dimensions - it is a two-dimensional array

    29

 * where index is computed as (x * platforms) + platform. */

    30

typedef byte *StationLayout;

    31

    32

struct StationSpec {

    33

	const struct GRFFile *grffile; ///< ID of GRF file station belongs to.

    34

	int localidx; ///< Index within GRF file of station.

    35

    36

	bool allocated; ///< Flag whether this station has been added to a station class list

    37

    38

	StationClassID sclass; ///< The class to which this spec belongs.

    39

	StringID name; ///< Name of this station.

    40

    41

	/**

    42

	 * Bitmask of number of platforms available for the station.

    43

	 * 0..6 correpsond to 1..7, while bit 7 corresponds to >7 platforms.

    44

	 */

    45

	byte disallowed_platforms;

    46

	/**

    47

	 * Bitmask of platform lengths available for the station.

    48

	 * 0..6 correpsond to 1..7, while bit 7 corresponds to >7 tiles long.

    49

	 */

    50

	byte disallowed_lengths;

    51

    52

	/** Number of tile layouts.

    53

	 * A minimum of 8 is required is required for stations.

    54

	 * 0-1 = plain platform

    55

	 * 2-3 = platform with building

    56

	 * 4-5 = platform with roof, left side

    57

	 * 6-7 = platform with roof, right side

    58

	 */

    59

	uint tiles;

    60

	DrawTileSprites *renderdata; ///< Array of tile layouts.

    61

	bool copied_renderdata;

    62

    63

	/** Cargo threshold for choosing between little and lots of cargo

    64

	 * @note little/lots are equivalent to the moving/loading states for vehicles

    65

	 */

    66

	uint16 cargo_threshold;

    67

    68

	uint32 cargo_triggers; ///< Bitmask of cargo types which cause trigger re-randomizing

    69

    70

	byte callbackmask; ///< Bitmask of callbacks to use, @see newgrf_callbacks.h

    71

    72

	byte flags; ///< Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by station size

    73

    74

	byte pylons;  ///< Bitmask of base tiles (0 - 7) which should contain elrail pylons

    75

	byte wires;   ///< Bitmask of base tiles (0 - 7) which should contain elrail wires

    76

	byte blocked; ///< Bitmask of base tiles (0 - 7) which are blocked to trains

    77

    78

	byte lengths;

    79

	byte *platforms;

    80

	StationLayout **layouts;

    81

	bool copied_layouts;

    82

    83

	/**

    84

	 * NUM_CARGO real cargo plus three pseudo cargo sprite groups.

    85

	 * Used for obtaining the sprite offset of custom sprites, and for

    86

	 * evaluating callbacks.

    87

	 */

    88

	const struct SpriteGroup *spritegroup[NUM_CARGO + 3];

    89

};

    90

    91

/**

    92

 * Struct containing information relating to station classes.

    93

 */

    94

struct StationClass {

    95

	uint32 id;          ///< ID of this class, e.g. 'DFLT', 'WAYP', etc.

    96

	StringID name;      ///< Name of this class.

    97

	uint stations;      ///< Number of stations in this class.

    98

	StationSpec **spec; ///< Array of station specifications.

    99

};

   100

   101

void ResetStationClasses();

   102

StationClassID AllocateStationClass(uint32 cls);

   103

void SetStationClassName(StationClassID sclass, StringID name);

   104

StringID GetStationClassName(StationClassID sclass);

   105

   106

uint GetNumStationClasses();

   107

uint GetNumCustomStations(StationClassID sclass);

   108

   109

void SetCustomStationSpec(StationSpec *statspec);

   110

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station);

   111

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx);

   112

   113

/* Evaluate a tile's position within a station, and return the result a bitstuffed format. */

   114

uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred);

   115

   116

/* Get sprite offset for a given custom station and station structure (may be

   117

 * NULL - that means we are in a build dialog). The station structure is used

   118

 * for variational sprite groups. */

   119

SpriteID GetCustomStationRelocation(const StationSpec *statspec, const Station *st, TileIndex tile);

   120

SpriteID GetCustomStationGroundRelocation(const StationSpec *statspec, const Station *st, TileIndex tile);

   121

uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, const Station *st, TileIndex tile);

   122

   123

/* Check if a rail station tile is traversable. */

   124

bool IsStationTileBlocked(TileIndex tile);

   125

   126

/* Check if a rail station tile is electrifiable. */

   127

bool IsStationTileElectrifiable(TileIndex tile);

   128

   129

/* Allocate a StationSpec to a Station. This is called once per build operation. */

   130

int AllocateSpecToStation(const StationSpec *statspec, Station *st, bool exec);

   131

   132

/* Deallocate a StationSpec from a Station. Called when removing a single station tile. */

   133

void DeallocateSpecFromStation(Station* st, byte specindex);

   134

   135

/* Draw representation of a station tile for GUI purposes. */

   136

bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station);

   137

   138

#endif /* NEWGRF_STATION_H */