1

/* $Id$ */

     2

     3

/** @file newgrf_station.cpp Functions for dealing with station classes and custom stations. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "functions.h"

     9

#include "debug.h"

    10

#include "sprite.h"

    11

#include "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "station.h"

    14

#include "station_map.h"

    15

#include "newgrf.h"

    16

#include "newgrf_callbacks.h"

    17

#include "newgrf_station.h"

    18

#include "newgrf_spritegroup.h"

    19

#include "date.h"

    20

#include "helpers.hpp"

    21

#include "cargotype.h"

    22

    23

static StationClass station_classes[STAT_CLASS_MAX];

    24

    25

enum {

    26

	MAX_SPECLIST = 255,

    27

};

    28

    29

/**

    30

 * Reset station classes to their default state.

    31

 * This includes initialising the Default and Waypoint classes with an empty

    32

 * entry, for standard stations and waypoints.

    33

 */

    35

{

    36

	for (StationClassID i = STAT_CLASS_BEGIN; i < STAT_CLASS_MAX; i++) {

    37

		station_classes[i].id = 0;

    38

		station_classes[i].name = STR_EMPTY;

    39

		station_classes[i].stations = 0;

    40

    41

		free(station_classes[i].spec);

    42

		station_classes[i].spec = NULL;

    43

	}

    44

    45

	// Set up initial data

    46

	station_classes[0].id = 'DFLT';

    47

	station_classes[0].name = STR_STAT_CLASS_DFLT;

    48

	station_classes[0].stations = 1;

    49

	station_classes[0].spec = MallocT<StationSpec*>(1);

    50

	station_classes[0].spec[0] = NULL;

    51

    52

	station_classes[1].id = 'WAYP';

    53

	station_classes[1].name = STR_STAT_CLASS_WAYP;

    54

	station_classes[1].stations = 1;

    55

	station_classes[1].spec = MallocT<StationSpec*>(1);

    56

	station_classes[1].spec[0] = NULL;

    57

}

    58

    59

/**

    60

 * Allocate a station class for the given class id.

    61

 * @param classid A 32 bit value identifying the class.

    62

 * @return Index into station_classes of allocated class.

    63

 */

    64

StationClassID AllocateStationClass(uint32 cls)

    65

{

    66

	for (StationClassID i = STAT_CLASS_BEGIN; i < STAT_CLASS_MAX; i++) {

    67

		if (station_classes[i].id == cls) {

    68

			// ClassID is already allocated, so reuse it.

    69

			return i;

    70

		} else if (station_classes[i].id == 0) {

    71

			// This class is empty, so allocate it to the ClassID.

    72

			station_classes[i].id = cls;

    73

			return i;

    74

		}

    75

	}

    76

    77

	grfmsg(2, "StationClassAllocate: already allocated %d classes, using default", STAT_CLASS_MAX);

    78

	return STAT_CLASS_DFLT;

    79

}

    80

    81

/** Set the name of a custom station class */

    82

void SetStationClassName(StationClassID sclass, StringID name)

    83

{

    84

	assert(sclass < STAT_CLASS_MAX);

    85

	station_classes[sclass].name = name;

    86

}

    87

    88

/** Retrieve the name of a custom station class */

    89

StringID GetStationClassName(StationClassID sclass)

    90

{

    91

	assert(sclass < STAT_CLASS_MAX);

    92

	return station_classes[sclass].name;

    93

}

    94

    95

/** Build a list of station class name StringIDs to use in a dropdown list

    96

 * @return Pointer to a (static) array of StringIDs

    97

 */

    99

{

   100

	/* Allow room for all station classes, plus a terminator entry */

   101

	static StringID names[STAT_CLASS_MAX + 1];

   102

	uint i;

   103

   104

	/* Add each name */

   105

	for (i = 0; i < STAT_CLASS_MAX && station_classes[i].id != 0; i++) {

   106

		names[i] = station_classes[i].name;

   107

	}

   108

	/* Terminate the list */

   109

	names[i] = INVALID_STRING_ID;

   110

   111

	return names;

   112

}

   113

   114

