1

/* $Id$ */

     2

     3

/** @file industry_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "clear_map.h"

     8

#include "industry_map.h"

     9

#include "station_map.h"

    10

#include "train.h"

    11

#include "landscape.h"

    12

#include "viewport_func.h"

    13

#include "command_func.h"

    14

#include "industry.h"

    15

#include "town.h"

    16

#include "news_func.h"

    17

#include "saveload.h"

    18

#include "variables.h"

    20

#include "genworld.h"

    21

#include "water_map.h"

    22

#include "tree_map.h"

    23

#include "cargotype.h"

    24

#include "newgrf.h"

    25

#include "newgrf_commons.h"

    26

#include "newgrf_industries.h"

    27

#include "newgrf_industrytiles.h"

    28

#include "newgrf_callbacks.h"

    29

#include "misc/autoptr.hpp"

    30

#include "autoslope.h"

    31

#include "transparency.h"

    32

#include "water.h"

    33

#include "strings_func.h"

    34

#include "tile_cmd.h"

    35

#include "functions.h"

    36

#include "window_func.h"

    37

#include "date_func.h"

    38

#include "vehicle_func.h"

    39

#include "sound_func.h"

    40

#include "station_base.h"

    41

#include "oldpool_func.h"

    42

    43

#include "table/strings.h"

    44

#include "table/sprites.h"

    45

#include "table/industry_land.h"

    46

#include "table/build_industry.h"

    47

    48

void ShowIndustryViewWindow(int industry);

    49

void BuildOilRig(TileIndex tile);

    50

    51

static byte _industry_sound_ctr;

    52

static TileIndex _industry_sound_tile;

    53

    54

int _total_industries;                      //general counter

    55

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

    56

    57

const Industry **_industry_sort;

    58

bool _industry_sort_dirty;

    59

    60

IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

    61

IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

    62

    63

/** This function initialize the spec arrays of both

    64

 * industry and industry tiles.

    65

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

    66

 * This will allow for clearer testings */

    67

void ResetIndustries()

    68

{

    69

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

    70

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

    71

    72

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

    73

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

    74

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

    75

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

    76

	}

    77

    78

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

    79

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

    80

    81

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

    82

	_industile_mngr.ResetOverride();

    83

	_industry_mngr.ResetOverride();

    84

}

    85

    86

void ResetIndustryCreationProbility(IndustryType type)

    87

{

    88

	assert(type < INVALID_INDUSTRYTYPE);

    89

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

    90

}

    91

    92

DEFINE_OLD_POOL_GENERIC(Industry, Industry)

    93

    94

/**

    95

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

    96

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

    97

 * as would do GetIndustryGfx.

    98

 * @param tile that is queried

    99

 * @pre IsTileType(tile, MP_INDUSTRY)

   100

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

   101

 **/

   102

IndustryType GetIndustryType(TileIndex tile)

   103

{

   104

	assert(IsTileType(tile, MP_INDUSTRY));

   105

   106

	const Industry *ind = GetIndustryByTile(tile);

   107

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

   108

}

   109

   110

/**

   111

 * Accessor for array _industry_specs.

   112

 * This will ensure at once : proper access and

   113

 * not allowing modifications of it.

   114

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

   115

 * @pre thistype < NUM_INDUSTRYTYPES

   116

 * @return a pointer to the corresponding industry spec

   117

 **/

   118

const IndustrySpec *GetIndustrySpec(IndustryType thistype)

   119

{

   120

	assert(thistype < NUM_INDUSTRYTYPES);

   121

	return &_industry_specs[thistype];

   122

}

   123

   124

/**

   125

 * Accessor for array _industry_tile_specs.

   126

 * This will ensure at once : proper access and

   127

 * not allowing modifications of it.

   128

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

   129

 * @pre gfx < INVALID_INDUSTRYTILE

   130

 * @return a pointer to the corresponding industrytile spec

   131

 **/

   132

const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx)

   133

{

   134

	assert(gfx < INVALID_INDUSTRYTILE);

   135

	return &_industry_tile_specs[gfx];

   136

}

   137

   138

Industry::~Industry()

   139

{

   140

	if (CleaningPool()) return;

   141

   142

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

   143

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

   144

	if (this->width == 0) {

   145

		this->xy = 0;

   146

		return;

   147

	}

   148

   149

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

   150

		if (IsTileType(tile_cur, MP_INDUSTRY)) {

   151

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

   152

				DoClearSquare(tile_cur);

   153

			}

   154

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

   155

			DeleteOilRig(tile_cur);

   156

		}

   157

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

   158

   159

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

   160

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

   161

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

   162

			tile_cur = TILE_MASK(tile_cur);

   163

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

   164

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

   165

				SetIndustryIndexOfField(tile_cur, INVALID_INDUSTRY);

   166

			}

   167

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

   168

	}

   169

   170

	_industry_sort_dirty = true;

   171

	DecIndustryTypeCount(this->type);

   172

   173

	DeleteSubsidyWithIndustry(this->index);

   174

	DeleteWindowById(WC_INDUSTRY_VIEW, this->index);

   175

	InvalidateWindow(WC_INDUSTRY_DIRECTORY, 0);

   176

	this->xy = 0;

   177

}

   178

   179

