1

/* $Id$ */

     2

     3

/** @file newgrf_industries.cpp Handling of NewGRF industries. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "variables.h"

     9

#include "landscape.h"

    10

#include "industry.h"

    11

#include "industry_map.h"

    12

#include "newgrf.h"

    13

#include "newgrf_callbacks.h"

    14

#include "newgrf_spritegroup.h"

    15

#include "newgrf_industries.h"

    16

#include "newgrf_industrytiles.h"

    17

#include "newgrf_commons.h"

    18

#include "newgrf_text.h"

    19

#include "newgrf_town.h"

    20

#include "window_func.h"

    21

#include "town.h"

    22

#include "player_func.h"

    23

#include "player_base.h"

    24

#include "command_func.h"

    25

    26

#include "table/strings.h"

    27

    28

static uint32 _industry_creation_random_bits;

    29

    30

/* Since the industry IDs defined by the GRF file don't necessarily correlate

    31

 * to those used by the game, the IDs used for overriding old industries must be

    32

 * translated when the idustry spec is set. */

    33

IndustryOverrideManager _industry_mngr(NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, INVALID_INDUSTRYTYPE);

    34

IndustryTileOverrideManager _industile_mngr(NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, INVALID_INDUSTRYTILE);

    35

    36

IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)

    37

{

    38

	if (grf_type == IT_INVALID) return IT_INVALID;

    39

	if (!HasBit(grf_type, 7)) return GB(grf_type, 0, 6);

    40

    41

	return _industry_mngr.GetID(GB(grf_type, 0, 6), grf_id);

    42

}

    43

    44

static uint32 GetGRFParameter(IndustryType ind_id, byte parameter)

    45

{

    46

	const IndustrySpec *indspec = GetIndustrySpec(ind_id);

    47

	const GRFFile *file = indspec->grf_prop.grffile;

    48

    49

	if (parameter >= file->param_end) return 0;

    50

	return file->param[parameter];

    51

}

    52

    53

/**

    54

 * Finds the distance for the closest tile with water/land given a tile

    55

 * @param tile  the tile to find the distance too

    56

 * @param water whether to find water or land

    57

 * @note FAILS when an industry should be seen as water

    58

 */

    59

static uint GetClosestWaterDistance(TileIndex tile, bool water)

    60

{

    61

	TileIndex t;

    62

	int best_dist;

    63

	for (t = 0; t < MapSize(); t++) {

    64

		if (IsTileType(t, MP_WATER) == water) break;

    65

	}

    66

	if (t == MapSize() && !water) return 0x200;

    67

	best_dist = DistanceManhattan(tile, t);

    68

    69

	for (; t < MapSize(); t++) {

    70

		int dist = DistanceManhattan(tile, t);

    71

		if (dist < best_dist) {

    72

			if (IsTileType(t, MP_WATER) == water) best_dist = dist;

    73

		} else {

    74

			/* When the Y distance between the current row and the 'source' tile

    75

			 * is larger than the best distance, we've found the best distance */

    76

			if ((int)TileY(t) - (int)TileY(tile) > best_dist) break;

    77

			if ((int)TileX(t) - (int)TileX(tile) > best_dist) {

    78

				/* We can safely skip this many tiles; from here all tiles have a

    79

				 * higher or equal distance than the best distance */

    80

				t |= MapMaxX();

    81

				continue;

    82

			} else if (TileX(tile) < TileX(t)) {

    83

				/* We can safely skip this many tiles; up to here all tiles have a

    84

				 * higher or equal distance than the best distance */

    85

				t += max(best_dist - dist, 0);

    86

				continue;

    87

			}

    88

		}

    89

	}

    90

    91

	return min(best_dist, water ? 0x7F : 0x1FF);

    92

}

    93

    94

/** Make an analysis of a tile and check for its belonging to the same

    95

 * industry, and/or the same grf file

    96

 * @param tile TileIndex of the tile to query

    97

 * @param i Industry to which to compare the tile to

    98

 * @return value encoded as per NFO specs */

    99

