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

    10

typedef enum {

    11

	STAT_CLASS_DFLT,     ///< Default station class.

    12

	STAT_CLASS_WAYP,     ///< Waypoint class.

    13

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

    14

} StationClassID;

    15

    16

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

    17

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

    18

typedef byte *StationLayout;

    19

    20

typedef struct stationspec {

    21

	uint32 grfid; ///< ID of GRF file station belongs to.

    22

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

    23

    24

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

    25

    26

	/**

    27

	 * Bitmask of number of platforms available for the station.

    28

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

    29

	 */

    30

	byte allowed_platforms;

    31

	/**

    32

	 * Bitmask of platform lengths available for the station.

    33

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

    34

	 */

    35

	byte allowed_lengths;

    36

    37

	/** Number of tile layouts.

    38

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

    39

	 * 0-1 = plain platform

    40

	 * 2-3 = platform with building

    41

	 * 4-5 = platform with roof, left side

    42

	 * 6-7 = platform with roof, right side

    43

	 */

    44

	int tiles;

    45

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

    46

    47

	byte lengths;

    48

	byte *platforms;

    49

	StationLayout **layouts;

    50

    51

	/**

    52

	 * NUM_GLOBAL_CID sprite groups.

    53

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

    54

	 * evaluating callbacks.

    55

	 */

    56

	SpriteGroup *spritegroup[NUM_GLOBAL_CID];

    57

} StationSpec;

    58

    59

/**

    60

 * Struct containing information relating to station classes.

    61

 */

    62

typedef struct stationclass {

    63

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

    64

	char *name;         ///< Name of this class.

    65

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

    66

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

    67

} StationClass;

    68

    69

void ResetStationClasses(void);

    70

StationClassID AllocateStationClass(uint32 class);

    71

void SetStationClassName(StationClassID sclass, const char *name);

    72

uint GetNumCustomStations(StationClassID sclass);

    73

    74

void SetCustomStation(StationSpec *spec);

    75

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

    76

    77

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

    78

 * NULL if ctype is set - that means we are in a build dialog). The station

    79

 * structure is used for variational sprite groups. */

    80

uint32 GetCustomStationRelocation(const StationSpec *spec, const Station *st, byte ctype);

    81

    82

#endif /* NEWGRF_STATION_H */