/**

   115

 * Get the number of station classes in use.

   116

 * @return Number of station classes.

   117

 */

   119

{

   120

	uint i;

   121

	for (i = 0; i < STAT_CLASS_MAX && station_classes[i].id != 0; i++);

   122

	return i;

   123

}

   124

   125

/**

   126

 * Return the number of stations for the given station class.

   127

 * @param sclass Index of the station class.

   128

 * @return Number of stations in the class.

   129

 */

   130

uint GetNumCustomStations(StationClassID sclass)

   131

{

   132

	assert(sclass < STAT_CLASS_MAX);

   133

	return station_classes[sclass].stations;

   134

}

   135

   136

/**

   137

 * Tie a station spec to its station class.

   138

 * @param spec The station spec.

   139

 */

   140

void SetCustomStationSpec(StationSpec *statspec)

   141

{

   142

	StationClass *station_class;

   143

	int i;

   144

   145

	/* If the station has already been allocated, don't reallocate it. */

   146

	if (statspec->allocated) return;

   147

   148

	assert(statspec->sclass < STAT_CLASS_MAX);

   149

	station_class = &station_classes[statspec->sclass];

   150

   151

	i = station_class->stations++;

   152

	station_class->spec = ReallocT(station_class->spec, station_class->stations);

   153

   154

	station_class->spec[i] = statspec;

   155

	statspec->allocated = true;

   156

}

   157

   158

/**

   159

 * Retrieve a station spec from a class.

   160

 * @param sclass Index of the station class.

   161

 * @param station The station index with the class.

   162

 * @return The station spec.

   163

 */

   164

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station)

   165

{

   166

	assert(sclass < STAT_CLASS_MAX);

   167

	if (station < station_classes[sclass].stations)

   168

		return station_classes[sclass].spec[station];

   169

   170

	// If the custom station isn't defined any more, then the GRF file

   171

	// probably was not loaded.

   172

	return NULL;

   173

}

   174

   175

   176

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx)

   177

{

   178

	uint j;

   179

   180

	for (StationClassID i = STAT_CLASS_BEGIN; i < STAT_CLASS_MAX; i++) {

   181

		for (j = 0; j < station_classes[i].stations; j++) {

   182

			const StationSpec *statspec = station_classes[i].spec[j];

   183

			if (statspec == NULL) continue;

   184

			if (statspec->grfid == grfid && statspec->localidx == localidx) return statspec;

   185

		}

   186

	}

   187

   188

	return NULL;

   189

}

   190

   191

   192

/* Evaluate a tile's position within a station, and return the result a bitstuffed format.

   193

 * if not centred: .TNLcCpP, if centred: .TNL..CP

   194

 * T = Tile layout number (GetStationGfx), N = Number of platforms, L = Length of platforms

   195

 * C = Current platform number from start, c = from end

   196

 * P = Position along platform from start, p = from end

   197

 * if centred, C/P start from the centre and c/p are not available.

   198

 */

   199

uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred)

   200

{

   201

	uint32 retval = 0;

   202

   203

	if (axis == AXIS_X) {

   204

		Swap(platforms, length);

   205

		Swap(x, y);

   206

	}

   207

   208

	/* Limit our sizes to 4 bits */

   209

	platforms = min(15, platforms);

   210

	length    = min(15, length);

   211

	x = min(15, x);

   212

	y = min(15, y);

   213

	if (centred) {

   214

		x -= platforms / 2;

   215

		y -= length / 2;

   216

		SB(retval,  0, 4, y & 0xF);

   217

		SB(retval,  4, 4, x & 0xF);

   218

	} else {

   219

		SB(retval,  0, 4, y);

   220

		SB(retval,  4, 4, length - y - 1);

   221

		SB(retval,  8, 4, x);

   222

		SB(retval, 12, 4, platforms - x - 1);

   223

	}

   224

	SB(retval, 16, 4, length);

   225

	SB(retval, 20, 4, platforms);

   226

	SB(retval, 24, 4, tile);

   227

   228

	return retval;

   229

}

   230

   231

   232

