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

	NEW_INDUSTRYOFFSET     = 37,                         ///< original number of industries

    17

	NUM_INDUSTRYTYPES      = 37,                         ///< total number of industries, new and old

    18

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

    19

	NEW_INDUSTRYTILEOFFSET = 175,                        ///< original number of tiles

    20

	INVALID_INDUSTRYTYPE   = NUM_INDUSTRYTYPES,          ///< one above amount is considered invalid

    21

	NUM_INDUSTRYTILES      = NEW_INDUSTRYTILEOFFSET,     ///< total number of industry tiles, new and old

    22

	INVALID_INDUSTRYTILE   = NUM_INDUSTRYTILES,          ///< one above amount is considered invalid

    23

};

    24

    25

enum {

    26

	CLEAN_RANDOMSOUNDS,    ///< Free the dynamically allocated sounds table

    27

	CLEAN_TILELSAYOUT,     ///< Free the dynamically allocated tile layout structure

    28

};

    29

    30

enum IndustryLifeType {

    31

	INDUSTRYLIFE_BLACK_HOLE =      0, ///< Like power plants and banks

    32

	INDUSTRYLIFE_EXTRACTIVE = 1 << 0, ///< Like mines

    33

	INDUSTRYLIFE_ORGANIC    = 1 << 1, ///< Like forests

    34

	INDUSTRYLIFE_PROCESSING = 1 << 2, ///< Like factories

    35

};

    36

    37

/* Procedures that can be run to check whether an industry may

    38

 * build at location the given to the procedure */

    39

enum CheckProc {

    40

	CHECK_NOTHING,

    41

	CHECK_FOREST,

    42

	CHECK_REFINERY,

    43

	CHECK_FARM,

    44

	CHECK_PLANTATION,

    45

	CHECK_WATER,

    46

	CHECK_LUMBERMILL,

    47

	CHECK_BUBBLEGEN,

    48

	CHECK_OIL_RIG,

    49

	CHECK_END,

    50

};

    51

    52

enum IndustyBehaviour {

    53

	INDUSTRYBEH_NONE                  =      0,

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

	INDUSTRYBEH_DONT_INCR_PROD        = 1 << 7,  ///< do not increase production (oil wells) in the temperate climate

    62

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

    63

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

    64

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

    65

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

    66

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

    67

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

    68

};

    69

    70

    71

DECLARE_ENUM_AS_BIT_SET(IndustyBehaviour);

    72

    73

/**

    74

 * Defines the internal data of a functionnal industry

    75

 */

    76

struct Industry {

    77

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

    78

	byte width;

    79

	byte height;

    80

	const Town *town;                   ///< Nearest town

    81

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

    82

	uint16 incoming_cargo_waiting[3];   ///< incoming cargo waiting to be processed

    83

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

    84

	byte prod_level;                    ///< general production level

    85

	uint16 this_month_production[2];    ///< stats of this month's production per cargo

    86

	uint16 this_month_transported[2];   ///< stats of this month's transport per cargo

    87

	byte last_month_pct_transported[2]; ///< percentage transported per cargo in the last full month

    88

	uint16 last_month_production[2];    ///< total units produced per cargo in the last full month

    89

	uint16 last_month_transported[2];   ///< total units transported per cargo in the last full month

    90

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

    91

    92

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

    93

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

    94

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

    95

	Year last_prod_year;                ///< last year of production

    96

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

    97

    98

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

    99

};

   100

   101

struct IndustryTileTable {

   102

	TileIndexDiffC ti;

   103

	IndustryGfx gfx;

   104

};

   105

   106

/** Data related to the handling of grf files.  Common to both industry and industry tile */

   107

struct GRFFileProps {

   108

	uint8 subst_id;

   109

	uint16 local_id;                      ///< id defined by the grf file for this industry

   110

	struct SpriteGroup *spritegroup;      ///< pointer to the different sprites of the industry

   111

	const struct GRFFile *grffile;        ///< grf file that introduced this industry

   112

	uint16 override;                      ///< id of the entity been replaced by

   113

};

   114

   115

/**

   116

 * Defines the data structure for constructing industry.

   117

 */

   118

struct IndustrySpec {

