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

/**

    45

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

    46

 * @param tile  the tile to find the distance too

    47

 * @param water whether to find water or land

    48

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

    49

 */

    50

static uint GetClosestWaterDistance(TileIndex tile, bool water)

    51

{

    52

	TileIndex t;

    53

	int best_dist;

    54

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

    55

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

    56

	}

    57

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

    58

	best_dist = DistanceManhattan(tile, t);

    59

    60

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

    61

		int dist = DistanceManhattan(tile, t);

    62

		if (dist < best_dist) {

    63

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

    64

		} else {

    65

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

    66

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

    67

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

    68

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

    69

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

    70

				 * higher or equal distance than the best distance */

    71

				t |= MapMaxX();

    72

				continue;

    73

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

    74

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

    75

				 * higher or equal distance than the best distance */

    76

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

    77

				continue;

    78

			}

    79

		}

    80

	}

    81

    82

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

    83

}

    84

    85

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

    86

 * industry, and/or the same grf file

    87

 * @param tile TileIndex of the tile to query

    88

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

    89

 * @return value encoded as per NFO specs */

    90

uint32 GetIndustryIDAtOffset(TileIndex tile, const Industry *i)

    91

{

    92

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

    93

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

    94

		return 0xFFFF;

    95

	}

    96

    97

	IndustryGfx gfx = GetCleanIndustryGfx(tile);

    98

	const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);

    99

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

   100

   101

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

   102

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

   103

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

   104

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

   105

		}

   106

		/* Not overriden */

   107

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

   108

   109

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

   110

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

   111

		} else {

   112

			return 0xFFFE; // not the same grf file

   113

		}

   114

	}

   115

	/* Not an 'old type' tile */

   116

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

   117

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

   118

			return indtsp->grf_prop.local_id;

   119

		} else {

   120

			return 0xFFFE; // Defined in another grf file

   121

		}

   122

	}

   123

	/* The tile has no spritegroup */

   124

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

   125

}

   126

   127

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

   128

{

   129

	uint32 best_dist = UINT32_MAX;

   130

	const Industry *i;

   131

	FOR_ALL_INDUSTRIES(i) {

   132

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

   133

   134

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

   135

	}

   136

   137

	return best_dist;

   138

}

   139

   140

/** Implementation of both var 67 and 68

   141

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

   142

 * function.

   143

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

   144

 * @param layout_filter on what layout do we filter?

   145

 * @param current Industry for which the inquiry is made

   146

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

   147

 */

   148

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

   149

{

   150

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

   151

	IndustryType ind_index;

   152

	uint32 closest_dist = UINT32_MAX;

   153

	byte count = 0;

   154

   155

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

   156

	switch (GrfID) {

   157

		case 0:  // this is a default industry type

   158

			ind_index = param_setID;

   159

			break;

   160

   161

		case 0xFFFFFFFF: // current grf

   162

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

   163

			/* Fall through */

   164

   165

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

   166

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

   167

			ind_index = MapNewGRFIndustryType(param_setID, GrfID);

   168

			break;

   169

	}

   170

   171

	if (layout_filter == 0) {

   172

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

   173

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

   174

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

   175

		count = GetIndustryTypeCount(ind_index);

   176

	} else {

   177

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

   178

		 * Unfortunately, we have to do it manually */

   179

		const Industry *i;

   180

		FOR_ALL_INDUSTRIES(i) {

   181

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

   182

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

   183

				count++;

   184

			}

   185

		}

   186

	}

   187

   188

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

   189

}

   190

   191

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

   192

 * @param variable that is queried

   193

 * @param parameter unused

   194

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

   195

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

   196

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

   197

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

   198

