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_base.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"

    25

#include "player_func.h"

    26

#include "gfx_func.h"

    27

#include "strings_func.h"

    28

#include "widgets/dropdown_type.h"

    29

    30

static FSMportsClass fsmports_classes[FSMPORTS_CLASS_MAX];

    31

    32

enum {

    33

	MAX_SPECLIST = 255,

    34

};

    35

    36

/**

    37

 * Reset station classes to their default state.

    38

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

    39

 * entry, for standard stations and waypoints.

    40

 */

    41

void ResetFSMportsClasses()

    42

{

    43

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

    44

		fsmports_classes[i].id = 0;

    45

		fsmports_classes[i].name = STR_EMPTY;

    46

		fsmports_classes[i].FSMports = 0;

    47

    48

		free(fsmports_classes[i].spec);

    49

		fsmports_classes[i].spec = NULL;

    50

	}

    51

    52

	/* Set up initial data */

    53

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

    54

	//fsmports_classes[0].name = STR_STAT_CLASS_DFLT;

    55

	//fsmports_classes[0].FSMports = 1;

    56

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

    57

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

    58

    59

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

    60

	//fsmports_classes[1].name = STR_STAT_CLASS_WAYP;

    61

	//fsmports_classes[1].FSMports = 1;

    62

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

    63

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

    64

}

    65

    66

/**

    67

 * Allocate a station class for the given class id.

    68

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

    69

 * @return Index into station_classes of allocated class.

    70

 */

    71

FSMportsClassID AllocateFSMportsClass(uint32 cls)

    72

{

    73

	if (cls == SYSTEM_HIDDEN_CLASS) {

    74

		fsmports_classes[31].id = cls;

    75

		return FSMPORTS_CLASS_SYST;

    76

	}

    77

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

    78

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

    79

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

    80

			return i;

    81

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

    82

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

    83

			fsmports_classes[i].id = cls;

    84

			return i;

    85

		}

    86

	}

    87

    88

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

    89

	return FSMPORTS_CLASS_DFLT;

    90

}

    91

    92

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

    93

void SetFSMportsClassName(FSMportsClassID sclass, StringID name)

    94

{

    95

	assert(sclass < FSMPORTS_CLASS_MAX);

    96

	fsmports_classes[sclass].name = name;

    97

}

    98

    99

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

   100

StringID GetFSMportsClassName(FSMportsClassID sclass)

   101

{

   102

	assert(sclass < FSMPORTS_CLASS_MAX);

   103

	return fsmports_classes[sclass].name;

   104

}

   105

   106

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

   107

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

   108

 */

   109

DropDownList *BuildFSMportsClassDropdown()

   110

{

   111

	DropDownList *list = new DropDownList();

   112

   113

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

   114

		if (fsmports_classes[i].id == SYSTEM_HIDDEN_CLASS) continue;

   115

		list->push_back(new DropDownListStringItem(GetFSMportsClassName((FSMportsClassID)i), i, false));

   116

	}

   117

   118

	return list;

   119

}

   120

   121

/**

   122

 * Get the number of station classes in use.

   123

 * @return Number of station classes.

   124

 */

   125

uint GetNumFSMportsClasses()

   126

{

   127

	uint i;

   128

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

   129

	return i;

   130

}

   131

   132

/**

   133

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

   134

 * @param sclass Index of the station class.

   135

 * @return Number of stations in the class.

   136

 */

   137

uint GetNumCustomFSMports(FSMportsClassID sclass)

   138

{

   139

	assert(sclass < FSMPORTS_CLASS_MAX);

   140

	return fsmports_classes[sclass].FSMports;

   141

}

   142

   143

/**

   144

 * Tie a fsmport spec to its class.

   145

 * @param fsmportspec The station spec.

   146

 */

   147

void SetCustomFSMportsSpec(FSMportsSpec *fsmportspec)

   148

{

   149

	FSMportsClass *fsmports_class;

   150

	int i;

   151

   152

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

   153

	if (fsmportspec->allocated) return;

   154

   155

	assert(fsmportspec->sclass < FSMPORTS_CLASS_MAX);

   156

	fsmports_class = &fsmports_classes[fsmportspec->sclass];

   157

   158

	i = fsmports_class->FSMports++;

   159

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

   160

   161

	fsmports_class->spec[i] = fsmportspec;

   162

	fsmportspec->allocated = true;

   163

}

   164

   165