   119

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

   120

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

   121

	uint8 cost_multiplier;                ///< Base cost multiplier.

   122

	uint16 raw_industry_cost_multiplier;  ///< Multiplier for the raw industries cost

   123

	uint32 prospecting_chance;            ///< Chance prospecting succeeds

   124

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

   125

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

   126

	CargoID produced_cargo[2];

   127

	byte production_rate[2];

   128

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

   129

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

   130

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

   131

	uint16 input_cargo_multiplier[3][2];  ///< Input cargo multipliers (multiply amount of incoming cargo for the produced cargos)

   132

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

   133

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

   134

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

   135

	byte map_colour;                      ///< colour used for the small map

   136

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

   137

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

   138

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

   139

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

   140

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

   141

	byte appear_ingame[NUM_LANDSCAPE];    ///< Probability of appearance in game

   142

	byte appear_creation[NUM_LANDSCAPE];  ///< Probability of appearance during map creation

   143

	uint8 number_of_sounds;               ///< Number of sounds available in the sounds array

   144

	const uint8 *random_sounds;           ///< array of random sounds.

   145

	/* Newgrf data */

   146

	uint16 callback_flags;                ///< Flags telling which grf callback is set

   147

	uint8 cleanup_flag;                   ///< flags indicating which data should be freed upon cleaning up

   148

	bool enabled;                         ///< entity still avaible (by default true).newgrf can disable it, though

   149

	struct GRFFileProps grf_prop;         ///< properties related the the grf file

   162

};

   163

   164

/**

   165

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

   166

 */

   167

struct IndustryTileSpec {

   168

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

   169

	uint8 acceptance[3];                  ///< Level of aceptance per cargo type

   170

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

   171

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

   172

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

   173

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

   174

	                                      ///< state instead of the construction state

   175

	/* Newgrf data */

   176

	uint8 callback_flags;                 ///< Flags telling which grf callback is set

   177

	bool enabled;                         ///< entity still avaible (by default true).newgrf can disable it, though

   178

	struct GRFFileProps grf_prop;

   179

};

   180

   181

/* industry_cmd.cpp*/

   182

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

   183

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

   184

void ResetIndustries();

   185

void PlantRandomFarmField(const Industry *i);

   186

   187

/* writable arrays of specs */

   188

extern IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

   189

extern IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

   190

   191

/* smallmap_gui.cpp */

   192

void BuildIndustriesLegend();

   193

   194

DECLARE_OLD_POOL(Industry, Industry, 3, 8000)

   195

   196

/**

   197

 * Check if an Industry really exists.

   198

 * @param industry to check

   199

 * @return true if position is a valid one

   200

 */

   201

static inline bool IsValidIndustry(const Industry *industry)

   202

{

   203

	return industry->xy != 0;

   204

}

   205

   206

/**

   207

 * Check if an Industry exists whithin the pool of industries

   208

 * @param index of the desired industry

   209

 * @return true if it is inside the pool

   210

 */

   211

static inline bool IsValidIndustryID(IndustryID index)

   212

{

   213

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

   214

}

   215

   216

   217

static inline IndustryID GetMaxIndustryIndex()

   218

{

   219

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

   220

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

   221

	 *  _really_ returns the highest index. Now it just returns

   222

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

   223

	 */

   224

	return GetIndustryPoolSize() - 1;

   225

}

   226

   227

extern int _total_industries;  // general counter

   228

extern uint16 _industry_counts[NUM_INDUSTRYTYPES]; // Number of industries per type ingame

   229

   230

static inline uint GetNumIndustries()

   231

{

   232

	return _total_industries;

   233

}

   234

   235

/** Increment the count of industries for this type

   236

 * @param type IndustryType to increment

   237

 * @pre type < INVALID_INDUSTRYTYPE */

   238

static inline void IncIndustryTypeCount(IndustryType type)

   239

{

   240

	assert(type < INVALID_INDUSTRYTYPE);

   241

	_industry_counts[type]++;

   242

	_total_industries++;

   243

}

   244

   245

/** Decrement the count of industries for this type

   246

 * @param type IndustryType to decrement

   247

 * @pre type < INVALID_INDUSTRYTYPE */

   248

