1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

     6

#include "command.h"

     7

#include "functions.h"

     8

#include "gfx.h"

     9

#include "map.h"

    10

#include "order.h"

    11

#include "saveload.h"

    12

#include "station.h"

    13

#include "tile.h"

    14

#include "town.h"

    15

#include "waypoint.h"

    16

#include "variables.h"

    17

#include "pbs.h"

    18

#include "table/sprites.h"

    19

#include "table/strings.h"

    20

    21

enum {

    22

	/* Max waypoints: 64000 (8 * 8000) */

    23

	WAYPOINT_POOL_BLOCK_SIZE_BITS = 3,       /* In bits, so (1 << 3) == 8 */

    24

	WAYPOINT_POOL_MAX_BLOCKS      = 8000,

    25

    26

	MAX_WAYPOINTS_PER_TOWN        = 64,

    27

};

    28

    29

/**

    30

 * Called if a new block is added to the waypoint-pool

    31

 */

    32

static void WaypointPoolNewBlock(uint start_item)

    33

{

    34

	Waypoint *wp;

    35

    36

	FOR_ALL_WAYPOINTS_FROM(wp, start_item)

    37

		wp->index = start_item++;

    38

}

    39

    40

/* Initialize the town-pool */

    41

MemoryPool _waypoint_pool = { "Waypoints", WAYPOINT_POOL_MAX_BLOCKS, WAYPOINT_POOL_BLOCK_SIZE_BITS, sizeof(Waypoint), &WaypointPoolNewBlock, 0, 0, NULL };

    42

    43

/* Create a new waypoint */

    44

Waypoint *AllocateWaypoint(void)

    45

{

    46

	Waypoint *wp;

    47

    48

	FOR_ALL_WAYPOINTS(wp) {

    49

		if (wp->xy == 0) {

    50

			uint index = wp->index;

    51

    52

			memset(wp, 0, sizeof(Waypoint));

    53

			wp->index = index;

    54

    55

			return wp;

    56

		}

    57

	}

    58

    59

	/* Check if we can add a block to the pool */

    60

	if (AddBlockToPool(&_waypoint_pool))

    61

		return AllocateWaypoint();

    62

    63

	return NULL;

    64

}

    65

    66

/* Update the sign for the waypoint */

    67

void UpdateWaypointSign(Waypoint *wp)

    68

{

    69

	Point pt = RemapCoords2(TileX(wp->xy) * 16, TileY(wp->xy) * 16);

    70

	SetDParam(0, wp->index);

    71

	UpdateViewportSignPos(&wp->sign, pt.x, pt.y - 0x20, STR_WAYPOINT_VIEWPORT);

    72

}

    73

    74

/* Redraw the sign of a waypoint */

    75

void RedrawWaypointSign(Waypoint *wp)

    76

{

    77

	MarkAllViewportsDirty(

    78

		wp->sign.left - 6,

    79

		wp->sign.top,

    80

		wp->sign.left + (wp->sign.width_1 << 2) + 12,

    81

		wp->sign.top + 48);

    82

}

    83

    84

/* Update all signs */

    85

void UpdateAllWaypointSigns(void)

    86

{

    87

	Waypoint *wp;

    88

    89

	FOR_ALL_WAYPOINTS(wp) {

    90

		if (wp->xy)

    91

			UpdateWaypointSign(wp);

    92

	}

    93

}

    94

    95

/* Set the default name for a waypoint */

    96

void MakeDefaultWaypointName(Waypoint *wp)

    97

{

    98

	Waypoint *local_wp;

    99

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   100

	int i;

   101

   102

	wp->town_index = ClosestTownFromTile(wp->xy, (uint)-1)->index;

   103

   104

	memset(used_waypoint, 0, sizeof(used_waypoint));

   105

   106

	/* Find an unused waypoint number belonging to this town */

   107

	FOR_ALL_WAYPOINTS(local_wp) {

   108

		if (wp == local_wp)

   109

			continue;

   110

   111

		if (local_wp->xy && local_wp->string == STR_NULL && local_wp->town_index == wp->town_index)

   112

			used_waypoint[local_wp->town_cn] = true;

   113

	}

   114

   115

	/* Find an empty spot */

   116

	for (i = 0; used_waypoint[i] && i < MAX_WAYPOINTS_PER_TOWN; i++) {}

   117

   118

	wp->string = STR_NULL;

   119

	wp->town_cn = i;

   120

}

   121

   122

