1

/* $Id$ */

     2

     3

#ifndef NEWGRF_H

     4

#define NEWGRF_H

     5

     6

#include "station.h"

     7

#include "newgrf_config.h"

     8

#include "helpers.hpp"

     9

#include "cargotype.h"

    10

    11

enum GrfLoadingStage {

    12

	GLS_FILESCAN,

    13

	GLS_SAFETYSCAN,

    14

	GLS_LABELSCAN,

    15

	GLS_INIT,

    16

	GLS_ACTIVATION,

    17

	GLS_END,

    18

};

    19

    20

DECLARE_POSTFIX_INCREMENT(GrfLoadingStage);

    21

    22

    23

struct GRFLabel {

    24

	byte label;

    25

	uint32 nfo_line;

    26

	uint32 pos;

    27

	struct GRFLabel *next;

    28

};

    29

    30

struct GRFFile {

    31

	char *filename;

    32

	uint32 grfid;

    33

	uint16 sprite_offset;

    34

	byte grf_version;

    35

	GRFFile *next;

    36

    37

	/* A sprite group contains all sprites of a given vehicle (or multiple

    38

	 * vehicles) when carrying given cargo. It consists of several sprite

    39

	 * sets.  Group ids are refered as "cargo id"s by TTDPatch

    40

	 * documentation, contributing to the global confusion.

    41

	 *

    42

	 * A sprite set contains all sprites of a given vehicle carrying given

    43

	 * cargo at a given *stage* - that is usually its load stage. Ie. you

    44

	 * can have a spriteset for an empty wagon, wagon full of coal,

    45

	 * half-filled wagon etc.  Each spriteset contains eight sprites (one

    46

	 * per direction) or four sprites if the vehicle is symmetric. */

    47

    48

	SpriteID spriteset_start;

    49

	int spriteset_numsets;

    50

	int spriteset_numents;

    51

	int spriteset_feature;

    52

    53

	int spritegroups_count;

    54

	struct SpriteGroup **spritegroups;

    55

    56

	uint sound_offset;

    57

    58

	StationSpec **stations;

    59

    60

	uint32 param[0x80];

    61

	uint param_end; /// one more than the highest set parameter

    62

    63

	GRFLabel *label; ///< Pointer to the first label. This is a linked list, not an array.

    64

    65

	uint8 cargo_max;

    66

	CargoLabel *cargo_list;

    67

	uint8 cargo_map[NUM_CARGO];

    68

};

    69

    70

extern GRFFile *_first_grffile;

    71

    72

extern SpriteID _signal_base;

    73

extern SpriteID _coast_base;

    74

extern bool _have_2cc;

    75

    76

void LoadNewGRFFile(GRFConfig *config, uint file_index, GrfLoadingStage stage);

    77

void LoadNewGRF(uint load_index, uint file_index);

    78

void ReloadNewGRFData(); // in openttd.c

    79

    80

void CDECL grfmsg(int severity, const char *str, ...);

    81

    82

#endif /* NEWGRF_H */