1

#include "stdafx.h"

     2

#include "openttd.h"

     3

     4

#include "command.h"

     5

#include "gfx.h"

     6

#include "map.h"

     7

#include "order.h"

     8

#include "saveload.h"

     9

#include "station.h"

    10

#include "tile.h"

    11

#include "town.h"

    12

#include "waypoint.h"

    13

#include "table/sprites.h"

    14

#include "table/strings.h"

    15

#include "table/track_land.h"

    16

    17

enum {

    18

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

    19

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

    20

	WAYPOINT_POOL_MAX_BLOCKS      = 8000,

    21

    22

	MAX_WAYPOINTS_PER_TOWN        = 64,

    23

};

    24

    25

/**

    26

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

    27

 */

    28

static void WaypointPoolNewBlock(uint start_item)

    29

{

    30

	Waypoint *wp;

    31

    32

	FOR_ALL_WAYPOINTS_FROM(wp, start_item)

    33

		wp->index = start_item++;

    34

}

    35

    36

/* Initialize the town-pool */

    37

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

    38

    39

/* Create a new waypoint */

    40

Waypoint *AllocateWaypoint(void)

    41

{

    42

	Waypoint *wp;

    43

    44

	FOR_ALL_WAYPOINTS(wp) {

    45

		if (wp->xy == 0) {

    46

			uint index = wp->index;

    47

    48

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

    49

			wp->index = index;

    50

    51

			return wp;

    52

		}

    53

	}

    54

    55

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

    56

	if (AddBlockToPool(&_waypoint_pool))

    57

		return AllocateWaypoint();

    58

    59

	return NULL;

    60

}

    61

    62

/* Fetch a waypoint by tile */

    63

Waypoint *GetWaypointByTile(TileIndex tile)

    64

{

    65

	Waypoint *wp;

    66

    67

	FOR_ALL_WAYPOINTS(wp) {

    68

		if (wp->xy == tile)

    69

			return wp;

    70

	}

    71

    72

	return NULL;

    73

}

    74

    75

/* Update the sign for the waypoint */

    76

void UpdateWaypointSign(Waypoint *wp)

    77

{

    78

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

    79

	SetDParam(0, wp->index);

    80

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

    81

}

    82

    83

/* Redraw the sign of a waypoint */

    84

void RedrawWaypointSign(Waypoint *wp)

    85

{

    86

	MarkAllViewportsDirty(

    87

		wp->sign.left - 6,

    88

		wp->sign.top,

    89

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

    90

		wp->sign.top + 48);

    91

}

    92

    93

/* Update all signs */

    94

void UpdateAllWaypointSigns(void)

    95

{

    96

	Waypoint *wp;

    97

    98

	FOR_ALL_WAYPOINTS(wp) {

    99

		if (wp->xy)

   100

			UpdateWaypointSign(wp);

   101

	}

   102

}

   103

   104

/* Set the default name for a waypoint */

   105

void MakeDefaultWaypointName(Waypoint *wp)

   106

{

   107

	Waypoint *local_wp;

   108

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   109

	int i;

   110

   111

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

   112

   113

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

   114

   115

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

   116

	FOR_ALL_WAYPOINTS(local_wp) {

   117

		if (wp == local_wp)

   118

			continue;

   119

   120

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

   121

			used_waypoint[local_wp->town_cn] = true;

   122

	}

   123

   124

	/* Find an empty spot */

   125

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

   126

   127

	wp->string = STR_NULL;

   128

	wp->town_cn = i;

   129

}

   130

   131

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

   132

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   133

{

   134

	Waypoint *wp, *best = NULL;

   135

	uint thres = 8, cur_dist;

   136

   137

	FOR_ALL_WAYPOINTS(wp) {

   138

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

   139

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

   140

			if (cur_dist < thres) {

   141

				thres = cur_dist;

   142

				best = wp;

   143

			}

   144

		}

   145

	}

   146

   147

	return best;

   148

}

   149

   150

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

   151

 * piece of rail

   152

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

   153

 * @param p1 graphics for waypoint type, bit 8 signifies custom waypoint gfx (& 0x100)

   154

 * @param p2 unused

   155

 *

   156

 * @todo When checking for the tile slope,

   157

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

   158

 */

   159

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

   160

