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

    23

#include "company_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

 * @return distance to nearest water (max 0x7F) / land (max 0x1FF; 0x200 if there is no land)

    49

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

    50

 */

    51

static uint GetClosestWaterDistance(TileIndex tile, bool water)

    52

{

    53

	if (IsTileType(tile, MP_WATER) == water) return 0;

    54

    55

	uint max_dist = water ? 0x7F : 0x200;

    56

    57

	int x = TileX(tile);

    58

	int y = TileY(tile);

    59

    60

	uint max_x = MapMaxX();

    61

	uint max_y = MapMaxY();

    62

    63

	/* go in a 'spiral' with increasing manhattan distance in each iteration */

    64

	for (uint dist = 1; dist < max_dist; dist++) {

    65

		/* next 'diameter' */

    66

		y--;

    67

    68

		/* going counter-clockwise around this square */

    69

		for (DiagDirection dir = DIAGDIR_BEGIN; dir < DIAGDIR_END; dir++) {

    70

			static const int8 ddx[DIAGDIR_END] = { -1,  1,  1, -1};

    71

			static const int8 ddy[DIAGDIR_END] = {  1,  1, -1, -1};

    72

    73

			int dx = ddx[dir];

    74

			int dy = ddy[dir];

    75

    76

			/* each side of this square has length 'dist' */

    77

			for (uint a = 0; a < dist; a++) {

    78

				/* MP_VOID tiles are not checked (interval is [0; max) for IsInsideMM())*/

    79

				if (IsInsideMM(x, 0, max_x) && IsInsideMM(y, 0, max_y)) {

    80

					TileIndex t = TileXY(x, y);

    81

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

    82

				}

    83

				x += dx;

    84

				y += dy;

    85

			}

    86

		}

    87

	}

    88

    89

	if (!water) {

    90

		/* no land found - is this a water-only map? */

    91

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

    92

			if (!IsTileType(t, MP_VOID) && !IsTileType(t, MP_WATER)) return 0x1FF;

    93

		}

    94

	}

    95

    96

	return max_dist;

    97

}

    98

    99

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

   100

 * industry, and/or the same grf file

   101

 * @param tile TileIndex of the tile to query

   102

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

   103

 * @return value encoded as per NFO specs */

   104

uint32 GetIndustryIDAtOffset(TileIndex tile, const Industry *i)

   105

{

   106

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

   107

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

   108

		return 0xFFFF;

   109

	}

   110

   111

	IndustryGfx gfx = GetCleanIndustryGfx(tile);

   112

	const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);

   113

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

   114

   115

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

   116

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

   117

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

   118

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

   119

		}

   120

		/* Not overriden */

   121

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

   122

   123

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

   124

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

   125

		} else {

   126

			return 0xFFFE; // not the same grf file

   127

		}

   128

	}

   129

	/* Not an 'old type' tile */

   130

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

   131

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

   132

			return indtsp->grf_prop.local_id;

   133

		} else {

   134

			return 0xFFFE; // Defined in another grf file

   135

		}

   136

	}

   137

	/* The tile has no spritegroup */

   138

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

   139

}

   140

   141

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

   142

{

   143

	uint32 best_dist = UINT32_MAX;

   144

	const Industry *i;

   145

	FOR_ALL_INDUSTRIES(i) {

   146

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

   147

   148

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

   149

	}

   150

   151

	return best_dist;

   152

}

   153

   154

/** Implementation of both var 67 and 68

   155

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

   156

 * function.

   157

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

   158

 * @param layout_filter on what layout do we filter?

   159

 * @param current Industry for which the inquiry is made

   160

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

   161

 */

   162

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

   163

{

   164

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

   165

	IndustryType ind_index;

   166

	uint32 closest_dist = UINT32_MAX;

   167

	byte count = 0;

   168

   169

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

   170

	switch (GrfID) {

   171

		case 0:  // this is a default industry type

   172

			ind_index = param_setID;

   173

			break;

   174

   175

		case 0xFFFFFFFF: // current grf

   176

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

   177

			/* Fall through */

   178

   179

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

   180

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

   181

			ind_index = MapNewGRFIndustryType(param_setID, GrfID);

   182

			break;

   183

	}

   184

   185

	if (layout_filter == 0) {

   186

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

   187

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

   188

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

   189

		count = GetIndustryTypeCount(ind_index);

   190

	} else {

   191

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

   192

		 * Unfortunately, we have to do it manually */

   193

		const Industry *i;

   194

		FOR_ALL_INDUSTRIES(i) {

   195

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

   196

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

   197

				count++;

   198

			}

   199

		}

   200

	}

   201

   202

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

   203

}

   204

   205

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

   206

 * @param variable that is queried

   207

 * @param parameter unused

   208

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

   209

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

   210

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

   211

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

   212