/* Find the end of a railway station, from the tile, in the direction of delta.

   233

 * If check_type is set, we stop if the custom station type changes.

   234

 * If check_axis is set, we stop if the station direction changes.

   235

 */

   236

static TileIndex FindRailStationEnd(TileIndex tile, TileIndexDiff delta, bool check_type, bool check_axis)

   237

{

   238

	bool waypoint;

   239

	byte orig_type = 0;

   240

	Axis orig_axis = AXIS_X;

   241

   242

	waypoint = IsTileType(tile, MP_RAILWAY);

   243

   244

	if (waypoint) {

   245

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   246

	} else {

   247

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   248

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   249

	}

   250

   251

	while (true) {

   252

		TileIndex new_tile = TILE_ADD(tile, delta);

   253

   254

		if (waypoint) {

   255

			if (!IsTileType(new_tile, MP_RAILWAY)) break;

   256

			if (!IsRailWaypoint(new_tile)) break;

   257

			if (check_axis && GetWaypointAxis(new_tile) != orig_axis) break;

   258

		} else {

   259

			if (!IsRailwayStationTile(new_tile)) break;

   260

			if (check_type && GetCustomStationSpecIndex(new_tile) != orig_type) break;

   261

			if (check_axis && GetRailStationAxis(new_tile) != orig_axis) break;

   262

		}

   263

   264

		tile = new_tile;

   265

	}

   266

	return tile;

   267

}

   268

   269

   270

static uint32 GetPlatformInfoHelper(TileIndex tile, bool check_type, bool check_axis, bool centred)

   271

{

   272

	int tx = TileX(tile);

   273

	int ty = TileY(tile);

   274

	int sx = TileX(FindRailStationEnd(tile, TileDiffXY(-1,  0), check_type, check_axis));

   275

	int sy = TileY(FindRailStationEnd(tile, TileDiffXY( 0, -1), check_type, check_axis));

   276

	int ex = TileX(FindRailStationEnd(tile, TileDiffXY( 1,  0), check_type, check_axis)) + 1;

   277

	int ey = TileY(FindRailStationEnd(tile, TileDiffXY( 0,  1), check_type, check_axis)) + 1;

   278

	Axis axis = IsTileType(tile, MP_RAILWAY) ? GetWaypointAxis(tile) : GetRailStationAxis(tile);

   279

   280

	tx -= sx; ex -= sx;

   281

	ty -= sy; ey -= sy;

   282

   283

	return GetPlatformInfo(axis, IsTileType(tile, MP_RAILWAY) ? 2 : GetStationGfx(tile), ex, ey, tx, ty, centred);

   284

}

   285

   286

   287

static uint32 GetRailContinuationInfo(TileIndex tile)

   288

{

   289

	/* Tile offsets and exit dirs for X axis */

   290

	static Direction x_dir[8] = { DIR_SW, DIR_NE, DIR_SE, DIR_NW, DIR_S, DIR_E, DIR_W, DIR_N };

   291

	static DiagDirection x_exits[8] = { DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SW, DIAGDIR_NE };

   292

   293

	/* Tile offsets and exit dirs for Y axis */

   294

	static Direction y_dir[8] = { DIR_SE, DIR_NW, DIR_SW, DIR_NE, DIR_S, DIR_W, DIR_E, DIR_N };

   295

	static DiagDirection y_exits[8] = { DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NW, DIAGDIR_SE, DIAGDIR_NW };

   296

   297

	Axis axis = IsTileType(tile, MP_RAILWAY) ? GetWaypointAxis(tile) : GetRailStationAxis(tile);

   298

   299

	/* Choose appropriate lookup table to use */

   300

	Direction *dir = axis == AXIS_X ? x_dir : y_dir;

   301

	DiagDirection *diagdir = axis == AXIS_X ? x_exits : y_exits;

   302

   303

	uint32 res = 0;

   304

	uint i;

   305

   306

	for (i = 0; i < lengthof(x_dir); i++, dir++, diagdir++) {

   307

		uint32 ts = GetTileTrackStatus(tile + TileOffsByDir(*dir), TRANSPORT_RAIL);

   308

		if (ts != 0) {

   309

			/* If there is any track on the tile, set the bit in the second byte */

   310

			SETBIT(res, i + 8);

   311

   312

			/* If any track reaches our exit direction, set the bit in the lower byte */

   313

			if (ts & DiagdirReachesTracks(*diagdir)) SETBIT(res, i);

   314

		}

   315

	}

   316

   317

	return res;

   318

}

   319

   320

   321

