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, _settings_game.game_creation.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[_settings_game.game_creation.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

				/* MakeWaterKeepingClass() can also handle 'land' */

   151

				MakeWaterKeepingClass(tile_cur, OWNER_NONE);

   152

			}

   153

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

   154

			DeleteOilRig(tile_cur);

   155

		}

   156

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

   157

   158

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

   159

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

   160

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

   161

			tile_cur = TILE_MASK(tile_cur);

   162

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

   163

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

   164

				SetIndustryIndexOfField(tile_cur, INVALID_INDUSTRY);

   165

			}

   166

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

   167

	}

   168

   169

	DecIndustryTypeCount(this->type);

   170

   171

	DeleteSubsidyWithIndustry(this->index);

   172

	DeleteWindowById(WC_INDUSTRY_VIEW, this->index);

   173

	InvalidateWindowData(WC_INDUSTRY_DIRECTORY, 0, 0);

   174

	this->xy = 0;

   175

}

   176

   177

static void IndustryDrawSugarMine(const TileInfo *ti)

   178

{

   179

	const DrawIndustryAnimationStruct *d;

   180

   181

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

   182

   183

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

   184

   185

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

   186

   187

	if (d->image_2 != 0) {

   188

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

   189

	}

   190

   191

	if (d->image_3 != 0) {

   192

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

   193

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

   194

	}

   195

}

   196

   197

static void IndustryDrawToffeeQuarry(const TileInfo *ti)

   198

{

   199

	uint8 x = 0;

   200

   201

	if (IsIndustryCompleted(ti->tile)) {

   202

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

   203

		if (x == 0xFF)

   204

			x = 0;

   205

	}

   206

   207

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

   208

	AddChildSpriteScreen(SPR_IT_TOFFEE_QUARRY_TOFFEE, PAL_NONE, 6, 14);

   209

}

   210

   211

static void IndustryDrawBubbleGenerator( const TileInfo *ti)

   212

{

   213

	if (IsIndustryCompleted(ti->tile)) {

   214

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

   215

	} else {

   216

		AddChildSpriteScreen(SPR_IT_BUBBLE_GENERATOR_SPRING, PAL_NONE, 3, 67);

   217

	}

   218

}

   219

   220

static void IndustryDrawToyFactory(const TileInfo *ti)

   221

{

   222

	const DrawIndustryAnimationStruct *d;

   223

   224

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

   225

   226

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

   227

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

   228

	}

   229

   230

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

   231

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

   232

	}

   233

   234

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

   235

	AddChildSpriteScreen(SPR_IT_TOY_FACTORY_STAMP_HOLDER, PAL_NONE, 0, 42);

   236

}

   237

   238

static void IndustryDrawCoalPlantSparks(const TileInfo *ti)

   239

{

   240

	if (IsIndustryCompleted(ti->tile)) {

   241

		uint8 image = GetIndustryAnimationState(ti->tile);

   242

   243

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

   244

			AddChildSpriteScreen(image + SPR_IT_POWER_PLANT_TRANSFORMERS,

   245

				PAL_NONE,

   246

				_coal_plant_sparks[image - 1].x,

   247

				_coal_plant_sparks[image - 1].y

   248

			);

   249

		}

   250

	}

   251

}

   252

   253

typedef void IndustryDrawTileProc(const TileInfo *ti);

   254

static IndustryDrawTileProc * const _industry_draw_tile_procs[5] = {

   255

	IndustryDrawSugarMine,

   256

	IndustryDrawToffeeQuarry,

   257

	IndustryDrawBubbleGenerator,

   258

	IndustryDrawToyFactory,

   259

	IndustryDrawCoalPlantSparks,

   260

};

   261

   262

static void DrawTile_Industry(TileInfo *ti)

   263

{

   264

	IndustryGfx gfx = GetIndustryGfx(ti->tile);

   265

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

   266

	const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   267

	const DrawBuildingsTileStruct *dits;

   268

	SpriteID image;

   269

	SpriteID pal;

   270

   271

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

   272

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   273

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

   274

		 * DrawNewIndustry will return false if ever the resolver could not

   275

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

   276

		 * substitute gfx instead. */

   277

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

   278

			return;

   279

		} else {

   280

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

   281

			 * Use the substitute one instead */

   282

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

   283

				gfx = indts->grf_prop.subst_id;

   284

				/* And point the industrytile spec accordingly */

   285

				indts = GetIndustryTileSpec(gfx);

   286

			}

   287

		}

   288

	}

   289

   290

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

   291

			GetIndustryAnimationState(ti->tile) & INDUSTRY_COMPLETED :

   292

			GetIndustryConstructionStage(ti->tile))];

   293

   294

	image = dits->ground.sprite;

   295

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

   296

		pal = GENERAL_SPRITE_COLOR(ind->random_color);

   297

	} else {

   298

		pal = dits->ground.pal;

   299

	}

   300

   301

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

   302

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

   303

   304

	/* If the ground sprite is the default flat water sprite, draw also canal/river borders.

   305

	 * Do not do this if the tile's WaterClass is 'land'. */

   306

	if (image == SPR_FLAT_WATER_TILE && IsIndustryTileOnWater(ti->tile)) {

   307

		DrawWaterClassGround(ti);

   308

	} else {

   309

		DrawGroundSprite(image, pal);

   310

	}

   311

   312

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

   313

	if (IsInvisibilitySet(TO_INDUSTRIES)) return;

   314

   315

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

   316

	image = dits->building.sprite;

   317

	if (image != 0) {

   318

		AddSortableSpriteToDraw(image,

   319

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

   320

			ti->x + dits->subtile_x,

   321

			ti->y + dits->subtile_y,

   322

			dits->width,

   323

			dits->height,

   324

			dits->dz,

   325

			ti->z,

   326

			IsTransparencySet(TO_INDUSTRIES));

   327

   328

		if (IsTransparencySet(TO_INDUSTRIES)) return;

   329

	}

   330

   331

	{

   332

		int proc = dits->draw_proc - 1;

   333

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

   334

	}

   335

}

   336

   337

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

   338

