1

/* $Id$ */

     2

     3

/** @file industry_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "clear_map.h"

     8

#include "functions.h"

     9

#include "industry_map.h"

    10

#include "station_map.h"

    11

#include "table/strings.h"

    12

#include "strings.h"

    13

#include "table/sprites.h"

    14

#include "map.h"

    15

#include "tile.h"

    16

#include "landscape.h"

    17

#include "viewport.h"

    18

#include "command.h"

    19

#include "industry.h"

    20

#include "town.h"

    21

#include "vehicle.h"

    22

#include "news.h"

    23

#include "saveload.h"

    24

#include "economy.h"

    25

#include "sound.h"

    26

#include "variables.h"

    27

#include "table/industry_land.h"

    28

#include "table/build_industry.h"

    29

#include "genworld.h"

    30

#include "date.h"

    31

#include "water_map.h"

    32

#include "tree_map.h"

    33

#include "cargotype.h"

    34

#include "newgrf.h"

    35

#include "newgrf_commons.h"

    36

#include "newgrf_industries.h"

    37

#include "newgrf_industrytiles.h"

    38

#include "newgrf_callbacks.h"

    39

#include "misc/autoptr.hpp"

    40

#include "autoslope.h"

    41

    42

void ShowIndustryViewWindow(int industry);

    43

void BuildOilRig(TileIndex tile);

    44

    45

static byte _industry_sound_ctr;

    46

static TileIndex _industry_sound_tile;

    47

    48

int _total_industries;                      //general counter

    49

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

    50

    51

const Industry **_industry_sort;

    52

bool _industry_sort_dirty;

    53

    54

IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

    55

IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

    56

    57

/** This function initialize the spec arrays of both

    58

 * industry and industry tiles.

    59

 * It adjusts the enabling of the industry too, based on climate availability.

    60

 * This will allow for clearer testings */

    61

void ResetIndustries()

    62

{

    63

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

    64

	memcpy(&_industry_specs, &_origin_industry_specs, sizeof(_origin_industry_specs));

    65

    66

	/* once performed, enable only the current climate industries */

    67

	for (IndustryType i = 0; i < NUM_INDUSTRYTYPES; i++) {

    68

		_industry_specs[i].enabled = i < NEW_INDUSTRYOFFSET &&

    69

				HASBIT(_origin_industry_specs[i].climate_availability, _opt.landscape);

    70

	}

    71

    72

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

    73

	memcpy(&_industry_tile_specs, &_origin_industry_tile_specs, sizeof(_origin_industry_tile_specs));

    74

    75

	/* Reset any overrides that have been set. */

    76

	_industile_mngr.ResetOverride();

    77

	_industry_mngr.ResetOverride();

    78

}

    79

    80

void ResetIndustryCreationProbility(IndustryType type)

    81

{

    82

	assert(type < INVALID_INDUSTRYTYPE);

    83

	_industry_specs[type].appear_creation[_opt.landscape] = 0;

    84

}

    85

    86

DEFINE_OLD_POOL_GENERIC(Industry, Industry)

    87

    88

/**

    89

 * Retrieve the type for this industry.  Although it is accessed by a tile,

    90

 * it will return the general type of industry, and not the sprite index

    91

 * as would do GetIndustryGfx.

    92

 * @param tile that is queried

    93

 * @pre IsTileType(tile, MP_INDUSTRY)

    94

 * @return general type for this industry, as defined in industry.h

    95

 **/

    96

IndustryType GetIndustryType(TileIndex tile)

    97

{

    98

	assert(IsTileType(tile, MP_INDUSTRY));

    99

   100

	const Industry *ind = GetIndustryByTile(tile);

   101

	return ind->IsValid() ? ind->type : (IndustryType)IT_INVALID;

   102

}

   103

   104

/**

   105

 * Accessor for array _industry_specs.

   106

 * This will ensure at once : proper access and

   107

 * not allowing modifications of it.

   108

 * @param thistype of industry (which is the index in _industry_specs)

   109

 * @pre thistype < NUM_INDUSTRYTYPES

   110

 * @return a pointer to the corresponding industry spec

   111

 **/

   112

const IndustrySpec *GetIndustrySpec(IndustryType thistype)

   113

{

   114

	assert(thistype < NUM_INDUSTRYTYPES);

   115

	return &_industry_specs[thistype];

   116

}

   117

   118

