1

/* $Id$ */

     2

     3

/** @file newgrf_industries.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "macros.h"

    10

#include "variables.h"

    11

#include "landscape.h"

    12

#include "table/strings.h"

    13

#include "industry.h"

    14

#include "industry_map.h"

    15

#include "newgrf.h"

    16

#include "newgrf_callbacks.h"

    17

#include "newgrf_spritegroup.h"

    18

#include "newgrf_industries.h"

    19

#include "newgrf_industrytiles.h"

    20

#include "newgrf_commons.h"

    21

#include "newgrf_text.h"

    22

#include "newgrf_town.h"

    23

#include "date.h"

    24

    25

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

    26

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

    27

 * translated when the idustry spec is set. */

    28

IndustryOverrideManager _industry_mngr(NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, INVALID_INDUSTRYTYPE);

    29

IndustryTileOverrideManager _industile_mngr(NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, INVALID_INDUSTRYTILE);

    30

    31

IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)

    32

{

    33

	if (grf_type == IT_INVALID) return IT_INVALID;

    34

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

    35

    36

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

    37

}

    38

    39

/**

    40

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

    41

 * @param tile  the tile to find the distance too

    42

 * @param water whether to find water or land

    43

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

    44

 */

    45

static uint GetClosestWaterDistance(TileIndex tile, bool water)

    46

{

    47

	TileIndex t;

    48

	int best_dist;

    49

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

    50

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

    51

	}

    52

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

    53

	best_dist = DistanceManhattan(tile, t);

    54

    55

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

    56

		int dist = DistanceManhattan(tile, t);

    57

		if (dist < best_dist) {

    58

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

    59

		} else {

    60

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

    61

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

    62

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

    63

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

    64

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

    65

				 * higher or equal distance than the best distance */

    66

				t |= MapMaxX();

    67

				continue;

    68

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

    69

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

    70

				 * higher or equal distance than the best distance */

    71

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

    72

				continue;

    73

			}

    74

		}

    75

	}

    76

    77

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

    78

}

    79

    80

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

    81

 * industry, and/or the same grf file

    82

 * @param tile TileIndex of the tile to query

    83

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

    84

 * @return value encoded as per NFO specs */

    85

uint32 GetIndustryIDAtOffset(TileIndex tile, const Industry *i)

    86

{

    87

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

    88

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

    89

		return 0xFFFF;

    90

	}

    91

    92

	IndustryGfx gfx = GetCleanIndustryGfx(tile);

    93

	const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);

    94

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

    95

    96

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

    97

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

    98

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

    99

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

   100

		}

   101

		/* Not overriden */

   102

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

   103

   104

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

   105

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

   106

		} else {

   107

			return 0xFFFE; // not the same grf file

   108

		}

   109

	}

   110

	/* Not an 'old type' tile */

   111

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

   112

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

   113

			return indtsp->grf_prop.local_id;

   114

		} else {

   115

			return 0xFFFE; // Defined in another grf file

   116

		}

   117

	}

   118

	/* The tile has no spritegroup */

   119

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

   120

}

   121

   122

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

   123

{

   124

	uint32 best_dist = MAX_UVALUE(uint32);

   125

	const Industry *i;

   126

	FOR_ALL_INDUSTRIES(i) {

   127

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

   128

   129

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

   130

	}

   131

   132

	return best_dist;

   133

}

   134

   135

/** Implementation of both var 67 and 68

   136

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

   137

 * function.

   138

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

   139

 * @param layout_filter on what layout do we filter?

   140

 * @param current Industry for which the inquiry is made

   141

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

   142

 */

   143

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

   144