static void IndustryDrawSugarMine(const TileInfo *ti)

   180

{

   181

	const DrawIndustryAnimationStruct *d;

   182

   183

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

   184

   185

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

   186

   187

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

   188

   189

	if (d->image_2 != 0) {

   190

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

   191

	}

   192

   193

	if (d->image_3 != 0) {

   194

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

   195

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

   196

	}

   197

}

   198

   199

static void IndustryDrawToffeeQuarry(const TileInfo *ti)

   200

{

   201

	uint8 x = 0;

   202

   203

	if (IsIndustryCompleted(ti->tile)) {

   204

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

   205

		if (x == 0xFF)

   206

			x = 0;

   207

	}

   208

   209

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

   210

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_TOFFEE, PAL_NONE, 6, 14);

   211

}

   212

   213

static void IndustryDrawBubbleGenerator( const TileInfo *ti)

   214

{

   215

	if (IsIndustryCompleted(ti->tile)) {

   216

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

   217

	} else {

   218

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_SPRING, PAL_NONE, 3, 67);

   219

	}

   220

}

   221

   222

static void IndustryDrawToyFactory(const TileInfo *ti)

   223

{

   224

	const DrawIndustryAnimationStruct *d;

   225

   226

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

   227

   228

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

   229

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

   230

	}

   231

   232

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

   233

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

   234

	}

   235

   236

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

   237

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP_HOLDER, PAL_NONE, 0, 42);

   238

}

   239

   240

static void IndustryDrawCoalPlantSparks(const TileInfo *ti)

   241

{

   242

	if (IsIndustryCompleted(ti->tile)) {

   243

		uint8 image = GetIndustryAnimationState(ti->tile);

   244

   245

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

   246

			AddChildSpriteScreen(image + SPR_IT_POWER_PLANT_TRANSFORMERS,

   247

				PAL_NONE,

   248

				_coal_plant_sparks[image - 1].x,

   249

				_coal_plant_sparks[image - 1].y

   250

			);

   251

		}

   252

	}

   253

}

   254

   255

typedef void IndustryDrawTileProc(const TileInfo *ti);

   256

static IndustryDrawTileProc * const _industry_draw_tile_procs[5] = {

   257

	IndustryDrawSugarMine,

   258

	IndustryDrawToffeeQuarry,

   259

	IndustryDrawBubbleGenerator,

   260

	IndustryDrawToyFactory,

   261

	IndustryDrawCoalPlantSparks,

   262

};

   263

   264

static void DrawTile_Industry(TileInfo *ti)

   265

{

   266

	IndustryGfx gfx = GetIndustryGfx(ti->tile);

   267

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

   268

	const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   269

	const DrawBuildingsTileStruct *dits;

   270

	SpriteID image;

   271

	SpriteID pal;

   272

   273

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

   274

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   275

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

   276

		 * DrawNewIndustry will return false if ever the resolver could not

   277

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

   278

		 * substitute gfx instead. */

   279

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

   280

			return;

   281

		} else {

   282

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

   283

			 * Use the substitute one instead */

   284

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

   285

				gfx = indts->grf_prop.subst_id;

   286

				/* And point the industrytile spec accordingly */

   287

				indts = GetIndustryTileSpec(gfx);

   288

			}

   289

		}

   290

	}

   291

   292

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

   293

			GetIndustryAnimationState(ti->tile) & INDUSTRY_COMPLETED :

   294

			GetIndustryConstructionStage(ti->tile))];

   295

   296

	image = dits->ground.sprite;

   297

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

   298

		pal = GENERAL_SPRITE_COLOR(ind->random_color);

   299

	} else {

   300

		pal = dits->ground.pal;

   301

	}

   302

   303

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

   304

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

   305

   306

	DrawGroundSprite(image, pal);

   307

   308

	/* If industries are transparent and invisible, do not draw the upper part */

   309

	if (IsInvisibilitySet(TO_INDUSTRIES)) return;

   310

   311

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

   312

	image = dits->building.sprite;

   313

	if (image != 0) {

   314

		AddSortableSpriteToDraw(image,

   315

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

   316

			ti->x + dits->subtile_x,

   317

			ti->y + dits->subtile_y,

   318

			dits->width,

   319

			dits->height,

   320

			dits->dz,

   321

			ti->z,

   322

			IsTransparencySet(TO_INDUSTRIES));

   323

   324

		if (IsTransparencySet(TO_INDUSTRIES)) return;

   325

	}

   326

   327

	{

   328

		int proc = dits->draw_proc - 1;

   329

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

   330

	}

   331

}

   332

   333

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

   334

