1

/* $Id$ */

     2

     3

/** @file industry.h */

     4

     5

#ifndef INDUSTRY_H

     6

#define INDUSTRY_H

     7

     8

#include "oldpool.h"

     9

    10

typedef byte IndustryGfx;

    11

typedef uint8 IndustryType;

    12

    13

enum {

    14

	INVALID_INDUSTRY = 0xFFFF,

    15

};

    16

    17

typedef enum IndustryLifeTypes {

    18

	INDUSTRYLIFE_NOT_CLOSABLE,     ///< Industry can never close

    19

	INDUSTRYLIFE_PRODUCTION,       ///< Industry can close and change of production

    20

	INDUSTRYLIFE_CLOSABLE,         ///< Industry can only close (no production change)

    21

} IndustryLifeType;

    22

    23

/**

    24

 * Defines the internal data of a functionnal industry

    25

 */

    26

struct Industry {

    27

	TileIndex xy;                   ///< coordinates of the primary tile the industry is built one

    28

	byte width;

    29

	byte height;

    30

	const Town* town;               ///< Nearest town

    31

	CargoID produced_cargo[2];      ///< 2 production cargo slots

    32

	uint16 cargo_waiting[2];        ///< amount of cargo produced per cargo

    33

	byte production_rate[2];        ///< production rate for each cargo

    34

	CargoID accepts_cargo[3];       ///< 3 input cargo slots

    35

	byte prod_level;                ///< general production level

    36

	uint16 last_mo_production[2];   ///< stats of last month production per cargo

    37

	uint16 last_mo_transported[2];  ///< stats of last month transport per cargo

    38

	byte pct_transported[2];        ///< percentage transported per cargo

    39

	uint16 total_production[2];     ///< total units produced per cargo

    40

	uint16 total_transported[2];    ///< total units transported per cargo

    41

	uint16 counter;                 ///< used for animation and/or production (if available cargo)

    42

    43

	byte type;                      ///< type of industry. see IT_COAL_MINE and others

    44

	OwnerByte owner;                ///< owner of the industry.  Which SHOULD always be (imho) OWNER_NONE

    45

	byte random_color;              ///< randomized colour of the industry, for display purpose

    46

	Year last_prod_year;            ///< last year of production

    47

	byte was_cargo_delivered;       ///< flag that indicate this has been the closest industry chosen for cargo delivery by a station. see DeliverGoodsToIndustry

    48

    49

	IndustryID index;               ///< index of the industry in the pool of industries

    50

};

    51

    52

typedef struct IndustryTileTable {

    53

	TileIndexDiffC ti;

    54

	IndustryGfx gfx;

    55

} IndustryTileTable;

    56

    57

/**

    58

 * Defines the data structure for constructing industry.

    59

 */

    60

typedef struct IndustrySpec {

    61

	const IndustryTileTable *const *table;///< List of the tiles composing the industry

    62

	byte num_table;                       ///< Number of elements in the table

    63

	byte cost_multiplier;                 ///< Base cost multiplier*/

    64

	IndustryType conflicting[3];          ///< Industries this industry cannot be close to

    65

	byte check_proc;                      ///< Index to a procedure to check for conflicting circumstances

    66

	CargoID produced_cargo[2];

    67

	byte production_rate[2];

    68

	byte minimal_cargo;                   ///< minimum amount of cargo transported to the stations

    69

	                                      ///< If the waiting cargo is less than this number, no cargo is moved to it

    70

	CargoID accepts_cargo[3];             ///< 3 accepted cargos

    71

	IndustryLifeType life_type;           ///< This is also known as Industry production flag, in newgrf specs

    72

	byte climate_availability;            ///< Bitmask, giving landscape enums as bit position

    73

	StringID name;                        ///< Displayed name of the industry

    74

	StringID closure_text;                ///< Message appearing when the industry closes

    75

	StringID production_up_text;          ///< Message appearing when the industry's production is increasing

    76

	StringID production_down_text;        ///< Message appearing when the industry's production is decreasing

    77

} IndustrySpec;

    78

    79

/**

    80

 * Defines the data structure of each indivudual tile of an industry.

    81

 */

    82

typedef struct IndustryTileSpec {

    83

	CargoID accepts_cargo[3];             ///< Cargo accepted by this tile

    84

	Slope slopes_refused;                 ///< slope pattern on which this tile cannot be built

    85

} IndustryTileSpec;

    86

    87

const IndustrySpec *GetIndustrySpec(IndustryType thistype);    ///< Array of industries default data

    88

const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx);  ///< Array of industry tiles default data

    89

    90

DECLARE_OLD_POOL(Industry, Industry, 3, 8000)

    91

    92

/**

    93

 * Check if an Industry really exists.

    94

 * @param industry to check

    95

 * @return true if position is a valid one

    96

 */

    97