{

   199

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

   200

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

   201

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

   202

	const IndustrySpec *indspec = GetIndustrySpec(type);

   203

   204

	/* Shall the variable get resolved in parent scope and are we not yet in parent scope? */

   205

	if (object->u.industry.gfx == INVALID_INDUSTRYTILE && object->scope == VSG_SCOPE_PARENT) {

   206

		/* Pass the request on to the town of the industry */

   207

		const Town *t;

   208

   209

		if (industry != NULL) {

   210

			t = industry->town;

   211

		} else if (tile != INVALID_TILE) {

   212

			t = ClosestTownFromTile(tile, UINT_MAX);

   213

		} else {

   214

			*available = false;

   215

			return UINT_MAX;

   216

		}

   217

   218

		return TownGetVariable(variable, parameter, available, t);

   219

	}

   220

   221

	if (industry == NULL) {

   222

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

   223

		switch (variable) {

   224

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

   225

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

   226

		}

   227

   228

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

   229

   230

		*available = false;

   231

		return UINT_MAX;

   232

	}

   233

   234

	switch (variable) {

   235

		case 0x40:

   236

		case 0x41:

   237

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

   238

			uint16 callback = indspec->callback_flags;

   239

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

   240

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

   241

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

   242

				} else {

   243

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

   244

				}

   245

			} else {

   246

				return 0;

   247

			}

   248

		}

   249

   250

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

   251

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

   252

   253

		/* Layout number */

   254

		case 0x44: return industry->selected_layout;

   255

   256

		/* player info */

   257

		case 0x45: {

   258

			byte colours;

   259

			bool is_ai = false;

   260

   261

			if (IsValidPlayerID(industry->founder)) {

   262

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

   263

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

   264

   265

				is_ai = p->is_ai;

   266

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

   267

			} else {

   268

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

   269

			}

   270

   271

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

   272

		}

   273

   274

		case 0x46: return industry->construction_date; // Date when built - long format - (in days)

   275

   276

		/* Get industry ID at offset param */

   277

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

   278

   279

		/* Get random tile bits at offset param */

   280

		case 0x61:

   281

			tile = GetNearbyTile(parameter, tile);

   282

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

   283

   284

		/* Land info of nearby tiles */

   285

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

   286

   287

		/* Animation stage of nearby tiles */

   288

		case 0x63:

   289

			tile = GetNearbyTile(parameter, tile);

   290

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

   291

				return GetIndustryAnimationState(tile);

   292

			}

   293

			return 0xFFFFFFFF;

   294

   295

		/* Distance of nearest industry of given type */

   296

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

   297

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

   298

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

   299

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

   300

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

   301

   302

		/* Count of industry, distance of closest instance

   303

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

   304

		case 0x67:

   305

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

   306

   307

		/* Get a variable from the persistent storage */

   308

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

   309

   310

		/* Industry structure access*/

   311

		case 0x80: return industry->xy;

   312

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

   313

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

   314

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

   315

		case 0x83:

   316

		case 0x84:

   317

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

   318

		case 0x86: return industry->width;

   319

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

   320

		/*  */

   321

		case 0x88:

   322

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

   323

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

   324

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

   325

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

   326

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

   327

		case 0x8E:

   328

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

   329

		case 0x90:

   330

		case 0x91:

   331

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

   332

		case 0x93: return industry->prod_level;

   333

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

   334

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

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

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

   343

		/* fraction of cargo transported LAST month. */

   344

		case 0x9C:

   345

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

   346

		/* amount of cargo produced LAST month. */

   347

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

   348

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

   349

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

   350

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

   351

		/* amount of cargo transported last month. */

   352

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

   353

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

   354

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

   355

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

   356

   357

		case 0xA6: return industry->type;

   358

		case 0xA7: return industry->founder;

   359

		case 0xA8: return industry->random_color;

   360

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

   361

		case 0xAA: return industry->counter;

   362

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

   363

		case 0xAC: return industry->was_cargo_delivered;

   364

   365

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

   366

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

   367

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

   368

	}

   369

   370

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

   371

   372

	*available = false;

   373

	return (uint32)-1;

   374

}

   375

   376

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

   377

{

   378

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

   379

	return NULL;

   380

}

   381

   382

static uint32 IndustryGetRandomBits(const ResolverObject *object)

   383

{

   384

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

   385

}

   386

   387

static uint32 IndustryGetTriggers(const ResolverObject *object)

   388

{

   389

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

   390

}

   391

   392

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

   393

{

   394

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

   395

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

   396

}

   397

   398

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

   399

{

   400

	res->GetRandomBits = IndustryGetRandomBits;

   401

	res->GetTriggers   = IndustryGetTriggers;

   402

	res->SetTriggers   = IndustrySetTriggers;

   403

	res->GetVariable   = IndustryGetVariable;

   404

	res->ResolveReal   = IndustryResolveReal;

   405

   406

	res->psa             = &indus->psa;

   407

	res->u.industry.tile = tile;

   408

	res->u.industry.ind  = indus;

   409

	res->u.industry.gfx  = INVALID_INDUSTRYTILE;

   410

	res->u.industry.type = type;

   411

   412

	res->callback        = CBID_NO_CALLBACK;

   413

	res->callback_param1 = 0;

   414

	res->callback_param2 = 0;

   415

	res->last_value      = 0;

   416

	res->trigger         = 0;

   417

	res->reseed          = 0;

   418

	res->count           = 0;

   419

   420

	const IndustrySpec *indspec = GetIndustrySpec(type);

   421

	res->grffile         = (indspec != NULL ? indspec->grf_prop.grffile : NULL);

   422

}

   423

   424

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

   425

{

   426

	ResolverObject object;

   427

	const SpriteGroup *group;

   428

   429

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

   430

	object.callback = callback;

   431

	object.callback_param1 = param1;

   432

	object.callback_param2 = param2;

   433

   434

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

   435

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

   436

   437

	return group->g.callback.result;

   438

}

   439

   440

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

   441

{

   442

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

   443

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

   444

   445

	if (object->scope == VSG_SCOPE_PARENT) {

   446

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

   447

	}

   448

   449

	switch (variable) {

   450

		case 0x80: return tile;

   451

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

   452

   453

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

   454

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

   455

		case 0x83:

   456

		case 0x84:

   457

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

   458

   459

		/* Number of the layout */

   460

		case 0x86: return industry->selected_layout;

   461

   462

		/* Ground type */

   463

		case 0x87: return GetTerrainType(tile);

   464

   465

		/* Town zone */

   466

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

   467

   468

		/* Manhattan distance of the closest town */

   469

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

   470

   471

		/* Lowest height of the tile */

   472

		case 0x8A: return GetTileZ(tile);

   473

   474

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

   475

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

   476

   477

		/* Square of Euclidian distance from town */

   478

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

   479

   480

		/* 32 random bits */

   481

		case 0x8F: return _industry_creation_random_bits;

   482

	}

   483

   484

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

   485

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

   486

}

   487

   488

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

   489

{

   490

	const IndustrySpec *indspec = GetIndustrySpec(type);

   491

   492

	ResolverObject object;

   493

	const SpriteGroup *group;

   494

   495

	Industry ind;