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

	best_dist = DistanceManhattan(tile, t);

    52

    53

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

    54

		int dist = DistanceManhattan(tile, t);

    55

		if (dist < best_dist) {

    56

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

    57

		} else {

    58

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

    59

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

    60

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

    61

			if (TileX(tile) > TileX(t)) {

    62

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

    63

				 * higher or equal distance than the best distance */

    64

				t |= MapMaxX();

    65

				continue;

    66

			} else {

    67

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

    68

				 * higher or equal distance than the best distance */

    69

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

    70

				continue;

    71

			}

    72

		}

    73

	}

    74

    75

	return best_dist;

    76

}

    77

    78

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

    79

 * industry, and/or the same grf file

    80

 * @param new_tile TileIndex of the tile to query

    81

 * @param old_tile TileIndex of the reference tile

    82

 * @param i Industry to which old_tile belongs to

    83

 * @return value encoded as per NFO specs */

    84

uint32 GetIndustryIDAtOffset(TileIndex new_tile, TileIndex old_tile, const Industry *i)

    85

{

    86

	if (IsTileType(new_tile, MP_INDUSTRY)) {  // Is this an industry tile?

    87

    88

		if (GetIndustryIndex(new_tile) == i->index) {  // Does it belong to the same industry?

    89

			IndustryGfx gfx = GetIndustryGfx(new_tile);

    90

			const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);

    91

			const IndustryTileSpec *indold = GetIndustryTileSpec(GetIndustryGfx(old_tile));

    92

    93

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

    94

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

    95

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

    96

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

    97

				} else { // yes.  FInd out if it is from the same grf file or not

    98

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

    99

   100

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

   101

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

   102

					} else {

   103

						return 0xFFFE; // not the same grf file

   104

					}

   105

				}

   106

			} else {

   107

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

   108

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

   109

						return indtsp->grf_prop.local_id;

   110

					} else {

   111

						return 0xFFFE;  // Defined in another grf file

   112

					}

   113

				} else {  // tile has no spritegroup

   114

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

   115

				}

   116

			}

   117

		}

   118

	}

   119

   120

	return 0xFFFF; // tile is not an industry one or  does not belong to the current industry

   121

}

   122

   123

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

   124

{

   125

	uint32 best_dist = MAX_UVALUE(uint32);

   126

	const Industry *i;

   127

	FOR_ALL_INDUSTRIES(i) {

   128

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

   129

   130

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

   131

	}

   132

   133

	return best_dist;

   134

}

   135

   136

/** Implementation of both var 67 and 68

   137

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

   138

 * function.

   139

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

   140

 * @param layout_filter on what layout do we filter?

   141

 * @param current Industry for which the inquiry is made

   142

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

   143

 */

   144

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

   145

{

   146

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

   147

	IndustryType ind_index;

   148

	uint32 closest_dist = MAX_UVALUE(uint32);

   149

	byte count = 0;

   150

   151

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

   152

	switch (GrfID) {

   153

		case 0:  // this is a default industry type

   154

			ind_index = param_setID;

   155

			break;

   156

   157

		case 0xFFFFFFFF: // current grf

   158

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

   159

			/*Fall through*/

   160

   161

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

   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, (object->u.industry_location.spec->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);

   212

   213

		/* Layout number */

   214

		case 0x44: return industry->selected_layout;

   215

   216

		/* Get industry ID at offset param */

   217

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

   218

   219

		case 0x61: return 0; // Get random tile bits at offset param

   220

   221

		/* Land info of nearby tiles */

   222

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

   223

   224

		/* Animation stage of nearby tiles */

   225

		case 0x63: {

   226

			tile = GetNearbyTile(parameter, tile);

   227

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

   228

				return GetIndustryAnimationState(tile);

   229

			}

   230

			return 0xFFFFFFFF;

   231

		}

   232

   233

		/* Distance of nearest industry of given type */

   234

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

   235

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

   236

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

   237

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

   238

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

   239

   240

		/* Count of industry, distance of closest instance

   241

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

   242

		case 0x67:

   243

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

   244

   245

		/* Industry structure access*/

   246

		case 0x80: return industry->xy;

   247

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

   248

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

   249

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

   250

		case 0x83:

   251

		case 0x84:

   252

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

   253

		case 0x86: return industry->width;

   254

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

   255

		/*  */

   256

		case 0x88:

   257

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

   258

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

   259

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

   260

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

   261

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

   262

		case 0x8E:

   263

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

   264

		case 0x90:

   265

		case 0x91:

   266

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

   267

		case 0x93: return industry->prod_level;

   268

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

   269

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

   270

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

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

		/* fraction of cargo transported LAST month. */

   279

		case 0x9C:

   280

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

   281

		/* amount of cargo produced LAST month. */

   282

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

   283

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

   284

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

   285

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

   286

		/* amount of cargo transported last month. */

   287

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

   288

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

   289

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

   290

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

   291

   292

		case 0xA6: return industry->type;

   293

		case 0xA7: return industry->founder;

   294

		case 0xA8: return industry->random_color;

   295

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

   296

		case 0xAA: return industry->counter;

   297

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

   298

		case 0xAC: return industry->was_cargo_delivered;

   299

   300

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

   301

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

   302

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

   303

	}

   304

   305

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

   306

   307

	*available = false;

   308

	return (uint32)-1;

   309

}

   310

   311

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

   312

{

   313

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

   314

	return NULL;

   315

}

   316

   317

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

   318

