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"

    11

    12

typedef byte IndustryGfx;

    13

typedef uint8 IndustryType;

    14

    15

enum {

    16

	INVALID_INDUSTRY       = 0xFFFF,

    17

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

    18

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

    19

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

    20

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

    21

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

    22

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

    23

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

    24

	INDUSTRY_COMPLETED     = 3,                          ///< final stage of industry construction.

    25

};

    26

    27

enum {

    28

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

    29

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

    30

};

    31

    32

enum IndustryLifeType {

    33

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

    34

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

    35

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

    36

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

    37

};

    38

    39

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

    40

 * build at location the given to the procedure */

    41

enum CheckProc {

    42

	CHECK_NOTHING,

    43

	CHECK_FOREST,

    44

	CHECK_REFINERY,

    45

	CHECK_FARM,

    46

	CHECK_PLANTATION,

    47

	CHECK_WATER,

    48

	CHECK_LUMBERMILL,

    49

	CHECK_BUBBLEGEN,

    50

	CHECK_OIL_RIG,

    51

	CHECK_END,

    52

};

    53

    54

/** How was the industry created */

    55

enum IndustryConstructionType {

    56

	ICT_UNKNOWN,          ///< in previous game version or without newindustries activated

    57

	ICT_NORMAL_GAMEPLAY,  ///< either by user or random creation proccess

    58

	ICT_MAP_GENERATION,   ///< during random map creation

    59

	ICT_SCENARIO_EDITOR   ///< while scenarion edition

    60

};

    61

    62

/** From where is callback CBID_INDUSTRY_AVAILABLE been called */

    63

enum IndustryAvailabilityCallType {

    64

	IACT_MAPGENERATION,   ///< during random map generation

    65

	IACT_RANDOMCREATION,  ///< during creation of random ingame industry

    66

	IACT_USERCREATION,    ///< from the Fund/build window

    67

};

    68

    69

enum IndustyBehaviour {

    70

	INDUSTRYBEH_NONE                  =      0,

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

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

    84

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

    85

	INDUSTRYBEH_CANCLOSE_LASTINSTANCE = 1 << 17, ///< Allow closing down the last instance of this type

    86

};

    87

    88

    89

DECLARE_ENUM_AS_BIT_SET(IndustyBehaviour);

    90

    91

struct Industry;

    92

DECLARE_OLD_POOL(Industry, Industry, 3, 8000)

    93

    94

/**

    95

 * Defines the internal data of a functionnal industry

    96

 */

    97

struct Industry : PoolItem<Industry, IndustryID, &_Industry_pool> {

   100

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

   101

	byte width;

   102

	byte height;

   103

	const Town *town;                   ///< Nearest town

   104

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

   105

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

   106

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

   107

	byte prod_level;                    ///< general production level

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

   115

	IndustryType type;                  ///< type of industry.

   116

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

   117

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

   118

	Year last_prod_year;                ///< last year of production

   119

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

   120

   121

	OwnerByte founder;                  ///< Founder of the industry

   122

	Date construction_date;             ///< Date of the construction of the industry

   123

	uint8 construction_type;            ///< Way the industry was constructed (@see IndustryConstructionType)

   124

	Date last_cargo_accepted_at;        ///< Last day cargo was accepted by this industry

   125

	byte selected_layout;               ///< Which tile layout was used when creating the industry

   126

   129

	Industry(TileIndex tile = 0) : xy(tile) {}

   130

	~Industry();

   131

   132

	inline bool IsValid() const { return this->xy != 0; }

   133

};

   134

   135

struct IndustryTileTable {

   136

	TileIndexDiffC ti;

   137

	IndustryGfx gfx;

   138

};

   139

   140

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

   141

struct GRFFileProps {

   142

	uint16 subst_id;

   143

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

   144

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

   145

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

   146

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

   147

};

   148

   149

/**

   150

 * Defines the data structure for constructing industry.

   151

 */

   152

struct IndustrySpec {

   153

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

   154

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

   155

	uint8 cost_multiplier;                ///< Base cost multiplier.

   156

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

   157

	uint32 prospecting_chance;            ///< Chance prospecting succeeds

   158

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

   159

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

   160

	CargoID produced_cargo[2];

   161

	byte production_rate[2];

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

	/* Newgrf data */

   180

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

   181

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

   182

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

   183

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

   184

   185

	/**

   186

	 * Is an industry with the spec a raw industry?

   187

	 * @return true if it should be handled as a raw industry

   188

	 */

   189

	bool IsRawIndustry() const;

   190

   191

	/**

   192

	 * Get the cost for constructing this industry

   193

	 * @return the cost (inflation corrected etc)

   194

	 */

   195

	Money GetConstructionCost() const;

   196

};

   197

   198

/**

   199

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

   200

 */

   201

struct IndustryTileSpec {

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

