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 "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

const Industry **_industry_sort;

    59

bool _industry_sort_dirty;

    60

    61

IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];

    62

IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];

    63

    64

/** This function initialize the spec arrays of both

    65

 * industry and industry tiles.

    66

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

    67

 * This will allow for clearer testings */

    68

void ResetIndustries()

    69

{

    70

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

    71

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

    72

    73

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

    74

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

    75

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

    76

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

    77

	}

    78

    79

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

    80

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

    81

    82

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

    83

	_industile_mngr.ResetOverride();

    84

	_industry_mngr.ResetOverride();

    85

}

    86

    87

void ResetIndustryCreationProbility(IndustryType type)

    88

{

    89

	assert(type < INVALID_INDUSTRYTYPE);

    90

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

    91

}

    92

    93

DEFINE_OLD_POOL_GENERIC(Industry, Industry)

    94

    95

/**

    96

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

    97

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

    98

 * as would do GetIndustryGfx.

    99

 * @param tile that is queried

   100

 * @pre IsTileType(tile, MP_INDUSTRY)

   101

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

   102

 **/

   103

IndustryType GetIndustryType(TileIndex tile)

   104

{

   105

	assert(IsTileType(tile, MP_INDUSTRY));

   106

   107

	const Industry *ind = GetIndustryByTile(tile);

   108

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

   109

}

   110

   111

/**

   112

 * Accessor for array _industry_specs.

   113

 * This will ensure at once : proper access and

   114

 * not allowing modifications of it.

   115

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

   116

 * @pre thistype < NUM_INDUSTRYTYPES

   117

 * @return a pointer to the corresponding industry spec

   118

 **/

   119

const IndustrySpec *GetIndustrySpec(IndustryType thistype)

   120

{

   121

	assert(thistype < NUM_INDUSTRYTYPES);

   122

	return &_industry_specs[thistype];

   123

}

   124

   125

/**

   126

 * Accessor for array _industry_tile_specs.

   127

 * This will ensure at once : proper access and

   128

 * not allowing modifications of it.

   129

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

   130

 * @pre gfx < INVALID_INDUSTRYTILE

   131

 * @return a pointer to the corresponding industrytile spec

   132

 **/

   133

const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx)

   134

{

   135

	assert(gfx < INVALID_INDUSTRYTILE);

   136

	return &_industry_tile_specs[gfx];

   137

}

   138

   139

Industry::~Industry()

   140

{

   141

	if (CleaningPool()) return;

   142

   143

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

   144

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

   145

	if (this->width == 0) {

   146

		this->xy = 0;

   147

		return;

   148

	}

   149

   150

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

   151

		if (IsTileType(tile_cur, MP_INDUSTRY)) {

   152

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

   153

				DoClearSquare(tile_cur);

   154

			}

   155

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

   156

			DeleteOilRig(tile_cur);

   157

		}

   158

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

   159

   160

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

   161

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

   162

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

   163

			tile_cur = TILE_MASK(tile_cur);

   164

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

   165

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

   166

				SetIndustryIndexOfField(tile_cur, INVALID_INDUSTRY);

   167

			}

   168

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

   169

	}

   170

   171

	_industry_sort_dirty = true;

   172

	DecIndustryTypeCount(this->type);

   173

   174

	DeleteSubsidyWithIndustry(this->index);

   175

	DeleteWindowById(WC_INDUSTRY_VIEW, this->index);

   176

	InvalidateWindow(WC_INDUSTRY_DIRECTORY, 0);

   177

	this->xy = 0;

   178

}

   179

   180

static void IndustryDrawSugarMine(const TileInfo *ti)

   181

{

   182

	const DrawIndustryAnimationStruct *d;

   183

   184

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

   185

   186

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

   187

   188

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

   189

   190

	if (d->image_2 != 0) {

   191

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

   192

	}

   193

   194

	if (d->image_3 != 0) {

   195

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

   196

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

   197

	}

   198

}

   199

   200

static void IndustryDrawToffeeQuarry(const TileInfo *ti)

   201

