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

    10

#include "debug.h"

    11

#include "sprite.h"

    12

#include "table/sprites.h"

    13

#include "table/strings.h"

    14

#include "station.h"

    15

#include "station_map.h"

    16

#include "newgrf.h"

    17

#include "newgrf_callbacks.h"

    18

#include "newgrf_commons.h"

    19

#include "newgrf_station.h"

    20

#include "newgrf_spritegroup.h"

    21

#include "date.h"

    22

#include "helpers.hpp"

    23

#include "cargotype.h"

    24

#include "town_map.h"

    25

#include "newgrf_town.h"

    26

    27

static FSMportsClass fsmports_classes[FSMPORTS_CLASS_MAX];

    28

    29

enum {

    30

	MAX_SPECLIST = 255,

    31

};

    32

    33

/**

    34

 * Reset station classes to their default state.

    35

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

    36

 * entry, for standard stations and waypoints.

    37

 */

    38

void ResetFSMportsClasses()

    39

{

    40

	for (FSMportsClassID i = FSMPORTS_CLASS_BEGIN; i < FSMPORTS_CLASS_MAX; i++) {

    41

		fsmports_classes[i].id = 0;

    42

		fsmports_classes[i].name = STR_EMPTY;

    43

		fsmports_classes[i].FSMports = 0;

    44

    45

		free(fsmports_classes[i].spec);

    46

		fsmports_classes[i].spec = NULL;

    47

	}

    48

    49

	/* Set up initial data */

    50

	//fsmports_classes[0].id = 'DFLT';

    51

	//fsmports_classes[0].name = STR_STAT_CLASS_DFLT;

    52

	//fsmports_classes[0].FSMports = 1;

    53

	//fsmports_classes[0].spec = MallocT<FSMportsSpec*>(1);

    54

	//fsmports_classes[0].spec[0] = NULL;

    55

    56

	//fsmports_classes[1].id = 'WAYP';

    57

	//fsmports_classes[1].name = STR_STAT_CLASS_WAYP;

    58

	//fsmports_classes[1].FSMports = 1;

    59

	//fsmports_classes[1].spec = MallocT<FSMportsSpec*>(1);

    60

	//fsmports_classes[1].spec[0] = NULL;

    61

}

    62

    63

/**

    64

 * Allocate a station class for the given class id.

    65

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

    66

 * @return Index into station_classes of allocated class.

    67

 */

    68

FSMportsClassID AllocateFSMportsClass(uint32 cls)

    69

{

    70

	for (FSMportsClassID i = FSMPORTS_CLASS_BEGIN; i < FSMPORTS_CLASS_MAX; i++) {

    71

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

    72

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

    73

			return i;

    74

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

    75

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

    76

			fsmports_classes[i].id = cls;

    77

			return i;

    78

		}

    79

	}

    80

    81

	grfmsg(2, "FSMportsClassAllocate: already allocated %d classes, using default", FSMPORTS_CLASS_MAX);

    82

	return FSMPORTS_CLASS_DFLT;

    83

}

    84

    85

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

    86

void SetFSMportsClassName(FSMportsClassID sclass, StringID name)

    87

{

    88

	assert(sclass < FSMPORTS_CLASS_MAX);

    89

	fsmports_classes[sclass].name = name;

    90

}

    91

    92

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

    93

StringID GetFSMportsClassName(FSMportsClassID sclass)

    94

{

    95

	assert(sclass < FSMPORTS_CLASS_MAX);

    96

	return fsmports_classes[sclass].name;

    97

}

    98

    99

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

   100

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

   101

 */

   102

StringID *BuildFSMportsClassDropdown()

   103

{

   104

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

   105

	static StringID names[FSMPORTS_CLASS_MAX + 1];

   106

	uint i;

   107

   108

	/* Add each name */

   109

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

   110

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

   111

	}

   112

	/* Terminate the list */

   113

	names[i] = INVALID_STRING_ID;

   114

   115

	return names;

   116

}

   117

   118

