1

/* $Id$ */

     2

     3

/** @file newgrf_industries.cpp */

     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"

    27

    28

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

    29

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

    30

 * translated when the idustry spec is set. */

    31

IndustryOverrideManager _industry_mngr(NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, INVALID_INDUSTRYTYPE);

    32

IndustryTileOverrideManager _industile_mngr(NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, INVALID_INDUSTRYTILE);

    33

    34

IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)

    35

{

    36

	if (grf_type == IT_INVALID) return IT_INVALID;

    37

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

    38

    39

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

    40

}

    41

    51

/**

    52

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

    53

 * @param tile  the tile to find the distance too

    54

 * @param water whether to find water or land

    55

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

    56

 */

    57

static uint GetClosestWaterDistance(TileIndex tile, bool water)

    58

{

    59

	TileIndex t;

    60

	int best_dist;

    61

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

    62

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

    63

	}

    64

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

    65

	best_dist = DistanceManhattan(tile, t);

    66

    67

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

    68

		int dist = DistanceManhattan(tile, t);

    69

		if (dist < best_dist) {

    70

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

    71

		} else {

    72

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

    73

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

    74

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

    75

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

    76

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

    77

				 * higher or equal distance than the best distance */

    78

				t |= MapMaxX();

    79

				continue;

    80

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

    81

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

    82

				 * higher or equal distance than the best distance */

    83

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

    84

				continue;

    85

			}

    86

		}

    87

	}

    88

    89

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

    90

}

    91

    92

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

    93

 * industry, and/or the same grf file

    94

 * @param tile TileIndex of the tile to query

    95

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

    96

 * @return value encoded as per NFO specs */

    97

uint32 GetIndustryIDAtOffset(TileIndex tile, const Industry *i)

    98

{

    99

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

   100

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

   101

		return 0xFFFF;

   102

	}

   103

   104

	IndustryGfx gfx = GetCleanIndustryGfx(tile);

   105

	const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);

   106

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

   107

   108

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

   109

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

   110

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

   111

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

   112

		}

   113

		/* Not overriden */

   114

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

   115

   116

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

   117

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

   118

		} else {

   119

			return 0xFFFE; // not the same grf file

   120

		}

   121

	}

   122

	/* Not an 'old type' tile */

   123

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

   124

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

   125

			return indtsp->grf_prop.local_id;

   126

		} else {

   127

			return 0xFFFE; // Defined in another grf file

   128

		}

   129

	}

   130

	/* The tile has no spritegroup */

   131

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

   132

}

   133

   134

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

   135

{

   136

	uint32 best_dist = MAX_UVALUE(uint32);

   137

	const Industry *i;

   138

	FOR_ALL_INDUSTRIES(i) {

   139

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

   140

   141

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

   142

	}

   143

   144

	return best_dist;

   145

}

   146

   147

/** Implementation of both var 67 and 68

   148

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

   149

 * function.

   150

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

   151

 * @param layout_filter on what layout do we filter?

   152

 * @param current Industry for which the inquiry is made

   153

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

   154

 */

   155

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

   156

{

   157

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

   158

	IndustryType ind_index;

   159

	uint32 closest_dist = MAX_UVALUE(uint32);

   160

	byte count = 0;

   161

   162

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

   163

	switch (GrfID) {

   164

		case 0:  // this is a default industry type

   165

			ind_index = param_setID;

   166

			break;

   167

   168

		case 0xFFFFFFFF: // current grf

   169

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

   170

			/* Fall through */

   171

   172

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

   173

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

   174

			ind_index = MapNewGRFIndustryType(param_setID, GrfID);

   175

			break;

   176

	}

   177

   178

	if (layout_filter == 0) {

   179

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

   180

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

   181

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

   182

		count = GetIndustryTypeCount(ind_index);

   183

	} else {

   184

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

   185

		 * Unfortunately, we have to do it manually */

   186

		const Industry *i;

   187

		FOR_ALL_INDUSTRIES(i) {

   188

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

   189

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

   190

				count++;

   191

			}

   192

		}

   193

	}

   194

   195

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

   196

}

   197

   198

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

   199

 * @param variable that is queried

   200

 * @param parameter unused

   201

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

   202

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

   203

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

   204

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

   205