{

   319

	res->GetRandomBits = IndustryTileGetRandomBits;

   320

	res->GetTriggers   = IndustryTileGetTriggers;

   321

	res->SetTriggers   = IndustryTileSetTriggers;

   322

	res->GetVariable   = IndustryGetVariable;

   323

	res->ResolveReal   = IndustryResolveReal;

   324

   325

	res->u.industry.tile = tile;

   326

	res->u.industry.ind  = indus;

   327

	res->u.industry.gfx  = INVALID_INDUSTRYTILE;

   328

   329

	res->callback        = CBID_NO_CALLBACK;

   330

	res->callback_param1 = 0;

   331

	res->callback_param2 = 0;

   332

	res->last_value      = 0;

   333

	res->trigger         = 0;

   334

	res->reseed          = 0;

   335

}

   336

   337

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

   338

{

   339

	ResolverObject object;

   340

	const SpriteGroup *group;

   341

   342

	NewIndustryResolver(&object, tile, industry);

   343

	object.callback = callback;

   344

	object.callback_param1 = param1;

   345

	object.callback_param2 = param2;

   346

   347

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

   348

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

   349

   350

	return group->g.callback.result;

   351

}

   352

   353

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

   354

{

   355

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

   356

   357

	if (object->scope == VSG_SCOPE_PARENT) {

   358

		return TownGetVariable(variable, parameter, available, ClosestTownFromTile(tile, (uint)-1));

   359

	}

   360

   361

	switch (variable) {

   362

		/* Land info of nearby tiles */

   363

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

   364

   365

		/* Distance of nearest industry of given type */

   366

		case 0x64: return GetClosestIndustry(tile, MapNewGRFIndustryType(parameter, object->u.industry_location.spec->grf_prop.grffile->grfid), NULL);

   367

   368

		/* Location where to build the industry */

   369

		case 0x80: return tile;

   370

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

   371

   372

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

   373

		case 0x82: return ClosestTownFromTile(tile, (uint)-1)->index;

   374

		case 0x83:

   375

		case 0x84:

   376

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

   377

   378

		/* Number of the layout */

   379

		case 0x86: return object->u.industry_location.itspec_index;

   380

   381

		/* Ground type */

   382

		case 0x87: return GetTerrainType(tile);

   383

   384

		/* Town zone */

   385

		case 0x88: return GetTownRadiusGroup(ClosestTownFromTile(tile, (uint)-1), tile);

   386

   387

		/* Manhattan distance of the closest town */

   388

		case 0x89: return min(DistanceManhattan(ClosestTownFromTile(tile, (uint)-1)->xy, tile), 255);

   389

   390

		/* Lowest height of the tile */

   391

		case 0x8A: return GetTileZ(tile);

   392

   393

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

   394

		case 0x8B: return GetClosestWaterDistance(tile, (object->u.industry_location.spec->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0);

   395

   396

		/* Square of Euclidian distance from town */

   397

		case 0x8D: return min(DistanceSquare(ClosestTownFromTile(tile, (uint)-1)->xy, tile), 65535);

   398

	}

   399

   400

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

   401

   402

	*available = false;

   403

	return (uint32)-1;

   404

}

   405

   406

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

   407

{

   408

	const IndustrySpec *indspec = GetIndustrySpec(type);

   409

   410

	ResolverObject object;

   411

	const SpriteGroup *group;

   412

   413

	NewIndustryResolver(&object, tile, NULL);

   414

	object.GetVariable = IndustryLocationGetVariable;

   415

	object.callback = CBID_INDUSTRY_LOCATION;

   416

	object.u.industry_location.tile = tile;

   417

	object.u.industry_location.spec = indspec;

   418

	object.u.industry_location.itspec_index = itspec_index;

   419

   420

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

   421

   422

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

   423

   424

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

   425

		case 0x400: return true;

   426

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE; break;

   427

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; break;

   428

		case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT; break;

   429

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

   430

	}

   431

   432

	return false;

   433

}

   434

   435

bool CheckIfCallBackAllowsAvailability(IndustryType type, IndustryAvailabilityCallType creation_type)

   436

{

   437

	const IndustrySpec *indspec = GetIndustrySpec(type);

   438

   439

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

   440

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

   441

		if (res != CALLBACK_FAILED) {

   442

			return (res == 0);

   443

		}

   444

	}

   445

	return true;

   446

}

   447

   448

static int32 DerefIndProd(uint field, bool use_register)

   449

{

   450

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

   451

}

   452

   453

/**

   454

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

   455

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

   456

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

   457

 */

   458

void IndustryProductionCallback(Industry *ind, int reason)

   459

{

   460

	ResolverObject object;

   461

	NewIndustryResolver(&object, ind->xy, ind);

   462

	object.callback_param2 = reason;

   463

   464

	for (uint loop = 0;; loop++) {

   465

		SB(object.callback_param2, 8, 16, loop);

   466

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

   467

		if (group == NULL || group->type != SGT_INDUSTRY_PRODUCTION) break;

   468

   469

		bool deref = (group->g.indprod.version == 1);

   470

   471

		for (uint i = 0; i < 3; i++) {

   472

			ind->incoming_cargo_waiting[i] = clamp(ind->incoming_cargo_waiting[i] - DerefIndProd(group->g.indprod.substract_input[i], deref), 0, 0xFFFF);

   473

		}

   474

		for (uint i = 0; i < 2; i++) {

   475

			ind->produced_cargo_waiting[i] = clamp(ind->produced_cargo_waiting[i] + DerefIndProd(group->g.indprod.add_output[i], deref), 0, 0xFFFF);

   476

		}

   477

   478

		int32 again = DerefIndProd(group->g.indprod.again, deref);

   479

		if (again == 0) break;

   480

   481

		SB(object.callback_param2, 24, 8, again);

   482

	}

   483

   484

	InvalidateWindow(WC_INDUSTRY_VIEW, ind->index);

   485

}