1

/* $Id$ */

     2

     3

/** @file newgrf.h */

     4

     5

#ifndef NEWGRF_H

     6

#define NEWGRF_H

     7

     8

#include "station.h"

    10

#include "newgrf_config.h"

    11

#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

enum GrfMiscBit {

    27

	GMB_DESERT_TREES_FIELDS    = 0, // Unsupported.

    28

	GMB_DESERT_PAVED_ROADS     = 1,

    29

	GMB_FIELD_BOUNDING_BOX     = 2, // Unsupported.

    30

	GMB_TRAIN_WIDTH_32_PIXELS  = 3,

    31

	GMB_AMBIENT_SOUND_CALLBACK = 4, // Unsupported.

    32

	GMB_CATENARY_ON_3RD_TRACK  = 5, // Unsupported.

    33

};

    34

    35

struct GRFLabel {

    36

	byte label;

    37

	uint32 nfo_line;

    38

	uint32 pos;

    39

	struct GRFLabel *next;

    40

};

    41

    42

struct GRFFile {

    43

	char *filename;

    44

	bool is_ottdfile;

    45

	uint32 grfid;

    46

	uint16 sprite_offset;

    47

	byte grf_version;

    48

	GRFFile *next;

    49

    50

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

    51

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

    52

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

    53

	 * documentation, contributing to the global confusion.

    54

	 *

    55

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

    56

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

    57

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

    58

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

    59

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

    60

    61

	SpriteID spriteset_start;

    62

	int spriteset_numsets;

    63

	int spriteset_numents;

    64

	int spriteset_feature;

    65

    66

	int spritegroups_count;

    67

	struct SpriteGroup **spritegroups;

    68

    69

	uint sound_offset;

    70

    71

	StationSpec **stations;

    72

	HouseSpec **housespec;

    73

	IndustrySpec **industryspec;

    74

	IndustryTileSpec **indtspec;

    75

    76

	uint32 param[0x80];

    77

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

    78

    79

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

    80

    81

	uint8 cargo_max;

    82

	CargoLabel *cargo_list;

    83

	uint8 cargo_map[NUM_CARGO];

    84

};

    85

    86

extern GRFFile *_first_grffile;

    87

    88

struct GRFLoadedFeatures {

    89

	bool has_2CC;             ///< Set if any vehicle is loaded which uses 2cc (two company colours).

    90

	bool has_newhouses;       ///< Set if there are any newhouses loaded.

    91

	bool has_newindustries;   ///< Set if there are any newindustries loaded.

    92

};

    93

    94

/* Indicates which are the newgrf features currently loaded ingame */

    95

extern GRFLoadedFeatures _loaded_newgrf_features;

    96

    97

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

    98

void LoadNewGRF(uint load_index, uint file_index);

    99

void ReloadNewGRFData(); // in openttd.cpp

   100

   101

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

   102

   103

bool HasGrfMiscBit(GrfMiscBit bit);

   104

   105

#endif /* NEWGRF_H */