{

   161

	TileIndex tile = TileVirtXY(x, y);

   162

	Waypoint *wp;

   163

	uint tileh;

   164

	uint dir;

   165

   166

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   167

   168

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

   169

	if (p1 > 0x100 + (uint)GetCustomStationsCount(STAT_CLASS_WAYP)) return CMD_ERROR;

   170

   171

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

   172

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   173

   174

	if (!CheckTileOwnership(tile))

   175

		return CMD_ERROR;

   176

   177

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   178

   179

	tileh = GetTileSlope(tile, NULL);

   180

	if (tileh != 0) {

   181

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

   182

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   183

	}

   184

   185

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

   186

	wp = FindDeletedWaypointCloseTo(tile);

   187

	if (wp == NULL) {

   188

		wp = AllocateWaypoint();

   189

		if (wp == NULL) return CMD_ERROR;

   190

   191

		wp->town_index = 0;

   192

		wp->string = STR_NULL;

   193

		wp->town_cn = 0;

   194

	}

   195

   196

	if (flags & DC_EXEC) {

   197

		ModifyTile(tile, MP_MAP5, RAIL_TYPE_WAYPOINT | dir);

   198

		if (--p1 & 0x100) { // waypoint type 0 uses default graphics

   199

			// custom graphics

   200

			_m[tile].m3 |= 16;

   201

			_m[tile].m4 = p1 & 0xff;

   202

		}

   203

   204

		wp->deleted = 0;

   205

		wp->xy = tile;

   206

		wp->build_date = _date;

   207

   208

		if (wp->town_index == STR_NULL)

   209

			MakeDefaultWaypointName(wp);

   210

   211

		UpdateWaypointSign(wp);

   212

		RedrawWaypointSign(wp);

   213

	}

   214

   215

	return _price.build_train_depot;

   216

}

   217

   218

/* Internal handler to delete a waypoint */

   219

static void DoDeleteWaypoint(Waypoint *wp)

   220

{

   221

	Order order;

   222

   223

	wp->xy = 0;

   224

   225

	order.type = OT_GOTO_WAYPOINT;

   226

	order.station = wp->index;

   227

	DeleteDestinationFromVehicleOrder(order);

   228

   229

	if (wp->string != STR_NULL)

   230

		DeleteName(wp->string);

   231

   232

	RedrawWaypointSign(wp);

   233

}

   234

   235

/* Daily loop for waypoints */

   236

void WaypointsDailyLoop(void)

   237

{

   238

	Waypoint *wp;

   239

   240

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

   241

	FOR_ALL_WAYPOINTS(wp) {

   242

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

   243

			DoDeleteWaypoint(wp);

   244

		}

   245

	}

   246

}

   247

   248

/* Remove a waypoint */

   249

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

   250

{

   251

	Waypoint *wp;

   252

   253

	/* Make sure it's a waypoint */

   254

	if (!IsTileType(tile, MP_RAILWAY) || !IsRailWaypoint(_m[tile].m5))

   255

		return CMD_ERROR;

   256

   257

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

   258

		return CMD_ERROR;

   259

   260

	if (!EnsureNoVehicle(tile))

   261

		return CMD_ERROR;

   262

   263

	if (flags & DC_EXEC) {

   264

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

   265

   266

		wp = GetWaypointByTile(tile);

   267

   268

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

   269

		RedrawWaypointSign(wp);

   270

   271

		if (justremove) {

   272

			ModifyTile(tile, MP_MAP5, 1<<direction);

   273

			_m[tile].m3 &= ~16;

   274

			_m[tile].m4 = 0;

   275

		} else {

   276

			DoClearSquare(tile);

   277

			SetSignalsOnBothDir(tile, direction);

   278

		}

   279

	}

   280

   281

	return _price.remove_train_depot;

   282

}

   283

   284

/** Delete a waypoint

   285

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

   286

 * @param p1 unused

   287

 * @param p2 unused

   288

 */

   289

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

   290

{

   291

	TileIndex tile = TileVirtXY(x, y);

   292

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   293

	return RemoveTrainWaypoint(tile, flags, true);

   294

}

   295

   296

/** Rename a waypoint.

   297

 * @param x,y unused

   298

 * @param p1 id of waypoint

   299

 * @param p2 unused

   300

 */

   301

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

   302

{

   303

	Waypoint *wp;

   304

	StringID str;

   305

   306

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   307

   308

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

   309

		str = AllocateNameUnique(_cmd_text, 0);

   310

		if (str == 0)

   311

			return CMD_ERROR;

   312

   313

		if (flags & DC_EXEC) {

   314

			wp = GetWaypoint(p1);

   315

			if (wp->string != STR_NULL)

   316

				DeleteName(wp->string);

   317

   318

			wp->string = str;

   319

			wp->town_cn = 0;

   320

   321

			UpdateWaypointSign(wp);

   322

			MarkWholeScreenDirty();

   323

		} else {

   324

			DeleteName(str);

   325

		}

   326

	} else {

   327

		if (flags & DC_EXEC) {

   328

			wp = GetWaypoint(p1);

   329

			if (wp->string != STR_NULL)

   330

				DeleteName(wp->string);

   331

   332

			MakeDefaultWaypointName(wp);

   333

			UpdateWaypointSign(wp);

   334

			MarkWholeScreenDirty();

   335

		}

   336

	}

   337

	return 0;

   338

}

   339

   340

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

   341

