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 IndustryLifeType {

    26

	INDUSTRYLIFE_NOT_CLOSABLE,     ///< Industry can never close

    27

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

    28

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

    29

};

    30

    31

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

    32

 * build at location the given to the procedure */

    33

enum CheckProc {

    34

	CHECK_NOTHING    = 0,

    35

	CHECK_FOREST     = 1,

    36

	CHECK_REFINERY   = 2,

    37

	CHECK_FARM       = 3,

    38

	CHECK_PLANTATION = 4,

    39

	CHECK_WATER      = 5,

    40

	CHECK_LUMBERMILL = 6,

    41

	CHECK_BUBBLEGEN  = 7,

    42

	CHECK_OIL_RIG    = 8,

    43

	CHECK_END,

    44

};

    45

    46

enum IndustyBehaviour {

    47

	INDUSTRYBEH_NONE                  =      0,

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

};

    63

    64

    65

DECLARE_ENUM_AS_BIT_SET(IndustyBehaviour);

    66

    67

/**

    68

 * Defines the internal data of a functionnal industry

    69

 */

    70

struct Industry {

    71

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

    72

	byte width;

    73

	byte height;

    74

	const Town* town;               ///< Nearest town

    75

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

    76

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

    77

	byte prod_level;                ///< general production level

    78

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

    79

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

    80

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

    81

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

    82

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

    83

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

    84

    85

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

    86

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

    87

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

    88

	Year last_prod_year;            ///< last year of production

    89

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

    90

    91

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

    92

};

    93

    94

struct IndustryTileTable {

    95

	TileIndexDiffC ti;

    96

	IndustryGfx gfx;

    97

};

    98

    99

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

   100

struct GRFFileProps {

   101

	uint8 subst_id;

   102

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

   103

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

   104

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

   105

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

   106

};

   107

   108

/**

   109

 * Defines the data structure for constructing industry.

   110

 */

   111

struct IndustrySpec {

   112

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

   113

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

   114

	byte cost_multiplier;                 ///< Base cost multiplier. Watch out for this one, << 5  VS << 8

   115

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

   116

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

   117

	CargoID produced_cargo[2];

   118

	byte production_rate[2];

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

	/* Newgrf data */

   137

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

   138

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

   139

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

   140

};

   141

   142

/**

   143

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

   144

 */

   145

struct IndustryTileSpec {

   146

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

   147

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

   148

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

   149

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

   150

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

   151

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

   152

	                                      ///< state instead of the construction state

   153

	/* Newgrf data */

   154

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

   155

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

   156

	struct GRFFileProps grf_prop;

   157

};

   158

   159

/* industry_cmd.cpp*/

   160

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

   161

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

   162

void ResetIndustries();

   163

void PlantRandomFarmField(const Industry *i);

   164

   165

/* writable arrays of specs */

   166

extern IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

   167

extern IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

   168

   169

/* smallmap_gui.cpp */

   170

void BuildIndustriesLegend();

   171

   172

DECLARE_OLD_POOL(Industry, Industry, 3, 8000)

   173

   174

/**

   175

 * Check if an Industry really exists.

   176

 * @param industry to check

   177

 * @return true if position is a valid one

   178

 */

   179

static inline bool IsValidIndustry(const Industry *industry)

   180

{

   181

	return industry->xy != 0;

   182

}

   183

   184

/**

   185

 * Check if an Industry exists whithin the pool of industries

   186

 * @param index of the desired industry

   187

 * @return true if it is inside the pool

   188

 */

   189

static inline bool IsValidIndustryID(IndustryID index)

   190

{

   191

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

   192

}

   193

   194

VARDEF int _total_industries; //general counter

   195

   196

static inline IndustryID GetMaxIndustryIndex()

   197

{

   198

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

   199

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

   200

	 *  _really_ returns the highest index. Now it just returns

   201

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

   202

	 */

   203

	return GetIndustryPoolSize() - 1;

   204

}

   205

   206

static inline uint GetNumIndustries()

   207

{

   208

	return _total_industries;

   209

}

   210

   211

/**

   212

 * Return a random valid industry.

   213

 */

   214

static inline Industry *GetRandomIndustry()

   215

{

   216

	int num = RandomRange(GetNumIndustries());

   217

	IndustryID index = INVALID_INDUSTRY;

   218

   219

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

   220

   221

	while (num >= 0) {

   222

		num--;

   223

		index++;

   224

   225

		/* Make sure we have a valid industry */

   226

		while (!IsValidIndustryID(index)) {

   227

			index++;

   228

			assert(index <= GetMaxIndustryIndex());

   229

		}

   230

	}

   231

   232

	return GetIndustry(index);

   233

}

   234

   235

void DestroyIndustry(Industry *i);

   236

   237

static inline void DeleteIndustry(Industry *i)

   238

{

   239

	DestroyIndustry(i);

   240

	i->xy = 0;

   241

}

   242

   243

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

   244

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

   245

   246

VARDEF const Industry** _industry_sort;

   247

VARDEF bool _industry_sort_dirty;

   248

   249

enum {

   250

	IT_COAL_MINE           =   0,

   251

	IT_POWER_STATION       =   1,

   252

	IT_SAWMILL             =   2,

   253

	IT_FOREST              =   3,

   254

	IT_OIL_REFINERY        =   4,

   255

	IT_OIL_RIG             =   5,

   256

	IT_FACTORY             =   6,

   257

	IT_PRINTING_WORKS      =   7,

   258

	IT_STEEL_MILL          =   8,

   259

	IT_FARM                =   9,

   260

	IT_COPPER_MINE         =  10,

   261

	IT_OIL_WELL            =  11,

   262

	IT_BANK_TEMP           =  12,

   263

	IT_FOOD_PROCESS        =  13,

   264

	IT_PAPER_MILL          =  14,

   265

	IT_GOLD_MINE           =  15,

   266

	IT_BANK_TROPIC_ARCTIC  =  16,

   267

	IT_DIAMOND_MINE        =  17,

   268

	IT_IRON_MINE           =  18,

   269

	IT_FRUIT_PLANTATION    =  19,

   270

	IT_RUBBER_PLANTATION   =  20,

   271

	IT_WATER_SUPPLY        =  21,

   272

	IT_WATER_TOWER         =  22,

   273

	IT_FACTORY_2           =  23,

   274

	IT_FARM_2              =  24,

   275

	IT_LUMBER_MILL         =  25,

   276

	IT_COTTON_CANDY        =  26,

   277

	IT_CANDY_FACTORY       =  27,

   278

	IT_BATTERY_FARM        =  28,

   279

	IT_COLA_WELLS          =  29,

   280

	IT_TOY_SHOP            =  30,

   281

	IT_TOY_FACTORY         =  31,

   282

	IT_PLASTIC_FOUNTAINS   =  32,

   283

	IT_FIZZY_DRINK_FACTORY =  33,

   284

	IT_BUBBLE_GENERATOR    =  34,

   285

	IT_TOFFEE_QUARRY       =  35,

   286

	IT_SUGAR_MINE          =  36,

   287

	IT_END,

   288

	IT_INVALID             = 255,

   289

};

   290

   291

#endif /* INDUSTRY_H */