{

   145

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

   146

	IndustryType ind_index;

   147

	uint32 closest_dist = MAX_UVALUE(uint32);

   148

	byte count = 0;

   149

   150

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

   151

	switch (GrfID) {

   152

		case 0:  // this is a default industry type

   153

			ind_index = param_setID;

   154

			break;

   155

   156

		case 0xFFFFFFFF: // current grf

   157

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

   158

			/* Fall through */

   159

   160

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

   161

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

   162

			ind_index = MapNewGRFIndustryType(param_setID, GrfID);

   163

			break;

   164

	}

   165

   166

	if (layout_filter == 0) {

   167

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

   168

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

   169

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

   170

		count = GetIndustryTypeCount(ind_index);

   171

	} else {

   172

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

   173

		 * Unfortunately, we have to do it manually */

   174

		const Industry *i;

   175

		FOR_ALL_INDUSTRIES(i) {

   176

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

   177

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

   178

				count++;

   179

			}

   180

		}

   181

	}

   182

   183

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

   184

}

   185

   186

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

   187

 * @param variable that is queried

   188

 * @param parameter unused

   189

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

   190

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

   191

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

   192

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

   193

{

   194

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

   195

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

   196

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

   197

   198

	switch (variable) {

   199

		case 0x40:

   200

		case 0x41:

   201

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

   202

			uint16 callback = indspec->callback_flags;

   203

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

   204

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

   205

			} else {

   206

				return 0;

   207

			}

   208

		}

   209

   210

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

   211

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

   212

   213

		/* Layout number */

   214

		case 0x44: return industry->selected_layout;

   215

   216

		/* player info */

   217

		case 0x45: {

   218

			byte colours;

   219

			bool is_ai = false;

   220

   221

			if (IsValidPlayer(industry->founder)) {

   222

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

   223

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

   224

   225

				is_ai = p->is_ai;

   226

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

   227

			} else {

   228

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

   229

			}

   230

   231

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

   232

		}

   233

   234

		/* Get industry ID at offset param */

   235

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

   236

   237

		/* Get random tile bits at offset param */

   238

		case 0x61:

   239

			tile = GetNearbyTile(parameter, tile);

   240

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

   241

   242

		/* Land info of nearby tiles */

   243

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

   244

   245

		/* Animation stage of nearby tiles */

   246

		case 0x63:

   247

			tile = GetNearbyTile(parameter, tile);

   248

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

   249

				return GetIndustryAnimationState(tile);

   250

			}

   251

			return 0xFFFFFFFF;

   252

   253

		/* Distance of nearest industry of given type */

   254

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

   255

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

   256

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

   257

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

   258

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

   259

   260

		/* Count of industry, distance of closest instance

   261

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

   262

		case 0x67:

   263

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

   264

   265

		/* Get a variable from the persistent storage */

   266

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

   267

   268

		/* Industry structure access*/

   269

		case 0x80: return industry->xy;

   270

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

   271

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

   272

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

   273

		case 0x83:

   274

		case 0x84:

   275

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

   276

		case 0x86: return industry->width;

   277

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

   278

		/*  */

   279

		case 0x88:

   280

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

   281

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

   282

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

   283

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

   284

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

   285

		case 0x8E:

   286

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

   287

		case 0x90:

   288

		case 0x91:

   289

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

   290

		case 0x93: return industry->prod_level;

   291

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

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

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

   299

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

   300

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

   301

		/* fraction of cargo transported LAST month. */

   302

		case 0x9C:

   303

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

   304

		/* amount of cargo produced LAST month. */

   305

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

   306

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

   307

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

   308

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

   309

		/* amount of cargo transported last month. */

   310

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

   311

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

   312

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

   313

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

   314

   315

		case 0xA6: return industry->type;

   316

		case 0xA7: return industry->founder;

   317

		case 0xA8: return industry->random_color;

   318

		case 0xA9: return clamp(0, industry->last_prod_year - 1920, 255);

   319

		case 0xAA: return industry->counter;

   320

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

   321

		case 0xAC: return industry->was_cargo_delivered;

   322

   323

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

   324

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

   325

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

   326

	}

   327

   328

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

   329

   330

	*available = false;

   331

	return (uint32)-1;

   332

}

   333

   334

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

   335

{

   336

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

   337

	return NULL;

   338

}

   339

   340

static uint32 IndustryGetRandomBits(const ResolverObject *object)

   341

{

   342

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

   343

}

   344

   345

static uint32 IndustryGetTriggers(const ResolverObject *object)

   346

{

   347

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

   348

}

   349

   350

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

   351

{

   352

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

   353

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

   354

}

   355

   356

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

   357