/**

   119

 * Get the number of station classes in use.

   120

 * @return Number of station classes.

   121

 */

   122

uint GetNumFSMportsClasses()

   123

{

   124

	uint i;

   125

	for (i = 0; i < FSMPORTS_CLASS_MAX && fsmports_classes[i].id != 0; i++);

   126

	return i;

   127

}

   128

   129

/**

   130

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

   131

 * @param sclass Index of the station class.

   132

 * @return Number of stations in the class.

   133

 */

   134

uint GetNumCustomFSMports(FSMportsClassID sclass)

   135

{

   136

	assert(sclass < FSMPORTS_CLASS_MAX);

   137

	return fsmports_classes[sclass].FSMports;

   138

}

   139

   140

/**

   141

 * Tie a fsmport spec to its class.

   142

 * @param fsmportspec The station spec.

   143

 */

   144

void SetCustomFSMportsSpec(FSMportsSpec *fsmportspec)

   145

{

   146

	FSMportsClass *fsmports_class;

   147

	int i;

   148

   149

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

   150

	if (fsmportspec->allocated) return;

   151

   152

	assert(fsmportspec->sclass < FSMPORTS_CLASS_MAX);

   153

	fsmports_class = &fsmports_classes[fsmportspec->sclass];

   154

   155

	i = fsmports_class->FSMports++;

   156

	fsmports_class->spec = ReallocT(fsmports_class->spec, fsmports_class->FSMports);

   157

   158

	fsmports_class->spec[i] = fsmportspec;

   159

	fsmportspec->allocated = true;

   160

}

   161

   162

/**

   163

 * Retrieve a fsmspec from a class.

   164

 * @param sclass Index of the fsm class.

   165

 * @param fsport The index with the class.

   166

 * @return The fsmspec.

   167

 */

   168

const FSMportsSpec *GetCustomFSMportsSpec(FSMportsClassID sclass, uint fsmport)

   169

{

   170

	assert(sclass < FSMPORTS_CLASS_MAX);

   171

	if (fsmport < fsmports_classes[sclass].FSMports)

   172

		return fsmports_classes[sclass].spec[fsmport];

   173

   174

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

   175

	 * probably was not loaded. */

   176

	return NULL;

   177

}

   178

   179

   180

const FSMportsSpec *GetCustomFSMportsSpecByGrf(uint32 grfid, byte localidx)

   181

{

   182

	uint j;

   183

   184

	for (FSMportsClassID i = FSMPORTS_CLASS_BEGIN; i < FSMPORTS_CLASS_MAX; i++) {

   185

		for (j = 0; j < fsmports_classes[i].FSMports; j++) {

   186

			const FSMportsSpec *fsmportspec = fsmports_classes[i].spec[j];

   187

			if (fsmportspec == NULL) continue;

   188

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

   189

		}

   190

	}

   191

   192

	return NULL;

   193

}

   194

   224

   225

/* FSMports Resolver Functions */

   226

static uint32 FSMportsGetRandomBits(const ResolverObject *object)

   227

{

   228

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

   229

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

   230

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

   231

}

   232

   233

   234

static uint32 FSMportsGetTriggers(const ResolverObject *object)

   235

{

   236

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

   237

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

   238

}

   239

   240

   241

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

   242

{

   243

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

   244

	assert(st != NULL);

   245

	st->waiting_triggers = triggers;

   246

}

   247

   248

/**

   249

 * FSMports variable cache

   250

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

   251

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

   252

 */

   253

static struct {

   254

	uint32 v40;

   255

	uint32 v41;

   256

	uint32 v45;

   257

	uint32 v46;

   258

	uint32 v47;

   259

	uint32 v49;

   260

	uint8 valid;

   261

} _svc;

   262

   263

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

   264