{

   335

	return GetTileMaxZ(tile);

   336

}

   337

   338

static Foundation GetFoundation_Industry(TileIndex tile, Slope tileh)

   339

{

   340

	return FlatteningFoundation(tileh);

   341

}

   342

   343

static void GetAcceptedCargo_Industry(TileIndex tile, AcceptedCargo ac)

   344

{

   345

	IndustryGfx gfx = GetIndustryGfx(tile);

   346

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   347

   348

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

   349

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

   350

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

   351

   352

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

   353

	const CargoID *accepts_cargo = itspec->accepts_cargo;

   354

	const uint8 *acceptance = itspec->acceptance;

   355

   356

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

   357

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

   358

		if (res != CALLBACK_FAILED) {

   359

			accepts_cargo = raw_accepts_cargo;

   360

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

   361

		}

   362

	}

   363

   364

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

   365

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

   366

		if (res != CALLBACK_FAILED) {

   367

			acceptance = raw_acceptance;

   368

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

   369

		}

   370

	}

   371

   372

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

   373

		CargoID a = accepts_cargo[i];

   374

		/* Only set the value once. */

   375

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

   376

	}

   377

}

   378

   379

static void GetTileDesc_Industry(TileIndex tile, TileDesc *td)

   380

{

   381

	const Industry *i = GetIndustryByTile(tile);

   382

   383

	td->owner = i->owner;

   384

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

   385

	if (!IsIndustryCompleted(tile)) {

   386

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

   387

		td->str = STR_2058_UNDER_CONSTRUCTION;

   388

	}

   389

}

   390

   391

static CommandCost ClearTile_Industry(TileIndex tile, byte flags)

   392

{

   393

	Industry *i = GetIndustryByTile(tile);

   394

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

   395

   396

	/* water can destroy industries

   397

	 * in editor you can bulldoze industries

   398

	 * with magic_bulldozer cheat you can destroy industries

   399

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

   400

	 */

   401

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

   402

			!_cheats.magic_bulldozer.value) ||

   403

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

   404

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

   405

		SetDParam(0, indspec->name);

   406

		return_cmd_error(STR_4800_IN_THE_WAY);

   407

	}

   408

   409

	if (flags & DC_EXEC) delete i;

   410

	return CommandCost(EXPENSES_CONSTRUCTION, indspec->GetRemovalCost());

   411

}

   412

   413

static void TransportIndustryGoods(TileIndex tile)

   414

{

   415

	Industry *i = GetIndustryByTile(tile);

   416

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

   417

	bool moved_cargo = false;

   418

   419

	for (uint j = 0; j < lengthof(i->produced_cargo_waiting); j++) {

   420

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

   421

		if (cw > indspec->minimal_cargo && i->produced_cargo[j] != CT_INVALID) {

   422

			i->produced_cargo_waiting[j] -= cw;

   423

   424

			/* fluctuating economy? */

   425

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

   426

   427

			i->this_month_production[j] += cw;

   428

   429

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

   430

			i->this_month_transported[j] += am;

   431

   432

			moved_cargo |= (am != 0);

   433

		}

   434

	}

   435

   436

	if (moved_cargo && !StartStopIndustryTileAnimation(i, IAT_INDUSTRY_DISTRIBUTES_CARGO)) {

   437

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

   438

   439

		if (newgfx != INDUSTRYTILE_NOANIM) {

   440

			ResetIndustryConstructionStage(tile);

   441

			SetIndustryCompleted(tile, true);

   442

			SetIndustryGfx(tile, newgfx);

   443

			MarkTileDirtyByTile(tile);

   444

		}

   445

	}

   446

}

   447

   448

   449

static void AnimateTile_Industry(TileIndex tile)

   450

{

   451

	byte m;

   452

	IndustryGfx gfx = GetIndustryGfx(tile);

   453

   454

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

   455

		AnimateNewIndustryTile(tile);

   456

		return;

   457

	}

   458

   459

	switch (gfx) {

   460

	case GFX_SUGAR_MINE_SIEVE:

   461

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

   462

			m = GetIndustryAnimationState(tile) + 1;

   463

   464

			switch (m & 7) {

   465

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

   466

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

   467

			}

   468

   469

			if (m >= 96) {

   470

				m = 0;

   471

				DeleteAnimatedTile(tile);

   472

			}

   473

			SetIndustryAnimationState(tile, m);

   474

   475

			MarkTileDirtyByTile(tile);

   476

		}

   477

		break;

   478

   479

	case GFX_TOFFEE_QUARY:

   480

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

   481

			m = GetIndustryAnimationState(tile);

   482

   483

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

   484

				SndPlayTileFx(SND_30_CARTOON_SOUND, tile);

   485

			}

   486