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

     9

#include "landscape.h"

    10

#include "debug.h"

    11

#include "sprite.h"

    12

#include "station_base.h"

    13

#include "station_map.h"

    14

#include "newgrf.h"

    15

#include "newgrf_callbacks.h"

    16

#include "newgrf_commons.h"

    17

#include "newgrf_station.h"

    18

#include "newgrf_spritegroup.h"

    19

#include "newgrf_sound.h"

    20

#include "cargotype.h"

    21

#include "town_map.h"

    22

#include "newgrf_town.h"

    23

#include "gfx_func.h"

    24

#include "date_func.h"

    25

#include "player_func.h"

    26

#include "animated_tile_func.h"

    27

#include "functions.h"

    28

    29

#include "table/sprites.h"

    30

#include "table/strings.h"

    31

    32

static StationClass _station_classes[STAT_CLASS_MAX];

    33

    34

enum {

    35

	MAX_SPECLIST = 255,

    36

};

    37

    38

/**

    39

 * Reset station classes to their default state.

    40

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

    41

 * entry, for standard stations and waypoints.

    42

 */

    43

void ResetStationClasses()

    44

{

    45

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

    46

		_station_classes[i].id = 0;

    47

		_station_classes[i].name = STR_EMPTY;

    48

		_station_classes[i].stations = 0;

    49

    50

		free(_station_classes[i].spec);

    51

		_station_classes[i].spec = NULL;

    52

	}

    53

    54

	/* Set up initial data */

    55

	_station_classes[0].id = 'DFLT';

    56

	_station_classes[0].name = STR_STAT_CLASS_DFLT;

    57

	_station_classes[0].stations = 1;

    58

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

    59

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

    60

    61

	_station_classes[1].id = 'WAYP';

    62

	_station_classes[1].name = STR_STAT_CLASS_WAYP;

    63

	_station_classes[1].stations = 1;

    64

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

    65

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

    66

}

    67

    68

/**

    69

 * Allocate a station class for the given class id.

    70

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

    71

 * @return Index into _station_classes of allocated class.

    72

 */

    73

StationClassID AllocateStationClass(uint32 cls)

    74

{

    75

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

    76

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

    77

			/* ClassID is already allocated, so reuse it. */

    78

			return i;

    79

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

    80

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

    81

			_station_classes[i].id = cls;

    82

			return i;

    83

		}

    84

	}

    85

    86

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

    87

	return STAT_CLASS_DFLT;

    88

}

    89

    90

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

    91

void SetStationClassName(StationClassID sclass, StringID name)

    92

{

    93

	assert(sclass < STAT_CLASS_MAX);

    94

	_station_classes[sclass].name = name;

    95

}

    96

    97

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

    98

StringID GetStationClassName(StationClassID sclass)

    99

{

   100

	assert(sclass < STAT_CLASS_MAX);

   101

	return _station_classes[sclass].name;

   102

}

   103

   104

/**

   105

 * Get the number of station classes in use.

   106

 * @return Number of station classes.

   107

 */

   108

uint GetNumStationClasses()

   109

{

   110

	uint i;

   111

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

   112

	return i;

   113

}

   114

   115

/**

   116

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

   117

 * @param sclass Index of the station class.

   118

 * @return Number of stations in the class.

   119

 */

   120

uint GetNumCustomStations(StationClassID sclass)

   121

{

   122

	assert(sclass < STAT_CLASS_MAX);

   123

	return _station_classes[sclass].stations;

   124

}

   125

   126

/**

   127

 * Tie a station spec to its station class.

   128

 * @param statspec The station spec.

   129

 */

   130

void SetCustomStationSpec(StationSpec *statspec)

   131

{

   132

	StationClass *station_class;

   133

	int i;

   134

   135

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

   136

	if (statspec->allocated) return;

   137

   138

	assert(statspec->sclass < STAT_CLASS_MAX);

   139

	station_class = &_station_classes[statspec->sclass];

   140

   141

	i = station_class->stations++;

   142

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

   143

   144

	station_class->spec[i] = statspec;

   145

	statspec->allocated = true;

   146

}

   147

   148

/**

   149

 * Retrieve a station spec from a class.

   150

 * @param sclass Index of the station class.

   151

 * @param station The station index with the class.

   152

 * @return The station spec.

   153

 */

   154

const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station)

   155

{

   156

	assert(sclass < STAT_CLASS_MAX);

   157

	if (station < _station_classes[sclass].stations)

   158

		return _station_classes[sclass].spec[station];

   159

   160

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

   161

	 * probably was not loaded. */

   162

	return NULL;

   163

}

   164

   165

   166

const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx)

   167

{

   168

	uint j;

   169

   170

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

   171

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

   172

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

   173

			if (statspec == NULL) continue;

   174

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

   175

		}

   176

	}

   177

   178

	return NULL;

   179

}

   180

   181

   182

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

   183

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

   184

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

   185

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

   186

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

   187

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

   188

 */

   189

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

   190