{

   265

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

   266

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

   267

   268

	if (object->scope == VSG_SCOPE_PARENT) {

   269

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

   270

		Town *t;

   271

   272

		if (st != NULL) {

   273

			t = st->town;

   274

		} else if (tile != INVALID_TILE) {

   275

			t = GetTownByTile(tile);

   276

		} else {

   277

			*available = false;

   278

			return UINT_MAX;

   279

		}

   280

   281

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

   282

	}

   283

   284

	if (st == NULL) {

   285

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

   286

		switch (variable) {

   287

			case 0x40:

   288

			case 0x41:

   289

			case 0x46:

   290

			case 0x47:

   291

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

   292

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

   293

			case 0x43: return _current_player; // Station owner

   294

			case 0x44: return 2;               // PBS status

   295

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

   296

		}

   297

   298

		*available = false;

   299

		return UINT_MAX;

   300

	}

   301

   302

	switch (variable) {

   303

		/* Calculated station variables */

   304

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

   305

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

   306

		case 0x48: { // Accepted cargo types

   307

			CargoID cargo_type;

   308

			uint32 value = 0;

   309

   310

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

   311

				if (st->goods[cargo_type].acceptance) SETBIT(value, cargo_type);

   312

			}

   313

			return value;

   314

		}

   315

		/* Variables which use the parameter */

   316

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

   317

   318

		/* General station properties */

   319

		case 0x82: return 50;

   320

		case 0x84: return st->string_id;

   321

		case 0x86: return 0;

   322

		case 0x8A: return st->had_vehicle_of_type;

   323

		case 0xF0: return st->facilities;

   324

		case 0xF1: return st->airport_type;

   325

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

   326

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

   327

		//TODO: need to decide how/what to return

   328

		//case 0xF6: return st->airport_flags;

   329

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

   330

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

   331

	}

   332

   333

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

   334

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

   335

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

   336

   337

		if (c == CT_INVALID) return 0;

   338

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

   339

   340

		switch (variable) {

   341

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

   342

			case 0x61: return ge->days_since_pickup;

   343

			case 0x62: return ge->rating;

   344

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

   345

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

   346

			case 0x65: return ge->acceptance << 3;

   347

		}

   348

	}

   349

   350

	/* Handle cargo variables (deprecated) */

   351

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

   352

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

   353

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

   354

			case 0: return g->cargo.Count();

   355

			case 1: return GB(min(g->cargo.Count(), 4095), 0, 4) | (g->acceptance << 7);

   356

			case 2: return g->days_since_pickup;

   357

			case 3: return g->rating;

   358

			case 4: return g->cargo.Source();

   359

			case 5: return g->cargo.DaysInTransit();

   360

			case 6: return g->last_speed;

   361

			case 7: return g->last_age;

   362

		}

   363

	}

   364

   365

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

   366

   367

	*available = false;

   368

	return UINT_MAX;

   369

}

   370

   371

   372

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

   373

{

   374

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

   375

	const FSMportsSpec *fsmportspec = object->u.station.fsmportspec;

   376

	uint set;

   377

   378

	uint cargo = 0;

   379

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

   380

   381

	if (st == NULL || fsmportspec->sclass == FSMPORTS_CLASS_WAYP) {

   382

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

   383

	}

   384

   385

	switch (cargo_type) {

   386

		case CT_INVALID:

   387

		case CT_DEFAULT_NA:

   388

		case CT_PURCHASE:

   389

			cargo = 0;

   390

			break;

   391

   392

		case CT_DEFAULT:

   393

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

   394

				cargo += st->goods[cargo_type].cargo.Count();

   395

			}

   396

			break;

   397

   398

		default:

   399

			cargo = st->goods[cargo_type].cargo.Count();

   400

			break;

   401

	}

   402

   403

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

   404

	cargo = min(0xfff, cargo);

   405

   406

	if (cargo > fsmportspec->cargo_threshold) {

   407

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

   408

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

   409

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

   410

		}

   411

	} else {

   412

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

   413

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

   414

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

   415

		}

   416

	}

   417

   418

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

   419

}

   420

   421

   422

static void NewFSMportsResolver(ResolverObject *res, const FSMportsSpec *fsmportspec, const Station *st, TileIndex tile)

   423