/* Find a deleted waypoint close to a tile. */

   123

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   124

{

   125

	Waypoint *wp, *best = NULL;

   126

	uint thres = 8, cur_dist;

   127

   128

	FOR_ALL_WAYPOINTS(wp) {

   129

		if (wp->deleted && wp->xy) {

   130

			cur_dist = DistanceManhattan(tile, wp->xy);

   131

			if (cur_dist < thres) {

   132

				thres = cur_dist;

   133

				best = wp;

   134

			}

   135

		}

   136

	}

   137

   138

	return best;

   139

}

   140

   164

/** Convert existing rail to waypoint. Eg build a waypoint station over

   165

 * piece of rail

   166

 * @param x,y coordinates where waypoint will be built

   167

 * @param p1 graphics for waypoint type, 0 indicates standard graphics

   168

 * @param p2 unused

   169

 *

   170

 * @todo When checking for the tile slope,

   171

 * distingush between "Flat land required" and "land sloped in wrong direction"

   172

 */

   173

int32 CmdBuildTrainWaypoint(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   174

{

   175

	TileIndex tile = TileVirtXY(x, y);

   176

	Waypoint *wp;

   177

	uint tileh;

   178

	uint dir;

   179

   180

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   181

   182

	/* if custom gfx are used, make sure it is within bounds */

   183

	if (p1 >= GetNumCustomStations(STAT_CLASS_WAYP)) return CMD_ERROR;

   184

   185

	if (!IsTileType(tile, MP_RAILWAY) || ((dir = 0, _m[tile].m5 != 1) && (dir = 1, _m[tile].m5 != 2)))

   186

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   187

   188

	if (!CheckTileOwnership(tile))

   189

		return CMD_ERROR;

   190

   191

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   192

   193

	tileh = GetTileSlope(tile, NULL);

   194

	if (tileh != 0) {

   195

		if (!_patches.build_on_slopes || IsSteepTileh(tileh) || !(tileh & (0x3 << dir)) || !(tileh & ~(0x3 << dir)))

   196

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   197

	}

   198

   199

	/* Check if there is an already existing, deleted, waypoint close to us that we can reuse. */

   200

	wp = FindDeletedWaypointCloseTo(tile);

   201

	if (wp == NULL) {

   202

		wp = AllocateWaypoint();

   203

		if (wp == NULL) return CMD_ERROR;

   204

   205

		wp->town_index = 0;

   206

		wp->string = STR_NULL;

   207

		wp->town_cn = 0;

   208

	}

   209

   210

	if (flags & DC_EXEC) {

   212

		bool reserved = PBSTileReserved(tile) != 0;

   229

		}

   231

		if (reserved) {

   232

			PBSReserveTrack(tile, dir);

   233

		} else {

   234

			PBSClearTrack(tile, dir);

   235

		}

   236

   237

		wp->deleted = 0;

   238

		wp->xy = tile;

   239

		wp->build_date = _date;

   240

   241

		if (wp->town_index == STR_NULL)

   242

			MakeDefaultWaypointName(wp);

   243

   244

		UpdateWaypointSign(wp);

   245

		RedrawWaypointSign(wp);

   246

	}

   247

   248

	return _price.build_train_depot;

   249

}

   250

   251

/* Internal handler to delete a waypoint */

   252

static void DoDeleteWaypoint(Waypoint *wp)

   253

{

   254

	Order order;

   255

   256

	wp->xy = 0;

   257

   258

	order.type = OT_GOTO_WAYPOINT;

   259

	order.station = wp->index;

   260

	DeleteDestinationFromVehicleOrder(order);

   261

   262

	if (wp->string != STR_NULL)

   263

		DeleteName(wp->string);

   264

   265

	RedrawWaypointSign(wp);

   266

}

   267

   268

/* Daily loop for waypoints */

   269

void WaypointsDailyLoop(void)

   270

