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"

    19

#include "cheat_func.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"

    44

    45

#include "table/strings.h"

    46

#include "table/sprites.h"

    47

#include "table/industry_land.h"

    48

#include "table/build_industry.h"

    49

    50

void ShowIndustryViewWindow(int industry);

    51

void BuildOilRig(TileIndex tile);

    52

    53

static byte _industry_sound_ctr;

    54

static TileIndex _industry_sound_tile;

    55

    56

int _total_industries;                      //general counter

    57

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

    58

    59

const Industry **_industry_sort;

    60

bool _industry_sort_dirty;

    61

    62

IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

    63

IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

    64

    65

/** This function initialize the spec arrays of both

    66

 * industry and industry tiles.

    67

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

    68

 * This will allow for clearer testings */

    69

void ResetIndustries()

    70

{

    71

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

    72

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

    73

    74

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

    75

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

    76

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

    77

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

    78

	}

    79

    80

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

    81

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

    82

    83

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

    84

	_industile_mngr.ResetOverride();

    85

	_industry_mngr.ResetOverride();

    86

}

    87

    88

void ResetIndustryCreationProbility(IndustryType type)

    89

{

    90

	assert(type < INVALID_INDUSTRYTYPE);

    91

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

    92

}

    93

    94

DEFINE_OLD_POOL_GENERIC(Industry, Industry)

    95

    96

/**

    97

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

    98

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

    99

 * as would do GetIndustryGfx.

   100

 * @param tile that is queried

   101

 * @pre IsTileType(tile, MP_INDUSTRY)

   102

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

   103

 **/

   104

IndustryType GetIndustryType(TileIndex tile)

   105

{

   106

	assert(IsTileType(tile, MP_INDUSTRY));

   107

   108

	const Industry *ind = GetIndustryByTile(tile);

   109

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

   110

}

   111

   112

/**

   113

 * Accessor for array _industry_specs.

   114

 * This will ensure at once : proper access and

   115

 * not allowing modifications of it.

   116

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

   117

 * @pre thistype < NUM_INDUSTRYTYPES

   118

 * @return a pointer to the corresponding industry spec

   119

 **/

   120

const IndustrySpec *GetIndustrySpec(IndustryType thistype)

   121

{

   122

	assert(thistype < NUM_INDUSTRYTYPES);

   123

	return &_industry_specs[thistype];

   124

}

   125

   126

/**

   127

 * Accessor for array _industry_tile_specs.

   128

 * This will ensure at once : proper access and

   129

 * not allowing modifications of it.

   130

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

   131

 * @pre gfx < INVALID_INDUSTRYTILE

   132

 * @return a pointer to the corresponding industrytile spec

   133

 **/

   134

const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx)

   135

{

   136

	assert(gfx < INVALID_INDUSTRYTILE);

   137

	return &_industry_tile_specs[gfx];

   138

}

   139

   140

Industry::~Industry()

   141

{

   142

	if (CleaningPool()) return;

   143

   144

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

   145

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

   146

	if (this->width == 0) {

   147

		this->xy = 0;

   148

		return;

   149

	}

   150

   151

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

   152

		if (IsTileType(tile_cur, MP_INDUSTRY)) {

   153

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

   154

				DoClearSquare(tile_cur);

   155

			}

   156

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

   157

			DeleteOilRig(tile_cur);

   158

		}

   159

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

   160

   161

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

   162

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

   163

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

   164

			tile_cur = TILE_MASK(tile_cur);

   165

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

   166

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

   167

				SetIndustryIndexOfField(tile_cur, INVALID_INDUSTRY);

   168

			}

   169

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

   170

	}

   171

   172

	_industry_sort_dirty = true;

   173

	DecIndustryTypeCount(this->type);

   174

   175

	DeleteSubsidyWithIndustry(this->index);

   176

	DeleteWindowById(WC_INDUSTRY_VIEW, this->index);

   177

	InvalidateWindow(WC_INDUSTRY_DIRECTORY, 0);

   178

	this->xy = 0;

   179

}

   180

   181

static void IndustryDrawSugarMine(const TileInfo *ti)

   182

{

   183

	const DrawIndustryAnimationStruct *d;

   184

   185

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

   186

   187

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

   188

   189

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

   190

   191

	if (d->image_2 != 0) {

   192

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

   193

	}

   194

   195

	if (d->image_3 != 0) {

   196

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

   197

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

   198

	}

   199

}

   200

   201