{

   202

	uint8 x = 0;

   203

   204

	if (IsIndustryCompleted(ti->tile)) {

   205

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

   206

		if (x == 0xFF)

   207

			x = 0;

   208

	}

   209

   210

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

   211

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_TOFFEE, PAL_NONE, 6, 14);

   212

}

   213

   214

static void IndustryDrawBubbleGenerator( const TileInfo *ti)

   215

{

   216

	if (IsIndustryCompleted(ti->tile)) {

   217

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

   218

	} else {

   219

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_SPRING, PAL_NONE, 3, 67);

   220

	}

   221

}

   222

   223

static void IndustryDrawToyFactory(const TileInfo *ti)

   224

{

   225

	const DrawIndustryAnimationStruct *d;

   226

   227

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

   228

   229

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

   230

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

   231

	}

   232

   233

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

   234

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

   235

	}

   236

   237

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

   238

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP_HOLDER, PAL_NONE, 0, 42);

   239

}

   240

   241

static void IndustryDrawCoalPlantSparks(const TileInfo *ti)

   242

{

   243

	if (IsIndustryCompleted(ti->tile)) {

   244

		uint8 image = GetIndustryAnimationState(ti->tile);

   245

   246

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

   247

			AddChildSpriteScreen(image + SPR_IT_POWER_PLANT_TRANSFORMERS,

   248

				PAL_NONE,

   249

				_coal_plant_sparks[image - 1].x,

   250

				_coal_plant_sparks[image - 1].y

   251

			);

   252

		}

   253

	}

   254

}

   255

   256

typedef void IndustryDrawTileProc(const TileInfo *ti);

   257

static IndustryDrawTileProc * const _industry_draw_tile_procs[5] = {

   258

	IndustryDrawSugarMine,

   259

	IndustryDrawToffeeQuarry,

   260

	IndustryDrawBubbleGenerator,

   261

	IndustryDrawToyFactory,

   262

	IndustryDrawCoalPlantSparks,

   263

};

   264

   265

static void DrawTile_Industry(TileInfo *ti)

   266

{

   267

	IndustryGfx gfx = GetIndustryGfx(ti->tile);

   268

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

   269

	const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   270

	const DrawBuildingsTileStruct *dits;

   271

	SpriteID image;

   272

	SpriteID pal;

   273

   274

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

   275

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   276

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

   277

		 * DrawNewIndustry will return false if ever the resolver could not

   278

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

   279

		 * substitute gfx instead. */

   280

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

   281

			return;

   282

		} else {

   283

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

   284

			 * Use the substitute one instead */

   285

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

   286

				gfx = indts->grf_prop.subst_id;

   287

				/* And point the industrytile spec accordingly */

   288

				indts = GetIndustryTileSpec(gfx);

   289

			}

   290

		}

   291

	}

   292

   293

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

   294

			GetIndustryAnimationState(ti->tile) & INDUSTRY_COMPLETED :

   295

			GetIndustryConstructionStage(ti->tile))];

   296

   297

	image = dits->ground.sprite;

   298

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

   299

		pal = GENERAL_SPRITE_COLOR(ind->random_color);

   300

	} else {

   301

		pal = dits->ground.pal;

   302

	}

   303

   304

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

   305

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

   306

   307

	DrawGroundSprite(image, pal);

   308

   309

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

   310

	if (IsInvisibilitySet(TO_INDUSTRIES)) return;

   311

   312

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

   313

	image = dits->building.sprite;

   314

	if (image != 0) {

   315

		AddSortableSpriteToDraw(image,

   316

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

   317

			ti->x + dits->subtile_x,

   318

			ti->y + dits->subtile_y,

   319

			dits->width,

   320

			dits->height,

   321

			dits->dz,

   322

			ti->z,

   323

			IsTransparencySet(TO_INDUSTRIES));

   324

   325

		if (IsTransparencySet(TO_INDUSTRIES)) return;

   326

	}

   327

   328

	{

   329

		int proc = dits->draw_proc - 1;

   330

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

   331

	}

   332

}

   333

   334

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

   335

{

   336

	return GetTileMaxZ(tile);

   337

}

   338

   339

static Foundation GetFoundation_Industry(TileIndex tile, Slope tileh)

   340

