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

#include "helpers.hpp"

    11

    12

typedef enum {

    13

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

    14

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

    15

	STAT_CLASS_WAYP,         ///< Waypoint class.

    16

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

    17

} StationClassID;

    18

    19

/** Define basic enum properties */

    20

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

    21

typedef TinyEnumT<StationClassID> StationClassIDByte;

    22

    23

/** Allow incrementing of StationClassID variables */

    24

DECLARE_POSTFIX_INCREMENT(StationClassID);

    25

    26

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

    27

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

    28

typedef byte *StationLayout;

    29

    30

typedef struct StationSpec {

    31

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

    32

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

    33

    34

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

    35

    36

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

    37

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

    38

    39

	/**

    40

	 * Bitmask of number of platforms available for the station.

    41

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

    42

	 */

    43

	byte disallowed_platforms;

    44

	/**

    45

	 * Bitmask of platform lengths available for the station.

    46

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

    47

	 */

    48

	byte disallowed_lengths;

    49

    50

	/** Number of tile layouts.

    51

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

    52

	 * 0-1 = plain platform

    53

	 * 2-3 = platform with building

    54

	 * 4-5 = platform with roof, left side

    55

	 * 6-7 = platform with roof, right side

    56

	 */

    57

	uint tiles;

    58

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

    59

	bool copied_renderdata;

    60

    61

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

    62

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

    63

	 */

    64

	uint16 cargo_threshold;

    65

    66

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

    67

    68

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

    69

    70

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

    71

    72

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

    73

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

    74

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

    75

    76

	byte lengths;

    77

	byte *platforms;

    78

	StationLayout **layouts;

    79

	bool copied_layouts;

    80

    81

	/**

    82

	 * NUM_GLOBAL_CID sprite groups.

    83

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

    84

	 * evaluating callbacks.

    85

	 */

    86

	const struct SpriteGroup *spritegroup[NUM_GLOBAL_CID];

    87

} StationSpec;

    88

    89

/**

    90

 * Struct containing information relating to station classes.

    91

 */

    92

typedef struct StationClass {

    93

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

    94

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

    95

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

    96

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

    97

} StationClass;

    98

    99

void ResetStationClasses(void);

   100

StationClassID AllocateStationClass(uint32 cls);

   101

void SetStationClassName(StationClassID sclass, StringID name);

   102

StringID GetStationClassName(StationClassID sclass);

   103

StringID *BuildStationClassDropdown(void);

   104

   105

uint GetNumStationClasses(void);

   106

uint GetNumCustomStations(StationClassID sclass);

   107

   108

void SetCustomStationSpec(StationSpec *statspec);

   109

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

   110

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

   111

   112

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

   113

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

   114

   115

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

   116

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

   117

 * for variational sprite groups. */

   118

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

   119

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

   120

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

   121

   122

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

   123

bool IsStationTileBlocked(TileIndex tile);

   124

   125

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

   126

bool IsStationTileElectrifiable(TileIndex tile);

   127

   128

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

   129

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

   130

   131

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

   132

void DeallocateSpecFromStation(Station* st, byte specindex);

   133

   134

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

   135

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

   136

   137

#endif /* NEWGRF_STATION_H */