static void IndustryDrawToffeeQuarry(const TileInfo *ti)

   202

{

   203

	uint8 x = 0;

   204

   205

	if (IsIndustryCompleted(ti->tile)) {

   206

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

   207

		if (x == 0xFF)

   208

			x = 0;

   209

	}

   210

   211

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

   212

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_TOFFEE, PAL_NONE, 6, 14);

   213

}

   214

   215

static void IndustryDrawBubbleGenerator( const TileInfo *ti)

   216

{

   217

	if (IsIndustryCompleted(ti->tile)) {

   218

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

   219

	} else {

   220

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_SPRING, PAL_NONE, 3, 67);

   221

	}

   222

}

   223

   224

static void IndustryDrawToyFactory(const TileInfo *ti)

   225

{

   226

	const DrawIndustryAnimationStruct *d;

   227

   228

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

   229

   230

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

   231

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

   232

	}

   233

   234

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

   235

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

   236

	}

   237

   238

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

   239

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP_HOLDER, PAL_NONE, 0, 42);

   240

}

   241

   242

static void IndustryDrawCoalPlantSparks(const TileInfo *ti)

   243

{

   244

	if (IsIndustryCompleted(ti->tile)) {

   245

		uint8 image = GetIndustryAnimationState(ti->tile);

   246

   247

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

   248

			AddChildSpriteScreen(image + SPR_IT_POWER_PLANT_TRANSFORMERS,

   249

				PAL_NONE,

   250

				_coal_plant_sparks[image - 1].x,

   251

				_coal_plant_sparks[image - 1].y

   252

			);

   253

		}

   254

	}

   255

}

   256

   257

typedef void IndustryDrawTileProc(const TileInfo *ti);

   258

static IndustryDrawTileProc * const _industry_draw_tile_procs[5] = {

   259

	IndustryDrawSugarMine,

   260

	IndustryDrawToffeeQuarry,

   261

	IndustryDrawBubbleGenerator,

   262

	IndustryDrawToyFactory,

   263

	IndustryDrawCoalPlantSparks,

   264

};

   265

   266

static void DrawTile_Industry(TileInfo *ti)

   267

{

   268

	IndustryGfx gfx = GetIndustryGfx(ti->tile);

   269

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

   270

	const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   271

	const DrawBuildingsTileStruct *dits;

   272

	SpriteID image;

   273

	SpriteID pal;

   274

   275

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

   276

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   277

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

   278

		 * DrawNewIndustry will return false if ever the resolver could not

   279

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

   280

		 * substitute gfx instead. */

   281

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

   282

			return;

   283

		} else {

   284

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

   285

			 * Use the substitute one instead */

   286

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

   287

				gfx = indts->grf_prop.subst_id;

   288

				/* And point the industrytile spec accordingly */

   289

				indts = GetIndustryTileSpec(gfx);

   290

			}

   291

		}

   292

	}

   293

   294

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

   295

			GetIndustryAnimationState(ti->tile) & INDUSTRY_COMPLETED :

   296

			GetIndustryConstructionStage(ti->tile))];

   297

   298

	image = dits->ground.sprite;

   299

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

   300

		pal = GENERAL_SPRITE_COLOR(ind->random_color);

   301

	} else {

   302

		pal = dits->ground.pal;

   303

	}

   304

   305

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

   306

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

   307

   308

	DrawGroundSprite(image, pal);

   309

   310

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

   311

	if (IsInvisibilitySet(TO_INDUSTRIES)) return;

   312

   313

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

   314

	image = dits->building.sprite;

   315

	if (image != 0) {

   316

		AddSortableSpriteToDraw(image,

   317

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

   318

			ti->x + dits->subtile_x,

   319

			ti->y + dits->subtile_y,

   320

			dits->width,

   321

			dits->height,

   322

			dits->dz,

   323

			ti->z,

   324

			IsTransparencySet(TO_INDUSTRIES));

   325

   326

		if (IsTransparencySet(TO_INDUSTRIES)) return;

   327

	}

   328

   329

	{

   330

		int proc = dits->draw_proc - 1;

   331

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

   332

	}

   333

}

   334

   335

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

   336

