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_commons.h"

    20

#include "newgrf_text.h"

    21

#include "newgrf_town.h"

    22

#include "date.h"

    23

    24

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

    25

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

    26

 * translated when the idustry spec is set. */

    27

IndustryOverrideManager _industry_mngr(NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, INVALID_INDUSTRYTYPE);

    28

IndustryTileOverrideManager _industile_mngr(NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, INVALID_INDUSTRYTILE);

    29

    30

IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)

    31

{

    32

	if (grf_type == IT_INVALID) return IT_INVALID;

    33

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

    34

    35

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

    36

}

    37

    38

/**

    39

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

    40

 * @param tile  the tile to find the distance too

    41

 * @param water whether to find water or land

    42

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

    43

 */

    44

static uint GetClosestWaterDistance(TileIndex tile, bool water)

    45

{

    46

	TileIndex t;

    47

	int best_dist;

    48

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

    49

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

    50

	}

    51

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

    52

	best_dist = DistanceManhattan(tile, t);

    53

    54

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

    55

		int dist = DistanceManhattan(tile, t);

    56

		if (dist < best_dist) {

    57

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

    58

		} else {

    59

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

    60

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

    61

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

    62

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

    63

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

    64

				 * higher or equal distance than the best distance */

    65

				t |= MapMaxX();

    66

				continue;

    67

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

    68

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

    69

				 * higher or equal distance than the best distance */

    70

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

    71

				continue;

    72

			}

    73

		}

    74

	}

    75

    76

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

    77

}

    78

    79

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

    80

 * industry, and/or the same grf file

    81

 * @param tile TileIndex of the tile to query

    82

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

    83

 * @return value encoded as per NFO specs */

    84

uint32 GetIndustryIDAtOffset(TileIndex tile, const Industry *i)

    85

{

    87

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

    88

		return 0xFFFF;

    89

	}

    90

    91

	IndustryGfx gfx = GetCleanIndustryGfx(tile);

    92

	const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);

    93

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

    94

    95

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

    96

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

    97

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

    98

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

    99

		}

   100

		/* Not overriden */

   101

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

   102

   103

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

   104

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

   105

		} else {

   106

			return 0xFFFE; // not the same grf file

   107

		}

   108

	}

   109

	/* Not an 'old type' tile */

   110

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

   111

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

   112

			return indtsp->grf_prop.local_id;

   113

		} else {

   114

			return 0xFFFE; // Defined in another grf file

   115

		}

   116

	}

   117

	/* The tile has no spritegroup */

   118

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

   119

}

   120

   121

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

   122

{

   123

	uint32 best_dist = MAX_UVALUE(uint32);

   124

	const Industry *i;

   125

	FOR_ALL_INDUSTRIES(i) {

   126

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

   127

   128

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

   129

	}

   130

   131

	return best_dist;

   132

}

   133

   134

/** Implementation of both var 67 and 68

   135

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

   136

 * function.

   137

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

   138

 * @param layout_filter on what layout do we filter?

   139

 * @param current Industry for which the inquiry is made

   140

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

   141

 */

   142

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

   143

{

   144

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

   145

	IndustryType ind_index;

   146

	uint32 closest_dist = MAX_UVALUE(uint32);

   147

	byte count = 0;

   148

   149

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

   150

	switch (GrfID) {

   151

		case 0:  // this is a default industry type

   152

			ind_index = param_setID;

   153

			break;

   154

   155

		case 0xFFFFFFFF: // current grf

   156

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

   157

			/* Fall through */

   158

   159

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

   160

			ind_index = MapNewGRFIndustryType(param_setID, GrfID);

   161

			break;

   162

	}

   163

   164

	if (layout_filter == 0) {

   165

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

   166

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

   167

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

   168

		count = GetIndustryTypeCount(ind_index);

   169

	} else {

   170

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

   171

		 * Unfortunately, we have to do it manually */

   172

		const Industry *i;

   173

		FOR_ALL_INDUSTRIES(i) {

   174

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

   175

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

   176

				count++;

   177

			}

   178

		}

   179

	}

   180

   181

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

   182

}

   183

   184

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

   185

 * @param variable that is queried

   186

 * @param parameter unused

   187

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

   188

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

   189

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

   190

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

   191

