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

    22

#include "town_map.h"

    23

#include "newgrf_town.h"

    24

#include "player_func.h"

    25

#include "gfx_func.h"

    27

    28

static FSMportsClass fsmports_classes[FSMPORTS_CLASS_MAX];

    29

    30

enum {

    31

	MAX_SPECLIST = 255,

    32

};

    33

    34

/**

    35

 * Reset station classes to their default state.

    36

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

    37

 * entry, for standard stations and waypoints.

    38

 */

    39

void ResetFSMportsClasses()

    40

{

    41

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

    42

		fsmports_classes[i].id = 0;

    43

		fsmports_classes[i].name = STR_EMPTY;

    44

		fsmports_classes[i].FSMports = 0;

    45

    46

		free(fsmports_classes[i].spec);

    47

		fsmports_classes[i].spec = NULL;

    48

	}

    49

    50

	/* Set up initial data */

    51

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

    52

	//fsmports_classes[0].name = STR_STAT_CLASS_DFLT;

    53

	//fsmports_classes[0].FSMports = 1;

    54

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

    55

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

    56

    57

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

    58

	//fsmports_classes[1].name = STR_STAT_CLASS_WAYP;

    59

	//fsmports_classes[1].FSMports = 1;

    60

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

    61

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

    62

}

    63

    64

/**

    65

 * Allocate a station class for the given class id.

    66

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

    67

 * @return Index into station_classes of allocated class.

    68

 */

    69

FSMportsClassID AllocateFSMportsClass(uint32 cls)

    70

{

    71

	if (cls == SYSTEM_HIDDEN_CLASS) {

    72

		fsmports_classes[31].id = cls;

    73

		return FSMPORTS_CLASS_SYST;

    74

	}

    75

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

    76

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

    77

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

    78

			return i;

    79

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

    80

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

    81

			fsmports_classes[i].id = cls;

    82

			return i;

    83

		}

    84

	}

    85

    86

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

    87

	return FSMPORTS_CLASS_DFLT;

    88

}

    89

    90

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

    91

void SetFSMportsClassName(FSMportsClassID sclass, StringID name)

    92

{

    93

	assert(sclass < FSMPORTS_CLASS_MAX);

    94

	fsmports_classes[sclass].name = name;

    95

}

    96

    97

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

    98

StringID GetFSMportsClassName(FSMportsClassID sclass)

    99

{

   100

	assert(sclass < FSMPORTS_CLASS_MAX);

   101

	return fsmports_classes[sclass].name;

   102

}

   103

   104

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

   105

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

   106

 */

   108

{

   110

   114

	}

   115

   117

}

   118

   119

/**

   120

 * Get the number of station classes in use.

   121

 * @return Number of station classes.

   122

 */

   123

uint GetNumFSMportsClasses()

   124

{

   125

	uint i;

   126

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

   127

	return i;

   128

}

   129

   130

/**

   131

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

   132

 * @param sclass Index of the station class.

   133

 * @return Number of stations in the class.

   134

 */

   135

uint GetNumCustomFSMports(FSMportsClassID sclass)

   136

{

   137

	assert(sclass < FSMPORTS_CLASS_MAX);

   138

	return fsmports_classes[sclass].FSMports;

   139

}

   140

   141

/**

   142

 * Tie a fsmport spec to its class.

   143

 * @param fsmportspec The station spec.

   144

 */

   145

void SetCustomFSMportsSpec(FSMportsSpec *fsmportspec)

   146

{

   147

	FSMportsClass *fsmports_class;

   148

	int i;

   149

   150

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

   151

	if (fsmportspec->allocated) return;

   152

   153

	assert(fsmportspec->sclass < FSMPORTS_CLASS_MAX);

   154

	fsmports_class = &fsmports_classes[fsmportspec->sclass];

   155

   156

	i = fsmports_class->FSMports++;

   157

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

   158

   159

	fsmports_class->spec[i] = fsmportspec;

   160

	fsmportspec->allocated = true;

   161

}

   162

   163

/**

   164

 * Retrieve a fsmspec from a class.

   165

 * @param sclass Index of the fsm class.

   166

 * @param fsport The index with the class.

   167

 * @return The fsmspec.

   168

 */

   169

FSMportsSpec *GetCustomFSMportsSpec(FSMportsClassID sclass, uint fsmport)

   170