{

   424

	res->GetRandomBits = FSMportsGetRandomBits;

   425

	res->GetTriggers   = FSMportsGetTriggers;

   426

	res->SetTriggers   = FSMportsSetTriggers;

   427

	res->GetVariable   = FSMportsGetVariable;

   428

	res->ResolveReal   = FSMportsResolveReal;

   429

   430

	res->u.station.st       = st;

   431

	res->u.station.fsmportspec = fsmportspec;

   432

	res->u.station.tile     = tile;

   433

   434

	res->callback        = CBID_NO_CALLBACK;

   435

	res->callback_param1 = 0;

   436

	res->callback_param2 = 0;

   437

	res->last_value      = 0;

   438

	res->trigger         = 0;

   439

	res->reseed          = 0;

   440

}

   441

   442

static const SpriteGroup *ResolveFSMports(ResolverObject *object)

   443

{

   444

	const SpriteGroup *group;

   445

	CargoID ctype = CT_DEFAULT_NA;

   446

   447

	if (object->u.station.st == NULL) {

   448

		/* No station, so we are in a purchase list */

   449

		ctype = CT_PURCHASE;

   450

	} else {

   451

		/* Pick the first cargo that we have waiting */

   452

		for (CargoID cargo = 0; cargo < NUM_CARGO; cargo++) {

   453

			const CargoSpec *cs = GetCargo(cargo);

   454

			if (cs->IsValid() && object->u.station.fsmportspec->spritegroup[cargo] != NULL &&

   455

					!object->u.station.st->goods[cargo].cargo.Empty()) {

   456

				ctype = cargo;

   457

				break;

   458

			}

   459

		}

   460

	}

   461

   462

	group = object->u.station.fsmportspec->spritegroup[ctype];

   463

	if (group == NULL) {

   464

		ctype = CT_DEFAULT;

   465

		group = object->u.station.fsmportspec->spritegroup[ctype];

   466

	}

   467

   468

	if (group == NULL) return NULL;

   469

   470

	/* Remember the cargo type we've picked */

   471

	object->u.station.cargo_type = ctype;

   472

   473

	/* Invalidate all cached vars */

   474

	_svc.valid = 0;

   475

   476

	return Resolve(group, object);

   477

}

   478

   479

SpriteID GetCustomFSMportsRelocation(const FSMportsSpec *fsmportspec, const Station *st, TileIndex tile)

   480

{

   481

	const SpriteGroup *group;

   482

	ResolverObject object;

   483

   484

	NewFSMportsResolver(&object, fsmportspec, st, tile);

   485

   486

	group = ResolveFSMports(&object);

   487

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

   488

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

   489

}

   490

   491

   492

SpriteID GetCustomFSMportsGroundRelocation(const FSMportsSpec *fsmportspec, const Station *st, TileIndex tile)

   493

{

   494

	const SpriteGroup *group;

   495

	ResolverObject object;

   496

   497

	NewFSMportsResolver(&object, fsmportspec, st, tile);

   498

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

   499

   500

	group = ResolveFSMports(&object);

   501

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

   502

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

   503

}

   504

   505

   506

uint16 GetFSMportsCallback(CallbackID callback, uint32 param1, uint32 param2, const FSMportsSpec *fsmportspec, const Station *st, TileIndex tile)

   507

{

   508

	const SpriteGroup *group;

   509

	ResolverObject object;

   510

   511

	NewFSMportsResolver(&object, fsmportspec, st, tile);

   512

   513

	object.callback        = callback;

   514

	object.callback_param1 = param1;

   515

	object.callback_param2 = param2;

   516

   517

	group = ResolveFSMports(&object);

   518

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

   519

	return group->g.callback.result;

   520

}

   521

   522

   523

/**

   524

 * Allocate a FSMportsSpec to a Station. This is called once per build operation.

   525

 * @param statspec FSMportsSpec to allocate.

   526

 * @param st Station to allocate it to.