1

/* $Id$ */

     2

     3

/** @file newgrf_station.c 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_callbacks.h"

    16

#include "newgrf_station.h"

    17

#include "newgrf_spritegroup.h"

    18

#include "date.h"

    19

    20

static StationClass station_classes[STAT_CLASS_MAX];

    21

    22

enum {

    23

	MAX_SPECLIST = 255,

    24

};

    25

    26

/**

    27

 * Reset station classes to their default state.

    28

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

    29

 * entry, for standard stations and waypoints.

    30

 */

    31

void ResetStationClasses(void)

    32

{

    33

	StationClassID i;

    34

	for (i = 0; i < STAT_CLASS_MAX; i++) {

    35

		station_classes[i].id = 0;

    36

		station_classes[i].name = STR_EMPTY;

    37

		station_classes[i].stations = 0;

    38

    39

		free(station_classes[i].spec);

    40

		station_classes[i].spec = NULL;

    41

	}

    42

    43

	// Set up initial data

    44

	station_classes[0].id = 'DFLT';

    45

	station_classes[0].name = STR_STAT_CLASS_DFLT;

    46

	station_classes[0].stations = 1;

    47

	station_classes[0].spec = malloc(sizeof(*station_classes[0].spec));

    48

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

    49

    50

	station_classes[1].id = 'WAYP';

    51

	station_classes[1].name = STR_STAT_CLASS_WAYP;

    52

	station_classes[1].stations = 1;

    53

	station_classes[1].spec = malloc(sizeof(*station_classes[1].spec));

    54

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

    55

}

    56

    57

/**

    58

 * Allocate a station class for the given class id.

    59

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

    60

 * @return Index into station_classes of allocated class.

    61

 */

    62

StationClassID AllocateStationClass(uint32 class)

    63

{

    64

	StationClassID i;

    65

    66

	for (i = 0; i < STAT_CLASS_MAX; i++) {

    67

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

    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 = class;

    73

			return i;

    74

		}

    75

	}

    76

    77

	DEBUG(grf, 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

 */

    98

StringID *BuildStationClassDropdown(void)

    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

 */

   118

uint GetNumStationClasses(void)

   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 = realloc(station_class->spec, station_class->stations * sizeof(*station_class->spec));

   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

	StationClassID i;

   179

	uint j;

   180

   181

	for (i = STAT_CLASS_DFLT; i < STAT_CLASS_MAX; i++) {

   182

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

   183

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

   184

			if (statspec == NULL) continue;

   185

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

   186

		}

   187

	}

   188

   189

	return NULL;

   190

}

   191

   192

   193

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

   194

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

   195

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

   196

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

   197

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

   198

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

   199

 */

   200

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

   201

{

   202

	uint32 retval = 0;

   203

   204

	if (axis == AXIS_X) {

   205

		intswap(platforms, length);

   206

		intswap(x, y);

   207

	}

   208

   209

	/* Limit our sizes to 4 bits */

   210

	platforms = min(15, platforms);

   211

	length    = min(15, length);

   212

	x = min(15, x);

   213

	y = min(15, y);

   214

	if (centred) {

   215

		x -= platforms / 2;

   216

		y -= length / 2;

   217

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

   218

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

   219

	} else {

   220

		SB(retval,  0, 4, y);

   221

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

   222

		SB(retval,  8, 4, x);

   223

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

   224

	}

   225

	SB(retval, 16, 4, length);

   226

	SB(retval, 20, 4, platforms);

   227

	SB(retval, 24, 4, tile);

   228

   229

	return retval;

   230

}

   231

   232

   233

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

   234

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

   235

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

   236

 */

   237

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

   238

{

   239

	bool waypoint;

   240

	byte orig_type = 0;

   241

	Axis orig_axis = AXIS_X;

   242

   243

	waypoint = IsTileType(tile, MP_RAILWAY);

   244

   245

	if (waypoint) {

   246

		if (check_axis) orig_axis = GetWaypointAxis(tile);

   247

	} else {

   248

		if (check_type) orig_type = GetCustomStationSpecIndex(tile);

   249

		if (check_axis) orig_axis = GetRailStationAxis(tile);

   250

	}

   251

   252

	while (true) {

   253

		TileIndex new_tile = TILE_ADD(tile, delta);

   254

   255

		if (waypoint) {

   256

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

   257

			if (!IsRailWaypoint(new_tile)) break;

   258

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

   259

		} else {

   260

			if (!IsRailwayStationTile(new_tile)) break;

   261

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

   262

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

   263

		}

   264

   265

		tile = new_tile;

   266

	}

   267

	return tile;

   268

}

   269

   270

   271

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

   272

{

   273

	int tx = TileX(tile);

   274

	int ty = TileY(tile);

   275

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

   276

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

   277

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

   278

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

   279

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

   280

   281

	tx -= sx; ex -= sx;

   282

	ty -= sy; ey -= sy;

   283

   284

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

   285

}

   286

   287

   288

/* Station Resolver Functions */

   289

static uint32 StationGetRandomBits(const ResolverObject *object)

   290

{

   291

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

   292

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

   293

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

   294

}

   295

   296

   297

static uint32 StationGetTriggers(const ResolverObject *object)

   298

{

   299

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

   300

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

   301

}

   302

   303

   304

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

   305

{

   306

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

   307

	assert(st != NULL);

   308

	st->waiting_triggers = triggers;

   309

}

   310

   311

   312

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

   313

