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_commons.h"

    35

#include "newgrf_industries.h"

    36

#include "newgrf_industrytiles.h"

    37

#include "newgrf_callbacks.h"

    38

#include "misc/autoptr.hpp"

    39

    40

void ShowIndustryViewWindow(int industry);

    41

void BuildOilRig(TileIndex tile);

    42

    43

static byte _industry_sound_ctr;

    44

static TileIndex _industry_sound_tile;

    45

    46

int _total_industries;                      //general counter

    47

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

    48

    49

const Industry **_industry_sort;

    50

bool _industry_sort_dirty;

    51

    52

IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

    53

IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

    54

    55

/** This function initialize the spec arrays of both

    56

 * industry and industry tiles.

    57

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

    58

 * This will allow for clearer testings */

    59

void ResetIndustries()

    60

{

    61

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

    62

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

    63

    64

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

    65

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

    66

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

    67

	}

    68

    69

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

    70

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

    71

}

    72

    73

void ResetIndustryCreationProbility(IndustryType type)

    74

{

    75

	assert(type < INVALID_INDUSTRYTYPE);

    76

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

    77

}

    78

    79

DEFINE_OLD_POOL_GENERIC(Industry, Industry)

    80

    81

/**

    82

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

    83

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

    84

 * as would do GetIndustryGfx.

    85

 * @param tile that is queried

    86

 * @pre IsTileType(tile, MP_INDUSTRY)

    87

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

    88

 **/

    89

IndustryType GetIndustryType(TileIndex tile)

    90

{

    91

	assert(IsTileType(tile, MP_INDUSTRY));

    92

    93

	const Industry *ind = GetIndustryByTile(tile);

    94

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

    95

}

    96

    97

/**

    98

 * Accessor for array _industry_specs.

    99

 * This will ensure at once : proper access and

   100

 * not allowing modifications of it.

   101

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

   102

 * @pre thistype < NUM_INDUSTRYTYPES

   103

 * @return a pointer to the corresponding industry spec

   104

 **/

   105

const IndustrySpec *GetIndustrySpec(IndustryType thistype)

   106

{

   107

	assert(thistype < NUM_INDUSTRYTYPES);

   108

	return &_industry_specs[thistype];

   109

}

   110

   111

/**

   112

 * Accessor for array _industry_tile_specs.

   113

 * This will ensure at once : proper access and

   114

 * not allowing modifications of it.

   115

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

   116

 * @pre gfx < INVALID_INDUSTRYTILE

   117

 * @return a pointer to the corresponding industrytile spec

   118

 **/

   119

const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx)

   120

{

   121

	assert(gfx < INVALID_INDUSTRYTILE);

   122

	return &_industry_tile_specs[gfx];

   123

}

   124

   125

Industry::~Industry()

   126

{

   127

	if (CleaningPool()) return;

   128

   129

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

   130

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

   131

	if (this->width == 0) {

   132

		this->xy = 0;

   133

		return;

   134

	}

   135

   136

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

   137

		if (IsTileType(tile_cur, MP_INDUSTRY)) {

   138

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

   139

				DoClearSquare(tile_cur);

   140

			}

   141

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

   142

			DeleteOilRig(tile_cur);

   143

		}

   144

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

   145

   146

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

   147

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

   148

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

   149

			tile_cur = TILE_MASK(tile_cur);

   150

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

   151

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

   152

				SetIndustryIndexOfField(tile_cur, INVALID_INDUSTRY);

   153

			}

   154

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

   155

	}

   156

   157

	_industry_sort_dirty = true;

   158

	DecIndustryTypeCount(this->type);

   159

   160

	DeleteSubsidyWithIndustry(this->index);

   161

	DeleteWindowById(WC_INDUSTRY_VIEW, this->index);

   162

	InvalidateWindow(WC_INDUSTRY_DIRECTORY, 0);

   163

	this->xy = 0;

   164

}

   165

   166

static void IndustryDrawSugarMine(const TileInfo *ti)

   167

{

   168

	const DrawIndustryAnimationStruct *d;

   169

   170

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

   171

   172

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

   173

   174

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

   175

   176

	if (d->image_2 != 0) {

   177

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

   178

	}

   179

   180

	if (d->image_3 != 0) {

   181

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

   182

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

   183

	}

   184

}

   185

   186

static void IndustryDrawToffeeQuarry(const TileInfo *ti)

   187