{

   206

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

   207

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

   225

   226

	switch (variable) {

   227

		case 0x40:

   228

		case 0x41:

   229

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

   230

			uint16 callback = indspec->callback_flags;

   231

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

   232

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

   233

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

   234

				} else {

   235

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

   236

				}

   237

			} else {

   238

				return 0;

   239

			}

   240

		}

   241

   242

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

   243

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

   244

   245

		/* Layout number */

   246

		case 0x44: return industry->selected_layout;

   247

   248

		/* player info */

   249

		case 0x45: {

   250

			byte colours;

   251

			bool is_ai = false;

   252

   253

			if (IsValidPlayer(industry->founder)) {

   254

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

   255

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

   256

   257

				is_ai = p->is_ai;

   258

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

   259

			} else {

   260

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

   261

			}

   262

   263

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

   264

		}

   265

   266

		/* Get industry ID at offset param */

   267

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

   268

   269

		/* Get random tile bits at offset param */

   270

		case 0x61:

   271

			tile = GetNearbyTile(parameter, tile);

   272

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

   273

   274

		/* Land info of nearby tiles */

   275

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

   276

   277

		/* Animation stage of nearby tiles */

   278

		case 0x63:

   279

			tile = GetNearbyTile(parameter, tile);

   280

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

   281

				return GetIndustryAnimationState(tile);

   282

			}

   283

			return 0xFFFFFFFF;

   284

   285

		/* Distance of nearest industry of given type */

   286

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

   287

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

   288

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

   289

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

   290

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

   291

   292

		/* Count of industry, distance of closest instance

   293

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

   294

		case 0x67:

   295

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

   296

   297

		/* Get a variable from the persistent storage */

   298

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

   299

   303

		/* Industry structure access*/

   304

		case 0x80: return industry->xy;

   305

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

   306

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

   307

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

   308

		case 0x83:

   309

		case 0x84:

   310

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

   311

		case 0x86: return industry->width;

   312

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

   313

		/*  */

   314

		case 0x88:

   315

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

   316

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

   317

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

   318

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

   319

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

   320

		case 0x8E:

   321

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

   322

		case 0x90:

   323

		case 0x91:

   324

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

   325

		case 0x93: return industry->prod_level;

   326

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

   327

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

   328

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

   329

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

   330

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

   331

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

   332

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

   333

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

   334

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

   335

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

   336

		/* fraction of cargo transported LAST month. */

   337

		case 0x9C:

   338

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

   339

		/* amount of cargo produced LAST month. */

   340

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

   341

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

   342

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

   343

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

   344

		/* amount of cargo transported last month. */

   345

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

   346

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

   347

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

   348

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

   349

   350

		case 0xA6: return industry->type;

   351

		case 0xA7: return industry->founder;

   352

		case 0xA8: return industry->random_color;

   354

		case 0xAA: return industry->counter;

   355

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

   356

		case 0xAC: return industry->was_cargo_delivered;

   357

   358

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

   359

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

   360

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

   361

	}

   362

   363

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

   364

   365

	*available = false;

   366

	return (uint32)-1;

   367

}

   368

   369

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

   370

{

   371

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

   372

	return NULL;

   373

}

   374

   375

static uint32 IndustryGetRandomBits(const ResolverObject *object)

   376

{

   377

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

   378

}

   379

   380

static uint32 IndustryGetTriggers(const ResolverObject *object)

   381

{

   382

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

   383

}

   384

   385

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

   386

{

   387

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

   388

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

   389

}

   390

   392

{

   393

	res->GetRandomBits = IndustryGetRandomBits;

   394

	res->GetTriggers   = IndustryGetTriggers;

   395

	res->SetTriggers   = IndustrySetTriggers;

   396

	res->GetVariable   = IndustryGetVariable;

   397

	res->ResolveReal   = IndustryResolveReal;

   398

   399

	res->psa             = &indus->psa;

   400

	res->u.industry.tile = tile;

   401

	res->u.industry.ind  = indus;

   402

	res->u.industry.gfx  = INVALID_INDUSTRYTILE;

   404

   405

	res->callback        = CBID_NO_CALLBACK;

   406

	res->callback_param1 = 0;

   407

	res->callback_param2 = 0;

   408

	res->last_value      = 0;

   409

	res->trigger         = 0;

   410

	res->reseed          = 0;

   411

}

   412

   413

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

   414

{

   415

	ResolverObject object;

   416

	const SpriteGroup *group;

   417

   419

	object.callback = callback;

   420

	object.callback_param1 = param1;

   421

	object.callback_param2 = param2;

   422

   423

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

   424

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

   425

   426

	return group->g.callback.result;

   427

}

   428

   429

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

   430

{

   431

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

   432

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

   433

   434

	if (object->scope == VSG_SCOPE_PARENT) {

   435

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

   436

	}

   437

   438

	switch (variable) {

   439

		case 0x80: return tile;

   440

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

   441

   442

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

   443

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

   444

		case 0x83:

   445

		case 0x84:

   446

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

   447

   448

		/* Number of the layout */

   449

		case 0x86: return industry->selected_layout;

   450

   451

		/* Ground type */

   452

		case 0x87: return GetTerrainType(tile);

   453

   454

		/* Town zone */

   455

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

   456

   457

		/* Manhattan distance of the closest town */

   458

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

   459

   460

		/* Lowest height of the tile */

   461

		case 0x8A: return GetTileZ(tile);

   462

   463

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

   464

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

   465

   466

		/* Square of Euclidian distance from town */

   467

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

   468

	}

   469

   470

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

   471

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

   472

}

   473

   474

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

   475

{

   476

	const IndustrySpec *indspec = GetIndustrySpec(type);

   477

   478

	ResolverObject object;

   479

	const SpriteGroup *group;

   480

   481

	Industry ind;

   482

	ind.index = INVALID_INDUSTRY;

   483

	ind.xy = tile;

   484

	ind.width = 0;

   485

	ind.type = type;

   486

	ind.selected_layout = itspec_index;

   487

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

   488

   490

	object.GetVariable = IndustryLocationGetVariable;

   491

	object.callback = CBID_INDUSTRY_LOCATION;

   492

   493

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

   494

   495

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

   496

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

   497

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

   498

   499

	/* Copy some parameters from the registers to the error message text ref. stack */

   500

	SwitchToErrorRefStack();

   501

	PrepareTextRefStackUsage(4);

   502

	SwitchToNormalRefStack();

   503

   504

	switch (group->g.callback.result) {

   505

		case 0x400: return true;

   506

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE; break;

   507

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; break;