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_NOT_CLOSABLE,     ///< Industry can never close

    32

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

    33

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

    34

};

    35

    36

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

    37

 * build at location the given to the procedure */

    38

enum CheckProc {

    39

	CHECK_NOTHING    = 0,

    40

	CHECK_FOREST     = 1,

    41

	CHECK_REFINERY   = 2,

    42

	CHECK_FARM       = 3,

    43

	CHECK_PLANTATION = 4,

    44

	CHECK_WATER      = 5,

    45

	CHECK_LUMBERMILL = 6,

    46

	CHECK_BUBBLEGEN  = 7,

    47

	CHECK_OIL_RIG    = 8,

    48

	CHECK_END,

    49

};

    50

    51

enum IndustyBehaviour {

    52

	INDUSTRYBEH_NONE                  =      0,

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

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

    63

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

    64

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

    65

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

    66

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

    67

};

    68

    69

    70

DECLARE_ENUM_AS_BIT_SET(IndustyBehaviour);

    71

    72

/**

    73

 * Defines the internal data of a functionnal industry

    74

 */

    75

struct Industry {

    77

	byte width;

    78

	byte height;

    89

    95

    97

};

    98

    99

struct IndustryTileTable {

   100

	TileIndexDiffC ti;

   101

	IndustryGfx gfx;

   102

};

   103

   104

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

   105

struct GRFFileProps {

   106

	uint8 subst_id;

   107

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

   108

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

   110

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

   111

};

   112

   113

/**

   114

 * Defines the data structure for constructing industry.

   115

 */

   116

struct IndustrySpec {

   117

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

   118

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

   120

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

   121

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

   122

	CargoID produced_cargo[2];

   123

	byte production_rate[2];

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

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

   140

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

   141

	/* Newgrf data */

   142

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

   143

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

   144

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

   145

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

   146

};

   147

   148

/**

   149

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

   150

 */

   151

struct IndustryTileSpec {

   152

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

   153

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

   154

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

   155

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

   156

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

   157

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

   158

	                                      ///< state instead of the construction state

   159

	/* Newgrf data */

   160

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

   161

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

   162

	struct GRFFileProps grf_prop;

   163

};

   164

   165

/* industry_cmd.cpp*/

   166

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

   167

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

   168

void ResetIndustries();

   169

void PlantRandomFarmField(const Industry *i);

   170

   171

/* writable arrays of specs */

   172

extern IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

   173

extern IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

   174

   175

/* smallmap_gui.cpp */

   176

void BuildIndustriesLegend();

   177

   178

DECLARE_OLD_POOL(Industry, Industry, 3, 8000)

   179

   180

/**

   181

 * Check if an Industry really exists.

   182

 * @param industry to check

   183

 * @return true if position is a valid one

   184

 */

   185

static inline bool IsValidIndustry(const Industry *industry)

   186

{

   187

	return industry->xy != 0;

   188

}

   189

   190

/**

   191

 * Check if an Industry exists whithin the pool of industries

   192

 * @param index of the desired industry

   193

 * @return true if it is inside the pool

   194

 */

   195

static inline bool IsValidIndustryID(IndustryID index)

   196

{

   197

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

   198

}

   199

   200

   201

static inline IndustryID GetMaxIndustryIndex()

   202

{

   203

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

   204

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

   205

	 *  _really_ returns the highest index. Now it just returns

   206

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

   207

	 */

   208

	return GetIndustryPoolSize() - 1;

   209

}

   210

   214

static inline uint GetNumIndustries()

   215

{

   216

	return _total_industries;

   217

}

   218

   256

/**

   257

 * Return a random valid industry.

   258

 */

   259

static inline Industry *GetRandomIndustry()

   260

{

   261

	int num = RandomRange(GetNumIndustries());

   262

	IndustryID index = INVALID_INDUSTRY;

   263

   264

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

   265

   266

	while (num >= 0) {

   267

		num--;

   268

		index++;

   269

   270

		/* Make sure we have a valid industry */

   271

		while (!IsValidIndustryID(index)) {

   272

			index++;

   273

			assert(index <= GetMaxIndustryIndex());

   274

		}

   275

	}

   276

   277

	return GetIndustry(index);

   278

}

   279

   280

void DestroyIndustry(Industry *i);

   281

   282

static inline void DeleteIndustry(Industry *i)

   283

{

   284

	DestroyIndustry(i);

   285

	i->xy = 0;

   286

}

   287

   288

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

   289

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

   290

   293

   294

enum {

   295

	IT_COAL_MINE           =   0,

   296

	IT_POWER_STATION       =   1,

   297

	IT_SAWMILL             =   2,

   298

	IT_FOREST              =   3,

   299

	IT_OIL_REFINERY        =   4,

   300

	IT_OIL_RIG             =   5,

   301

	IT_FACTORY             =   6,

   302

	IT_PRINTING_WORKS      =   7,

   303

	IT_STEEL_MILL          =   8,

   304

	IT_FARM                =   9,

   305

	IT_COPPER_MINE         =  10,

   306

	IT_OIL_WELL            =  11,

   307

	IT_BANK_TEMP           =  12,

   308

	IT_FOOD_PROCESS        =  13,

   309

	IT_PAPER_MILL          =  14,

   310

	IT_GOLD_MINE           =  15,

   311

	IT_BANK_TROPIC_ARCTIC  =  16,

   312

	IT_DIAMOND_MINE        =  17,

   313

	IT_IRON_MINE           =  18,

   314

	IT_FRUIT_PLANTATION    =  19,

   315

	IT_RUBBER_PLANTATION   =  20,

   316

	IT_WATER_SUPPLY        =  21,

   317

	IT_WATER_TOWER         =  22,

   318

	IT_FACTORY_2           =  23,

   319

	IT_FARM_2              =  24,

   320

	IT_LUMBER_MILL         =  25,

   321

	IT_COTTON_CANDY        =  26,

   322

	IT_CANDY_FACTORY       =  27,

   323

	IT_BATTERY_FARM        =  28,

   324

	IT_COLA_WELLS          =  29,

   325

	IT_TOY_SHOP            =  30,

   326

	IT_TOY_FACTORY         =  31,

   327

	IT_PLASTIC_FOUNTAINS   =  32,

   328

	IT_FIZZY_DRINK_FACTORY =  33,

   329

	IT_BUBBLE_GENERATOR    =  34,

   330

	IT_TOFFEE_QUARRY       =  35,

   331

	IT_SUGAR_MINE          =  36,

   332

	IT_END,

   333

	IT_INVALID             = 255,

   334

};

   335

   336

#endif /* INDUSTRY_H */