	                                      ///< state instead of the construction state

   209

	/* Newgrf data */

   210

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

   211

	uint16 animation_info;                ///< Information about the animation (is it looping, how many loops etc)

   212

	uint8 animation_speed;                ///< The speed of the animation

   213

	uint8 animation_triggers;             ///< When to start the animation

   214

	uint8 animation_special_flags;        ///< Extra flags to influence the animation

   215

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

   216

	struct GRFFileProps grf_prop;

   217

};

   218

   219

/* industry_cmd.cpp*/

   220

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

   221

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

   222

void ResetIndustries();

   223

void PlantRandomFarmField(const Industry *i);

   224

   225

/* writable arrays of specs */

   226

extern IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

   227

extern IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

   228

   229

static inline IndustryGfx GetTranslatedIndustryTileID(IndustryGfx gfx)

   230

{

   231

	/* the 0xFF should be GFX_WATERTILE_SPECIALCHECK but for reasons of include mess,

   232

	 * we'll simplify the writing.

   233

	 * Basically, the first test is required since the GFX_WATERTILE_SPECIALCHECK value

   234

	 * will never be assigned as a tile index and is only required in order to do some

   235

	 * tests while building the industry (as in WATER REQUIRED */

   236

	if (gfx != 0xFF) {

   237

		assert(gfx < INVALID_INDUSTRYTILE);

   238

		const IndustryTileSpec *it = &_industry_tile_specs[gfx];

   239

		return it->grf_prop.override == INVALID_INDUSTRYTILE ? gfx : it->grf_prop.override;

   240

	} else {

   241

		return gfx;

   242

	}

   243

}

   244

   245

/* smallmap_gui.cpp */

   246

void BuildIndustriesLegend();

   247

   248

/**

   249

 * Check if an Industry exists whithin the pool of industries

   250

 * @param index of the desired industry

   251

 * @return true if it is inside the pool

   252

 */

   253

static inline bool IsValidIndustryID(IndustryID index)

   254

{

   255

	return index < GetIndustryPoolSize() && GetIndustry(index)->IsValid();

   256

}

   257

   258

   259

static inline IndustryID GetMaxIndustryIndex()

   260

{

   261

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

   262

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

   263

	 *  _really_ returns the highest index. Now it just returns

   264

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

   265

	 */

   266

	return GetIndustryPoolSize() - 1;

   267

}

   268

   269

extern int _total_industries;  // general counter

   270

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

   271

   272

static inline uint GetNumIndustries()

   273

{

   274

	return _total_industries;

   275

}

   276

   277

/** Increment the count of industries for this type

   278

 * @param type IndustryType to increment

   279

 * @pre type < INVALID_INDUSTRYTYPE */

   280

static inline void IncIndustryTypeCount(IndustryType type)

   281

{

   282

	assert(type < INVALID_INDUSTRYTYPE);

   283

	_industry_counts[type]++;

   284

	_total_industries++;

   285

}

   286

   287

/** Decrement the count of industries for this type

   288

 * @param type IndustryType to decrement

   289

 * @pre type < INVALID_INDUSTRYTYPE */

   290

static inline void DecIndustryTypeCount(IndustryType type)

   291

{

   292

	assert(type < INVALID_INDUSTRYTYPE);

   293

	_industry_counts[type]--;

   294

	_total_industries--;

   295

}

   296

   297

/** get the count of industries for this type

   298

 * @param type IndustryType to query

   299

 * @pre type < INVALID_INDUSTRYTYPE */

   300

static inline uint8 GetIndustryTypeCount(IndustryType type)

   301

{

   302

	assert(type < INVALID_INDUSTRYTYPE);

   303

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

   304

}

   305

   306

/** Resets both the total_industries and the _industry_counts

   307

 * This way, we centralize all counts activities */

   308

static inline void ResetIndustryCounts()

   309

{

   310

	_total_industries = 0;

   311

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

   312

}

   313

   314

/**

   315

 * Return a random valid industry.

   316

 */

   317

static inline Industry *GetRandomIndustry()

   318

{

   319

	int num = RandomRange(GetNumIndustries());

   320

	IndustryID index = INVALID_INDUSTRY;

   321

   322

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

   323

   324

	while (num >= 0) {

   325

		num--;

   326

		index++;

   327

   328

		/* Make sure we have a valid industry */

   329

		while (!IsValidIndustryID(index)) {

   330

			index++;

   331

			assert(index <= GetMaxIndustryIndex());

   332

		}

   333

	}

   334

   335

	return GetIndustry(index);

   336

}

   337

   338

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

   339

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

   340

   341

extern const Industry **_industry_sort;

   342

extern bool _industry_sort_dirty;

   343

   344

static const uint8 IT_INVALID = 255;

   345

   346

#endif /* INDUSTRY_H */