1

/* $Id$ */

     2

     3

/** @file industry_cmd.cpp Handling of industry tiles. */

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

    30

#include "transparency.h"

    31

#include "water.h"

    32

#include "strings_func.h"

    33

#include "tile_cmd.h"

    34

#include "functions.h"

    35

#include "window_func.h"

    36

#include "date_func.h"

    37

#include "vehicle_func.h"

    38

#include "sound_func.h"

    39

#include "station_base.h"

    40

#include "oldpool_func.h"

    41

#include "animated_tile_func.h"

    42

#include "effectvehicle_func.h"

    43

    44

#include "table/strings.h"

    45

#include "table/sprites.h"

    46

#include "table/industry_land.h"

    47

#include "table/build_industry.h"

    48

    49

void ShowIndustryViewWindow(int industry);

    50

void BuildOilRig(TileIndex tile);

    51

    52

static byte _industry_sound_ctr;

    53

static TileIndex _industry_sound_tile;

    54

    55

int _total_industries;                      //general counter

    56

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

    57

    58

IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

    59

IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

    60

    61

/** This function initialize the spec arrays of both

    62

 * industry and industry tiles.

    63

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

    64

 * This will allow for clearer testings */

    65

void ResetIndustries()

    66

{

    67

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

    68

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

    69

    70

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

    71

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

    72

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

    73

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

    74

	}

    75

    76

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

    77

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

    78

    79

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

    80

	_industile_mngr.ResetOverride();

    81

	_industry_mngr.ResetOverride();

    82

}

    83

    84

void ResetIndustryCreationProbility(IndustryType type)

    85

{

    86

	assert(type < INVALID_INDUSTRYTYPE);

    87

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

    88

}

    89

    90

DEFINE_OLD_POOL_GENERIC(Industry, Industry)

    91

    92

/**

    93

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

    94

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

    95

 * as would do GetIndustryGfx.

    96

 * @param tile that is queried

    97

 * @pre IsTileType(tile, MP_INDUSTRY)

    98

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

    99

 **/

   100

IndustryType GetIndustryType(TileIndex tile)

   101

{

   102

	assert(IsTileType(tile, MP_INDUSTRY));

   103

   104

	const Industry *ind = GetIndustryByTile(tile);

   105

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

   106

}

   107

   108

/**

   109

 * Accessor for array _industry_specs.

   110

 * This will ensure at once : proper access and

   111

 * not allowing modifications of it.

   112

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

   113

 * @pre thistype < NUM_INDUSTRYTYPES

   114

 * @return a pointer to the corresponding industry spec

   115

 **/

   116

const IndustrySpec *GetIndustrySpec(IndustryType thistype)

   117

{

   118

	assert(thistype < NUM_INDUSTRYTYPES);

   119

	return &_industry_specs[thistype];

   120

}

   121

   122

/**

   123

 * Accessor for array _industry_tile_specs.

   124

 * This will ensure at once : proper access and

   125

 * not allowing modifications of it.

   126

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

   127

 * @pre gfx < INVALID_INDUSTRYTILE

   128

 * @return a pointer to the corresponding industrytile spec

   129

 **/

   130

const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx)

   131

{

   132

	assert(gfx < INVALID_INDUSTRYTILE);

   133

	return &_industry_tile_specs[gfx];

   134

}

   135

   136

Industry::~Industry()

   137

{

   138

	if (CleaningPool()) return;

   139

   140

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

   141

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

   142

	if (this->width == 0) {

   143

		this->xy = 0;

   144

		return;

   145

	}

   146

   147

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

   148

		if (IsTileType(tile_cur, MP_INDUSTRY)) {

   149

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

   150

				DoClearSquare(tile_cur);

   151

			}

   152

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

   153

			DeleteOilRig(tile_cur);

   154

		}

   155

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

   156

   157

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

   158

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

   159

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

   160

			tile_cur = TILE_MASK(tile_cur);

   161

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

   162

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

   163

				SetIndustryIndexOfField(tile_cur, INVALID_INDUSTRY);

   164

			}

   165

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

   166

	}

   167

   168

	DecIndustryTypeCount(this->type);

   169

   170

	DeleteSubsidyWithIndustry(this->index);

   171

	DeleteWindowById(WC_INDUSTRY_VIEW, this->index);

   172

	InvalidateWindowData(WC_INDUSTRY_DIRECTORY, 0, 0);

   173

	this->xy = 0;

   174

}

   175

   176