{

   188

	uint8 x = 0;

   189

   190

	if (IsIndustryCompleted(ti->tile)) {

   191

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

   192

		if (x == 0xFF)

   193

			x = 0;

   194

	}

   195

   196

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

   197

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_TOFFEE, PAL_NONE, 6, 14);

   198

}

   199

   200

static void IndustryDrawBubbleGenerator( const TileInfo *ti)

   201

{

   202

	if (IsIndustryCompleted(ti->tile)) {

   203

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

   204

	} else {

   205

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_SPRING, PAL_NONE, 3, 67);

   206

	}

   207

}

   208

   209

static void IndustryDrawToyFactory(const TileInfo *ti)

   210

{

   211

	const DrawIndustryAnimationStruct *d;

   212

   213

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

   214

   215

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

   216

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

   217

	}

   218

   219

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

   220

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

   221

	}

   222

   223

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

   224

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP_HOLDER, PAL_NONE, 0, 42);

   225

}

   226

   227

static void IndustryDrawCoalPlantSparks(const TileInfo *ti)

   228

{

   229

	if (IsIndustryCompleted(ti->tile)) {

   230

		uint8 image = GetIndustryAnimationState(ti->tile);

   231

   232

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

   233

			AddChildSpriteScreen(image + SPR_IT_POWER_PLANT_TRANSFORMERS,

   234

				PAL_NONE,

   235

				_coal_plant_sparks[image - 1].x,

   236

				_coal_plant_sparks[image - 1].y

   237

			);

   238

		}

   239

	}

   240

}

   241

   242

typedef void IndustryDrawTileProc(const TileInfo *ti);

   243

static IndustryDrawTileProc * const _industry_draw_tile_procs[5] = {

   244

	IndustryDrawSugarMine,

   245

	IndustryDrawToffeeQuarry,

   246

	IndustryDrawBubbleGenerator,

   247

	IndustryDrawToyFactory,

   248

	IndustryDrawCoalPlantSparks,

   249

};

   250

   251

static void DrawTile_Industry(TileInfo *ti)

   252

{

   253

	IndustryGfx gfx = GetIndustryGfx(ti->tile);

   254

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

   255

	const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   256

	const DrawBuildingsTileStruct *dits;

   257

	SpriteID image;

   258

	SpriteID pal;

   259

   260

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

   261

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   262

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

   263

		 * DrawNewIndustry will return false if ever the resolver could not

   264

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

   265

		 * substitute gfx instead. */

   266

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

   267

			return;

   268

		} else {

   269

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

   270

			 * Use the substitute one instead */

   271

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

   272

				gfx = indts->grf_prop.subst_id;

   273

				/* And point the industrytile spec accordingly */

   274

				indts = GetIndustryTileSpec(gfx);

   275

			}

   276

		}

   277

	}

   278

   279

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

   280

			GetIndustryAnimationState(ti->tile) & INDUSTRY_COMPLETED :

   281

			GetIndustryConstructionStage(ti->tile))];

   282

   283

	image = dits->ground.sprite;

   284

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

   285

		pal = GENERAL_SPRITE_COLOR(ind->random_color);

   286

	} else {

   287

		pal = dits->ground.pal;

   288

	}

   289

   290

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

   291

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

   292

   293

	DrawGroundSprite(image, pal);

   294

   295

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

   296

	image = dits->building.sprite;

   297

	if (image != 0) {

   298

		AddSortableSpriteToDraw(image,

   299

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

   300

			ti->x + dits->subtile_x,

   301

			ti->y + dits->subtile_y,

   302

			dits->width  + 1,

   303

			dits->height + 1,

   304

			dits->dz,

   305

			ti->z,

   306

			HASBIT(_transparent_opt, TO_INDUSTRIES));

   307

   308

		if (HASBIT(_transparent_opt, TO_INDUSTRIES)) return;

   309

	}

   310

   311

	{

   312

		int proc = dits->draw_proc - 1;

   313

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

   314

	}

   315

}

   316

   317

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

   318

{

   319

	return GetTileMaxZ(tile);

   320

}

   321

   322

static Foundation GetFoundation_Industry(TileIndex tile, Slope tileh)

   323

{

   324

	return FlatteningFoundation(tileh);

   325

}

   326

   327

static void GetAcceptedCargo_Industry(TileIndex tile, AcceptedCargo ac)

   328