static inline bool IsValidIndustry(const Industry *industry)

    98

{

    99

	return industry->xy != 0;

   100

}

   101

   102

/**

   103

 * Check if an Industry exists whithin the pool of industries

   104

 * @param index of the desired industry

   105

 * @return true if it is inside the pool

   106

 */

   107

static inline bool IsValidIndustryID(IndustryID index)

   108

{

   109

	return index < GetIndustryPoolSize() && IsValidIndustry(GetIndustry(index));

   110

}

   111

   112

VARDEF int _total_industries; //general counter

   113

   114

static inline IndustryID GetMaxIndustryIndex(void)

   115

{

   116

	/* TODO - This isn't the real content of the function, but

   117

	 *  with the new pool-system this will be replaced with one that

   118

	 *  _really_ returns the highest index. Now it just returns

   119

	 *  the next safe value we are sure about everything is below.

   120

	 */

   121

	return GetIndustryPoolSize() - 1;

   122

}

   123

   124

static inline uint GetNumIndustries(void)

   125

{

   126

	return _total_industries;

   127

}

   128

   129

/**

   130

 * Return a random valid industry.

   131

 */

   132

static inline Industry *GetRandomIndustry(void)

   133

{

   134

	int num = RandomRange(GetNumIndustries());

   135

	IndustryID index = INVALID_INDUSTRY;

   136

   137

	if (GetNumIndustries() == 0) return NULL;

   138

   139

	while (num >= 0) {

   140

		num--;

   141

		index++;

   142

   143

		/* Make sure we have a valid industry */

   144

		while (!IsValidIndustryID(index)) {

   145

			index++;

   146

			assert(index <= GetMaxIndustryIndex());

   147

		}

   148

	}

   149

   150

	return GetIndustry(index);

   151

}

   152

   153

void DestroyIndustry(Industry *i);

   154

   155

static inline void DeleteIndustry(Industry *i)

   156

{

   157

	DestroyIndustry(i);

   158

	i->xy = 0;

   159

}

   160

   161

#define FOR_ALL_INDUSTRIES_FROM(i, start) for (i = GetIndustry(start); i != NULL; i = (i->index + 1U < GetIndustryPoolSize()) ? GetIndustry(i->index + 1U) : NULL) if (IsValidIndustry(i))

   162

#define FOR_ALL_INDUSTRIES(i) FOR_ALL_INDUSTRIES_FROM(i, 0)

   163

   164

VARDEF const Industry** _industry_sort;

   165

VARDEF bool _industry_sort_dirty;

   166

   167

   168

void DeleteIndustry(Industry *is);

   169

void PlantRandomFarmField(const Industry *i);

   170

   171

enum {

   172

	IT_COAL_MINE           =   0,

   173

	IT_POWER_STATION       =   1,

   174

	IT_SAWMILL             =   2,

   175

	IT_FOREST              =   3,

   176

	IT_OIL_REFINERY        =   4,

   177

	IT_OIL_RIG             =   5,

   178

	IT_FACTORY             =   6,

   179

	IT_PRINTING_WORKS      =   7,

   180

	IT_STEEL_MILL          =   8,

   181

	IT_FARM                =   9,

   182

	IT_COPPER_MINE         =  10,

   183

	IT_OIL_WELL            =  11,

   184

	IT_BANK_TEMP           =  12,

   185

	IT_FOOD_PROCESS        =  13,

   186

	IT_PAPER_MILL          =  14,

   187

	IT_GOLD_MINE           =  15,

   188

	IT_BANK_TROPIC_ARCTIC  =  16,

   189

	IT_DIAMOND_MINE        =  17,

   190

	IT_IRON_MINE           =  18,

   191

	IT_FRUIT_PLANTATION    =  19,

   192

	IT_RUBBER_PLANTATION   =  20,

   193

	IT_WATER_SUPPLY        =  21,

   194

	IT_WATER_TOWER         =  22,

   195

	IT_FACTORY_2           =  23,

   196

	IT_FARM_2              =  24,

   197

	IT_LUMBER_MILL         =  25,

   198

	IT_COTTON_CANDY        =  26,

   199

	IT_CANDY_FACTORY       =  27,

   200

	IT_BATTERY_FARM        =  28,

   201

	IT_COLA_WELLS          =  29,

   202

	IT_TOY_SHOP            =  30,

   203

	IT_TOY_FACTORY         =  31,

   204

	IT_PLASTIC_FOUNTAINS   =  32,

   205

	IT_FIZZY_DRINK_FACTORY =  33,

   206

	IT_BUBBLE_GENERATOR    =  34,

   207

	IT_TOFFEE_QUARRY       =  35,

   208

	IT_SUGAR_MINE          =  36,

   209

	IT_END,

   210

	IT_INVALID             = 255,

   211

};

   212

   213

#endif /* INDUSTRY_H */