{

   191

	uint32 retval = 0;

   192

   193

	if (axis == AXIS_X) {

   194

		Swap(platforms, length);

   195

		Swap(x, y);

   196

	}

   197

   198

	/* Limit our sizes to 4 bits */

   199

	platforms = min(15, platforms);

   200

	length    = min(15, length);

   201

	x = min(15, x);

   202

	y = min(15, y);

   203

	if (centred) {

   204

		x -= platforms / 2;

   205

		y -= length / 2;

   206

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

   207

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

   208

	} else {

   209

		SB(retval,  0, 4, y);

   210

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

   211

		SB(retval,  8, 4, x);

   212

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

   213

	}

   214

	SB(retval, 16, 4, length);

   215

	SB(retval, 20, 4, platforms);

   216

	SB(retval, 24, 4, tile);

   217

   218

	return retval;

   219

}

   220

   221

   222

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

   223

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

   224

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

   225

 */

   226

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

   227

{

   228

	bool waypoint;

   229

	byte orig_type = 0;

   230

	Axis orig_axis = AXIS_X;

   231

   232

	waypoint = IsTileType(tile, MP_RAILWAY);

   233

   234

	if (waypoint) {

   235

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   236

	} else {

   237

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   238

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   239

	}

   240

   241

	while (true) {

   242

		TileIndex new_tile = TILE_ADD(tile, delta);

   243

   244

		if (waypoint) {

   245

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

   246

			if (!IsRailWaypoint(new_tile)) break;

   247

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

   248

		} else {

   249

			if (!IsRailwayStationTile(new_tile)) break;

   250

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

   251

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

   252

		}

   253

   254

		tile = new_tile;

   255

	}

   256

	return tile;

   257

}

   258

   259

   260

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

   261

{

   262

	int tx = TileX(tile);

   263

	int ty = TileY(tile);

   264

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

   265

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

   266

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

   267

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

   268

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

   269

   270

	tx -= sx; ex -= sx;

   271

	ty -= sy; ey -= sy;

   272

   273

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

   274

}

   275

   276

   277

static uint32 GetRailContinuationInfo(TileIndex tile)

   278

{

   279

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

   280

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

   281

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

   282

   283

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

   284

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

   285

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

   286

   287

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

   288

   289

	/* Choose appropriate lookup table to use */

   290

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

   291

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

   292

   293

	uint32 res = 0;

   294

	uint i;

   295

   296

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

   297

		TrackBits trackbits = TrackStatusToTrackBits(GetTileTrackStatus(tile + TileOffsByDir(*dir), TRANSPORT_RAIL, 0));

   298

		if (trackbits != TRACK_BIT_NONE) {

   299

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

   300

			SetBit(res, i + 8);

   301

   302

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

   303

			if (trackbits & DiagdirReachesTracks(*diagdir)) SetBit(res, i);

   304

		}

   305

	}

   306

   307

	return res;

   308

}

   309

   310

   311

/* Station Resolver Functions */

   312

static uint32 StationGetRandomBits(const ResolverObject *object)

   313

{

   314

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

   315

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

   316

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

   317

}

   318

   319

   320

static uint32 StationGetTriggers(const ResolverObject *object)

   321

{

   322

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

   323

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

   324

}

   325

   326

   327

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

   328

{

   329

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

   330

	assert(st != NULL);

   331

	st->waiting_triggers = triggers;

   332

}

   333

   334

/**

   335

 * Station variable cache

   336

 * This caches 'expensive' station variable lookups which iterate over

   337

 * several tiles that may be called multiple times per Resolve().

   338

 */

   339

static struct {

   340

	uint32 v40;

   341

	uint32 v41;

   342

	uint32 v45;

   343

	uint32 v46;

   344

	uint32 v47;

   345

	uint32 v49;

   346

	uint8 valid;

   347

} _svc;

   348

   349

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

   350