{

   271

	Waypoint *wp;

   272

   273

	/* Check if we need to delete a waypoint */

   274

	FOR_ALL_WAYPOINTS(wp) {

   275

		if (wp->deleted && !--wp->deleted) {

   276

			DoDeleteWaypoint(wp);

   277

		}

   278

	}

   279

}

   280

   281

/* Remove a waypoint */

   282

int32 RemoveTrainWaypoint(TileIndex tile, uint32 flags, bool justremove)

   283

{

   284

	Waypoint *wp;

   285

   286

	/* Make sure it's a waypoint */

   287

	if (!IsTileType(tile, MP_RAILWAY) || !IsRailWaypoint(tile))

   288

		return CMD_ERROR;

   289

   290

	if (!CheckTileOwnership(tile) && !(_current_player == OWNER_WATER))

   291

		return CMD_ERROR;

   292

   293

	if (!EnsureNoVehicle(tile))

   294

		return CMD_ERROR;

   295

   296

	if (flags & DC_EXEC) {

   297

		int direction = _m[tile].m5 & RAIL_WAYPOINT_TRACK_MASK;

   298

   299

		wp = GetWaypointByTile(tile);

   300

   301

		wp->deleted = 30; // let it live for this many days before we do the actual deletion.

   302

		RedrawWaypointSign(wp);

   303

   304

		if (justremove) {

   305

			bool reserved = PBSTileReserved(tile) != 0;

   308

			_m[tile].m4 = 0;

   309

			if (reserved) {

   310

				PBSReserveTrack(tile, direction);

   311

			} else {

   312

				PBSClearTrack(tile, direction);

   313

			}

   314

		} else {

   315

			DoClearSquare(tile);

   316

			SetSignalsOnBothDir(tile, direction);

   317

		}

   318

	}

   319

   320

	return _price.remove_train_depot;

   321

}

   322

   323

/** Delete a waypoint

   324

 * @param x,y coordinates where waypoint is to be deleted

   325

 * @param p1 unused

   326

 * @param p2 unused

   327

 */

   328

