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 "table/strings.h"

    11

#include "table/sprites.h"

    12

#include "train.h"

    13

#include "landscape.h"

    14

#include "viewport.h"

    15

#include "command_func.h"

    16

#include "industry.h"

    17

#include "town.h"

    18

#include "news.h"

    19

#include "saveload.h"

    20

#include "variables.h"

    21

#include "table/industry_land.h"

    22

#include "table/build_industry.h"

    23

#include "genworld.h"

    24

#include "water_map.h"

    25

#include "tree_map.h"

    26

#include "cargotype.h"

    27

#include "newgrf.h"

    28

#include "newgrf_commons.h"

    29

#include "newgrf_industries.h"

    30

#include "newgrf_industrytiles.h"

    31

#include "newgrf_callbacks.h"

    32

#include "misc/autoptr.hpp"

    33

#include "autoslope.h"

    34

#include "transparency.h"

    35

#include "water.h"

    36

#include "strings_func.h"

    37

#include "tile_cmd.h"

    38

#include "functions.h"

    39

#include "window_func.h"

    40

#include "date_func.h"

    41

#include "vehicle_func.h"

    43

    44

void ShowIndustryViewWindow(int industry);

    45

void BuildOilRig(TileIndex tile);

    46

    47

static byte _industry_sound_ctr;

    48

static TileIndex _industry_sound_tile;

    49

    50

int _total_industries;                      //general counter

    51

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

    52

    53

const Industry **_industry_sort;

    54

bool _industry_sort_dirty;

    55

    56

IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

    57

IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

    58

    59

/** This function initialize the spec arrays of both

    60

 * industry and industry tiles.

    61

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

    62

 * This will allow for clearer testings */

    63

void ResetIndustries()

    64

{

    65

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

    66

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

    67

    68

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

    69

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

    70

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

    71

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

    72

	}

    73

    74

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

    75

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

    76

    77

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

    78

	_industile_mngr.ResetOverride();

    79

	_industry_mngr.ResetOverride();

    80

}

    81

    82

void ResetIndustryCreationProbility(IndustryType type)

    83

{

    84

	assert(type < INVALID_INDUSTRYTYPE);

    85

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

    86

}

    87

    88

DEFINE_OLD_POOL_GENERIC(Industry, Industry)

    89

    90

/**

    91

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

    92

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

    93

 * as would do GetIndustryGfx.

    94

 * @param tile that is queried

    95

 * @pre IsTileType(tile, MP_INDUSTRY)

    96

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

    97

 **/

    98

IndustryType GetIndustryType(TileIndex tile)

    99

{

   100

	assert(IsTileType(tile, MP_INDUSTRY));

   101

   102

	const Industry *ind = GetIndustryByTile(tile);

   103

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

   104

}

   105

   106

/**

   107

 * Accessor for array _industry_specs.

   108

 * This will ensure at once : proper access and

   109

 * not allowing modifications of it.

   110

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

   111

 * @pre thistype < NUM_INDUSTRYTYPES

   112

 * @return a pointer to the corresponding industry spec

   113

 **/

   114

const IndustrySpec *GetIndustrySpec(IndustryType thistype)

   115

{

   116

	assert(thistype < NUM_INDUSTRYTYPES);

   117

	return &_industry_specs[thistype];

   118

}

   119

   120

/**

   121

 * Accessor for array _industry_tile_specs.

   122

 * This will ensure at once : proper access and

   123

 * not allowing modifications of it.

   124

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

   125

 * @pre gfx < INVALID_INDUSTRYTILE

   126

 * @return a pointer to the corresponding industrytile spec

   127

 **/

   128

const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx)

   129

{

   130

	assert(gfx < INVALID_INDUSTRYTILE);

   131

	return &_industry_tile_specs[gfx];

   132

}

   133

   134

Industry::~Industry()

   135

{

   136

	if (CleaningPool()) return;

   137

   138

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

   139

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

   140

	if (this->width == 0) {

   141

		this->xy = 0;

   142

		return;

   143

	}

   144

   145

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

   146

		if (IsTileType(tile_cur, MP_INDUSTRY)) {

   147

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

   148

				DoClearSquare(tile_cur);

   149

			}

   150

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

   151

			DeleteOilRig(tile_cur);

   152

		}

   153

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

   154

   155

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

   156

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

   157

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

   158

			tile_cur = TILE_MASK(tile_cur);

   159

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

   160

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

   161

				SetIndustryIndexOfField(tile_cur, INVALID_INDUSTRY);

   162

			}

   163

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

   164

	}

   165

   166

	_industry_sort_dirty = true;

   167

	DecIndustryTypeCount(this->type);

   168

   169

	DeleteSubsidyWithIndustry(this->index);

   170

	DeleteWindowById(WC_INDUSTRY_VIEW, this->index);

   171

	InvalidateWindow(WC_INDUSTRY_DIRECTORY, 0);

   172

	this->xy = 0;

   173

}

   174

   175