static void IndustryDrawSugarMine(const TileInfo *ti)

   177

{

   178

	const DrawIndustryAnimationStruct *d;

   179

   180

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

   181

   182

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

   183

   184

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

   185

   186

	if (d->image_2 != 0) {

   187

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

   188

	}

   189

   190

	if (d->image_3 != 0) {

   191

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

   192

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

   193

	}

   194

}

   195

   196

static void IndustryDrawToffeeQuarry(const TileInfo *ti)

   197

{

   198

	uint8 x = 0;

   199

   200

	if (IsIndustryCompleted(ti->tile)) {

   201

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

   202

		if (x == 0xFF)

   203

			x = 0;

   204

	}

   205

   206

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

   207

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_TOFFEE, PAL_NONE, 6, 14);

   208

}

   209

   210

static void IndustryDrawBubbleGenerator( const TileInfo *ti)

   211

{

   212

	if (IsIndustryCompleted(ti->tile)) {

   213

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

   214

	} else {

   215

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_SPRING, PAL_NONE, 3, 67);

   216

	}

   217

}

   218

   219

static void IndustryDrawToyFactory(const TileInfo *ti)

   220

{

   221

	const DrawIndustryAnimationStruct *d;

   222

   223

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

   224

   225

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

   226

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

   227

	}

   228

   229

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

   230

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

   231

	}

   232

   233

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

   234

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP_HOLDER, PAL_NONE, 0, 42);

   235

}

   236

   237

static void IndustryDrawCoalPlantSparks(const TileInfo *ti)

   238

{

   239

	if (IsIndustryCompleted(ti->tile)) {

   240

		uint8 image = GetIndustryAnimationState(ti->tile);

   241

   242

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

   243

			AddChildSpriteScreen(image + SPR_IT_POWER_PLANT_TRANSFORMERS,

   244

				PAL_NONE,

   245

				_coal_plant_sparks[image - 1].x,

   246

				_coal_plant_sparks[image - 1].y

   247

			);

   248

		}

   249

	}

   250

}

   251

   252

typedef void IndustryDrawTileProc(const TileInfo *ti);

   253

static IndustryDrawTileProc * const _industry_draw_tile_procs[5] = {

   254

	IndustryDrawSugarMine,

   255

	IndustryDrawToffeeQuarry,

   256

	IndustryDrawBubbleGenerator,

   257

	IndustryDrawToyFactory,

   258

	IndustryDrawCoalPlantSparks,

   259

};

   260

   261

static void DrawTile_Industry(TileInfo *ti)

   262

{

   263

	IndustryGfx gfx = GetIndustryGfx(ti->tile);

   264

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

   265

	const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   266

	const DrawBuildingsTileStruct *dits;

   267

	SpriteID image;

   268

	SpriteID pal;

   269

   270

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

   271

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   272

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

   273

		 * DrawNewIndustry will return false if ever the resolver could not

   274

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

   275

		 * substitute gfx instead. */

   276

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

   277

			return;

   278

		} else {

   279

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

   280

			 * Use the substitute one instead */

   281

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

   282

				gfx = indts->grf_prop.subst_id;

   283

				/* And point the industrytile spec accordingly */

   284

				indts = GetIndustryTileSpec(gfx);

   285

			}

   286

		}

   287

	}

   288

   289

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

   290

			GetIndustryAnimationState(ti->tile) & INDUSTRY_COMPLETED :

   291

			GetIndustryConstructionStage(ti->tile))];

   292

   293

	image = dits->ground.sprite;

   294

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

   295

		pal = GENERAL_SPRITE_COLOR(ind->random_color);

   296

	} else {

   297

		pal = dits->ground.pal;

   298

	}

   299

   300

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

   301

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

   302

   303

	DrawGroundSprite(image, pal);

   304

   305

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

   306

	if (IsInvisibilitySet(TO_INDUSTRIES)) return;

   307

   308

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

   309

	image = dits->building.sprite;

   310

	if (image != 0) {

   311

		AddSortableSpriteToDraw(image,

   312

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

   313

			ti->x + dits->subtile_x,

   314

			ti->y + dits->subtile_y,

   315

			dits->width,

   316

			dits->height,

   317

			dits->dz,

   318

			ti->z,

   319

			IsTransparencySet(TO_INDUSTRIES));

   320

   321

		if (IsTransparencySet(TO_INDUSTRIES)) return;

   322

	}

   323

   324

	{

   325

		int proc = dits->draw_proc - 1;

   326

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

   327

	}

   328

}

   329

   330

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

   331

