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

     9

#include "newgrf_callbacks.h"

    10

#include "newgrf_cargo.h"

    11

#include "tile_type.h"

    12

#include "station_type.h"

    13

#include "strings_type.h"

    14

#include "sprite.h"

    15

#include "direction_type.h"

    16

    17

enum StationClassID {

    18

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

    19

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

    20

	STAT_CLASS_WAYP,         ///< Waypoint class.

    21

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

    22

};

    23

    24

/** Define basic enum properties */

    25

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

    26

typedef TinyEnumT<StationClassID> StationClassIDByte;

    27

    28

/** Allow incrementing of StationClassID variables */

    29

DECLARE_POSTFIX_INCREMENT(StationClassID);

    30

    31

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

    32

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

    33

typedef byte *StationLayout;

    34

    35

struct StationSpec {

    36

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

    37

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

    38

    39

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

    40

    41

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

    42

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

    43

    44

	/**

    45

	 * Bitmask of number of platforms available for the station.

    46

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

    47

	 */

    48

	byte disallowed_platforms;

    49

	/**

    50

	 * Bitmask of platform lengths available for the station.

    51

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

    52

	 */

    53

	byte disallowed_lengths;

    54

    55

	/** Number of tile layouts.

    56

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

    57

	 * 0-1 = plain platform

    58

	 * 2-3 = platform with building

    59

	 * 4-5 = platform with roof, left side

    60

	 * 6-7 = platform with roof, right side

    61

	 */

    62

	uint tiles;

    63

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

    64

	bool copied_renderdata;

    65

    66

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

    67

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

    68

	 */

    69

	uint16 cargo_threshold;

    70

    71

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

    72

    73

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

    74

    75

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

    76

    77

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

    78

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

    79

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

    80

    81

	byte lengths;

    82

	byte *platforms;

    83

	StationLayout **layouts;

    84

	bool copied_layouts;

    85

    86

	uint8  anim_frames;

    87

	uint8  anim_status;

    88

	uint8  anim_speed;

    89

	uint16 anim_triggers;

    90

    91

	/**

    92

	 * NUM_CARGO real cargo plus three pseudo cargo sprite groups.

    93

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

    94

	 * evaluating callbacks.

    95

	 */

    96

	const struct SpriteGroup *spritegroup[NUM_CARGO + 3];

    97

};

    98

    99

/**

   100

 * Struct containing information relating to station classes.

   101

 */

   102

struct StationClass {

   103

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

   104

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

   105

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

   106

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

   107

};

   108

   109

void ResetStationClasses();

   110

StationClassID AllocateStationClass(uint32 cls);

   111

void SetStationClassName(StationClassID sclass, StringID name);

   112

StringID GetStationClassName(StationClassID sclass);

   113

const StationSpec *GetStationSpec(TileIndex t);

   114

   115

uint GetNumStationClasses();

   116

uint GetNumCustomStations(StationClassID sclass);

   117

   118

void SetCustomStationSpec(StationSpec *statspec);

   119

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

   120

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

   121

   122

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

   123

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

   124

   125

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

   126

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

   127

 * for variational sprite groups. */

   128

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

   129

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

   130

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

   131

   132

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

   133

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

   134

   135

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

   136

void DeallocateSpecFromStation(Station* st, byte specindex);

   137

   138

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

   139

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

   140

   141

enum StatAnimTrigger {

   142

	STAT_ANIM_BUILT,

   143

	STAT_ANIM_NEW_CARGO,

   144

	STAT_ANIM_CARGO_TAKEN,

   145

	STAT_ANIM_TRAIN_ARRIVES,

   146

	STAT_ANIM_TRAIN_DEPARTS,

   147

	STAT_ANIM_TRAIN_LOADS,

   148

	STAT_ANIM_250_TICKS,

   149

};

   150

   151

void AnimateStationTile(TileIndex tile);

   152

void StationAnimationTrigger(const Station *st, TileIndex tile, StatAnimTrigger trigger, CargoID cargo_type = CT_INVALID);

   153

void StationUpdateAnimTriggers(Station *st);

   154

   155

#endif /* NEWGRF_STATION_H */