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

    18

    19

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

    20

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

    21

 * translated when the idustry spec is set. */

    22

IndustryOverrideManager _industry_mngr(NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, INVALID_INDUSTRYTYPE);

    23

IndustryTileOverrideManager _industile_mngr(NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, INVALID_INDUSTRYTILE);

    24

    25

/**

    26

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

    27

 * @param tile  the tile to find the distance too

    28

 * @param water whether to find water or land

    29

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

    30

 */

    31

static uint GetClosestWaterDistance(TileIndex tile, bool water)

    32

{

    33

	TileIndex t;

    34

	uint best_dist;

    35

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

    36

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

    37

	}

    38

	best_dist = DistanceManhattan(tile, t);

    39

    40

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

    41

		uint dist = DistanceManhattan(tile, t);

    42

		if (dist < best_dist) {

    43

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

    44

		} else {

    45

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

    46

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

    47

			if (TileY(t) - TileY(tile) > best_dist) return best_dist;

    48

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

    49

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

    50

				 * higher or equal distance than the best distance */

    51

				t |= MapMaxX();

    52

				continue;

    53

			} else {

    54

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

    55

				 * higher or equal distance than the best distance */

    56

				t += best_dist - dist;

    57

				continue;

    58

			}

    59

		}

    60

	}

    61

    62

	return best_dist;

    63

}

    64

    65

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

    66

 * industry, and/or the same grf file

    67

 * @param new_tile TileIndex of the tile to query

    68

 * @param old_tile TileINdex of teh reference tile

    69

 * @param i Industry to which old_tile belongs to

    70

 * @return value encoded as per NFO specs */

    71

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

    72

{

    73

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

    74

    75

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

    76

			IndustryGfx gfx = GetIndustryGfx(new_tile);

    77

			const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx);

    78

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

    79

    80

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

    81

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

    82

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

    83

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

    84

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

    85

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

    86

    87

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

    88

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

    89

					} else {

    90

						return 0xFFFE; // not the same grf file

    91

					}

    92

				}

    93

			} else {

    94

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

    95

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

    96

						return indtsp->grf_prop.local_id;

    97

					} else {

    98

						return 0xFFFE;  // Defined in another grf file

    99

					}

   100

				} else {  // tile has no spritegroup

   101

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

   102

				}

   103

			}

   104

		}

   105

	}

   106

   107

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

   108

}

   109

   110

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

   111

 * @param variable that is queried

   112

 * @param parameter unused

   113

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

   114

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

   115

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

   116

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

   117

{

   118

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

   119

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

   120

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

   121

   122

	switch (variable) {

   123

		case 0x40:

   124

		case 0x41:

   125

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

   126

			uint16 callback = indspec->callback_flags;

   127

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

   128

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

   129

			} else {

   130

				return 0;

   131

			}

   132

		}

   133

		/* TODO: somehow determine whether we're in water or not */

   134

		case 0x43: return GetClosestWaterDistance(tile, true); // Manhattan distance of closes dry/water tile

   135

   136

		/* Get industry ID at offset param */

   137

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

   138

   139

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

   140

   141

		case 0x62: // Land info of nearby tiles

   142

		case 0x63: // Animation stage of nerby tiles

   143

		case 0x64: break; // Distance of nearest industry of given type

   144

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

   145

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

   146

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

   147

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

   148

   149

		/* Count of industry, distance of closest instance

   150

		 * format is rr(reserved) cc(count)  dddd(manhattan distance of closest sister)

   151

		 * A lot more should be done, since it has to check for local id, grf id etc...

   152

		 * let's just say it is a beginning ;) */

   153

		case 0x67: return GetIndustryTypeCount(industry->type) << 16 | 0;

   154

   155

		/* Industry structure access*/

   156

		case 0x80: return industry->xy;

   157

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

   158

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

   159

		case 0x82:

   160

		case 0x83:

   161

		case 0x84:

   163

		case 0x86: return industry->width;

   164

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

   165

		/*  */

   166

		case 0x88:

   167

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

   168

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

   169

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

   170

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

   171

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

   172

		case 0x8E:

   173

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

   174

		case 0x90:

   175

		case 0x91:

   176

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

   177

		case 0x93: return industry->prod_level;

   178

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

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

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

   187

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

   188

		/* fraction of cargo transported LAST month. */

   189

		case 0x9C:

   190

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

   191

		/* amount of cargo produced LAST month. */

   192

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

   193

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

   194

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

   195

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

   196

		/* amount of cargo transported last month. */

   197

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

   198

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

   199

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

   200

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

   201

   202

		case 0xA6: return industry->type;

   204

		case 0xA8: return industry->random_color;

   206

		case 0xAA: return industry->counter;

   207

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

   208

		case 0xAC: return industry->was_cargo_delivered;

   213

	}

   214

   215

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

   216

   217

	*available = false;

   218

	return (uint32)-1;

   219

}

   220

   221

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

   222

{

   223

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

   224

	return NULL;

   225

}

   226

   227

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

   228

{

   229

	res->GetRandomBits = IndustryTileGetRandomBits;

   230

	res->GetTriggers   = IndustryTileGetTriggers;

   231

	res->SetTriggers   = IndustryTileSetTriggers;

   232

	res->GetVariable   = IndustryGetVariable;

   233

	res->ResolveReal   = IndustryResolveReal;

   234

   235

	res->u.industry.tile = tile;

   236

	res->u.industry.ind  = indus;

   237

	res->u.industry.gfx  = INVALID_INDUSTRYTILE;

   238

   239

	res->callback        = 0;

   240

	res->callback_param1 = 0;

   241

	res->callback_param2 = 0;

   242

	res->last_value      = 0;

   243

	res->trigger         = 0;

   244

	res->reseed          = 0;

   245

}

   246

   247

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

   248

{

   249

	ResolverObject object;

   250

	const SpriteGroup *group;

   251

   252

	NewIndustryResolver(&object, tile, industry);

   253

	object.callback = callback;

   254

	object.callback_param1 = param1;

   255

	object.callback_param2 = param2;

   256

   257

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

   258

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

   259

   260

	return group->g.callback.result;

   261

}

   262

   263

static int32 DerefIndProd(uint field, bool use_register)

   264

{

   265

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

   266

}

   267

   268

/**

   269

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

   270

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

   271

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

   272

 */

   273

void IndustryProductionCallback(Industry *ind, int reason)

   274

{

   275

	ResolverObject object;

   276

	NewIndustryResolver(&object, INVALID_TILE, ind);

   277

	object.callback_param2 = reason;

   278

   279

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

   280

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

   281

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

   282

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

   283

   284

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

   285

   286

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

   287

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

   288

		}

   289

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

   290

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

   291

		}

   292

   293

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

   294

		if (again == 0) break;

   295

   296

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

   297

	}

   298

}