static void IndustryDrawSugarMine(const TileInfo *ti)

   176

{

   177

	const DrawIndustryAnimationStruct *d;

   178

   179

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

   180

   181

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

   182

   183

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

   184

   185

	if (d->image_2 != 0) {

   186

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

   187

	}

   188

   189

	if (d->image_3 != 0) {

   190

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

   191

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

   192

	}

   193

}

   194

   195

static void IndustryDrawToffeeQuarry(const TileInfo *ti)

   196

{

   197

	uint8 x = 0;

   198

   199

	if (IsIndustryCompleted(ti->tile)) {

   200

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

   201

		if (x == 0xFF)

   202

			x = 0;

   203

	}

   204

   205

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

   206

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_TOFFEE, PAL_NONE, 6, 14);

   207

}

   208

   209

static void IndustryDrawBubbleGenerator( const TileInfo *ti)

   210

{

   211

	if (IsIndustryCompleted(ti->tile)) {

   212

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

   213

	} else {

   214

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_SPRING, PAL_NONE, 3, 67);

   215

	}

   216

}

   217

   218

static void IndustryDrawToyFactory(const TileInfo *ti)

   219

{

   220

	const DrawIndustryAnimationStruct *d;

   221

   222

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

   223

   224

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

   225

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

   226

	}

   227

   228

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

   229

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

   230

	}

   231

   232

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

   233

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP_HOLDER, PAL_NONE, 0, 42);

   234

}

   235

   236

static void IndustryDrawCoalPlantSparks(const TileInfo *ti)

   237

{

   238

	if (IsIndustryCompleted(ti->tile)) {

   239

		uint8 image = GetIndustryAnimationState(ti->tile);

   240

   241

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

   242

			AddChildSpriteScreen(image + SPR_IT_POWER_PLANT_TRANSFORMERS,

   243

				PAL_NONE,

   244

				_coal_plant_sparks[image - 1].x,

   245

				_coal_plant_sparks[image - 1].y

   246

			);

   247

		}

   248

	}

   249

}

   250

   251

typedef void IndustryDrawTileProc(const TileInfo *ti);

   252

static IndustryDrawTileProc * const _industry_draw_tile_procs[5] = {

   253

	IndustryDrawSugarMine,

   254

	IndustryDrawToffeeQuarry,

   255

	IndustryDrawBubbleGenerator,

   256

	IndustryDrawToyFactory,

   257

	IndustryDrawCoalPlantSparks,

   258

};

   259

   260

static void DrawTile_Industry(TileInfo *ti)

   261

{

   262

	IndustryGfx gfx = GetIndustryGfx(ti->tile);

   263

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

   264

	const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   265

	const DrawBuildingsTileStruct *dits;

   266

	SpriteID image;

   267

	SpriteID pal;

   268

   269

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

   270

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   271

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

   272

		 * DrawNewIndustry will return false if ever the resolver could not

   273

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

   274

		 * substitute gfx instead. */

   275

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

   276

			return;

   277

		} else {

   278

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

   279

			 * Use the substitute one instead */

   280

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

   281

				gfx = indts->grf_prop.subst_id;

   282

				/* And point the industrytile spec accordingly */

   283

				indts = GetIndustryTileSpec(gfx);

   284

			}

   285

		}

   286

	}

   287

   288

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

   289

			GetIndustryAnimationState(ti->tile) & INDUSTRY_COMPLETED :

   290

			GetIndustryConstructionStage(ti->tile))];

   291

   292

	image = dits->ground.sprite;

   293

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

   294

		pal = GENERAL_SPRITE_COLOR(ind->random_color);

   295

	} else {

   296

		pal = dits->ground.pal;

   297

	}

   298

   299

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

   300

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

   301

   302

	DrawGroundSprite(image, pal);

   303

   304

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

   305

	image = dits->building.sprite;

   306

	if (image != 0) {

   307

		AddSortableSpriteToDraw(image,

   308

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

   309

			ti->x + dits->subtile_x,

   310

			ti->y + dits->subtile_y,

   311

			dits->width,

   312

			dits->height,

   313

			dits->dz,

   314

			ti->z,

   315

			IsTransparencySet(TO_INDUSTRIES));

   316

   317

		if (IsTransparencySet(TO_INDUSTRIES)) return;

   318

	}

   319

   320

	{

   321

		int proc = dits->draw_proc - 1;

   322

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

   323

	}

   324

}

   325

   326

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

   327