/**

   166

 * Retrieve a fsmspec from a class.

   167

 * @param sclass Index of the fsm class.

   168

 * @param fsport The index with the class.

   169

 * @return The fsmspec.

   170

 */

   171

FSMportsSpec *GetCustomFSMportsSpec(FSMportsClassID sclass, uint fsmport)

   172

{

   173

	assert(sclass < FSMPORTS_CLASS_MAX);

   174

	if (fsmport < fsmports_classes[sclass].FSMports)

   175

		return fsmports_classes[sclass].spec[fsmport];

   176

   177

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

   178

	 * probably was not loaded. */

   179

	return NULL;

   180

}

   181

   182

   183

const FSMportsSpec *GetCustomFSMportsSpecByGrf(uint32 grfid, byte localidx)

   184

{

   185

	uint j;

   186

   187

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

   188

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

   189

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

   190

			if (fsmportspec == NULL) continue;

   191

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

   192

		}

   193

	}

   194

   195

	return NULL;

   196

}

   197

   198

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

   199

{

   200

	TileIndexDiffC new_position;

   201

   202

	switch (FSM_orientation) {

   203

		case DIR_NE:

   204

			new_position = position;

   205

			break;

   206

		case DIR_SE:

   207

			new_position.x = position.y;

   208

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

   209

			/*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 */

   210

			break;

   211

		case DIR_SW:

   212

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

   213

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

   214

			break;

   215

		case DIR_NW:

   216

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

   217

			/*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 */

   218

			new_position.y = position.x;

   219

			break;

   220

		default:

   221

			new_position = position;

   222

			break;

   223

	}

   224

   225

	return new_position;

   226

}

   227

   228

/* FSMports Resolver Functions */

   229

static uint32 FSMportsGetRandomBits(const ResolverObject *object)

   230

{

   231

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

   232

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

   233

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

   234

}

   235

   236

   237

static uint32 FSMportsGetTriggers(const ResolverObject *object)

   238

{

   239

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

   240

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

   241

}

   242

   243

   244

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

   245

{

   246

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

   247

	assert(st != NULL);

   248

	st->waiting_triggers = triggers;

   249

}

   250

   251

/**

   252

 * FSMports variable cache

   253

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

   254

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

   255

 */

   256

static struct {

   257

	uint32 v40;

   258

	uint32 v41;

   259

	uint32 v45;

   260

	uint32 v46;

   261

	uint32 v47;

   262

	uint32 v49;

   263

	uint8 valid;

   264

} _svc;

   265

   266

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

   267

{

   268

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

   269

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

   270

   271

	if (object->scope == VSG_SCOPE_PARENT) {

   272

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

   273

		Town *t;

   274

   275

		if (st != NULL) {

   276

			t = st->town;

   277

		} else if (tile != INVALID_TILE) {

   278

			t = GetTownByTile(tile);

   279

		} else {

   280

			*available = false;

   281

			return UINT_MAX;

   282

		}

   283

   284

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

   285

	}

   286

   287

	if (st == NULL) {

   288

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

   289

		switch (variable) {

   290

			case 0x40:

   291

			case 0x41:

   292

			case 0x46:

   293

			case 0x47:

   294

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

   295

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

   296

			case 0x43: return _current_player; // Station owner

   297

			case 0x44: return 2;               // PBS status

   298

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

   299

		}

   300

   301

		*available = false;

   302

		return UINT_MAX;

   303

	}

   304

   305

	switch (variable) {

   306

		/* Calculated station variables */

   307

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

   308

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

   309

		case 0x48: { // Accepted cargo types

   310

			CargoID cargo_type;

   311

			uint32 value = 0;

   312

   313

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

   314

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

   315

			}

   316

			return value;

   317

		}

   318

		/* Variables which use the parameter */

   319

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

   320

   321

		/* General station properties */

   322

		case 0x82: return 50;

   323

		case 0x84: return st->string_id;

   324

		case 0x86: return 0;

   325

		case 0x8A: return st->had_vehicle_of_type;

   326

		case 0xF0: return st->facilities;

   327

		case 0xF1: return st->airport_type;

   328

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

   329

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

   330

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

   331

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

   332

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

   333

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

   334

	}

   335

   336

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

   337

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

   338

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

   339

   340

		if (c == CT_INVALID) return 0;

   341

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

   342

   343

		switch (variable) {

   344

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

   345

			case 0x61: return ge->days_since_pickup;

   346

			case 0x62: return ge->rating;

   347

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

   348

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

   349

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

   350

		}

   351

	}

   352

   353

	/* Handle cargo variables (deprecated) */

   354

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

   355

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

   356

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

   357

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

   358

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

   359

			case 2: return g->days_since_pickup;

   360

			case 3: return g->rating;

   361

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

   362

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

   363

			case 6: return g->last_speed;

   364

			case 7: return g->last_age;

   365

		}

   366

	}

   367

   368

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

   369

   370

	*available = false;

   371

	return UINT_MAX;

   372

}

   373

   374

   375

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

   376