uint32 GetIndustryIDAtOffset(TileIndex tile, const Industry *i)

   100

{

   101

	if (!IsTileType(tile, MP_INDUSTRY) || GetIndustryIndex(tile) != i->index) {

   102

		/* No industry and/or the tile does not have the same industry as the one we match it with */

   103

		return 0xFFFF;

   104

	}

   105

   106

	IndustryGfx gfx = GetCleanIndustryGfx(tile);

   107

	const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);

   108

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

   109

   110

	if (gfx < NEW_INDUSTRYOFFSET) { // Does it belongs to an old type?

   111

		/* It is an old tile.  We have to see if it's been overriden */

   112

		if (indtsp->grf_prop.override == INVALID_INDUSTRYTILE) { // has it been overridden?

   113

			return 0xFF << 8 | gfx; // no. Tag FF + the gfx id of that tile

   114

		}

   115

		/* Not overriden */

   116

		const IndustryTileSpec *tile_ovr = GetIndustryTileSpec(indtsp->grf_prop.override);

   117

   118

		if (tile_ovr->grf_prop.grffile->grfid == indold->grf_prop.grffile->grfid) {

   119

			return tile_ovr->grf_prop.local_id; // same grf file

   120

		} else {

   121

			return 0xFFFE; // not the same grf file

   122

		}

   123

	}

   124

	/* Not an 'old type' tile */

   125

	if (indtsp->grf_prop.spritegroup != NULL) { // tile has a spritegroup ?

   126

		if (indtsp->grf_prop.grffile->grfid == indold->grf_prop.grffile->grfid) { // same industry, same grf ?

   127

			return indtsp->grf_prop.local_id;

   128

		} else {

   129

			return 0xFFFE; // Defined in another grf file

   130

		}

   131

	}

   132

	/* The tile has no spritegroup */

   133

	return 0xFF << 8 | indtsp->grf_prop.subst_id; // so just give him the substitute

   134

}

   135

   136

static uint32 GetClosestIndustry(TileIndex tile, IndustryType type, const Industry *current)

   137

{

   138

	uint32 best_dist = MAX_UVALUE(uint32);

   139

	const Industry *i;

   140

	FOR_ALL_INDUSTRIES(i) {

   141

		if (i->type != type || i == current) continue;

   142

   143

		best_dist = min(best_dist, DistanceManhattan(tile, i->xy));

   144

	}

   145

   146

	return best_dist;

   147

}

   148

   149

/** Implementation of both var 67 and 68

   150

 * since the mechanism is almost the same, it is easier to regroup them on the same

   151

 * function.

   152

 * @param param_setID parameter given to the callback, which is the set id, or the local id, in our terminology

   153

 * @param layout_filter on what layout do we filter?

   154

 * @param current Industry for which the inquiry is made

   155

 * @return the formatted answer to the callback : rr(reserved) cc(count) dddd(manhattan distance of closest sister)

   156

 */

   157

static uint32 GetCountAndDistanceOfClosestInstance(byte param_setID, byte layout_filter, const Industry *current)

   158