{

   314

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

   315

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

   316

   317

	if (st == NULL) {

   318

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

   319

		switch (variable) {

   320

			case 0x40:

   321

			case 0x41:

   322

			case 0x46:

   323

			case 0x47:

   324

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

   325

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

   326

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

   327

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

   328

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

   329

		}

   330

   331

		*available = false;

   332

		return -1;

   333

	}

   334

   335

	switch (variable) {

   336

		/* Calculated station variables */

   337

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

   338

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

   339

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

   340

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

   341

			       (GetRailType(tile) << 8);

   342

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

   343

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

   344

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

   345

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

   346

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

   347

			CargoID cargo_type;

   348

			uint32 value = 0;

   349

   350

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

   351

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

   352

			}

   353

			return value;

   354

		}

   355

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

   356

   357

		/* Variables which use the parameter */

   358

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

   359

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

   360

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

   361

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

   362

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

   363

   364

		/* General station properties */

   365

		case 0x82: return 50;

   366

		case 0x84: return st->string_id;

   367

		case 0x86: return 0;

   368

		case 0x8A: return st->had_vehicle_of_type;

   369

		case 0xF0: return st->facilities;

   370

		case 0xF1: return st->airport_type;

   371

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

   372

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

   373

		case 0xF6: return st->airport_flags;

   374

		case 0xF7: return st->airport_flags & 0xFF;

   375

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

   376

	}

   377

   378

	/* Handle cargo variables (deprecated) */

   379

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

   380

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

   381

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

   382

			case 0: return g->waiting_acceptance;

   383

			case 1: return g->waiting_acceptance & 0xFF;

   384

			case 2: return g->days_since_pickup;

   385

			case 3: return g->rating;

   386

			case 4: return g->enroute_from;

   387

			case 5: return g->enroute_time;

   388

			case 6: return g->last_speed;

   389

			case 7: return g->last_age;

   390

		}

   391

	}

   392

   393

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

   394

   395

	*available = false;

   396

	return -1;

   397

}

   398

   399

   400

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

   401

{

   402

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

   403

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

   404

	uint set;

   405

   406

	uint cargo = 0;

   407

	CargoID cargo_type = CT_INVALID; /* XXX Pick the correct cargo type */

   408

   409

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

   410

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

   411

	}

   412

   413

	if (cargo_type == CT_INVALID) {

   414

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

   415

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

   416

		}

   417

	} else {

   418

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

   419

	}

   420

   421

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

   422

	cargo = min(0xfff, cargo);

   423

   424

	if (cargo > statspec->cargo_threshold) {

   425

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

   426

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

   427

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

   428

		}

   429

	} else {

   430

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

   431

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

   432

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

   433

		}

   434

	}

   435

   436

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

   437

}

   438

   439

   440

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

   441

{

   442

	res->GetRandomBits = StationGetRandomBits;

   443

	res->GetTriggers   = StationGetTriggers;

   444

	res->SetTriggers   = StationSetTriggers;

   445

	res->GetVariable   = StationGetVariable;

   446

	res->ResolveReal   = StationResolveReal;

   447

   448

	res->u.station.st       = st;

   449

	res->u.station.statspec = statspec;

   450

	res->u.station.tile     = tile;

   451

   452

	res->callback        = 0;

   453

	res->callback_param1 = 0;

   454

	res->callback_param2 = 0;

   455

	res->last_value      = 0;

   456

	res->trigger         = 0;

   457

	res->reseed          = 0;

   458

}

   459

   460

   461

SpriteID GetCustomStationRelocation(const StationSpec *statspec, const Station *st, TileIndex tile)

   462

{

   463

	const SpriteGroup *group;

   464

	ResolverObject object;

   465

	CargoID ctype = (st == NULL) ? GC_PURCHASE : GC_DEFAULT_NA;

   466

   467

	NewStationResolver(&object, statspec, st, tile);

   468

   469

	group = Resolve(statspec->spritegroup[ctype], &object);

   470

	if ((group == NULL || group->type != SGT_RESULT) && ctype != GC_DEFAULT_NA) {

   471

		group = Resolve(statspec->spritegroup[GC_DEFAULT_NA], &object);

   472

	}

   473

	if ((group == NULL || group->type != SGT_RESULT) && ctype != GC_DEFAULT) {

   474

		group = Resolve(statspec->spritegroup[GC_DEFAULT], &object);

   475

	}

   476

   477

	if (group == NULL || group->type != SGT_RESULT) return 0;

   478

   479

	return group->g.result.sprite - 0x42D;

   480

}

   481

   482

   483

SpriteID GetCustomStationGroundRelocation(const StationSpec *statspec, const Station *st, TileIndex tile)

   484

{

   485

	const SpriteGroup *group;

   486

	ResolverObject object;

   487

	CargoID ctype = (st == NULL) ? GC_PURCHASE : GC_DEFAULT_NA;

   488

   489

	NewStationResolver(&object, statspec, st, tile);

   490

	object.callback_param1 = 1; /* Indicate we are resolving the ground sprite */

   491

   492

	group = Resolve(statspec->spritegroup[ctype], &object);

   493

	if ((group == NULL || group->type != SGT_RESULT) && ctype != GC_DEFAULT_NA) {

   494

		group = Resolve(statspec->spritegroup[GC_DEFAULT_NA], &object);

   495

	}

   496

	if ((group == NULL || group->type != SGT_RESULT) && ctype != GC_DEFAULT) {

   497

		group = Resolve(statspec->spritegroup[GC_DEFAULT], &object);