{

   339

	return GetTileMaxZ(tile);

   340

}

   341

   342

static Foundation GetFoundation_Industry(TileIndex tile, Slope tileh)

   343

{

   344

	IndustryGfx gfx = GetIndustryGfx(tile);

   345

   346

	/* For NewGRF industry tiles we might not be drawing a foundation. We need to

   347

	 * account for this, as other structures should

   348

	 * draw the wall of the foundation in this case.

   349

	 */

   350

	if (gfx >= NEW_INDUSTRYTILEOFFSET) {

   351

		const IndustryTileSpec *indts = GetIndustryTileSpec(gfx);

   352

		if (indts->grf_prop.spritegroup != NULL && HasBit(indts->callback_flags, CBM_INDT_DRAW_FOUNDATIONS)) {

   353

			uint32 callback_res = GetIndustryTileCallback(CBID_INDUSTRY_DRAW_FOUNDATIONS, 0, 0, gfx, GetIndustryByTile(tile), tile);

   354

			if (callback_res == 0) return FOUNDATION_NONE;

   355

		}

   356

	}

   357

	return FlatteningFoundation(tileh);

   358

}

   359

   360

static void GetAcceptedCargo_Industry(TileIndex tile, AcceptedCargo ac)

   361

{

   362

	IndustryGfx gfx = GetIndustryGfx(tile);

   363

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   364

   365

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

   366

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

   367

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

   368

   369

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

   370

	const CargoID *accepts_cargo = itspec->accepts_cargo;

   371

	const uint8 *acceptance = itspec->acceptance;

   372

   373

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

   374

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

   375

		if (res != CALLBACK_FAILED) {

   376

			accepts_cargo = raw_accepts_cargo;

   377

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

   378

		}

   379

	}

   380

   381

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

   382

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

   383

		if (res != CALLBACK_FAILED) {

   384

			acceptance = raw_acceptance;

   385

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

   386

		}

   387

	}

   388

   389

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

   390

		CargoID a = accepts_cargo[i];

   391

		/* Only set the value once. */

   392

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

   393

	}

   394

}

   395

   396

static void GetTileDesc_Industry(TileIndex tile, TileDesc *td)

   397

{

   398

	const Industry *i = GetIndustryByTile(tile);

   399

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

   400

   401

	td->owner[0] = i->owner;

   402

	td->str = is->name;

   403

	if (!IsIndustryCompleted(tile)) {

   404

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

   405

		td->str = STR_2058_UNDER_CONSTRUCTION;

   406

	}

   407

   408

	if (is->grf_prop.grffile != NULL) {

   409

		td->grf = GetGRFConfig(is->grf_prop.grffile->grfid)->name;

   410

	}

   411

}

   412

   413

static CommandCost ClearTile_Industry(TileIndex tile, byte flags)

   414

{

   415

	Industry *i = GetIndustryByTile(tile);

   416

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

   417

   418

	/* water can destroy industries

   419

	 * in editor you can bulldoze industries

   420

	 * with magic_bulldozer cheat you can destroy industries

   421

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

   422

	 */

   423

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

   424

			!_cheats.magic_bulldozer.value) ||

   425

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

   426

			(_current_company == OWNER_WATER &&

   427

				((indspec->behaviour & INDUSTRYBEH_BUILT_ONWATER) ||

   428

				HasBit(GetIndustryTileSpec(GetIndustryGfx(tile))->slopes_refused, 5)))) {

   429

		SetDParam(0, indspec->name);

   430

		return_cmd_error(STR_4800_IN_THE_WAY);

   431

	}

   432

   433

	if (flags & DC_EXEC) delete i;

   434

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

   435

}

   436

   437

static void TransportIndustryGoods(TileIndex tile)

   438

{

   439

	Industry *i = GetIndustryByTile(tile);

   440

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

   441

	bool moved_cargo = false;

   442

   443

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

   444

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

   445

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

   446

			i->produced_cargo_waiting[j] -= cw;

   447

   448

			/* fluctuating economy? */

   449

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

   450

   451

			i->this_month_production[j] += cw;

   452

   453

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

   454

			i->this_month_transported[j] += am;

   455

   456

			moved_cargo |= (am != 0);

   457

		}

   458

	}

   459

   460

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

   461

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

   462

   463

		if (newgfx != INDUSTRYTILE_NOANIM) {

   464

			ResetIndustryConstructionStage(tile);

   465

			SetIndustryCompleted(tile, true);

   466

			SetIndustryGfx(tile, newgfx);

   467

			MarkTileDirtyByTile(tile);

   468

		}

   469

	}

   470

}

   471

   472

   473

static void AnimateTile_Industry(TileIndex tile)

   474

{

   475

	byte m;

   476

	IndustryGfx gfx = GetIndustryGfx(tile);

   477

   478

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

   479

		AnimateNewIndustryTile(tile);

   480

		return;

   481

	}

   482

   483

	switch (gfx) {

   484

	case GFX_SUGAR_MINE_SIEVE:

   485

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