{

   171

	assert(sclass < FSMPORTS_CLASS_MAX);

   172

	if (fsmport < fsmports_classes[sclass].FSMports)

   173

		return fsmports_classes[sclass].spec[fsmport];

   174

   175

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

   176

	 * probably was not loaded. */

   177

	return NULL;

   178

}

   179

   180

   181

const FSMportsSpec *GetCustomFSMportsSpecByGrf(uint32 grfid, byte localidx)

   182

{

   183

	uint j;

   184

   185

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

   186

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

   187

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

   188

			if (fsmportspec == NULL) continue;

   189

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

   190

		}

   191

	}

   192

   193

	return NULL;

   194

}

   195

   196

TileIndexDiffC RotateFSMPosition(TileIndexDiffC position, byte size_x, byte size_y, byte FSM_orientation)

   197

{

   198

	TileIndexDiffC new_position;

   199

   200

	switch (FSM_orientation) {

   201

		case DIR_NE:

   202

			new_position = position;

   203

			break;

   204

		case DIR_SE:

   205

			new_position.x = position.y;

   206

			new_position.y = size_y - (position.x + 1);

   207

			/*note that size_y is used here, because the size_x is the size_x of the set, which is size_y in the 01 orientation */

   208

			break;

   209

		case DIR_SW:

   210

			new_position.x = size_x - (position.x + 1);

   211

			new_position.y = size_y - (position.y + 1);

   212

			break;

   213

		case DIR_NW:

   214

			new_position.x = size_x - (position.y + 1);

   215

			/*note that size_x is used here, because the size_y is the size_y of the set, which is size_x in the 01 orientation */

   216

			new_position.y = position.x;

   217

			break;

   218

		default:

   219

			new_position = position;

   220

			break;

   221

	}

   222

   223

	return new_position;

   224

}

   225

   226

/* FSMports Resolver Functions */

   227

static uint32 FSMportsGetRandomBits(const ResolverObject *object)

   228

{

   229

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

   230

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

   231

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

   232

}

   233

   234

   235

static uint32 FSMportsGetTriggers(const ResolverObject *object)

   236

{

   237

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

   238

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

   239

}

   240

   241

   242

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

   243

{

   244

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

   245

	assert(st != NULL);

   246

	st->waiting_triggers = triggers;

   247

}

   248

   249

/**

   250

 * FSMports variable cache

   251

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

   252

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

   253

 */

   254

static struct {

   255

	uint32 v40;

   256

	uint32 v41;

   257

	uint32 v45;

   258

	uint32 v46;

   259

	uint32 v47;

   260

	uint32 v49;

   261

	uint8 valid;

   262

} _svc;

   263

   264

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

   265

{

   266

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

   267

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

   268

   269

	if (object->scope == VSG_SCOPE_PARENT) {

   270

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

   271

		Town *t;

   272

   273

		if (st != NULL) {

   274

			t = st->town;

   275

		} else if (tile != INVALID_TILE) {

   276

			t = GetTownByTile(tile);

   277

		} else {

   278

			*available = false;

   279

			return UINT_MAX;

   280

		}

   281

   282

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

   283

	}

   284

   285

	if (st == NULL) {

   286

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

   287

		switch (variable) {

   288

			case 0x40:

   289

			case 0x41:

   290

			case 0x46:

   291

			case 0x47:

   292

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

   293

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

   294

			case 0x43: return _current_player; // Station owner

   295

			case 0x44: return 2;               // PBS status

   296

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

   297

		}

   298

   299

		*available = false;

   300

		return UINT_MAX;

   301

	}

   302

   303

	switch (variable) {

   304

		/* Calculated station variables */

   305

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

   306

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

   307

		case 0x48: { // Accepted cargo types

   308

			CargoID cargo_type;

   309

			uint32 value = 0;

   310

   311

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

   312

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

   313

			}

   314

			return value;

   315

		}

   316

		/* Variables which use the parameter */

   317

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

   318

   319

		/* General station properties */

   320

		case 0x82: return 50;

   321

		case 0x84: return st->string_id;

   322

		case 0x86: return 0;

   323

		case 0x8A: return st->had_vehicle_of_type;

   324

		case 0xF0: return st->facilities;

   325

		case 0xF1: return st->airport_type;

   326

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

   327

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

   328

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

   329

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

   330

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

   331

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

   332

	}

   333

   334

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

   335

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

   336

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

   337

   338

		if (c == CT_INVALID) return 0;

   339

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

   340

   341

		switch (variable) {

   342

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

   343

			case 0x61: return ge->days_since_pickup;

   344

			case 0x62: return ge->rating;

   345

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

   346

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

   347

			case 0x65: return GB(ge->acceptance_pickup, GoodsEntry::ACCEPTANCE, 1) << 3;

   348

		}

   349

	}

   350

   351

	/* Handle cargo variables (deprecated) */

   352

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

   353

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

   354

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

   355

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

   356

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

   357

			case 2: return g->days_since_pickup;

   358

			case 3: return g->rating;

   359

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

   360

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

   361

			case 6: return g->last_speed;

   362

			case 7: return g->last_age;

   363

		}

   364

	}

   365

   366

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

   367

   368

	*available = false;

   369

	return UINT_MAX;

   370

}

   371

   372

   373

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

   374