Station *ComposeWaypointStation(TileIndex tile)

   342

{

   343

	Waypoint *wp = GetWaypointByTile(tile);

   344

	static Station stat;

   345

   346

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

   347

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

   348

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

   349

	stat.build_date = wp->build_date;

   350

	stat.class_id = 6;

   351

	stat.stat_id = wp->stat_id;

   352

   353

	return &stat;

   354

}

   355

   356

extern uint16 _custom_sprites_base;

   357

   358

/* Draw a waypoint */

   359

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

   360

{

   361

	StationSpec *stat;

   362

	uint32 relocation;

   363

	DrawTileSprites *cust;

   364

	DrawTileSeqStruct const *seq;

   365

	uint32 ormod, img;

   366

   367

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   368

   369

	x += 33;

   370

	y += 17;

   371

   372

	/* draw default waypoint graphics of ID 0 */

   373

	if (stat_id == 0) {

   374

		const DrawTrackSeqStruct *dtss = _track_depot_layout_table[4];

   375

   376

		img = dtss++->image;

   377

		if (img & 0x8000) img = (img & 0x7FFF) + railtype*TRACKTYPE_SPRITE_PITCH;

   378

		DrawSprite(img, x, y);

   379

   380

		for (; dtss->image != 0; dtss++) {

   381

			Point pt = RemapCoords(dtss->subcoord_x, dtss->subcoord_y, 0);

   382

			img = dtss->image;

   383

			if (img & 0x8000) img |= ormod;

   384

			DrawSprite(img, x + pt.x, y + pt.y);

   385

		}

   386

		return;

   387

	}

   388

   389

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id - 1);

   390

	assert(stat);

   391

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   392

	// emulate station tile - open with building

   393

	// add 1 to get the other direction

   394

	cust = &stat->renderdata[2];

   395

   396

	img = cust->ground_sprite;

   397

	img += railtype * ((img < _custom_sprites_base) ? TRACKTYPE_SPRITE_PITCH : 1);

   398

   399

	if (img & 0x8000) img = (img & 0x7FFF);

   400

	DrawSprite(img, x, y);

   401

   402

	foreach_draw_tile_seq(seq, cust->seq) {

   403

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

   404

		uint32 image = seq->image + relocation;

   405

   406

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

   407

	}

   408

}

   409

   410

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

   411

void FixOldWaypoints(void)

   412

{

   413

	Waypoint *wp;

   414

   415

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

   416

	FOR_ALL_WAYPOINTS(wp) {

   417

		if (wp->xy == 0)

   418

			continue;

   419

   420

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

   421

		wp->town_cn = 0;

   422

		if (wp->string & 0xC000) {

   423

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

   424

			wp->string = STR_NULL;

   425

		}

   426

	}

   427

}

   428

   429

void InitializeWaypoints(void)

   430

{

   431

	CleanPool(&_waypoint_pool);

   432

	AddBlockToPool(&_waypoint_pool);

   433

}

   434

   435

static const SaveLoad _waypoint_desc[] = {

   436

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

   437

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

   438

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

   439

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

   440

	SLE_VAR(Waypoint, string, SLE_UINT16),

   441

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   442

   443

	SLE_CONDVAR(Waypoint, build_date, SLE_UINT16, 3, 255),

   444

	SLE_CONDVAR(Waypoint, stat_id, SLE_UINT8, 3, 255),

   445

   446

	SLE_END()

   447

};

   448

   449

static void Save_WAYP(void)

   450

{

   451

	Waypoint *wp;

   452

   453

	FOR_ALL_WAYPOINTS(wp) {

   454

		if (wp->xy != 0) {

   455

			SlSetArrayIndex(wp->index);

   456

			SlObject(wp, _waypoint_desc);

   457

		}

   458

	}

   459

}

   460

   461

static void Load_WAYP(void)

   462

{

   463

	int index;

   464

   465

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

   466

		Waypoint *wp;

   467

   468

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   469

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

   470

   471

		wp = GetWaypoint(index);

   472

		SlObject(wp, _waypoint_desc);

   473

	}

   474

}

   475

   476

const ChunkHandler _waypoint_chunk_handlers[] = {

   477

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

   478

};