/* Station Resolver Functions */

   322

static uint32 StationGetRandomBits(const ResolverObject *object)

   323

{

   324

	const Station *st = object->u.station.st;

   325

	const TileIndex tile = object->u.station.tile;

   326

	return (st == NULL ? 0 : st->random_bits) | (tile == INVALID_TILE ? 0 : GetStationTileRandomBits(tile) << 16);

   327

}

   328

   329

   330

static uint32 StationGetTriggers(const ResolverObject *object)

   331

{

   332

	const Station *st = object->u.station.st;

   333

	return st == NULL ? 0 : st->waiting_triggers;

   334

}

   335

   336

   337

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

   338

{

   339

	Station *st = (Station*)object->u.station.st;

   340

	assert(st != NULL);

   341

	st->waiting_triggers = triggers;

   342

}

   343

   344

   345

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

   346

{

   347

	const Station *st = object->u.station.st;

   348

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

   349

   350

	if (st == NULL) {

   351

		/* Station does not exist, so we're in a purchase list */

   352

		switch (variable) {

   353

			case 0x40:

   354

			case 0x41:

   355

			case 0x46:

   356

			case 0x47:

   357

			case 0x49: return 0x2110000;       /* Platforms, tracks & position */

   358

			case 0x42: return 0;               /* Rail type (XXX Get current type from GUI?) */

   359

			case 0x43: return _current_player; /* Station owner */

   360

			case 0x44: return 2;               /* PBS status */

   361

			case 0xFA: return max(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0); /* Build date */

   362

		}

   363

   364

		*available = false;

   365

		return UINT_MAX;

   366

	}

   367

   368

	switch (variable) {

   369

		/* Calculated station variables */

   370

		case 0x40: return GetPlatformInfoHelper(tile, false, false, false);

   371

		case 0x41: return GetPlatformInfoHelper(tile, true,  false, false);

   372

		case 0x42: /* Terrain and rail type */

   373

			return ((_opt.landscape == LT_HILLY && GetTileZ(tile) > _opt.snow_line) ? 4 : 0) |

   374

			       (_opt.landscape == LT_DESERT ? GetTropicZone(tile) : 0) |

   375

			       (GetRailType(tile) << 8);

   376

		case 0x43: return st->owner; /* Station owner */

   377

		case 0x44: return 2;         /* PBS status */

   378

		case 0x45: return GetRailContinuationInfo(tile);

   379

		case 0x46: return GetPlatformInfoHelper(tile, false, false, true);

   380

		case 0x47: return GetPlatformInfoHelper(tile, true,  false, true);

   381

		case 0x48: { /* Accepted cargo types */

   382

			CargoID cargo_type;

   383

			uint32 value = 0;

   384

   385

			for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {

   386

				if (HASBIT(st->goods[cargo_type].waiting_acceptance, 15)) SETBIT(value, cargo_type);

   387

			}

   388

			return value;

   389

		}

   390

		case 0x49: return GetPlatformInfoHelper(tile, false, true, false);

   391

   392

		/* Variables which use the parameter */

   393

		case 0x60: return GB(st->goods[parameter].waiting_acceptance, 0, 12);

   394

		case 0x61: return st->goods[parameter].days_since_pickup;

   395

		case 0x62: return st->goods[parameter].rating;

   396

		case 0x63: return st->goods[parameter].enroute_time;

   397

		case 0x64: return st->goods[parameter].last_speed | (st->goods[parameter].last_age << 8);

   398

		case 0x65: return GB(st->goods[parameter].waiting_acceptance, 12, 4);

   399

   400

		/* General station properties */

   401

		case 0x82: return 50;

   402

		case 0x84: return st->string_id;

   403

		case 0x86: return 0;

   404

		case 0x8A: return st->had_vehicle_of_type;

   405

		case 0xF0: return st->facilities;

   406

		case 0xF1: return st->airport_type;

   407

		case 0xF2: return st->truck_stops->status;

   408

		case 0xF3: return st->bus_stops->status;

   409

		case 0xF6: return st->airport_flags;

   410

		case 0xF7: return GB(st->airport_flags, 8, 8);

   411

		case 0xFA: return max(st->build_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0);

   412

	}

   413

   414

	/* Handle cargo variables (deprecated) */

   415

	if (variable >= 0x8C && variable <= 0xEC) {

   416

		const GoodsEntry *g = &st->goods[GB(variable - 0x8C, 3, 4)];

   417

		switch (GB(variable - 0x8C, 0, 3)) {

   418

			case 0: return g->waiting_acceptance;

   419

			case 1: return GB(g->waiting_acceptance, 8, 8);

   420

			case 2: return g->days_since_pickup;

   421

			case 3: return g->rating;

   422

			case 4: return g->enroute_from;

   423

			case 5: return g->enroute_time;

   424

			case 6: return g->last_speed;

   425

			case 7: return g->last_age;

   426

		}

   427

	}

   428

   429

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

   430

   431

	*available = false;

   432

	return UINT_MAX;

   433

}

   434

   435

   436

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

   437