/**

   119

 * Accessor for array _industry_tile_specs.

   120

 * This will ensure at once : proper access and

   121

 * not allowing modifications of it.

   122

 * @param gfx of industrytile (which is the index in _industry_tile_specs)

   123

 * @pre gfx < INVALID_INDUSTRYTILE

   124

 * @return a pointer to the corresponding industrytile spec

   125

 **/

   126

const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx)

   127

{

   128

	assert(gfx < INVALID_INDUSTRYTILE);

   129

	return &_industry_tile_specs[gfx];

   130

}

   131

   132

Industry::~Industry()

   133

{

   134

	if (CleaningPool()) return;

   135

   136

	/* Industry can also be destroyed when not fully initialized.

   137

	 * This means that we do not have to clear tiles either. */

   138

	if (this->width == 0) {

   139

		this->xy = 0;

   140

		return;

   141

	}

   142

   143

	BEGIN_TILE_LOOP(tile_cur, this->width, this->height, this->xy);

   144

		if (IsTileType(tile_cur, MP_INDUSTRY)) {

   145

			if (GetIndustryIndex(tile_cur) == this->index) {

   146

				DoClearSquare(tile_cur);

   147

			}

   148

		} else if (IsTileType(tile_cur, MP_STATION) && IsOilRig(tile_cur)) {

   149

			DeleteOilRig(tile_cur);

   150

		}

   151

	END_TILE_LOOP(tile_cur, this->width, this->height, this->xy);

   152

   153

	if (GetIndustrySpec(this->type)->behaviour & INDUSTRYBEH_PLANT_FIELDS) {

   154

		/* Remove the farmland and convert it to regular tiles over time. */

   155

		BEGIN_TILE_LOOP(tile_cur, 42, 42, this->xy - TileDiffXY(21, 21)) {

   156

			tile_cur = TILE_MASK(tile_cur);

   157

			if (IsTileType(tile_cur, MP_CLEAR) && IsClearGround(tile_cur, CLEAR_FIELDS) &&

   158

					GetIndustryIndexOfField(tile_cur) == this->index) {

   159

				SetIndustryIndexOfField(tile_cur, INVALID_INDUSTRY);

   160

			}

   161

		} END_TILE_LOOP(tile_cur, 42, 42, this->xy - TileDiff(21, 21))

   162

	}

   163

   164

	_industry_sort_dirty = true;

   165

	DecIndustryTypeCount(this->type);

   166

   167

	DeleteSubsidyWithIndustry(this->index);

   168

	DeleteWindowById(WC_INDUSTRY_VIEW, this->index);

   169

	InvalidateWindow(WC_INDUSTRY_DIRECTORY, 0);

   170

	this->xy = 0;

   171

}

   172

   173

static void IndustryDrawSugarMine(const TileInfo *ti)

   174

{

   175

	const DrawIndustryAnimationStruct *d;

   176

   177

	if (!IsIndustryCompleted(ti->tile)) return;

   178

   179

	d = &_draw_industry_spec1[GetIndustryAnimationState(ti->tile)];

   180

   181

	AddChildSpriteScreen(SPR_IT_SUGAR_MINE_SIEVE + d->image_1, PAL_NONE, d->x, 0);

   182

   183

	if (d->image_2 != 0) {

   184

		AddChildSpriteScreen(SPR_IT_SUGAR_MINE_CLOUDS + d->image_2 - 1, PAL_NONE, 8, 41);

   185

	}

   186

   187

	if (d->image_3 != 0) {

   188

		AddChildSpriteScreen(SPR_IT_SUGAR_MINE_PILE + d->image_3 - 1, PAL_NONE,

   189

			_drawtile_proc1[d->image_3 - 1].x, _drawtile_proc1[d->image_3 - 1].y);

   190

	}

   191

}

   192

   193

static void IndustryDrawToffeeQuarry(const TileInfo *ti)

   194

{

   195

	uint8 x = 0;

   196

   197

	if (IsIndustryCompleted(ti->tile)) {

   198

		x = _industry_anim_offs_toffee[GetIndustryAnimationState(ti->tile)];

   199

		if (x == 0xFF)

   200

			x = 0;

   201

	}

   202

   203

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_SHOVEL, PAL_NONE, 22 - x, 24 + x);

   204

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_TOFFEE, PAL_NONE, 6, 14);

   205

}

   206

   207

static void IndustryDrawBubbleGenerator( const TileInfo *ti)

   208

