1

/* $Id$ */

     2

     3

/** @file industry.h */

     4

     5

#ifndef INDUSTRY_H

     6

#define INDUSTRY_H

     7

     8

#include "oldpool.h"

     9

#include "helpers.hpp"

    10

    11

typedef byte IndustryGfx;

    12

typedef uint8 IndustryType;

    13

    14

enum {

    15

	INVALID_INDUSTRY = 0xFFFF,

    16

	INDUTILE_NOANIM = 0xFF,        ///< flag to mark industry tiles as having no animation

    17

};

    18

    19

enum IndustryLifeType {

    20

	INDUSTRYLIFE_NOT_CLOSABLE,     ///< Industry can never close

    21

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

    22

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

    23

};

    24

    25

enum IndustyBehaviour {

    26

	INDUSTRYBEH_NONE                  =      0,

    27

	INDUSTRYBEH_PLANT_FIELDS          = 1 << 0,  ///< periodically plants fileds around itself (temp and artic farms)

    28

	INDUSTRYBEH_CUT_TREES             = 1 << 1,  ///< cuts trees and produce first output cargo from them (lumber mill)

    29

	INDUSTRYBEH_BUILT_ONWATER         = 1 << 2,  ///< is built on water (oil rig)

    30

	INDUSTRYBEH_TOWN1200_MORE         = 1 << 3,  ///< can only be built in towns larger then 1200 inhabitants (temperate bank)

    31

	INDUSTRYBEH_ONLY_INTOWN           = 1 << 4,  ///< can only be built in towns (arctic/tropic banks, water tower)

    32

	INDUSTRYBEH_ONLY_NEARTOWN         = 1 << 5,  ///< is always built near towns (toy shop)

    33

	INDUSTRYBEH_PLANT_ON_BUILT        = 1 << 6,  ///< Fields are planted around when built (all farms)

    34

	INDUSTRYBEH_DONT_INCR_PROD        = 1 << 7,  ///< do not increase production (oil wells)

    35

	INDUSTRYBEH_BEFORE_1950           = 1 << 8,  ///< can only be built before 1950 (oil wells)

    36

	INDUSTRYBEH_AFTER_1960            = 1 << 9,  ///< can only be built after 1960 (oil rigs)

    37

	INDUSTRYBEH_AI_AIRSHIP_ROUTES     = 1 << 10, ///< ai will attempt to establish air/ship routes to this industry (oil rig)

    38

	INDUSTRYBEH_AIRPLANE_ATTACKS      = 1 << 11, ///< can be exploded by a military airplane (oil refinery)

    39

	INDUSTRYBEH_CHOPPER_ATTACKS       = 1 << 12, ///< can be exploded by a military helicopter (factory)

    40

	INDUSTRYBEH_CAN_SUBSIDENCE        = 1 << 13, ///< can cause a subsidence (coal mine, shaft that collapses)

    41

};

    42

    43

    44

DECLARE_ENUM_AS_BIT_SET(IndustyBehaviour);

    45

    46

/**

    47

 * Defines the internal data of a functionnal industry

    48

 */

    49

struct Industry {

    50

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

    51

	byte width;

    52

	byte height;

    53

	const Town* town;               ///< Nearest town

    54

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

    55

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

    56

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

    57

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

    58

	byte prod_level;                ///< general production level

    59

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

    60

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

    61

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

    62

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

    63

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

    64

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

    65

    66

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

    67

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

    68

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

    69

	Year last_prod_year;            ///< last year of production

    70

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

    71

    72

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

    73

};

    74

    75

struct IndustryTileTable {

    76

	TileIndexDiffC ti;

    77

	IndustryGfx gfx;

    78

};

    79

    80

/**

    81

 * Defines the data structure for constructing industry.

    82

 */

    83

struct IndustrySpec {

    84

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

    85

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

    86

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

    87

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

    88

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

    89

	CargoID produced_cargo[2];

    90

	byte production_rate[2];

    91

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

    92

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

    93

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

    94

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

    95

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

    96

	IndustyBehaviour behaviour;           ///< How this industry will behave, and how others entities can use it

    97

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

    98

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

    99

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

   100

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

   101

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

   104

};

   105

   106

/**

   107

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

   108

 */

   109

struct IndustryTileSpec {

   110

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

   111

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

   112

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

   113

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

   114

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

   115

                                         ///< state instead of the construction state

   116

};

   117

   118

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

   119

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

   120

   121