{

   438

	const Station *st = object->u.station.st;

   439

	const StationSpec *statspec = object->u.station.statspec;

   440

	uint set;

   441

   442

	uint cargo = 0;

   443

	CargoID cargo_type = object->u.station.cargo_type;

   444

   445

	if (st == NULL || statspec->sclass == STAT_CLASS_WAYP) {

   446

		return group->g.real.loading[0];

   447

	}

   448

   449

	switch (cargo_type) {

   450

		case CT_INVALID:

   451

		case CT_DEFAULT_NA:

   452

		case CT_PURCHASE:

   453

			cargo = 0;

   454

			break;

   455

   456

		case CT_DEFAULT:

   457

			for (cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {

   458

				cargo += GB(st->goods[cargo_type].waiting_acceptance, 0, 12);

   459

			}

   460

			break;

   461

   462

		default:

   463

			cargo = GB(st->goods[cargo_type].waiting_acceptance, 0, 12);

   464

			break;

   465

	}

   466

   467

	if (HASBIT(statspec->flags, 1)) cargo /= (st->trainst_w + st->trainst_h);

   468

	cargo = min(0xfff, cargo);

   469

   470

	if (cargo > statspec->cargo_threshold) {

   471

		if (group->g.real.num_loading > 0) {

   472

			set = ((cargo - statspec->cargo_threshold) * group->g.real.num_loading) / (4096 - statspec->cargo_threshold);

   473

			return group->g.real.loading[set];

   474

		}

   475

	} else {

   476

		if (group->g.real.num_loaded > 0) {

   477

			set = (cargo * group->g.real.num_loaded) / (statspec->cargo_threshold + 1);

   478

			return group->g.real.loaded[set];

   479

		}

   480

	}

   481

   482

	return group->g.real.loading[0];

   483

}

   484

   485

   486

static void NewStationResolver(ResolverObject *res, const StationSpec *statspec, const Station *st, TileIndex tile)

   487

{

   488

	res->GetRandomBits = StationGetRandomBits;

   489

	res->GetTriggers   = StationGetTriggers;

   490

	res->SetTriggers   = StationSetTriggers;

   491

	res->GetVariable   = StationGetVariable;

   492

	res->ResolveReal   = StationResolveReal;

   493