{

   332

	return GetTileMaxZ(tile);

   333

}

   334

   335

static Foundation GetFoundation_Industry(TileIndex tile, Slope tileh)

   336

{

   337

	return FlatteningFoundation(tileh);

   338

}

   339

   340

static void GetAcceptedCargo_Industry(TileIndex tile, AcceptedCargo ac)

   341

{

   342

	IndustryGfx gfx = GetIndustryGfx(tile);

   343

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   344

   345

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

   346

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

   347

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

   348

   349

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

   350

	const CargoID *accepts_cargo = itspec->accepts_cargo;

   351

	const uint8 *acceptance = itspec->acceptance;

   352

   353

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

   354

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

   355

		if (res != CALLBACK_FAILED) {

   356

			accepts_cargo = raw_accepts_cargo;

   357

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

   358

		}

   359

	}

   360

   361

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

   362

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

   363

		if (res != CALLBACK_FAILED) {

   364

			acceptance = raw_acceptance;

   365

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

   366

		}

   367

	}

   368

   369

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

   370

		CargoID a = accepts_cargo[i];

   371

		/* Only set the value once. */

   372

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

   373

	}

   374

}

   375

   376

static void GetTileDesc_Industry(TileIndex tile, TileDesc *td)

   377

{

   378

	const Industry *i = GetIndustryByTile(tile);

   379

   380

	td->owner = i->owner;

   381

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

   382

	if (!IsIndustryCompleted(tile)) {

   383

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

   384

		td->str = STR_2058_UNDER_CONSTRUCTION;

   385

	}

   386

}

   387

   388

static CommandCost ClearTile_Industry(TileIndex tile, byte flags)

   389

{

   390

	Industry *i = GetIndustryByTile(tile);

   391

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

   392

   393

	/* water can destroy industries

   394

	 * in editor you can bulldoze industries

   395

	 * with magic_bulldozer cheat you can destroy industries

   396

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

   397

	 */

   398

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

   399

			!_cheats.magic_bulldozer.value) ||

   400

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

   401

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

   402

		SetDParam(0, indspec->name);

   403

		return_cmd_error(STR_4800_IN_THE_WAY);

   404

	}

   405

   406

	if (flags & DC_EXEC) delete i;

   407

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

   408

}

   409

   410

static void TransportIndustryGoods(TileIndex tile)

   411

{

   412

	Industry *i = GetIndustryByTile(tile);

   413

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

   414

	bool moved_cargo = false;

   415

   416

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

   417

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

   418

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

   419

			i->produced_cargo_waiting[j] -= cw;

   420

   421

			/* fluctuating economy? */

   422

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

   423

   424

			i->this_month_production[j] += cw;

   425

   426

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

   427

			i->this_month_transported[j] += am;

   428

   429

			moved_cargo |= (am != 0);

   430

		}

   431

	}

   432

   433

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

   434

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

   435

   436

		if (newgfx != INDUSTRYTILE_NOANIM) {

   437

			ResetIndustryConstructionStage(tile);

   438

			SetIndustryCompleted(tile, true);

   439

			SetIndustryGfx(tile, newgfx);

   440

			MarkTileDirtyByTile(tile);

   441

		}

   442

	}

   443

}

   444

   445

   446

static void AnimateTile_Industry(TileIndex tile)

   447

{

   448

	byte m;

   449

	IndustryGfx gfx = GetIndustryGfx(tile);

   450

   451

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

   452

		AnimateNewIndustryTile(tile);

   453

		return;

   454

	}

   455

   456

	switch (gfx) {

   457

	case GFX_SUGAR_MINE_SIEVE:

   458

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

   459

			m = GetIndustryAnimationState(tile) + 1;

   460

   461

			switch (m & 7) {

   462

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

   463

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

   464

			}

   465

   466

			if (m >= 96) {

   467

				m = 0;

   468

				DeleteAnimatedTile(tile);

   469

			}

   470

			SetIndustryAnimationState(tile, m);

   471

   472

			MarkTileDirtyByTile(tile);

   473

		}

   474

		break;

   475

   476

	case GFX_TOFFEE_QUARY:

   477

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

   478

			m = GetIndustryAnimationState(tile);

   479

   480

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

   481

				SndPlayTileFx(SND_30_CARTOON_SOUND, tile);

   482

			}

   483

   484

			if (++m >= 70) {

   485

				m = 0;

   486

				DeleteAnimatedTile(tile);