{

   351

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

   352

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

   353

   354

	if (object->scope == VSG_SCOPE_PARENT) {

   355

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

   356

		Town *t;

   357

   358

		if (st != NULL) {

   359

			t = st->town;

   360

		} else if (tile != INVALID_TILE) {

   361

			t = GetTownByTile(tile);

   362

		} else {

   363

			*available = false;

   364

			return UINT_MAX;

   365

		}

   366

   367

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

   368

	}

   369

   370

	if (st == NULL) {

   371

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

   372

		switch (variable) {

   373

			case 0x40:

   374

			case 0x41:

   375

			case 0x46:

   376

			case 0x47:

   377

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

   378

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

   379

			case 0x43: return _current_player; // Station owner

   380

			case 0x44: return 2;               // PBS status

   381

			case 0xFA: return Clamp(_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 0, 65535); // Build date, clamped to a 16 bit value

   382

		}

   383

   384

		*available = false;

   385

		return UINT_MAX;

   386

	}

   387

   388

	switch (variable) {

   389

		/* Calculated station variables */

   390

		case 0x40:

   391

			if (!HasBit(_svc.valid, 0)) { _svc.v40 = GetPlatformInfoHelper(tile, false, false, false); SetBit(_svc.valid, 0); }

   392

			return _svc.v40;

   393

   394

		case 0x41:

   395

			if (!HasBit(_svc.valid, 1)) { _svc.v41 = GetPlatformInfoHelper(tile, true,  false, false); SetBit(_svc.valid, 1); }

   396

			return _svc.v41;

   397

   398

		case 0x42: return GetTerrainType(tile) | (GetRailType(tile) << 8);

   399

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

   400

		case 0x44: return 2;         // PBS status

   401

		case 0x45:

   402

			if (!HasBit(_svc.valid, 2)) { _svc.v45 = GetRailContinuationInfo(tile); SetBit(_svc.valid, 2); }

   403

			return _svc.v45;

   404

   405

		case 0x46:

   406

			if (!HasBit(_svc.valid, 3)) { _svc.v46 = GetPlatformInfoHelper(tile, false, false, true); SetBit(_svc.valid, 3); }

   407

			return _svc.v46;

   408

   409

		case 0x47:

   410

			if (!HasBit(_svc.valid, 4)) { _svc.v47 = GetPlatformInfoHelper(tile, true,  false, true); SetBit(_svc.valid, 4); }

   411

			return _svc.v47;

   412

   413

		case 0x48: { // Accepted cargo types

   414

			CargoID cargo_type;

   415

			uint32 value = 0;

   416

   417

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

   418

				if (HasBit(st->goods[cargo_type].acceptance_pickup, GoodsEntry::PICKUP)) SetBit(value, cargo_type);

   419

			}

   420

			return value;

   421

		}

   422

		case 0x49:

   423

			if (!HasBit(_svc.valid, 5)) { _svc.v49 = GetPlatformInfoHelper(tile, false, true, false); SetBit(_svc.valid, 5); }

   424

			return _svc.v49;

   425

   426

		case 0x4A: // Animation frame of tile

   427

			return GetStationAnimationFrame(tile);

   428

   429

		/* Variables which use the parameter */

   430

		/* Variables 0x60 to 0x65 are handled separately below */

   431

		case 0x66: // Animation frame of nearby tile

   432

			if (parameter != 0) tile = GetNearbyTile(parameter, tile);

   433

			return st->TileBelongsToRailStation(tile) ? GetStationAnimationFrame(tile) : UINT_MAX;

   434

   435

		case 0x67: { // Land info of nearby tile

   436

			Axis axis = GetRailStationAxis(tile);

   437

   438

			if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required

   439

   440

			Slope tileh = GetTileSlope(tile, NULL);

   441

			bool swap = (axis == AXIS_Y && HasBit(tileh, SLOPE_W) != HasBit(tileh, SLOPE_E));

   442

   443

			return GetNearbyTileInformation(tile) ^ (swap ? SLOPE_EW : 0);

   444

		}

   445

   446

		case 0x68: { // Station info of nearby tiles

   447

			TileIndex nearby_tile = GetNearbyTile(parameter, tile);

   448

   449

			if (!IsRailwayStationTile(nearby_tile)) return 0xFFFFFFFF;

   450

   451

			uint32 grfid = st->speclist[GetCustomStationSpecIndex(tile)].grfid;

   452

			bool perpendicular = GetRailStationAxis(tile) != GetRailStationAxis(nearby_tile);

   453

			bool same_station = st->TileBelongsToRailStation(nearby_tile);

   454

			uint32 res = GB(GetStationGfx(nearby_tile), 1, 2) << 12 | !!perpendicular << 11 | !!same_station << 10;

   455

   456

			if (IsCustomStationSpecIndex(nearby_tile)) {

   457

				const StationSpecList ssl = GetStationByTile(nearby_tile)->speclist[GetCustomStationSpecIndex(nearby_tile)];

   458

				res |= 1 << (ssl.grfid != grfid ? 9 : 8) | ssl.localidx;

   459

			}

   460

			return res;

   461

		}

   462

   463

		/* General station properties */

   464

		case 0x82: return 50;

   465

		case 0x84: return st->string_id;

   466

		case 0x86: return 0;

   467

		case 0x8A: return st->had_vehicle_of_type;

   468

		case 0xF0: return st->facilities;

   469

		case 0xF1: return st->airport_type;

   470

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

   471

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

   472

		case 0xF6: return st->airport_flags;

   473

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

   474

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

   475

	}

   476

   477

	/* Handle cargo variables with parameter, 0x60 to 0x65 */

   478

	if (variable >= 0x60 && variable <= 0x65) {

   479

		CargoID c = GetCargoTranslation(parameter, object->u.station.statspec->grffile);

   480

   481

		if (c == CT_INVALID) return 0;

   482

		const GoodsEntry *ge = &st->goods[c];

   483

   484

		switch (variable) {

   485

			case 0x60: return min(ge->cargo.Count(), 4095);

   486

			case 0x61: return ge->days_since_pickup;

   487

			case 0x62: return ge->rating;

   488

			case 0x63: return ge->cargo.DaysInTransit();

   489

			case 0x64: return ge->last_speed | (ge->last_age << 8);

   490