static inline void DecIndustryTypeCount(IndustryType type)

   249

{

   250

	assert(type < INVALID_INDUSTRYTYPE);

   251

	_industry_counts[type]--;

   252

	_total_industries--;

   253

}

   254

   255

/** get the count of industries for this type

   256

 * @param type IndustryType to query

   257

 * @pre type < INVALID_INDUSTRYTYPE */

   258

static inline uint8 GetIndustryTypeCount(IndustryType type)

   259

{

   260

	assert(type < INVALID_INDUSTRYTYPE);

   261

	return min(_industry_counts[type], 0xFF); // callback expects only a byte, so cut it

   262

}

   263

   264

/** Resets both the total_industries and the _industry_counts

   265

 * This way, we centralize all counts activities */

   266

static inline void ResetIndustryCounts()

   267

{

   268

	_total_industries = 0;

   269

	memset(&_industry_counts, 0, sizeof(_industry_counts));

   270

}

   271

   272

/**

   273

 * Return a random valid industry.

   274

 */

   275

static inline Industry *GetRandomIndustry()

   276

{

   277

	int num = RandomRange(GetNumIndustries());

   278

	IndustryID index = INVALID_INDUSTRY;

   279

   280

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

   281

   282

	while (num >= 0) {

   283

		num--;

   284

		index++;

   285

   286

		/* Make sure we have a valid industry */

   287

		while (!IsValidIndustryID(index)) {

   288

			index++;

   289

			assert(index <= GetMaxIndustryIndex());

   290

		}

   291

	}

   292

   293

	return GetIndustry(index);

   294

}

   295

   296

void DestroyIndustry(Industry *i);

   297

   298

static inline void DeleteIndustry(Industry *i)

   299

{

   300

	DestroyIndustry(i);

   301

	i->xy = 0;

   302

}

   303

   304

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

   305

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

   306

   307

extern const Industry **_industry_sort;

   308

extern bool _industry_sort_dirty;

   309

   310

enum {

   311

	IT_COAL_MINE           =   0,

   312

	IT_POWER_STATION       =   1,

   313

	IT_SAWMILL             =   2,

   314

	IT_FOREST              =   3,

   315

	IT_OIL_REFINERY        =   4,

   316

	IT_OIL_RIG             =   5,

   317

	IT_FACTORY             =   6,

   318

	IT_PRINTING_WORKS      =   7,

   319

	IT_STEEL_MILL          =   8,

   320

	IT_FARM                =   9,

   321

	IT_COPPER_MINE         =  10,

   322

	IT_OIL_WELL            =  11,

   323

	IT_BANK_TEMP           =  12,

   324

	IT_FOOD_PROCESS        =  13,

   325

	IT_PAPER_MILL          =  14,

   326

	IT_GOLD_MINE           =  15,

   327

	IT_BANK_TROPIC_ARCTIC  =  16,

   328

	IT_DIAMOND_MINE        =  17,

   329

	IT_IRON_MINE           =  18,

   330

	IT_FRUIT_PLANTATION    =  19,

   331

	IT_RUBBER_PLANTATION   =  20,

   332

	IT_WATER_SUPPLY        =  21,

   333

	IT_WATER_TOWER         =  22,

   334

	IT_FACTORY_2           =  23,

   335

	IT_FARM_2              =  24,

   336

	IT_LUMBER_MILL         =  25,

   337

	IT_COTTON_CANDY        =  26,

   338

	IT_CANDY_FACTORY       =  27,

   339

	IT_BATTERY_FARM        =  28,

   340

	IT_COLA_WELLS          =  29,

   341

	IT_TOY_SHOP            =  30,

   342

	IT_TOY_FACTORY         =  31,

   343

	IT_PLASTIC_FOUNTAINS   =  32,

   344

	IT_FIZZY_DRINK_FACTORY =  33,

   345

	IT_BUBBLE_GENERATOR    =  34,

   346

	IT_TOFFEE_QUARRY       =  35,

   347

	IT_SUGAR_MINE          =  36,

   348

	IT_END,

   349

	IT_INVALID             = 255,

   350

};

   351

   352

#endif /* INDUSTRY_H */