{

   209

	if (IsIndustryCompleted(ti->tile)) {

   210

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_BUBBLE, PAL_NONE, 5, _industry_anim_offs_bubbles[GetIndustryAnimationState(ti->tile)]);

   211

	} else {

   212

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_SPRING, PAL_NONE, 3, 67);

   213

	}

   214

}

   215

   216

static void IndustryDrawToyFactory(const TileInfo *ti)

   217

{

   218

	const DrawIndustryAnimationStruct *d;

   219

   220

	d = &_industry_anim_offs_toys[GetIndustryAnimationState(ti->tile)];

   221

   222

	if (d->image_1 != 0xFF) {

   223

		AddChildSpriteScreen(SPR_IT_TOY_FACTORY_CLAY, PAL_NONE, d->x, 96 + d->image_1);

   224

	}

   225

   226

	if (d->image_2 != 0xFF) {

   227

		AddChildSpriteScreen(SPR_IT_TOY_FACTORY_ROBOT, PAL_NONE, 16 - d->image_2 * 2, 100 + d->image_2);

   228

	}

   229

   230

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP, PAL_NONE, 7, d->image_3);

   231

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP_HOLDER, PAL_NONE, 0, 42);

   232

}

   233

   234

static void IndustryDrawCoalPlantSparks(const TileInfo *ti)

   235

{

   236

	if (IsIndustryCompleted(ti->tile)) {

   237

		uint8 image = GetIndustryAnimationState(ti->tile);

   238

   239

		if (image != 0 && image < 7) {

   240

			AddChildSpriteScreen(image + SPR_IT_POWER_PLANT_TRANSFORMERS,

   241

				PAL_NONE,

   242

				_coal_plant_sparks[image - 1].x,

   243

				_coal_plant_sparks[image - 1].y

   244

			);

   245

		}

   246

	}

   247

}

   248

   249

typedef void IndustryDrawTileProc(const TileInfo *ti);

   250

static IndustryDrawTileProc * const _industry_draw_tile_procs[5] = {

   251

	IndustryDrawSugarMine,

   252

	IndustryDrawToffeeQuarry,

   253

	IndustryDrawBubbleGenerator,

   254

	IndustryDrawToyFactory,

   255

	IndustryDrawCoalPlantSparks,

   256

};

   257

   258

static void DrawTile_Industry(TileInfo *ti)

   259

{

   260

	IndustryGfx gfx = GetIndustryGfx(ti->tile);

   261

	Industry *ind = GetIndustryByTile(ti->tile);

   262

	const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   263

	const DrawBuildingsTileStruct *dits;

   264

	SpriteID image;

   265

	SpriteID pal;

   266

   267

	/* Retrieve pointer to the draw industry tile struct */

   268

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   269

		/* Draw the tile using the specialized method of newgrf industrytile.

   270

		 * DrawNewIndustry will return false if ever the resolver could not

   271

		 * find any sprite to display.  So in this case, we will jump on the

   272

		 * substitute gfx instead. */

   273

		if (indts->grf_prop.spritegroup != NULL && DrawNewIndustryTile(ti, ind, gfx, indts)) {

   274

			return;

   275

		} else {

   276

			/* No sprite group (or no valid one) found, meaning no graphics associated.

   277

			 * Use the substitute one instead */

   278

			if (indts->grf_prop.subst_id != INVALID_INDUSTRYTILE) {

   279

				gfx = indts->grf_prop.subst_id;

   280

				/* And point the industrytile spec accordingly */

   281

				indts = GetIndustryTileSpec(gfx);

   282

			}

   283

		}

   284

	}

   285

   286

	dits = &_industry_draw_tile_data[gfx << 2 | (indts->anim_state ?

   287

			GetIndustryAnimationState(ti->tile) & INDUSTRY_COMPLETED :

   288

			GetIndustryConstructionStage(ti->tile))];

   289

   290

	image = dits->ground.sprite;

   291

	if (HASBIT(image, PALETTE_MODIFIER_COLOR) && dits->ground.pal == PAL_NONE) {

   292

		pal = GENERAL_SPRITE_COLOR(ind->random_color);

   293

	} else {

   294

		pal = dits->ground.pal;

   295

	}

   296

   297

	/* DrawFoundation() modifes ti->z and ti->tileh */

   298

	if (ti->tileh != SLOPE_FLAT) DrawFoundation(ti, FOUNDATION_LEVELED);

   299

   300

	DrawGroundSprite(image, pal);

   301

   302

	/* Add industry on top of the ground? */

   303

	image = dits->building.sprite;

   304

	if (image != 0) {

   305

		AddSortableSpriteToDraw(image,

   306

			(HASBIT(image, PALETTE_MODIFIER_COLOR) && dits->building.pal == PAL_NONE) ? GENERAL_SPRITE_COLOR(ind->random_color) : dits->building.pal,

   307

			ti->x + dits->subtile_x,

   308

			ti->y + dits->subtile_y,

   309

			dits->width,

   310

			dits->height,

   311

			dits->dz,

   312

			ti->z,

   313

			HASBIT(_transparent_opt, TO_INDUSTRIES));

   314

   315

		if (HASBIT(_transparent_opt, TO_INDUSTRIES)) return;

   316

	}

   317

   318

	{

   319

		int proc = dits->draw_proc - 1;

   320

		if (proc >= 0) _industry_draw_tile_procs[proc](ti);

   321

	}

   322

}

   323

   324