{

   341

	return FlatteningFoundation(tileh);

   342

}

   343

   344

static void GetAcceptedCargo_Industry(TileIndex tile, AcceptedCargo ac)

   345

{

   346

	IndustryGfx gfx = GetIndustryGfx(tile);

   347

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   348

   349

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

   350

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

   351

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

   352

   353

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

   354

	const CargoID *accepts_cargo = itspec->accepts_cargo;

   355

	const uint8 *acceptance = itspec->acceptance;

   356

   357

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

   358

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

   359

		if (res != CALLBACK_FAILED) {

   360

			accepts_cargo = raw_accepts_cargo;

   361

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

   362

		}

   363

	}

   364

   365

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

   366

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

   367

		if (res != CALLBACK_FAILED) {

   368

			acceptance = raw_acceptance;

   369

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

   370

		}

   371

	}

   372

   373

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

   374

		CargoID a = accepts_cargo[i];

   375

		/* Only set the value once. */

   376

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

   377

	}

   378

}

   379

   380

static void GetTileDesc_Industry(TileIndex tile, TileDesc *td)

   381

{

   382

	const Industry *i = GetIndustryByTile(tile);

   383

   384

	td->owner = i->owner;

   385

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

   386

	if (!IsIndustryCompleted(tile)) {

   387

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

   388

		td->str = STR_2058_UNDER_CONSTRUCTION;

   389

	}

   390

}

   391

   392

static CommandCost ClearTile_Industry(TileIndex tile, byte flags)

   393

{

   394

	Industry *i = GetIndustryByTile(tile);

   395

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

   396

   397

	/* water can destroy industries

   398

	 * in editor you can bulldoze industries

   399

	 * with magic_bulldozer cheat you can destroy industries

   400

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

   401

	 */

   402

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

   403

			!_cheats.magic_bulldozer.value) ||

   404

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

   405

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

   406

		SetDParam(0, indspec->name);

   407

		return_cmd_error(STR_4800_IN_THE_WAY);

   408

	}

   409

   410

	if (flags & DC_EXEC) delete i;

   411

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

   412

}

   413

   414

static void TransportIndustryGoods(TileIndex tile)

   415

{

   416

	Industry *i = GetIndustryByTile(tile);

   417

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

   418

	bool moved_cargo = false;

   419

   420

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

   421

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

   422

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

   423

			i->produced_cargo_waiting[j] -= cw;

   424

   425

			/* fluctuating economy? */

   426

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

   427

   428

			i->this_month_production[j] += cw;

   429

   430

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

   431

			i->this_month_transported[j] += am;

   432

   433

			moved_cargo |= (am != 0);

   434

		}

   435

	}

   436

   437

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

   438

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

   439

   440

		if (newgfx != INDUSTRYTILE_NOANIM) {

   441

			ResetIndustryConstructionStage(tile);

   442

			SetIndustryCompleted(tile, true);

   443

			SetIndustryGfx(tile, newgfx);

   444

			MarkTileDirtyByTile(tile);

   445

		}

   446

	}

   447

}

   448

   449

   450

static void AnimateTile_Industry(TileIndex tile)

   451

{

   452

	byte m;

   453

	IndustryGfx gfx = GetIndustryGfx(tile);

   454

   455

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

   456

		AnimateNewIndustryTile(tile);

   457

		return;

   458

	}

   459

   460

	switch (gfx) {

   461

	case GFX_SUGAR_MINE_SIEVE:

   462

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

   463

			m = GetIndustryAnimationState(tile) + 1;

   464

   465

			switch (m & 7) {

   466

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

   467

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

   468

			}

   469

   470

			if (m >= 96) {

   471

				m = 0;

   472

				DeleteAnimatedTile(tile);

   473

			}

   474

			SetIndustryAnimationState(tile, m);

   475

   476

			MarkTileDirtyByTile(tile);

   477

		}

   478

		break;

   479

   480

	case GFX_TOFFEE_QUARY:

   481

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

   482

			m = GetIndustryAnimationState(tile);

   483

   484

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

   485

				SndPlayTileFx(SND_30_CARTOON_SOUND, tile);

   486

			}