{

   159

	uint32 GrfID = GetRegister(0x100);  ///< Get the GRFID of the definition to look for in register 100h

   160

	IndustryType ind_index;

   161

	uint32 closest_dist = MAX_UVALUE(uint32);

   162

	byte count = 0;

   163

   164

	/* Determine what will be the industry type to look for */

   165

	switch (GrfID) {

   166

		case 0:  // this is a default industry type

   167

			ind_index = param_setID;

   168

			break;

   169

   170

		case 0xFFFFFFFF: // current grf

   171

			GrfID = GetIndustrySpec(current->type)->grf_prop.grffile->grfid;

   172

			/* Fall through */

   173

   174

		default: //use the grfid specified in register 100h

   175

			SetBit(param_setID, 7); // bit 7 means it is not an old type

   176

			ind_index = MapNewGRFIndustryType(param_setID, GrfID);

   177

			break;

   178

	}

   179

   180

	if (layout_filter == 0) {

   181

		/* If the filter is 0, it could be because none was specified as well as being really a 0.

   182

		 * In either case, just do the regular var67 */

   183

		closest_dist = GetClosestIndustry(current->xy, ind_index, current);

   184

		count = GetIndustryTypeCount(ind_index);

   185

	} else {

   186

		/* Count only those who match the same industry type and layout filter

   187

		 * Unfortunately, we have to do it manually */

   188

		const Industry *i;

   189

		FOR_ALL_INDUSTRIES(i) {

   190

			if (i->type == ind_index && i != current && i->selected_layout == layout_filter) {

   191

				closest_dist = min(closest_dist, DistanceManhattan(current->xy, i->xy));

   192

				count++;

   193

			}

   194

		}

   195

	}

   196

   197

	return count << 16 | GB(closest_dist, 0, 16);

   198

}

   199

   200

/** This function implements the industries variables that newGRF defines.

   201

 * @param variable that is queried

   202

 * @param parameter unused

   203

 * @param available will return false if ever the variable asked for does not exist

   204

 * @param ind is of course the industry we are inquiring

   205

 * @return the value stored in the corresponding variable*/

   206

uint32 IndustryGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)

   207