static uint GetSlopeZ_Industry(TileIndex tile, uint x, uint y)

   325

{

   326

	return GetTileMaxZ(tile);

   327

}

   328

   329

static Foundation GetFoundation_Industry(TileIndex tile, Slope tileh)

   330

{

   331

	return FlatteningFoundation(tileh);

   332

}

   333

   334

static void GetAcceptedCargo_Industry(TileIndex tile, AcceptedCargo ac)

   335

{

   336

	IndustryGfx gfx = GetIndustryGfx(tile);

   337

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   338

   339

	/* When we have to use a callback, we put our data in the next two variables */

   340

	CargoID raw_accepts_cargo[lengthof(itspec->accepts_cargo)];

   341

	uint8 raw_acceptance[lengthof(itspec->acceptance)];

   342

   343

	/* And then these will always point to a same sized array with the required data */

   344

	const CargoID *accepts_cargo = itspec->accepts_cargo;

   345

	const uint8 *acceptance = itspec->acceptance;

   346

   347

	if (HASBIT(itspec->callback_flags, CBM_INDT_ACCEPT_CARGO)) {

   348

		uint16 res = GetIndustryTileCallback(CBID_INDTILE_ACCEPT_CARGO, 0, 0, gfx, GetIndustryByTile(tile), tile);

   349

		if (res != CALLBACK_FAILED) {

   350

			accepts_cargo = raw_accepts_cargo;

   351

			for (uint i = 0; i < lengthof(itspec->accepts_cargo); i++) raw_accepts_cargo[i] = GetCargoTranslation(GB(res, i * 5, 5), itspec->grf_prop.grffile);

   352

		}

   353

	}

   354

   355

	if (HASBIT(itspec->callback_flags, CBM_INDT_CARGO_ACCEPTANCE)) {

   356

		uint16 res = GetIndustryTileCallback(CBID_INDTILE_CARGO_ACCEPTANCE, 0, 0, gfx, GetIndustryByTile(tile), tile);

   357

		if (res != CALLBACK_FAILED) {

   358

			acceptance = raw_acceptance;

   359

			for (uint i = 0; i < lengthof(itspec->accepts_cargo); i++) raw_acceptance[i] = GB(res, i * 4, 4);

   360

		}

   361

	}

   362

   363

	for (byte i = 0; i < lengthof(itspec->accepts_cargo); i++) {

   364

		CargoID a = accepts_cargo[i];

   365

		/* Only set the value once. */

   366

		if (a != CT_INVALID && ac[a] == 0) ac[a] = acceptance[i];

   367

	}

   368

}

   369

   370

static void GetTileDesc_Industry(TileIndex tile, TileDesc *td)

   371

{

   372

	const Industry *i = GetIndustryByTile(tile);

   373

   374

	td->owner = i->owner;

   375

	td->str = GetIndustrySpec(i->type)->name;

   376

	if (!IsIndustryCompleted(tile)) {

   377

		SetDParamX(td->dparam, 0, td->str);

   378

		td->str = STR_2058_UNDER_CONSTRUCTION;

   379

	}

   380

}

   381

   382

static CommandCost ClearTile_Industry(TileIndex tile, byte flags)

   383