int32 CmdRemoveTrainWaypoint(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   329

{

   330

	TileIndex tile = TileVirtXY(x, y);

   331

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   332

	return RemoveTrainWaypoint(tile, flags, true);

   333

}

   334

   335

/** Rename a waypoint.

   336

 * @param x,y unused

   337

 * @param p1 id of waypoint

   338

 * @param p2 unused

   339

 */

   340

int32 CmdRenameWaypoint(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   341

{

   342

	Waypoint *wp;

   343

	StringID str;

   344

   345

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   346

   347

	if (_cmd_text[0] != '\0') {

   348

		str = AllocateNameUnique(_cmd_text, 0);

   349

		if (str == 0)

   350

			return CMD_ERROR;

   351

   352

		if (flags & DC_EXEC) {

   353

			wp = GetWaypoint(p1);

   354

			if (wp->string != STR_NULL)

   355

				DeleteName(wp->string);

   356

   357

			wp->string = str;

   358

			wp->town_cn = 0;

   359

   360

			UpdateWaypointSign(wp);

   361

			MarkWholeScreenDirty();

   362

		} else {

   363

			DeleteName(str);

   364

		}

   365

	} else {

   366

		if (flags & DC_EXEC) {

   367

			wp = GetWaypoint(p1);

   368

			if (wp->string != STR_NULL)

   369

				DeleteName(wp->string);

   370

   371

			MakeDefaultWaypointName(wp);

   372

			UpdateWaypointSign(wp);

   373

			MarkWholeScreenDirty();

   374

		}

   375

	}

   376

	return 0;

   377

}

   378

   379

/* This hacks together some dummy one-shot Station structure for a waypoint. */

   380

Station *ComposeWaypointStation(TileIndex tile)

   381

{

   382

	Waypoint *wp = GetWaypointByTile(tile);

   383

	static Station stat;

   384

   385

	stat.train_tile = stat.xy = wp->xy;

   386

	stat.town = GetTown(wp->town_index);

   387

	stat.string_id = wp->string == STR_NULL ? /* FIXME? */ 0 : wp->string;

   388

	stat.build_date = wp->build_date;

   389

	stat.class_id = 6;

   390

	stat.stat_id = wp->stat_id;

   391

   392

	return &stat;

   393

}

   394

   395

extern uint16 _custom_sprites_base;

   396

   397

   398

/* Draw a waypoint */

   399

void DrawWaypointSprite(int x, int y, int stat_id, RailType railtype)

   400

{

   401

	const StationSpec *stat;

   402

	uint32 relocation;

   403

	const DrawTileSprites *cust;

   404

	DrawTileSeqStruct const *seq;

   405

	const RailtypeInfo *rti = GetRailTypeInfo(railtype);

   406

	uint32 ormod, img;

   407

   408

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   409

   410

	x += 33;

   411

	y += 17;

   412

   413

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id);

   414

	if (stat == NULL) {

   415

		// stat is NULL for default waypoints and when waypoint graphics are

   416

		// not loaded.

   417

		DrawDefaultWaypointSprite(x, y, railtype);

   418

		return;

   419

	}

   420

   421

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   422

	// emulate station tile - open with building

   423

	// add 1 to get the other direction

   424

	cust = &stat->renderdata[2];

   425

   426

	img = cust->ground_sprite;

   427

	img += (img < _custom_sprites_base) ? rti->total_offset : railtype;

   428

   429

	if (img & PALETTE_MODIFIER_COLOR) img = (img & SPRITE_MASK);

   430

	DrawSprite(img, x, y);

   431

   432

	foreach_draw_tile_seq(seq, cust->seq) {

   433

		Point pt = RemapCoords(seq->delta_x, seq->delta_y, seq->delta_z);

   434

		uint32 image = seq->image + relocation;

   435

		DrawSprite((image & SPRITE_MASK) | ormod, x + pt.x, y + pt.y);

   436

	}

   437

}

   438

   439

/* Fix savegames which stored waypoints in their old format */

   440

void FixOldWaypoints(void)

   441

{

   442

	Waypoint *wp;

   443

   444

	/* Convert the old 'town_or_string', to 'string' / 'town' / 'town_cn' */

   445

	FOR_ALL_WAYPOINTS(wp) {

   446

		if (wp->xy == 0)

   447

			continue;

   448

   449

		wp->town_index = ClosestTownFromTile(wp->xy, (uint)-1)->index;

   450

		wp->town_cn = 0;

   451

		if (wp->string & 0xC000) {

   452

			wp->town_cn = wp->string & 0x3F;

   453

			wp->string = STR_NULL;

   454

		}

   455

	}

   456

}

   457

   458

void InitializeWaypoints(void)

   459

{

   460

	CleanPool(&_waypoint_pool);

   461

	AddBlockToPool(&_waypoint_pool);

   462

}

   463

   464

static const SaveLoad _waypoint_desc[] = {

   465

	SLE_CONDVAR(Waypoint, xy, SLE_FILE_U16 | SLE_VAR_U32, 0, 5),

   466

	SLE_CONDVAR(Waypoint, xy, SLE_UINT32, 6, 255),

   467

	SLE_CONDVAR(Waypoint, town_index, SLE_UINT16, 12, 255),

   468

	SLE_CONDVAR(Waypoint, town_cn, SLE_UINT8, 12, 255),

   469

	SLE_VAR(Waypoint, string, SLE_UINT16),

   470

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   471

   475

   476

	SLE_END()

   477

};

   478

   479

static void Save_WAYP(void)

   480

{

   481

	Waypoint *wp;

   482

   483

	FOR_ALL_WAYPOINTS(wp) {

   484

		if (wp->xy != 0) {

   485

			SlSetArrayIndex(wp->index);

   486

			SlObject(wp, _waypoint_desc);

   487

		}

   488

	}

   489

}

   490

   491

static void Load_WAYP(void)

   492

{

   493

	int index;

   494

   495

	while ((index = SlIterateArray()) != -1) {

   496

		Waypoint *wp;

   497

   498

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   499

			error("Waypoints: failed loading savegame: too many waypoints");

   500

   501

		wp = GetWaypoint(index);

   502

		SlObject(wp, _waypoint_desc);

   503

	}

   504

}

   505

   506

const ChunkHandler _waypoint_chunk_handlers[] = {

   507

	{ 'CHKP', Save_WAYP, Load_WAYP, CH_ARRAY | CH_LAST},

   508

};