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

    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

enum GrfSpecFeature {

    36

	GSF_TRAIN,

    37

	GSF_ROAD,

    38

	GSF_SHIP,

    39

	GSF_AIRCRAFT,

    40

	GSF_STATION,

    41

	GSF_CANAL,

    42

	GSF_BRIDGE,

    43

	GSF_TOWNHOUSE,

    44

	GSF_GLOBALVAR,

    45

	GSF_INDUSTRYTILES,

    46

	GSF_INDUSTRIES,

    47

	GSF_CARGOS,

    48

	GSF_SOUNDFX,

    49

	GSF_END,

    50

};

    51

    52

struct GRFLabel {

    53

	byte label;

    54

	uint32 nfo_line;

    55

	size_t pos;

    56

	struct GRFLabel *next;

    57

};

    58

    59

struct GRFFile {

    60

	char *filename;

    61

	bool is_ottdfile;

    62

	uint32 grfid;

    63

	uint16 sprite_offset;

    64

	byte grf_version;

    65

	GRFFile *next;

    66

    67

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

    68

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

    69

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

    70

	 * documentation, contributing to the global confusion.

    71

	 *

    72

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

    73

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

    74

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

    75

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

    76

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

    77

    78

	SpriteID spriteset_start;

    79

	int spriteset_numsets;

    80

	int spriteset_numents;

    81

	int spriteset_feature;

    82

    83

	int spritegroups_count;

    84

	struct SpriteGroup **spritegroups;

    85

    86

	uint sound_offset;

    87

    88

	StationSpec **stations;

    89

	HouseSpec **housespec;

    90

	IndustrySpec **industryspec;

    91

	IndustryTileSpec **indtspec;

    92

    93

	uint32 param[0x80];

    94

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

    95

    96

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

    97

    98

	uint8 cargo_max;

    99

	CargoLabel *cargo_list;

   100

	uint8 cargo_map[NUM_CARGO];

   101

};

   102

   103

extern GRFFile *_first_grffile;

   104

   105

enum ShoreReplacement {

   106

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

   107

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

   108

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

   109

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

   110

};

   111

   112

struct GRFLoadedFeatures {

   113

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

   114

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

   115

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

   116

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

   117

};

   118

   119

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

   120

extern GRFLoadedFeatures _loaded_newgrf_features;

   121

   122

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

   123

void LoadNewGRF(uint load_index, uint file_index);

   124

void ReloadNewGRFData(); // in openttd.cpp

   125

   126

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

   127

   128

bool HasGrfMiscBit(GrfMiscBit bit);

   129

bool GetGlobalVariable(byte param, uint32 *value);

   130

   131

StringID MapGRFStringID(uint32 grfid, StringID str);

   132

   133

#endif /* NEWGRF_H */