{

   337

	return GetTileMaxZ(tile);

   338

}

   339

   340

static Foundation GetFoundation_Industry(TileIndex tile, Slope tileh)

   341

{

   342

	return FlatteningFoundation(tileh);

   343

}

   344

   345

static void GetAcceptedCargo_Industry(TileIndex tile, AcceptedCargo ac)

   346

{

   347

	IndustryGfx gfx = GetIndustryGfx(tile);

   348

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   349

   350

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

   351

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

   352

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

   353

   354

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

   355

	const CargoID *accepts_cargo = itspec->accepts_cargo;

   356

	const uint8 *acceptance = itspec->acceptance;

   357

   358

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

   359

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

   360

		if (res != CALLBACK_FAILED) {

   361

			accepts_cargo = raw_accepts_cargo;

   362

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

   363

		}

   364

	}

   365

   366

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

   367

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

   368

		if (res != CALLBACK_FAILED) {

   369

			acceptance = raw_acceptance;

   370

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

   371

		}

   372

	}

   373

   374

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

   375

		CargoID a = accepts_cargo[i];

   376

		/* Only set the value once. */

   377

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

   378

	}

   379

}

   380

   381

static void GetTileDesc_Industry(TileIndex tile, TileDesc *td)

   382

{

   383

	const Industry *i = GetIndustryByTile(tile);

   384

   385

	td->owner = i->owner;

   386

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

   387

	if (!IsIndustryCompleted(tile)) {

   388

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

   389

		td->str = STR_2058_UNDER_CONSTRUCTION;

   390

	}

   391

}

   392

   393

static CommandCost ClearTile_Industry(TileIndex tile, byte flags)

   394

{

   395

	Industry *i = GetIndustryByTile(tile);

   396

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

   397

   398

	/* water can destroy industries

   399

	 * in editor you can bulldoze industries

   400

	 * with magic_bulldozer cheat you can destroy industries

   401

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

   402

	 */

   403

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

   404

			!_cheats.magic_bulldozer.value) ||

   405

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

   406

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

   407

		SetDParam(0, indspec->name);

   408

		return_cmd_error(STR_4800_IN_THE_WAY);

   409

	}

   410

   411

	if (flags & DC_EXEC) delete i;

   412

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

   413

}

   414

   415

static void TransportIndustryGoods(TileIndex tile)

   416

{

   417

	Industry *i = GetIndustryByTile(tile);

   418

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

   419

	bool moved_cargo = false;

   420

   421

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

   422

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

   423

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

   424

			i->produced_cargo_waiting[j] -= cw;

   425

   426

			/* fluctuating economy? */

   427

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

   428

   429

			i->this_month_production[j] += cw;

   430

   431

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

   432

			i->this_month_transported[j] += am;

   433

   434

			moved_cargo |= (am != 0);

   435

		}

   436

	}

   437

   438

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

   439

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

   440

   441

		if (newgfx != INDUSTRYTILE_NOANIM) {

   442

			ResetIndustryConstructionStage(tile);

   443

			SetIndustryCompleted(tile, true);

   444

			SetIndustryGfx(tile, newgfx);

   445

			MarkTileDirtyByTile(tile);

   446

		}

   447

	}

   448

}

   449

   450

   451

static void AnimateTile_Industry(TileIndex tile)

   452

{

   453

	byte m;

   454

	IndustryGfx gfx = GetIndustryGfx(tile);

   455

   456

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

   457

		AnimateNewIndustryTile(tile);

   458

		return;

   459

	}

   460

   461

	switch (gfx) {

   462

	case GFX_SUGAR_MINE_SIEVE:

   463

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

   464

			m = GetIndustryAnimationState(tile) + 1;

   465

   466

			switch (m & 7) {

   467

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

   468

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

   469

			}

   470

   471

			if (m >= 96) {

   472

				m = 0;

   473

				DeleteAnimatedTile(tile);

   474

			}

   475

			SetIndustryAnimationState(tile, m);

   476

   477

			MarkTileDirtyByTile(tile);

   478

		}

   479

		break;

   480

   481

	case GFX_TOFFEE_QUARY:

   482

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

   483

			m = GetIndustryAnimationState(tile);

   484

   485

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

   486

				SndPlayTileFx(SND_30_CARTOON_SOUND, tile);