{

   213

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

   214

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

   215

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

   216

	const IndustrySpec *indspec = GetIndustrySpec(type);

   217

   218

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

   219

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

   220

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

   221

		const Town *t;

   222

   223

		if (industry != NULL) {

   224

			t = industry->town;

   225

		} else if (tile != INVALID_TILE) {

   226

			t = ClosestTownFromTile(tile, UINT_MAX);

   227

		} else {

   228

			*available = false;

   229

			return UINT_MAX;

   230

		}

   231

   232

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

   233

	}

   234

   235

	if (industry == NULL) {

   236

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

   237

		switch (variable) {

   238

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

   239

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

   240

		}

   241

   242

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

   243

   244

		*available = false;

   245

		return UINT_MAX;

   246

	}

   247

   248

	switch (variable) {

   249

		case 0x40:

   250

		case 0x41:

   251

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

   252

			uint16 callback = indspec->callback_flags;

   253

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

   254

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

   255

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

   256

				} else {

   257

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

   258

				}

   259

			} else {

   260

				return 0;

   261

			}

   262

		}

   263

   264

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

   265

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

   266

   267

		/* Layout number */

   268

		case 0x44: return industry->selected_layout;

   269

   270

		/* Company info */

   271

		case 0x45: {

   272

			byte colours;

   273

			bool is_ai = false;

   274

   275

			if (IsValidCompanyID(industry->founder)) {

   276

				const Company *c = GetCompany(industry->founder);

   277

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

   278

   279

				is_ai = c->is_ai;

   280

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

   281

			} else {

   282

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

   283

			}

   284

   285

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

   286

		}

   287

   288

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

   289

   290

		/* Get industry ID at offset param */

   291

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

   292

   293

		/* Get random tile bits at offset param */

   294

		case 0x61:

   295

			tile = GetNearbyTile(parameter, tile);

   296

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

   297

   298

		/* Land info of nearby tiles */

   299

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

   300

   301

		/* Animation stage of nearby tiles */

   302

		case 0x63:

   303

			tile = GetNearbyTile(parameter, tile);

   304

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

   305

				return GetIndustryAnimationState(tile);

   306

			}

   307

			return 0xFFFFFFFF;

   308

   309

		/* Distance of nearest industry of given type */

   310

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

   311

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

   312

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

   313

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

   314

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

   315

   316

		/* Count of industry, distance of closest instance

   317

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

   318

		case 0x67:

   319

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

   320

   321

		/* Get a variable from the persistent storage */

   322

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

   323

   324

		/* Industry structure access*/

   325

		case 0x80: return industry->xy;

   326

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

   327

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

   328

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

   329

		case 0x83:

   330

		case 0x84:

   331

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

   332

		case 0x86: return industry->width;

   333

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

   334

		/*  */

   335

		case 0x88:

   336

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

   337

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

   338

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

   339

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

   340

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

   341

		case 0x8E:

   342

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

   343

		case 0x90:

   344

		case 0x91:

   345

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

   346

		case 0x93: return industry->prod_level;

   347

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

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

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

   355

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

   356

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

   357

		/* fraction of cargo transported LAST month. */

   358

		case 0x9C:

   359

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

   360

		/* amount of cargo produced LAST month. */

   361

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

   362

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

   363

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

   364

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

   365

		/* amount of cargo transported last month. */

   366

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

   367

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

   368

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

   369

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

   370

   371

		case 0xA6: return industry->type;

   372

		case 0xA7: return industry->founder;

   373

		case 0xA8: return industry->random_color;

   374

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

   375

		case 0xAA: return industry->counter;

   376

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

   377

		case 0xAC: return industry->was_cargo_delivered;

   378

   379

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

   380

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

   381

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

   382

	}

   383

   384

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

   385

   386

	*available = false;

   387

	return (uint32)-1;

   388

}

   389

   390

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

   391

{

   392

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

   393

	return NULL;

   394

}

   395

   396

static uint32 IndustryGetRandomBits(const ResolverObject *object)

   397

{

   398

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

   399

}

   400

   401

static uint32 IndustryGetTriggers(const ResolverObject *object)

   402

{

   403

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

   404

}

   405

   406

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

   407

{

   408

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

   409

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

   410

}

   411

   412

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

   413

{

   414

	res->GetRandomBits = IndustryGetRandomBits;

   415

	res->GetTriggers   = IndustryGetTriggers;

   416

	res->SetTriggers   = IndustrySetTriggers;

   417

	res->GetVariable   = IndustryGetVariable;

   418

	res->ResolveReal   = IndustryResolveReal;

   419

   420

	res->psa             = &indus->psa;

   421

	res->u.industry.tile = tile;

   422

	res->u.industry.ind  = indus;

   423

	res->u.industry.gfx  = INVALID_INDUSTRYTILE;

   424

	res->u.industry.type = type;

   425

   426

	res->callback        = CBID_NO_CALLBACK;

   427

	res->callback_param1 = 0;

   428

	res->callback_param2 = 0;

   429

	res->last_value      = 0;

   430

	res->trigger         = 0;

   431

	res->reseed          = 0;

   432

	res->count           = 0;

   433

   434

	const IndustrySpec *indspec = GetIndustrySpec(type);

   435

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

   436

}

   437

   438

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

   439

{

   440

	ResolverObject object;

   441

	const SpriteGroup *group;

   442

   443

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

   444

	object.callback = callback;

   445

	object.callback_param1 = param1;

   446

	object.callback_param2 = param2;

   447

   448

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

   449

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

   450

   451

	return group->g.callback.result;

   452

}

   453

   454

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

   455

{

   456

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

   457

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

   458

   459

	if (object->scope == VSG_SCOPE_PARENT) {

   460

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

   461

	}

   462

   463

	switch (variable) {

   464

		case 0x80: return tile;

   465

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

   466

   467

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

   468

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

   469

		case 0x83:

   470

		case 0x84:

   471

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

   472

   473

		/* Number of the layout */

   474

		case 0x86: return industry->selected_layout;

   475

   476

		/* Ground type */

   477

		case 0x87: return GetTerrainType(tile);

   478

   479

		/* Town zone */

   480

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

   481

   482

		/* Manhattan distance of the closest town */

   483

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

   484

   485

		/* Lowest height of the tile */

   486

		case 0x8A: return GetTileZ(tile);

   487

   488

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

   489

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

   490

   491

		/* Square of Euclidian distance from town */

   492

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

   493

   494

		/* 32 random bits */

   495

		case 0x8F: return _industry_creation_random_bits;