DECLARE_OLD_POOL(Industry, Industry, 3, 8000)

   122

   123

/**

   124

 * Check if an Industry really exists.

   125

 * @param industry to check

   126

 * @return true if position is a valid one

   127

 */

   128

static inline bool IsValidIndustry(const Industry *industry)

   129

{

   130

	return industry->xy != 0;

   131

}

   132

   133

/**

   134

 * Check if an Industry exists whithin the pool of industries

   135

 * @param index of the desired industry

   136

 * @return true if it is inside the pool

   137

 */

   138

static inline bool IsValidIndustryID(IndustryID index)

   139

{

   140

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

   141

}

   142

   143

VARDEF int _total_industries; //general counter

   144

   145

static inline IndustryID GetMaxIndustryIndex()

   146

{

   147

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

   148

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

   149

	 *  _really_ returns the highest index. Now it just returns

   150

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

   151

	 */

   152

	return GetIndustryPoolSize() - 1;

   153

}

   154

   155

static inline uint GetNumIndustries()

   156

{

   157

	return _total_industries;

   158

}

   159

   160

/**

   161

 * Return a random valid industry.

   162

 */

   163

static inline Industry *GetRandomIndustry()

   164

{

   165

	int num = RandomRange(GetNumIndustries());

   166

	IndustryID index = INVALID_INDUSTRY;

   167

   168

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

   169

   170

	while (num >= 0) {

   171

		num--;

   172

		index++;

   173

   174

		/* Make sure we have a valid industry */

   175

		while (!IsValidIndustryID(index)) {

   176

			index++;

   177

			assert(index <= GetMaxIndustryIndex());

   178

		}

   179

	}

   180

   181

	return GetIndustry(index);

   182

}

   183

   184

void DestroyIndustry(Industry *i);

   185

   186

static inline void DeleteIndustry(Industry *i)

   187

{

   188

	DestroyIndustry(i);

   189

	i->xy = 0;

   190

}

   191

   192

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

   193

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

   194

   195

VARDEF const Industry** _industry_sort;

   196

VARDEF bool _industry_sort_dirty;

   197

   198

   199

void DeleteIndustry(Industry *is);

   200

void PlantRandomFarmField(const Industry *i);

   201

   202

enum {

   203

	IT_COAL_MINE           =   0,

   204

	IT_POWER_STATION       =   1,

   205

	IT_SAWMILL             =   2,

   206

	IT_FOREST              =   3,

   207

	IT_OIL_REFINERY        =   4,

   208

	IT_OIL_RIG             =   5,

   209

	IT_FACTORY             =   6,

   210

	IT_PRINTING_WORKS      =   7,

   211

	IT_STEEL_MILL          =   8,

   212

	IT_FARM                =   9,

   213

	IT_COPPER_MINE         =  10,

   214

	IT_OIL_WELL            =  11,

   215

	IT_BANK_TEMP           =  12,

   216

	IT_FOOD_PROCESS        =  13,

   217

	IT_PAPER_MILL          =  14,

   218

	IT_GOLD_MINE           =  15,

   219

	IT_BANK_TROPIC_ARCTIC  =  16,

   220

	IT_DIAMOND_MINE        =  17,

   221

	IT_IRON_MINE           =  18,

   222

	IT_FRUIT_PLANTATION    =  19,

   223

	IT_RUBBER_PLANTATION   =  20,

   224

	IT_WATER_SUPPLY        =  21,

   225

	IT_WATER_TOWER         =  22,

   226

	IT_FACTORY_2           =  23,

   227

	IT_FARM_2              =  24,

   228

	IT_LUMBER_MILL         =  25,

   229

	IT_COTTON_CANDY        =  26,

   230

	IT_CANDY_FACTORY       =  27,

   231

	IT_BATTERY_FARM        =  28,

   232

	IT_COLA_WELLS          =  29,

   233

	IT_TOY_SHOP            =  30,

   234

	IT_TOY_FACTORY         =  31,

   235

	IT_PLASTIC_FOUNTAINS   =  32,

   236

	IT_FIZZY_DRINK_FACTORY =  33,

   237

	IT_BUBBLE_GENERATOR    =  34,

   238

	IT_TOFFEE_QUARRY       =  35,

   239

	IT_SUGAR_MINE          =  36,

   240

	IT_END,

   241

	IT_INVALID             = 255,

   242

};

   243

   244

#endif /* INDUSTRY_H */