{

   358

	res->GetRandomBits = IndustryGetRandomBits;

   359

	res->GetTriggers   = IndustryGetTriggers;

   360

	res->SetTriggers   = IndustrySetTriggers;

   361

	res->GetVariable   = IndustryGetVariable;

   362

	res->ResolveReal   = IndustryResolveReal;

   363

   364

	res->psa             = &indus->psa;

   365

	res->u.industry.tile = tile;

   366

	res->u.industry.ind  = indus;

   367

	res->u.industry.gfx  = INVALID_INDUSTRYTILE;

   368

   369

	res->callback        = CBID_NO_CALLBACK;

   370

	res->callback_param1 = 0;

   371

	res->callback_param2 = 0;

   372

	res->last_value      = 0;

   373

	res->trigger         = 0;

   374

	res->reseed          = 0;

   375

}

   376

   377

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

   378

{

   379

	ResolverObject object;

   380

	const SpriteGroup *group;

   381

   382

	NewIndustryResolver(&object, tile, industry);

   383

	object.callback = callback;

   384

	object.callback_param1 = param1;

   385

	object.callback_param2 = param2;

   386

   387

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

   388

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

   389

   390

	return group->g.callback.result;

   391

}

   392

   393

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

   394

{

   395

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

   396

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

   397

   398

	if (object->scope == VSG_SCOPE_PARENT) {

   399

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

   400

	}

   401

   402

	switch (variable) {

   403

		case 0x80: return tile;

   404

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

   405

   406

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

   407

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

   408

		case 0x83:

   409

		case 0x84:

   410

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

   411

   412

		/* Number of the layout */

   413

		case 0x86: return industry->selected_layout;

   414

   415

		/* Ground type */

   416

		case 0x87: return GetTerrainType(tile);

   417

   418

		/* Town zone */

   419

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

   420

   421

		/* Manhattan distance of the closest town */

   422

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

   423

   424

		/* Lowest height of the tile */

   425

		case 0x8A: return GetTileZ(tile);

   426

   427

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

   428

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

   429

   430

		/* Square of Euclidian distance from town */

   431

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

   432

	}

   433

   434

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

   435

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

   436

}

   437

   438

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

   439

{

   440

	const IndustrySpec *indspec = GetIndustrySpec(type);

   441

   442

	ResolverObject object;

   443

	const SpriteGroup *group;

   444

   445

	Industry ind;

   446

	ind.index = INVALID_INDUSTRY;

   447

	ind.xy = tile;

   448

	ind.width = 0;

   449

	ind.type = type;

   450

	ind.selected_layout = itspec_index;

   451

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

   452

   453

	NewIndustryResolver(&object, tile, &ind);

   454

	object.GetVariable = IndustryLocationGetVariable;

   455

	object.callback = CBID_INDUSTRY_LOCATION;

   456

   457

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

   458

   459

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

   460

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

   461

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

   462

   463

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

   464

	SwitchToErrorRefStack();

   465

	PrepareTextRefStackUsage(4);

   466

	SwitchToNormalRefStack();

   467

   468

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

   469

		case 0x400: return true;

   470

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE; break;

   471

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; break;

   472

		case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT; break;

   473

		default: _error_message = GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 + group->g.callback.result); break;

   474

	}

   475

   476

	return false;

   477

}

   478

   479

bool CheckIfCallBackAllowsAvailability(IndustryType type, IndustryAvailabilityCallType creation_type)

   480

{

   481

	const IndustrySpec *indspec = GetIndustrySpec(type);

   482

   483

	if (HASBIT(indspec->callback_flags, CBM_IND_AVAILABLE)) {

   484

		uint16 res = GetIndustryCallback(CBID_INDUSTRY_AVAILABLE, 0, creation_type, NULL, type, INVALID_TILE);

   485

		if (res != CALLBACK_FAILED) {

   486

			return (res == 0);

   487

		}

   488

	}

   489

	return true;

   490

}

   491

   492

static int32 DerefIndProd(uint field, bool use_register)

   493

{

   494

	return use_register ? (int32)GetRegister(field) : field;

   495

}

   496

   497

/**