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,

    16

};

    17

    18

enum IndustryLifeType {

    19

	INDUSTRYLIFE_NOT_CLOSABLE,     ///< Industry can never close

    20

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

    21

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

    22

};

    23

    24

/**

    25

 * Defines the internal data of a functionnal industry

    26

 */

    27

struct Industry {

    28

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

    29

	byte width;

    30

	byte height;

    31

	const Town* town;               ///< Nearest town

    32

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

    33

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

    34

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

    35

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

    36

	byte prod_level;                ///< general production level

    37

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

    38

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

    39

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

    40

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

    41

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

    42

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

    43

    44

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

    45

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

    46

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

    47

	Year last_prod_year;            ///< last year of production

    48

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

    49

    50

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

    51

};

    52

    53

struct IndustryTileTable {

    54

	TileIndexDiffC ti;

    55

	IndustryGfx gfx;

    56

};

    57

    58

/**

    59

 * Defines the data structure for constructing industry.

    60

 */

    61

struct IndustrySpec {

    62

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

    63

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

    64

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

    65

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

    66

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

    67

	CargoID produced_cargo[2];

    68

	byte production_rate[2];

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

	StringID new_industry_text;           ///< Message appearing when the industry is built

    76

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

    77

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

    78

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

    79

};

    80

    81

/**

    82

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

    83

 */

    84

struct IndustryTileSpec {

    85

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

    86

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

    87

	byte anim_production;                 ///< Animation frame to start when goods are produced

    88

	byte anim_next;                       ///< Next frame in an animation

    89

	bool anim_state;                      ///< When true, the tile has to be drawn using the animation

    90

                                         ///< state instead of the construction state

    91

};

    92

    93

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

    94

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

    95

    96

DECLARE_OLD_POOL(Industry, Industry, 3, 8000)

    97

    98

/**

    99

 * Check if an Industry really exists.

   100

 * @param industry to check

   101

 * @return true if position is a valid one

   102

 */

   103

static inline bool IsValidIndustry(const Industry *industry)

   104

{

   105

	return industry->xy != 0;

   106

}

   107

   108

/**

   109

 * Check if an Industry exists whithin the pool of industries

   110

 * @param index of the desired industry

   111

 * @return true if it is inside the pool

   112

 */

   113

static inline bool IsValidIndustryID(IndustryID index)

   114

{

   115

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

   116

}

   117

   118

VARDEF int _total_industries; //general counter

   119

   120

static inline IndustryID GetMaxIndustryIndex()

   121

{

   122

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

   123

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

   124

	 *  _really_ returns the highest index. Now it just returns

   125

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

   126

	 */

   127

	return GetIndustryPoolSize() - 1;

   128

}

   129

   130

static inline uint GetNumIndustries()

   131

{

   132

	return _total_industries;

   133

}

   134

   135

/**

   136

 * Return a random valid industry.

   137

 */

   138

static inline Industry *GetRandomIndustry()

   139

{

   140

	int num = RandomRange(GetNumIndustries());

   141

	IndustryID index = INVALID_INDUSTRY;

   142

   143

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

   144

   145

	while (num >= 0) {

   146

		num--;

   147

		index++;

   148

   149

		/* Make sure we have a valid industry */

   150

		while (!IsValidIndustryID(index)) {

   151

			index++;

   152

			assert(index <= GetMaxIndustryIndex());

   153

		}

   154

	}

   155

   156

	return GetIndustry(index);

   157

}

   158

   159

void DestroyIndustry(Industry *i);

   160

   161

static inline void DeleteIndustry(Industry *i)

   162

{

   163

	DestroyIndustry(i);

   164

	i->xy = 0;

   165

}

   166

   167

#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))

   168

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

   169

   170

VARDEF const Industry** _industry_sort;

   171

VARDEF bool _industry_sort_dirty;

   172

   173

   174

void DeleteIndustry(Industry *is);

   175

void PlantRandomFarmField(const Industry *i);

   176

   177

enum {

   178

	IT_COAL_MINE           =   0,

   179

	IT_POWER_STATION       =   1,

   180

	IT_SAWMILL             =   2,

   181

	IT_FOREST              =   3,

   182

	IT_OIL_REFINERY        =   4,

   183

	IT_OIL_RIG             =   5,

   184

	IT_FACTORY             =   6,

   185

	IT_PRINTING_WORKS      =   7,

   186

	IT_STEEL_MILL          =   8,

   187

	IT_FARM                =   9,

   188

	IT_COPPER_MINE         =  10,

   189

	IT_OIL_WELL            =  11,

   190

	IT_BANK_TEMP           =  12,

   191

	IT_FOOD_PROCESS        =  13,

   192

	IT_PAPER_MILL          =  14,

   193

	IT_GOLD_MINE           =  15,

   194

	IT_BANK_TROPIC_ARCTIC  =  16,

   195

	IT_DIAMOND_MINE        =  17,

   196

	IT_IRON_MINE           =  18,

   197

	IT_FRUIT_PLANTATION    =  19,

   198

	IT_RUBBER_PLANTATION   =  20,

   199

	IT_WATER_SUPPLY        =  21,

   200

	IT_WATER_TOWER         =  22,

   201

	IT_FACTORY_2           =  23,

   202

	IT_FARM_2              =  24,

   203

	IT_LUMBER_MILL         =  25,

   204

	IT_COTTON_CANDY        =  26,

   205

	IT_CANDY_FACTORY       =  27,

   206

	IT_BATTERY_FARM        =  28,

   207

	IT_COLA_WELLS          =  29,

   208

	IT_TOY_SHOP            =  30,

   209

	IT_TOY_FACTORY         =  31,

   210

	IT_PLASTIC_FOUNTAINS   =  32,

   211

	IT_FIZZY_DRINK_FACTORY =  33,

   212

	IT_BUBBLE_GENERATOR    =  34,

   213

	IT_TOFFEE_QUARRY       =  35,

   214

	IT_SUGAR_MINE          =  36,

   215

	IT_END,

   216

	IT_INVALID             = 255,

   217

};

   218

   219

#endif /* INDUSTRY_H */