{

   329

	IndustryGfx gfx = GetIndustryGfx(tile);

   330

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   331

   332

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

   333

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

   334

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

   335

   336

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

   337

	const CargoID *accepts_cargo = itspec->accepts_cargo;

   338

	const uint8 *acceptance = itspec->acceptance;

   339

   340

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

   341

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

   342

		if (res != CALLBACK_FAILED) {

   343

			accepts_cargo = raw_accepts_cargo;

   344

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

   345

		}

   346

	}

   347

   348

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

   349

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

   350

		if (res != CALLBACK_FAILED) {

   351

			acceptance = raw_acceptance;

   352

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

   353

		}

   354

	}

   355

   356

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

   357

		CargoID a = accepts_cargo[i];

   358

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

   359

	}

   360

}

   361

   362

static void GetTileDesc_Industry(TileIndex tile, TileDesc *td)

   363

{

   364

	const Industry *i = GetIndustryByTile(tile);

   365

   366

	td->owner = i->owner;

   367

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

   368

	if (!IsIndustryCompleted(tile)) {

   369

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

   370

		td->str = STR_2058_UNDER_CONSTRUCTION;

   371

	}

   372

}

   373

   374

static CommandCost ClearTile_Industry(TileIndex tile, byte flags)

   375

{

   376

	Industry *i = GetIndustryByTile(tile);

   377

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

   378

   379

	/* water can destroy industries

   380

	 * in editor you can bulldoze industries

   381

	 * with magic_bulldozer cheat you can destroy industries

   382

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

   383

	 */

   384

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

   385

			!_cheats.magic_bulldozer.value) ||

   386

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

   387

		SetDParam(0, indspec->name);

   388

		return_cmd_error(STR_4800_IN_THE_WAY);

   389

	}

   390

   391

	if (flags & DC_EXEC) delete i;

   392

	return CommandCost();

   393

}

   394

   395

static void TransportIndustryGoods(TileIndex tile)

   396

{

   397

	Industry *i = GetIndustryByTile(tile);

   398

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

   399

	uint cw, am;

   400

   401

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

   402

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

   403

		i->produced_cargo_waiting[0] -= cw;

   404

   405

		/* fluctuating economy? */

   406

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

   407

   408

		i->this_month_production[0] += cw;

   409

   410

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

   411

		i->this_month_transported[0] += am;

   412

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

   413

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

   414

   415

			if (newgfx != INDUSTRYTILE_NOANIM) {

   416

				ResetIndustryConstructionStage(tile);

   417

				SetIndustryCompleted(tile, true);

   418

				SetIndustryGfx(tile, newgfx);

   419

				MarkTileDirtyByTile(tile);

   420

			}

   421

		}

   422

	}

   423

   424

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

   425

	if (cw > indspec->minimal_cargo) {

   426

		i->produced_cargo_waiting[1] -= cw;

   427

   428

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

   429

   430

		i->this_month_production[1] += cw;

   431

   432

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

   433

		i->this_month_transported[1] += am;

   434

	}

   435

}

   436

   437

   438

static void AnimateTile_Industry(TileIndex tile)

   439

{

   440

	byte m;

   441

	IndustryGfx gfx = GetIndustryGfx(tile);

   442

   443

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

   444

		AnimateNewIndustryTile(tile);

   445

		return;

   446

	}

   447

   448

	switch (gfx) {

   449

	case GFX_SUGAR_MINE_SIEVE:

   450

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

   451

			m = GetIndustryAnimationState(tile) + 1;

   452

   453

			switch (m & 7) {

   454

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

   455

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

   456

			}

   457

   458

			if (m >= 96) {

   459

				m = 0;

   460

				DeleteAnimatedTile(tile);

   461

			}

   462

			SetIndustryAnimationState(tile, m);

   463

   464

			MarkTileDirtyByTile(tile);

   465

		}

   466

		break;

   467

   468

	case GFX_TOFFEE_QUARY:

   469

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

   470

			m = GetIndustryAnimationState(tile);

   471

   472

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

   473

				SndPlayTileFx(SND_30_CARTOON_SOUND, tile);

   474

			}

   475

   476

			if (++m >= 70) {

   477

				m = 0;

   478

				DeleteAnimatedTile(tile);

   479

			}

   480

			SetIndustryAnimationState(tile, m);

   481

   482

			MarkTileDirtyByTile(tile);

   483

		}

   484

		break;

   485

   486

	case GFX_BUBBLE_CATCHER:

   487

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

   488