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

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

    26

    27

	/**

    28

	 * Bitmask of number of platforms available for the station.

    29

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

    30

	 */

    31

	byte disallowed_platforms;

    32

	/**

    33

	 * Bitmask of platform lengths available for the station.

    34

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

    35

	 */

    36

	byte disallowed_lengths;

    37

    38

	/** Number of tile layouts.

    39

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

    40

	 * 0-1 = plain platform

    41

	 * 2-3 = platform with building

    42

	 * 4-5 = platform with roof, left side

    43

	 * 6-7 = platform with roof, right side

    44

	 */

    45

	uint tiles;

    46

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

    47

    48

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

    49

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

    50

	 */

    51

	uint16 cargo_threshold;

    52

    53

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

    54

    55

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

    56

    57

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

    58

    59

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

    60

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

    61

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

    62

    63

	byte lengths;

    64

	byte *platforms;

    65

	StationLayout **layouts;

    66

    67

	/**

    68

	 * NUM_GLOBAL_CID sprite groups.

    69

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

    70

	 * evaluating callbacks.

    71

	 */

    72

	SpriteGroup *spritegroup[NUM_GLOBAL_CID];

    73

} StationSpec;

    74

    75

/**

    76

 * Struct containing information relating to station classes.

    77

 */

    78

typedef struct StationClass {

    79

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

    80

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

    81

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

    82

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

    83

} StationClass;

    84

    85

void ResetStationClasses(void);

    86

StationClassID AllocateStationClass(uint32 class);

    87

void SetStationClassName(StationClassID sclass, StringID name);

    88

StringID GetStationClassName(StationClassID sclass);

    89

StringID *BuildStationClassDropdown(void);

    90

    91

uint GetNumStationClasses(void);

    92

uint GetNumCustomStations(StationClassID sclass);

    93

    94

void SetCustomStationSpec(StationSpec *statspec);

    95

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

    96

    97

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

    98

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

    99

 * structure is used for variational sprite groups. */

   100

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

   101

   102

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

   103

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

   104

   105

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

   106

bool DeallocateSpecFromStation(Station *st, byte specindex);

   107

   108

#endif /* NEWGRF_STATION_H */