1

/* $Id$ */

     2

     3

/** @file newgrf.h Base for the NewGRF implementation. */

     4

     5

#ifndef NEWGRF_H

     6

#define NEWGRF_H

     7

     8

#include "town_type.h"

     9

#include "newgrf_config.h"

    10

#include "cargotype.h"

    11

#include "industry_type.h"

    12

#include "station_type.h"

    13

#include "newgrf_fsmports.h"

    14

    15

enum GrfLoadingStage {

    16

	GLS_FILESCAN,

    17

	GLS_SAFETYSCAN,

    18

	GLS_LABELSCAN,

    19

	GLS_INIT,

    20

	GLS_RESERVE,

    21

	GLS_ACTIVATION,

    22

	GLS_END,

    23

};

    24

    25

DECLARE_POSTFIX_INCREMENT(GrfLoadingStage);

    26

    27

enum GrfMiscBit {

    28

	GMB_DESERT_TREES_FIELDS    = 0, // Unsupported.

    29

	GMB_DESERT_PAVED_ROADS     = 1,

    30

	GMB_FIELD_BOUNDING_BOX     = 2, // Unsupported.

    31

	GMB_TRAIN_WIDTH_32_PIXELS  = 3,

    32

	GMB_AMBIENT_SOUND_CALLBACK = 4, // Unsupported.

    33

	GMB_CATENARY_ON_3RD_TRACK  = 5, // Unsupported.

    34

};

    35

    36

enum GrfSpecFeature {

    37

	GSF_TRAIN,

    38

	GSF_ROAD,

    39

	GSF_SHIP,

    40

	GSF_AIRCRAFT,

    41

	GSF_STATION,

    42

	GSF_CANAL,

    43

	GSF_BRIDGE,

    44

	GSF_TOWNHOUSE,

    45

	GSF_GLOBALVAR,

    46

	GSF_INDUSTRYTILES,

    47

	GSF_INDUSTRIES,

    48

	GSF_CARGOS,

    49

	GSF_SOUNDFX,

    50

	GSF_FSMPORTS,

    51

	GSF_END,

    52

};

    53

    54

struct GRFLabel {

    55

	byte label;

    56

	uint32 nfo_line;

    57

	size_t pos;

    58

	struct GRFLabel *next;

    59

};

    60

    61

struct GRFFile {

    62

	char *filename;

    63

	bool is_ottdfile;

    64

	uint32 grfid;

    65

	uint16 sprite_offset;

    66

	byte grf_version;

    67

	GRFFile *next;

    68

    69

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

    70

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

    71

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

    72

	 * documentation, contributing to the global confusion.

    73

	 *

    74

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

    75

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

    76

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

    77

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

    78

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

    79

    80

	SpriteID spriteset_start;

    81

	int spriteset_numsets;

    82

	int spriteset_numents;

    83

	int spriteset_feature;

    84

    85

	int spritegroups_count;

    86

	struct SpriteGroup **spritegroups;

    87

    88

	uint sound_offset;

    89

    90

	StationSpec **stations;

    91

	HouseSpec **housespec;

    92

	IndustrySpec **industryspec;

    93

	IndustryTileSpec **indtspec;

    94

	FSMportsSpec **fsmports;

    95

    96

	uint32 param[0x80];

    97

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

    98

    99

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

   100

   101

	uint8 cargo_max;

   102

	CargoLabel *cargo_list;

   103

	uint8 cargo_map[NUM_CARGO];

   104

};

   105

   106

extern GRFFile *_first_grffile;

   107

   108

enum ShoreReplacement {

   109

	SHORE_REPLACE_NONE,       ///< No shore sprites were replaced.

   110

	SHORE_REPLACE_ACTION_5,   ///< Shore sprites were replaced by Action5.

   111

	SHORE_REPLACE_ACTION_A,   ///< Shore sprites were replaced by ActionA (using grass tiles for the corner-shores).

   112

	SHORE_REPLACE_ONLY_NEW,   ///< Only corner-shores were loaded by Action5 (openttd(w/d).grf only).

   113

};

   114

   115

struct GRFLoadedFeatures {

   116

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

   117

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

   118

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

   119

	ShoreReplacement shore;   ///< It which way shore sprites were replaced.

   120

};

   121

   122

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

   123

extern GRFLoadedFeatures _loaded_newgrf_features;

   124

   125

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

   126

void LoadNewGRF(uint load_index, uint file_index);

   127

void ReloadNewGRFData(); // in openttd.cpp

   128

   129

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

   130

   131

bool HasGrfMiscBit(GrfMiscBit bit);

   132

bool GetGlobalVariable(byte param, uint32 *value);

   133

   134

StringID MapGRFStringID(uint32 grfid, StringID str);

   135

   136

#endif /* NEWGRF_H */