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_cargo.h"

    10

    11

typedef enum {

    12

	STAT_CLASS_DFLT,     ///< Default station class.

    13

	STAT_CLASS_WAYP,     ///< Waypoint class.

    14

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

    15

} StationClassID;

    16

    17

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

    18

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

    19

typedef byte *StationLayout;

    20

    21

typedef struct StationSpec {

    22

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

    23

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

    24

    25

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

    26

    27

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

    28

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

    29

    30

	/**

    31

	 * Bitmask of number of platforms available for the station.

    32

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

    33

	 */

    34

	byte disallowed_platforms;

    35

	/**

    36

	 * Bitmask of platform lengths available for the station.

    37

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

    38

	 */

    39

	byte disallowed_lengths;

    40

    41

	/** Number of tile layouts.

    42

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

    43

	 * 0-1 = plain platform

    44

	 * 2-3 = platform with building

    45

	 * 4-5 = platform with roof, left side

    46

	 * 6-7 = platform with roof, right side

    47

	 */

    48

	uint tiles;

    49

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

    50

	bool copied_renderdata;

    51

    52

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

    53

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

    54

	 */

    55

	uint16 cargo_threshold;

    56

    57

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

    58

    59

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

    60

    61

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

    62

    63

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

    64

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

    65

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

    66

    67

	byte lengths;

    68

	byte *platforms;

    69

	StationLayout **layouts;

    70

    71

	/**

    72

	 * NUM_GLOBAL_CID sprite groups.

    73

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

    74

	 * evaluating callbacks.

    75

	 */

    76

	struct SpriteGroup *spritegroup[NUM_GLOBAL_CID];

    77

	struct SpriteGroup *groundgroup;

    78

} StationSpec;

    79

    80

/**

    81

 * Struct containing information relating to station classes.

    82

 */

    83

typedef struct StationClass {

    84

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

    85

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

    86

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

    87

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

    88

} StationClass;

    89

    90

void ResetStationClasses(void);

    91

StationClassID AllocateStationClass(uint32 cls);

    92

void SetStationClassName(StationClassID sclass, StringID name);

    93

StringID GetStationClassName(StationClassID sclass);

    94

StringID *BuildStationClassDropdown(void);

    95

    96

uint GetNumStationClasses(void);

    97

uint GetNumCustomStations(StationClassID sclass);

    98

    99

void SetCustomStationSpec(StationSpec *statspec);

   100

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

   101

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

   102

   103

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

   104

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

   105

   106

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

   107

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

   108

 * for variational sprite groups. */

   109

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

   110

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

   111

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

   112

   113

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

   114

bool IsStationTileBlocked(TileIndex tile);

   115

   116

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

   117

bool IsStationTileElectrifiable(TileIndex tile);

   118

   119

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

   120

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

   121

   122

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

   123

void DeallocateSpecFromStation(Station* st, byte specindex);

   124

   125

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

   126

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

   127

   128

#endif /* NEWGRF_STATION_H */