{

   208

	const Industry *industry = object->u.industry.ind;

   209

	TileIndex tile = object->u.industry.tile;

   210

	IndustryType type = object->u.industry.type;

   211

	const IndustrySpec *indspec = GetIndustrySpec(type);

   212

   213

	if (industry == NULL) {

   214

		/* industry does not exist, only use those variables that are "safe" */

   215

		switch (variable) {

   216

			/* Read GRF parameter */

   217

			case 0x7F: return GetGRFParameter(type, parameter);

   218

			/* Manhattan distance of closes dry/water tile */

   219

			case 0x43: return GetClosestWaterDistance(tile, (indspec->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);

   220

		}

   221

   222

		DEBUG(grf, 1, "Unhandled property 0x%X (no available industry) in callback 0x%x", variable, object->callback);

   223

   224

		*available = false;

   225

		return UINT_MAX;

   226

	}

   227

   228

	switch (variable) {

   229

		case 0x40:

   230

		case 0x41:

   231

		case 0x42: { // waiting cargo, but only if those two callback flags are set

   232

			uint16 callback = indspec->callback_flags;

   233

			if (HasBit(callback, CBM_IND_PRODUCTION_CARGO_ARRIVAL) || HasBit(callback, CBM_IND_PRODUCTION_256_TICKS)) {

   234

				if ((indspec->behaviour & INDUSTRYBEH_PROD_MULTI_HNDLING) != 0) {

   235

					return min(industry->incoming_cargo_waiting[variable - 0x40] / industry->prod_level, (uint16)0xFFFF);

   236

				} else {

   237

					return min(industry->incoming_cargo_waiting[variable - 0x40], (uint16)0xFFFF);

   238

				}

   239

			} else {

   240

				return 0;

   241

			}

   242

		}

   243

   244

		/* Manhattan distance of closes dry/water tile */

   245

		case 0x43: return GetClosestWaterDistance(tile, (indspec->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);

   246

   247

		/* Layout number */

   248

		case 0x44: return industry->selected_layout;

   249

   250

		/* player info */

   251

		case 0x45: {

   252

			byte colours;

   253

			bool is_ai = false;

   254

   255

			if (IsValidPlayer(industry->founder)) {

   256

				const Player *p = GetPlayer(industry->founder);

   257

				const Livery *l = &p->livery[LS_DEFAULT];

   258

   259

				is_ai = p->is_ai;

   260

				colours = l->colour1 + l->colour2 * 16;

   261

			} else {

   262

				colours = GB(Random(), 0, 8);

   263

			}

   264

   265

			return industry->founder | (is_ai ? 0x10000 : 0) | (colours << 24);

   266

		}

   267

   270

		/* Get industry ID at offset param */

   271

		case 0x60: return GetIndustryIDAtOffset(GetNearbyTile(parameter, industry->xy), industry);

   272

   273

		/* Get random tile bits at offset param */

   274

		case 0x61:

   275

			tile = GetNearbyTile(parameter, tile);

   276

			return (IsTileType(tile, MP_INDUSTRY) && GetIndustryByTile(tile) == industry) ? GetIndustryRandomBits(tile) : 0;

   277

   278

		/* Land info of nearby tiles */

   279

		case 0x62: return GetNearbyIndustryTileInformation(parameter, tile, INVALID_INDUSTRY);

   280

   281

		/* Animation stage of nearby tiles */

   282

		case 0x63:

   283

			tile = GetNearbyTile(parameter, tile);

   284

			if (IsTileType(tile, MP_INDUSTRY) && GetIndustryByTile(tile) == industry) {

   285

				return GetIndustryAnimationState(tile);

   286

			}

   287

			return 0xFFFFFFFF;

   288

   289

		/* Distance of nearest industry of given type */

   290

		case 0x64: return GetClosestIndustry(tile, MapNewGRFIndustryType(parameter, indspec->grf_prop.grffile->grfid), industry);

   291

		/* Get town zone and Manhattan distance of closest town */

   292

		case 0x65: return GetTownRadiusGroup(industry->town, tile) << 16 | min(DistanceManhattan(tile, industry->town->xy), 0xFFFF);

   293

		/* Get square of Euclidian distance of closes town */

   294

		case 0x66: return GetTownRadiusGroup(industry->town, tile) << 16 | min(DistanceSquare(tile, industry->town->xy), 0xFFFF);

   295

   296

		/* Count of industry, distance of closest instance

   297

		 * 68 is the same as 67, but with a filtering on selected layout */

   298

		case 0x67:

   299

		case 0x68: return GetCountAndDistanceOfClosestInstance(parameter, variable == 0x68 ? GB(GetRegister(0x101), 0, 8) : 0, industry);

   300

   301

		/* Get a variable from the persistent storage */

   302

		case 0x7C: return industry->psa.Get(parameter);

   303

   304

		/* Read GRF parameter */

   305

		case 0x7F: return GetGRFParameter(type, parameter);

   306

   307

		/* Industry structure access*/

   308

		case 0x80: return industry->xy;

   309

		case 0x81: return GB(industry->xy, 8, 8);

   310

		/* Pointer to the town the industry is associated with */

   311

		case 0x82: return industry->town->index;

   312

		case 0x83:

   313

		case 0x84:

   314

		case 0x85: DEBUG(grf, 0, "NewGRFs shouldn't be doing pointer magic"); break; // not supported

   315

		case 0x86: return industry->width;

   316

		case 0x87: return industry->height;// xy dimensions

   317

		/*  */

   318

		case 0x88:

   319

		case 0x89: return industry->produced_cargo[variable - 0x88];

   320

		case 0x8A: return industry->produced_cargo_waiting[0];

   321

		case 0x8B: return GB(industry->produced_cargo_waiting[0], 8, 8);

   322

		case 0x8C: return industry->produced_cargo_waiting[1];

   323

		case 0x8D: return GB(industry->produced_cargo_waiting[1], 8, 8);

   324

		case 0x8E:

   325

		case 0x8F: return industry->production_rate[variable - 0x8E];

   326

		case 0x90:

   327

		case 0x91:

   328

		case 0x92: return industry->accepts_cargo[variable - 0x90];

   329

		case 0x93: return industry->prod_level;

   330

		/* amount of cargo produced so far THIS month. */

   331

		case 0x94: return industry->this_month_production[0];

   332

		case 0x95: return GB(industry->this_month_production[0], 8, 8);

   333

		case 0x96: return industry->this_month_production[1];

   334

		case 0x97: return GB(industry->this_month_production[1], 8, 8);

   335

		/* amount of cargo transported so far THIS month. */

   336

		case 0x98: return industry->this_month_transported[0];

   337

		case 0x99: return GB(industry->this_month_transported[0], 8, 8);

   338

		case 0x9A: return industry->this_month_transported[1];

   339

		case 0x9B: return GB(industry->this_month_transported[0], 8, 8);

   340

		/* fraction of cargo transported LAST month. */

   341

		case 0x9C:

   342

		case 0x9D: return industry->last_month_pct_transported[variable - 0x9C];

   343

		/* amount of cargo produced LAST month. */

   344

		case 0x9E: return industry->last_month_production[0];

   345

		case 0x9F: return GB(industry->last_month_production[0], 8, 8);

   346

		case 0xA0: return industry->last_month_production[1];

   347

		case 0xA1: return GB(industry->last_month_production[1], 8, 8);

   348

		/* amount of cargo transported last month. */

   349

		case 0xA2: return industry->last_month_transported[0];

   350

		case 0xA3: return GB(industry->last_month_transported[0], 8, 8);

   351

		case 0xA4: return industry->last_month_transported[1];

   352

		case 0xA5: return GB(industry->last_month_transported[0], 8, 8);

   353

   354

		case 0xA6: return industry->type;

   355

		case 0xA7: return industry->founder;

   356

		case 0xA8: return industry->random_color;

   357

		case 0xA9: return Clamp(industry->last_prod_year - ORIGINAL_BASE_YEAR, 0, 255);

   358

		case 0xAA: return industry->counter;

   359

		case 0xAB: return GB(industry->counter, 8, 8);

   360

		case 0xAC: return industry->was_cargo_delivered;

   361

   362

		case 0xB0: return Clamp(industry->construction_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Date when built since 1920 (in days)

   363

		case 0xB3: return industry->construction_type; // Construction type

   364

		case 0xB4: return Clamp(industry->last_cargo_accepted_at - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Date last cargo accepted since 1920 (in days)

   365

	}

   366

   367

	DEBUG(grf, 1, "Unhandled industry property 0x%X", variable);

   368

   369

	*available = false;

   370

	return (uint32)-1;

   371

}

   372

   373

static const SpriteGroup *IndustryResolveReal(const ResolverObject *object, const SpriteGroup *group)

   374

{

   375

	/* IndustryTile do not have 'real' groups */

   376

	return NULL;

   377

}

   378

   379

static uint32 IndustryGetRandomBits(const ResolverObject *object)

   380

{

   381

	return object->u.industry.ind == NULL ? 0 : object->u.industry.ind->random;

   382

}

   383

   384

static uint32 IndustryGetTriggers(const ResolverObject *object)

   385

{

   386

	return object->u.industry.ind == NULL ? 0 : object->u.industry.ind->random_triggers;

   387

}

   388

   389

static void IndustrySetTriggers(const ResolverObject *object, int triggers)

   390

{

   391

	if (object->u.industry.ind == NULL) return;

   392

	object->u.industry.ind->random_triggers = triggers;

   393

}

   394

   395

static void NewIndustryResolver(ResolverObject *res, TileIndex tile, Industry *indus, IndustryType type)

   396

{

   397

	res->GetRandomBits = IndustryGetRandomBits;

   398

	res->GetTriggers   = IndustryGetTriggers;

   399

	res->SetTriggers   = IndustrySetTriggers;

   400

	res->GetVariable   = IndustryGetVariable;

   401

	res->ResolveReal   = IndustryResolveReal;

   402

   403

	res->psa             = &indus->psa;

   404

	res->u.industry.tile = tile;

   405

	res->u.industry.ind  = indus;

   406

	res->u.industry.gfx  = INVALID_INDUSTRYTILE;

   407

	res->u.industry.type = type;

   408

   409

	res->callback        = CBID_NO_CALLBACK;

   410

	res->callback_param1 = 0;

   411

	res->callback_param2 = 0;

   412

	res->last_value      = 0;

   413

	res->trigger         = 0;

   414

	res->reseed          = 0;

   415

	res->count           = 0;

   416

}

   417

   418

uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile)

   419

{

   420

	ResolverObject object;

   421

	const SpriteGroup *group;

   422

   423

	NewIndustryResolver(&object, tile, industry, type);

   424

	object.callback = callback;

   425

	object.callback_param1 = param1;

   426

	object.callback_param2 = param2;

   427

   428

	group = Resolve(GetIndustrySpec(type)->grf_prop.spritegroup, &object);

   429

	if (group == NULL || group->type != SGT_CALLBACK) return CALLBACK_FAILED;

   430

   431

	return group->g.callback.result;

   432

}

   433

   434

uint32 IndustryLocationGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)

   435

{

   436

	const Industry *industry = object->u.industry.ind;

   437

	TileIndex tile = object->u.industry.tile;

   438

   439

	if (object->scope == VSG_SCOPE_PARENT) {

   440

		return TownGetVariable(variable, parameter, available, industry->town);

   441

	}

   442

   443

	switch (variable) {

   444

		case 0x80: return tile;

   445

		case 0x81: return GB(tile, 8, 8);

   446

   447

		/* Pointer to the town the industry is associated with */

   448

		case 0x82: return industry->town->index;

   449

		case 0x83:

   450

		case 0x84:

   451

		case 0x85: DEBUG(grf, 0, "NewGRFs shouldn't be doing pointer magic"); break; // not supported

   452

   453

		/* Number of the layout */

   454

		case 0x86: return industry->selected_layout;

   455

   456

		/* Ground type */

   457

		case 0x87: return GetTerrainType(tile);

   458

   459

		/* Town zone */

   460

		case 0x88: return GetTownRadiusGroup(industry->town, tile);

   461

   462

		/* Manhattan distance of the closest town */

   463

		case 0x89: return min(DistanceManhattan(industry->town->xy, tile), 255);

   464

   465

		/* Lowest height of the tile */

   466

		case 0x8A: return GetTileZ(tile);

   467

   468

		/* Distance to the nearest water/land tile */

   469

		case 0x8B: return GetClosestWaterDistance(tile, (GetIndustrySpec(industry->type)->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);

   470

   471

		/* Square of Euclidian distance from town */

   472

		case 0x8D: return min(DistanceSquare(industry->town->xy, tile), 65535);

   473

   474

		/* 32 random bits */

   475

		case 0x8F: return _industry_creation_random_bits;

   476

	}

   477

   478

	/* None of the special ones, so try the general ones */

   479

	return IndustryGetVariable(object, variable, parameter, available);

   480

}

   481

   482

bool CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, uint itspec_index, uint32 seed)

   483

{

   484

	const IndustrySpec *indspec = GetIndustrySpec(type);

   485

   486

	ResolverObject object;

   487

	const SpriteGroup *group;

   488

   489

	Industry ind;

   490

	ind.index = INVALID_INDUSTRY;

   491

	ind.xy = tile;

   492

	ind.width = 0;

   493

	ind.type = type;

   494

	ind.selected_layout = itspec_index;

   495

	ind.town = ClosestTownFromTile(tile, (uint)-1);

   496

   497

	NewIndustryResolver(&object, tile, &ind, type);

   498

	object.GetVariable = IndustryLocationGetVariable;

   499

	object.callback = CBID_INDUSTRY_LOCATION;

   500

	_industry_creation_random_bits = seed;

   501

   502

	group = Resolve(GetIndustrySpec(type)->grf_prop.spritegroup, &object);

   503

   504

	/* Unlike the "normal" cases, not having a valid result means we allow

   505

	 * the building of the industry, as that's how it's done in TTDP. */

   506

	if (group == NULL || group->type != SGT_CALLBACK) return true;