{

   384

	Industry *i = GetIndustryByTile(tile);

   385

	const IndustrySpec *indspec = GetIndustrySpec(i->type);

   386

   387

	/* water can destroy industries

   388

	 * in editor you can bulldoze industries

   389

	 * with magic_bulldozer cheat you can destroy industries

   390

	 * (area around OILRIG is water, so water shouldn't flood it

   391

	 */

   392

	if ((_current_player != OWNER_WATER && _game_mode != GM_EDITOR &&

   393

			!_cheats.magic_bulldozer.value) ||

   394

			((flags & DC_AUTO) != 0) ||

   395

			(_current_player == OWNER_WATER && (indspec->behaviour & INDUSTRYBEH_BUILT_ONWATER))) {

   396

		SetDParam(0, indspec->name);

   397

		return_cmd_error(STR_4800_IN_THE_WAY);

   398

	}

   399

   400

	if (flags & DC_EXEC) delete i;

   401

	return CommandCost();

   402

}

   403

   404

static void TransportIndustryGoods(TileIndex tile)

   405

{

   406

	Industry *i = GetIndustryByTile(tile);

   407

	const IndustrySpec *indspec = GetIndustrySpec(i->type);

   408

	uint cw, am;

   409

   410

	cw = min(i->produced_cargo_waiting[0], 255);

   411

	if (cw > indspec->minimal_cargo/* && i->produced_cargo[0] != 0xFF*/) {

   412

		i->produced_cargo_waiting[0] -= cw;

   413

   414

		/* fluctuating economy? */

   415

		if (_economy.fluct <= 0) cw = (cw + 1) / 2;

   416

   417

		i->this_month_production[0] += cw;

   418

   419

		am = MoveGoodsToStation(i->xy, i->width, i->height, i->produced_cargo[0], cw);

   420

		i->this_month_transported[0] += am;

   421

		if (am != 0 && !StartStopIndustryTileAnimation(i, IAT_INDUSTRY_DISTRIBUTES_CARGO)) {

   422

			uint newgfx = GetIndustryTileSpec(GetIndustryGfx(tile))->anim_production;

   423

   424

			if (newgfx != INDUSTRYTILE_NOANIM) {

   425

				ResetIndustryConstructionStage(tile);

   426

				SetIndustryCompleted(tile, true);

   427

				SetIndustryGfx(tile, newgfx);

   428

				MarkTileDirtyByTile(tile);

   429

			}

   430

		}

   431

	}

   432

   433

	cw = min(i->produced_cargo_waiting[1], 255);

   434

	if (cw > indspec->minimal_cargo) {

   435

		i->produced_cargo_waiting[1] -= cw;

   436

   437

		if (_economy.fluct <= 0) cw = (cw + 1) / 2;

   438

   439

		i->this_month_production[1] += cw;

   440

   441

		am = MoveGoodsToStation(i->xy, i->width, i->height, i->produced_cargo[1], cw);

   442

		i->this_month_transported[1] += am;

   443

	}

   444

}

   445

   446

   447

static void AnimateTile_Industry(TileIndex tile)

   448

{

   449

	byte m;

   450

	IndustryGfx gfx = GetIndustryGfx(tile);

   451

   452

	if (GetIndustryTileSpec(gfx)->animation_info != 0xFFFF) {

   453

		AnimateNewIndustryTile(tile);

   454

		return;

   455

	}

   456

   457

	switch (gfx) {

   458

	case GFX_SUGAR_MINE_SIEVE:

   459

		if ((_tick_counter & 1) == 0) {

   460

			m = GetIndustryAnimationState(tile) + 1;

   461

   462

			switch (m & 7) {

   463

			case 2: SndPlayTileFx(SND_2D_RIP_2, tile); break;

   464

			case 6: SndPlayTileFx(SND_29_RIP, tile); break;

   465

			}

   466

   467

			if (m >= 96) {

   468

				m = 0;

   469

				DeleteAnimatedTile(tile);

   470

			}

   471

			SetIndustryAnimationState(tile, m);

   472

   473

			MarkTileDirtyByTile(tile);

   474

		}

   475

		break;

   476

   477

	case GFX_TOFFEE_QUARY:

   478

		if ((_tick_counter & 3) == 0) {

   479

			m = GetIndustryAnimationState(tile);

   480

   481

			if (_industry_anim_offs_toffee[m] == 0xFF) {

   482

				SndPlayTileFx(SND_30_CARTOON_SOUND, tile);

   483

			}

   484

   485

			if (++m >= 70) {

   486

				m = 0;

   487

				DeleteAnimatedTile(tile);