{

   328

	return GetTileMaxZ(tile);

   329

}

   330

   331

static Foundation GetFoundation_Industry(TileIndex tile, Slope tileh)

   332

{

   333

	return FlatteningFoundation(tileh);

   334

}

   335

   336

static void GetAcceptedCargo_Industry(TileIndex tile, AcceptedCargo ac)

   337

{

   338

	IndustryGfx gfx = GetIndustryGfx(tile);

   339

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   340

   341

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

   342

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

   343

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

   344

   345

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

   346

	const CargoID *accepts_cargo = itspec->accepts_cargo;

   347

	const uint8 *acceptance = itspec->acceptance;

   348

   349

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

   350

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

   351

		if (res != CALLBACK_FAILED) {

   352

			accepts_cargo = raw_accepts_cargo;

   353

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

   354

		}

   355

	}

   356

   357

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

   358

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

   359

		if (res != CALLBACK_FAILED) {

   360

			acceptance = raw_acceptance;

   361

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

   362

		}

   363

	}

   364

   365

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

   366

		CargoID a = accepts_cargo[i];

   367

		/* Only set the value once. */

   368

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

   369

	}

   370

}

   371

   372

static void GetTileDesc_Industry(TileIndex tile, TileDesc *td)

   373

{

   374

	const Industry *i = GetIndustryByTile(tile);

   375

   376

	td->owner = i->owner;

   377

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

   378

	if (!IsIndustryCompleted(tile)) {

   379

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

   380

		td->str = STR_2058_UNDER_CONSTRUCTION;

   381

	}

   382

}

   383

   384

static CommandCost ClearTile_Industry(TileIndex tile, byte flags)

   385

{

   386

	Industry *i = GetIndustryByTile(tile);

   387

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

   388

   389

	/* water can destroy industries

   390

	 * in editor you can bulldoze industries

   391

	 * with magic_bulldozer cheat you can destroy industries

   392

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

   393

	 */

   394

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

   395

			!_cheats.magic_bulldozer.value) ||

   396

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

   397

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

   398

		SetDParam(0, indspec->name);

   399

		return_cmd_error(STR_4800_IN_THE_WAY);

   400

	}

   401

   402

	if (flags & DC_EXEC) delete i;

   403

	return CommandCost(indspec->GetRemovalCost());

   404

}

   405

   406

static void TransportIndustryGoods(TileIndex tile)

   407

{

   408

	Industry *i = GetIndustryByTile(tile);

   409

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

   410

	bool moved_cargo = false;

   411

   412

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

   413

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

   414

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

   415

			i->produced_cargo_waiting[j] -= cw;

   416

   417

			/* fluctuating economy? */

   418

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

   419

   420

			i->this_month_production[j] += cw;

   421

   422

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

   423

			i->this_month_transported[j] += am;

   424

   425

			moved_cargo |= (am != 0);

   426

		}

   427

	}

   428

   429

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

   430

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

   431

   432

		if (newgfx != INDUSTRYTILE_NOANIM) {

   433

			ResetIndustryConstructionStage(tile);

   434

			SetIndustryCompleted(tile, true);

   435

			SetIndustryGfx(tile, newgfx);

   436

			MarkTileDirtyByTile(tile);

   437

		}

   438

	}

   439

}

   440

   441

   442

static void AnimateTile_Industry(TileIndex tile)

   443

{

   444

	byte m;

   445

	IndustryGfx gfx = GetIndustryGfx(tile);

   446

   447

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

   448

		AnimateNewIndustryTile(tile);

   449

		return;

   450

	}

   451

   452

	switch (gfx) {

   453

	case GFX_SUGAR_MINE_SIEVE:

   454

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

   455

			m = GetIndustryAnimationState(tile) + 1;

   456

   457

			switch (m & 7) {

   458

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

   459

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

   460

			}

   461

   462

			if (m >= 96) {

   463

				m = 0;

   464

				DeleteAnimatedTile(tile);

   465

			}

   466

			SetIndustryAnimationState(tile, m);

   467

   468

			MarkTileDirtyByTile(tile);

   469

		}

   470

		break;

   471

   472

	case GFX_TOFFEE_QUARY:

   473

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

   474

			m = GetIndustryAnimationState(tile);

   475

   476

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

   477

				SndPlayTileFx(SND_30_CARTOON_SOUND, tile);

   478

			}

   479

   480

			if (++m >= 70) {

   481

				m = 0;

   482

				DeleteAnimatedTile(tile);

   483

			}

   484

			SetIndustryAnimationState(tile, m);

   485

   486

			MarkTileDirtyByTile(tile);

   487

		}