1

/* $Id$ */

     2

     3

/** @file newgrf.h */

     4

     5

#ifndef NEWGRF_H

     6

#define NEWGRF_H

     7

     8

#include "station.h"

     9

#include "town.h"

    10

#include "newgrf_config.h"

    11

#include "helpers.hpp"

    12

#include "cargotype.h"

    13

    14

enum GrfLoadingStage {

    15

	GLS_FILESCAN,

    16

	GLS_SAFETYSCAN,

    17

	GLS_LABELSCAN,

    18

	GLS_INIT,

    19

	GLS_RESERVE,

    20

	GLS_ACTIVATION,

    21

	GLS_END,

    22

};

    23

    24

DECLARE_POSTFIX_INCREMENT(GrfLoadingStage);

    25

    26

    27

struct GRFLabel {

    28

	byte label;

    29

	uint32 nfo_line;

    30

	uint32 pos;

    31

	struct GRFLabel *next;

    32

};

    33

    34

struct GRFFile {

    35

	char *filename;

    36

	uint32 grfid;

    37

	uint16 sprite_offset;

    38

	byte grf_version;

    39

	GRFFile *next;

    40

    41

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

    42

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

    43

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

    44

	 * documentation, contributing to the global confusion.

    45

	 *

    46

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

    47

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

    48

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

    49

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

    50

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

    51

    52

	SpriteID spriteset_start;

    53

	int spriteset_numsets;

    54

	int spriteset_numents;

    55

	int spriteset_feature;

    56

    57

	int spritegroups_count;

    58

	struct SpriteGroup **spritegroups;

    59

    60

	uint sound_offset;

    61

    62

	StationSpec **stations;

    63

	HouseSpec **housespec;

    64

    65

	uint32 param[0x80];

    66

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

    67

    68

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

    69

    70

	uint8 cargo_max;

    71

	CargoLabel *cargo_list;

    72

	uint8 cargo_map[NUM_CARGO];

    73

};

    74

    75

extern GRFFile *_first_grffile;

    76

    77

extern SpriteID _signal_base;

    78

extern SpriteID _coast_base;

    79

extern bool _have_2cc;

    80

extern bool _have_newhouses;

    81

    82

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

    83

void LoadNewGRF(uint load_index, uint file_index);

    84

void ReloadNewGRFData(); // in openttd.cpp

    85

    86

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

    87

    88

#endif /* NEWGRF_H */