{

   375

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

   376

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

   377

	uint set;

   378

   379

	uint cargo = 0;

   380

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

   381

   382

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

   383

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

   384

	}

   385

   386

	switch (cargo_type) {

   387

		case CT_INVALID:

   388

		case CT_DEFAULT_NA:

   389

		case CT_PURCHASE:

   390

			cargo = 0;

   391

			break;

   392

   393

		case CT_DEFAULT:

   394

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

   395

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

   396

			}

   397

			break;

   398

   399

		default:

   400

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

   401

			break;

   402

	}

   403

   404

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

   405

	cargo = min(0xfff, cargo);

   406

   407

	if (cargo > fsmportspec->cargo_threshold) {

   408

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

   409

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

   410

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

   411

		}

   412

	} else {

   413

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

   414

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

   415

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

   416

		}

   417

	}

   418

   419

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

   420

}

   421

   422

   423

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

   424

{

   425

	res->GetRandomBits = FSMportsGetRandomBits;

   426

	res->GetTriggers   = FSMportsGetTriggers;

   427

	res->SetTriggers   = FSMportsSetTriggers;

   428

	res->GetVariable   = FSMportsGetVariable;

   429

	res->ResolveReal   = FSMportsResolveReal;

   430

   431

	res->u.station.st       = st;

   432

	res->u.station.fsmportspec = fsmportspec;

   433

	res->u.station.tile     = tile;

   434

   435

	res->callback        = CBID_NO_CALLBACK;

   436

	res->callback_param1 = 0;

   437

	res->callback_param2 = 0;

   438

	res->last_value      = 0;

   439

	res->trigger         = 0;

   440

	res->reseed          = 0;

   441

}

   442

   443

static const SpriteGroup *ResolveFSMports(ResolverObject *object)

   444

{

   445

	const SpriteGroup *group;

   446

	CargoID ctype = CT_DEFAULT_NA;

   447

   448

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

   449

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

   450

		ctype = CT_PURCHASE;

   451

	} else {

   452

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

   453

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

   454

			const CargoSpec *cs = GetCargo(cargo);

   455

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

   456

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

   457

				ctype = cargo;

   458

				break;

   459

			}

   460

		}

   461

	}

   462

   463

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

   464

	if (group == NULL) {

   465

		ctype = CT_DEFAULT;

   466

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

   467

	}

   468

   469

	if (group == NULL) return NULL;

   470

   471

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

   472

	object->u.station.cargo_type = ctype;

   473

   474

	/* Invalidate all cached vars */

   475

	_svc.valid = 0;

   476

   477

	return Resolve(group, object);

   478

}

   479

   480

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

   481

{

   482

	const SpriteGroup *group;

   483

	ResolverObject object;

   484

   485

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

   486

   487

	group = ResolveFSMports(&object);

   488

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

   489

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

   490

}

   491

   492

   493

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

   494

{

   495

	const SpriteGroup *group;

   496

	ResolverObject object;

   497

   498

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

   499

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

   500

   501

	group = ResolveFSMports(&object);

   502

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

   503

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

   504

}

   505

   506

   507

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

   508

{

   509

	const SpriteGroup *group;

   510

	ResolverObject object;

   511

   512

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

   513

   514

	object.callback        = callback;

   515

	object.callback_param1 = param1;

   516

	object.callback_param2 = param2;

   517

   518

	group = ResolveFSMports(&object);

   519

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

   520

	return group->g.callback.result;

   521

}

   522

   523