{

   377

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

   378

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

   379

	uint set;

   380

   381

	uint cargo = 0;

   382

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

   383

   384

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

   385

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

   386

	}

   387

   388

	switch (cargo_type) {

   389

		case CT_INVALID:

   390

		case CT_DEFAULT_NA:

   391

		case CT_PURCHASE:

   392

			cargo = 0;

   393

			break;

   394

   395

		case CT_DEFAULT:

   396

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

   397

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

   398

			}

   399

			break;

   400

   401

		default:

   402

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

   403

			break;

   404

	}

   405

   406

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

   407

	cargo = min(0xfff, cargo);

   408

   409

	if (cargo > fsmportspec->cargo_threshold) {

   410

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

   411

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

   412

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

   413

		}

   414

	} else {

   415

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

   416

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

   417

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

   418

		}

   419

	}

   420

   421

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

   422

}

   423

   424

   425

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

   426

{

   427

	res->GetRandomBits = FSMportsGetRandomBits;

   428

	res->GetTriggers   = FSMportsGetTriggers;

   429

	res->SetTriggers   = FSMportsSetTriggers;

   430

	res->GetVariable   = FSMportsGetVariable;

   431

	res->ResolveReal   = FSMportsResolveReal;

   432

   433

	res->u.station.st       = st;

   434

	res->u.station.fsmportspec = fsmportspec;

   435

	res->u.station.tile     = tile;

   436

   437

	res->callback        = CBID_NO_CALLBACK;

   438

	res->callback_param1 = 0;

   439

	res->callback_param2 = 0;

   440

	res->last_value      = 0;

   441

	res->trigger         = 0;

   442

	res->reseed          = 0;

   443

}

   444

   445

static const SpriteGroup *ResolveFSMports(ResolverObject *object)

   446

{

   447

	const SpriteGroup *group;

   448

	CargoID ctype = CT_DEFAULT_NA;

   449

   450

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

   451

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

   452

		ctype = CT_PURCHASE;

   453

	} else {

   454

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

   455

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

   456

			const CargoSpec *cs = GetCargo(cargo);

   457

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

   458

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

   459

				ctype = cargo;

   460

				break;

   461

			}

   462

		}

   463

	}

   464

   465

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

   466

	if (group == NULL) {

   467

		ctype = CT_DEFAULT;

   468

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

   469

	}

   470

   471

	if (group == NULL) return NULL;

   472

   473

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

   474

	object->u.station.cargo_type = ctype;

   475

   476

	/* Invalidate all cached vars */

   477

	_svc.valid = 0;

   478

   479

	return Resolve(group, object);

   480

}

   481

   482

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

   483

{

   484

	const SpriteGroup *group;

   485

	ResolverObject object;

   486

   487

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

   488

   489

	group = ResolveFSMports(&object);

   490

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

   491

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

   492

}

   493

   494

   495

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

   496

{

   497

	const SpriteGroup *group;

   498

	ResolverObject object;

   499

   500

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

   501

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

   502

   503

	group = ResolveFSMports(&object);

   504

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

   505

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

   506

}

   507

   508

   509

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

   510

{

   511

	const SpriteGroup *group;

   512

	ResolverObject object;

   513

   514

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

   515

   516

	object.callback        = callback;

   517

	object.callback_param1 = param1;

   518

	object.callback_param2 = param2;

   519

   520

	group = ResolveFSMports(&object);

   521

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

   522

	return group->g.callback.result;