{

   192

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

   193

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

   194

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

   195

   196

	switch (variable) {

   197

		case 0x40:

   198

		case 0x41:

   199

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

   200

			uint16 callback = indspec->callback_flags;

   201

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

   202

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

   203

			} else {

   204

				return 0;

   205

			}

   206

		}

   207

   208

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

   209

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

   210

   211

		/* Layout number */

   212

		case 0x44: return industry->selected_layout;

   213

   214

		/* player info */

   215

		case 0x45: {

   216

			byte colours;

   217

			bool is_ai = false;

   218

   219

			if (IsValidPlayer(industry->founder)) {

   220

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

   221

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

   222

   223

				is_ai = p->is_ai;

   224

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

   225

			} else {

   226

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

   227

			}

   228

   229

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

   230

		}

   231

   232

		/* Get industry ID at offset param */

   233

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

   234

   235

		/* Get random tile bits at offset param */

   236

		case 0x61:

   237

			tile = GetNearbyTile(parameter, tile);

   238

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

   239

   240

		/* Land info of nearby tiles */

   241

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

   242

   243

		/* Animation stage of nearby tiles */

   244

		case 0x63:

   245

			tile = GetNearbyTile(parameter, tile);

   246

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

   247

				return GetIndustryAnimationState(tile);

   248

			}

   249

			return 0xFFFFFFFF;

   250

   251

		/* Distance of nearest industry of given type */

   252

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

   253

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

   254

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

   255

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

   256

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

   257

   258

		/* Count of industry, distance of closest instance

   259

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

   260

		case 0x67:

   261

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

   262

   263

		/* Get a variable from the persistent storage */

   264

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

   265

   266

		/* Industry structure access*/

   267

		case 0x80: return industry->xy;

   268

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

   269

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

   270

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

   271

		case 0x83:

   272

		case 0x84:

   273

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

   274

		case 0x86: return industry->width;

   275

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

   276

		/*  */

   277

		case 0x88:

   278

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

   279

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

   280

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

   281

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

   282

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

   283

		case 0x8E:

   284

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

   285

		case 0x90:

   286

		case 0x91:

   287

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

   288

		case 0x93: return industry->prod_level;

   289

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

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

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

   299

		/* fraction of cargo transported LAST month. */

   300

		case 0x9C:

   301

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

   302

		/* amount of cargo produced LAST month. */

   303

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

   304

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

   305

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

   306

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

   307

		/* amount of cargo transported last month. */

   308

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

   309

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

   310

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

   311

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

   312

   313

		case 0xA6: return industry->type;

   314

		case 0xA7: return industry->founder;

   315

		case 0xA8: return industry->random_color;

   316

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

   317

		case 0xAA: return industry->counter;

   318

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

   319

		case 0xAC: return industry->was_cargo_delivered;

   320

   321

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

   322

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

   323

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

   324

	}

   325

   326

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

   327

   328

	*available = false;

   329

	return (uint32)-1;

   330

}

   331

   332

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

   333

{

   334

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

   335

	return NULL;

   336

}

   337

   338

static uint32 IndustryGetRandomBits(const ResolverObject *object)

   339

{

   340

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

   341

}

   342

   343

static uint32 IndustryGetTriggers(const ResolverObject *object)

   344

{

   345

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

   346

}

   347

   348

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

   349

{

   350

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

   351

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

   352

}

   353

   354

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

   355

{

   356

	res->GetRandomBits = IndustryGetRandomBits;

   357

	res->GetTriggers   = IndustryGetTriggers;

   358

	res->SetTriggers   = IndustrySetTriggers;

   359

	res->GetVariable   = IndustryGetVariable;

   360

	res->ResolveReal   = IndustryResolveReal;

   361

   362

	res->psa             = &indus->psa;

   363

	res->u.industry.tile = tile;

   364

	res->u.industry.ind  = indus;

   365

	res->u.industry.gfx  = INVALID_INDUSTRYTILE;

   366

   367

	res->callback        = CBID_NO_CALLBACK;

   368

	res->callback_param1 = 0;

   369

	res->callback_param2 = 0;

   370

	res->last_value      = 0;

   371

	res->trigger         = 0;

   372

	res->reseed          = 0;

   373

}

   374

   375

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

   376

{

   377

	ResolverObject object;

   378

	const SpriteGroup *group;

   379

   380

	NewIndustryResolver(&object, tile, industry);

   381

	object.callback = callback;

   382

	object.callback_param1 = param1;

   383

	object.callback_param2 = param2;

   384

   385

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

   386

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

   387

   388

	return group->g.callback.result;

   389

}

   390

   391

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

   392

{

   393

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

   394

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

   395

   396

	if (object->scope == VSG_SCOPE_PARENT) {

   397

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

   398

	}

   399

   400

	switch (variable) {

   401

		case 0x80: return tile;

   402

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

   403

   404

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

   405

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

   406

		case 0x83:

   407

		case 0x84:

   408

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

   409

   410

		/* Number of the layout */

   411

		case 0x86: return industry->selected_layout;

   412

   413

		/* Ground type */

   414

		case 0x87: return GetTerrainType(tile);

   415

   416

		/* Town zone */

   417

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

   418

   419

		/* Manhattan distance of the closest town */

   420

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

   421

   422

		/* Lowest height of the tile */

   423

		case 0x8A: return GetTileZ(tile);

   424

   425

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

   426

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

   427

   428

		/* Square of Euclidian distance from town */

   429

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

   430

	}

   431

   432

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

   433

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

   434

}

   435

   436

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

   437

{

   438

	const IndustrySpec *indspec = GetIndustrySpec(type);

   439

   440

	ResolverObject object;

   441

	const SpriteGroup *group;

   442

   443

	Industry ind;

   444

	ind.index = INVALID_INDUSTRY;

   445

	ind.xy = tile;

   446

	ind.width = 0;

   447

	ind.type = type;

   448

	ind.selected_layout = itspec_index;

   449

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

   450

   451

	NewIndustryResolver(&object, tile, &ind);

   452

	object.GetVariable = IndustryLocationGetVariable;

   453

	object.callback = CBID_INDUSTRY_LOCATION;

   454

   455

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

   456

   457

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

   458

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

   459

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

   460

   466

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

   467

		case 0x400: return true;

   468

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE; break;

   469

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; break;

   470

		case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT; break;

   471

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

   472

	}

   473

   474

	return false;

   475

}

   476

   477

bool CheckIfCallBackAllowsAvailability(IndustryType type, IndustryAvailabilityCallType creation_type)

   478

{

   479

	const IndustrySpec *indspec = GetIndustrySpec(type);

   480

   481

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

   482

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

   483

		if (res != CALLBACK_FAILED) {

   484

			return (res == 0);

   485

		}

   486

	}

   487

	return true;

   488

}

   489

   490

static int32 DerefIndProd(uint field, bool use_register)

   491

{

   492

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

   493

}

   494

   495

/**

   496

 * Get the industry production callback and apply it to the industry.

   497

 * @param ind    the industry this callback has to be called for

   498

 * @param reason the reason it is called (0 = incoming cargo, 1 = periodic tick callback)

   499