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"

    14

#include "table/sprites.h"

    15

#include "table/strings.h"

    16

#include "table/track_land.h"

    17

    18

enum {

    19

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

    20

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

    21

	WAYPOINT_POOL_MAX_BLOCKS      = 8000,

    22

    23

	MAX_WAYPOINTS_PER_TOWN        = 64,

    24

};

    25

    26

/**

    27

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

    28

 */

    29

static void WaypointPoolNewBlock(uint start_item)

    30

{

    31

	Waypoint *wp;

    32

    33

	FOR_ALL_WAYPOINTS_FROM(wp, start_item)

    34

		wp->index = start_item++;

    35

}

    36

    37

/* Initialize the town-pool */

    38

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

    39

    40

/* Create a new waypoint */

    41

Waypoint *AllocateWaypoint(void)

    42

{

    43

	Waypoint *wp;

    44

    45

	FOR_ALL_WAYPOINTS(wp) {

    46

		if (wp->xy == 0) {

    47

			uint index = wp->index;

    48

    49

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

    50

			wp->index = index;

    51

    52

			return wp;

    53

		}

    54

	}

    55

    56

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

    57

	if (AddBlockToPool(&_waypoint_pool))

    58

		return AllocateWaypoint();

    59

    60

	return NULL;

    61

}

    62

    63

/* Fetch a waypoint by tile */

    64

Waypoint *GetWaypointByTile(TileIndex tile)

    65

{

    66

	Waypoint *wp;

    67

    68

	FOR_ALL_WAYPOINTS(wp) {

    69

		if (wp->xy == tile)

    70

			return wp;

    71

	}

    72

    73

	return NULL;

    74

}

    75

    76

/* Update the sign for the waypoint */

    77

void UpdateWaypointSign(Waypoint *wp)

    78

{

    79

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

    80

	SetDParam(0, wp->index);

    81

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

    82

}

    83

    84

/* Redraw the sign of a waypoint */

    85

void RedrawWaypointSign(Waypoint *wp)

    86

{

    87

	MarkAllViewportsDirty(

    88

		wp->sign.left - 6,

    89

		wp->sign.top,

    90

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

    91

		wp->sign.top + 48);

    92

}

    93

    94

/* Update all signs */

    95

void UpdateAllWaypointSigns(void)

    96

{

    97

	Waypoint *wp;

    98

    99

	FOR_ALL_WAYPOINTS(wp) {

   100

		if (wp->xy)

   101

			UpdateWaypointSign(wp);

   102

	}

   103

}

   104

   105

/* Set the default name for a waypoint */

   106

void MakeDefaultWaypointName(Waypoint *wp)

   107

{

   108

	Waypoint *local_wp;

   109

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   110

	int i;

   111

   112

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

   113

   114

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

   115

   116

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

   117

	FOR_ALL_WAYPOINTS(local_wp) {

   118

		if (wp == local_wp)

   119

			continue;

   120

   121

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

   122

			used_waypoint[local_wp->town_cn] = true;

   123

	}

   124

   125

	/* Find an empty spot */

   126

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

   127

   128

	wp->string = STR_NULL;

   129

	wp->town_cn = i;

   130

}

   131

   132

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

   133

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   134

{

   135

	Waypoint *wp, *best = NULL;

   136

	uint thres = 8, cur_dist;

   137

   138

	FOR_ALL_WAYPOINTS(wp) {

   139

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

   140

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

   141

			if (cur_dist < thres) {

   142

				thres = cur_dist;

   143

				best = wp;

   144

			}

   145

		}

   146

	}

   147

   148

	return best;

   149

}

   150

   151

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

   152

 * piece of rail

   153

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

   154

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

   155

 * @param p2 unused

   156

 *

   157

 * @todo When checking for the tile slope,

   158

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

   159

 */

   160

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

   161

{

   162

	TileIndex tile = TileVirtXY(x, y);

   163

	Waypoint *wp;

   164

	uint tileh;

   165

	uint dir;

   166

   167

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   168

   169

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

   170

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

   171

   172

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

   173

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   174

   175

	if (!CheckTileOwnership(tile))

   176

		return CMD_ERROR;

   177

   178

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   179

   180

	tileh = GetTileSlope(tile, NULL);

   181

	if (tileh != 0) {

   182

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

   183

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   184

	}

   185

   186

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

   187

	wp = FindDeletedWaypointCloseTo(tile);

   188

	if (wp == NULL) {

   189

		wp = AllocateWaypoint();

   190

		if (wp == NULL) return CMD_ERROR;

   191

   192

		wp->town_index = 0;

   193

		wp->string = STR_NULL;

   194

		wp->town_cn = 0;

   195

	}

   196

   197

	if (flags & DC_EXEC) {

   198

		ModifyTile(tile, MP_MAP5, RAIL_TYPE_WAYPOINT | dir);

   199

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

   200

			// custom graphics

   201

			_m[tile].m3 |= 16;

   202

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

   203

		}

   204

   205

		wp->deleted = 0;

   206

		wp->xy = tile;

   207

		wp->build_date = _date;

   208

   209

		if (wp->town_index == STR_NULL)

   210

			MakeDefaultWaypointName(wp);

   211

   212

		UpdateWaypointSign(wp);

   213

		RedrawWaypointSign(wp);

   214

	}

   215

   216

	return _price.build_train_depot;

   217

}

   218

   219

/* Internal handler to delete a waypoint */

   220

static void DoDeleteWaypoint(Waypoint *wp)

   221

{

   222

	Order order;

   223

   224

	wp->xy = 0;

   225

   226

	order.type = OT_GOTO_WAYPOINT;

   227

	order.station = wp->index;

   228

	DeleteDestinationFromVehicleOrder(order);

   229

   230

	if (wp->string != STR_NULL)

   231

		DeleteName(wp->string);

   232

   233

	RedrawWaypointSign(wp);

   234

}

   235

   236

/* Daily loop for waypoints */

   237

void WaypointsDailyLoop(void)

   238

{

   239

	Waypoint *wp;

   240

   241

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

   242

	FOR_ALL_WAYPOINTS(wp) {

   243

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

   244

			DoDeleteWaypoint(wp);

   245

		}

   246

	}

   247

}

   248

   249

/* Remove a waypoint */

   250

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

   251

{

   252

	Waypoint *wp;

   253

   254

	/* Make sure it's a waypoint */

   255

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

   256

		return CMD_ERROR;

   257

   258

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

   259

		return CMD_ERROR;

   260

   261

	if (!EnsureNoVehicle(tile))

   262

		return CMD_ERROR;

   263

   264

	if (flags & DC_EXEC) {

   265

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

   266

   267

		wp = GetWaypointByTile(tile);

   268

   269

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

   270

		RedrawWaypointSign(wp);

   271

   272

		if (justremove) {

   273

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

   274

			_m[tile].m3 &= ~16;

   275

			_m[tile].m4 = 0;

   276

		} else {

   277

			DoClearSquare(tile);

   278

			SetSignalsOnBothDir(tile, direction);

   279

		}

   280

	}

   281

   282

	return _price.remove_train_depot;

   283

}

   284

   285

/** Delete a waypoint

   286

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

   287

 * @param p1 unused

   288

 * @param p2 unused

   289

 */

   290

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

   291

{

   292

	TileIndex tile = TileVirtXY(x, y);

   293

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   294

	return RemoveTrainWaypoint(tile, flags, true);

   295

}

   296

   297

/** Rename a waypoint.

   298

 * @param x,y unused

   299

 * @param p1 id of waypoint

   300

 * @param p2 unused

   301

 */

   302

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

   303

{

   304

	Waypoint *wp;

   305

	StringID str;

   306

   307

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   308

   309

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

   310

		str = AllocateNameUnique(_cmd_text, 0);

   311

		if (str == 0)

   312

			return CMD_ERROR;

   313

   314

		if (flags & DC_EXEC) {

   315

			wp = GetWaypoint(p1);

   316

			if (wp->string != STR_NULL)

   317

				DeleteName(wp->string);

   318

   319

			wp->string = str;

   320

			wp->town_cn = 0;

   321

   322

			UpdateWaypointSign(wp);

   323

			MarkWholeScreenDirty();

   324

		} else {

   325

			DeleteName(str);

   326

		}

   327

	} else {

   328

		if (flags & DC_EXEC) {

   329

			wp = GetWaypoint(p1);

   330

			if (wp->string != STR_NULL)

   331

				DeleteName(wp->string);

   332

   333

			MakeDefaultWaypointName(wp);

   334

			UpdateWaypointSign(wp);

   335

			MarkWholeScreenDirty();

   336

		}

   337

	}

   338

	return 0;

   339

}

   340

   341

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

   342

Station *ComposeWaypointStation(TileIndex tile)

   343

{

   344

	Waypoint *wp = GetWaypointByTile(tile);

   345

	static Station stat;

   346

   347

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

   348

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

   349

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

   350

	stat.build_date = wp->build_date;

   351

	stat.class_id = 6;

   352

	stat.stat_id = wp->stat_id;

   353

   354

	return &stat;

   355

}

   356

   357

extern uint16 _custom_sprites_base;

   358

   359

/* Draw a waypoint */

   360

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

   361

{

   362

	StationSpec *stat;

   363

	uint32 relocation;

   364

	DrawTileSprites *cust;

   365

	DrawTileSeqStruct const *seq;

   366

	uint32 ormod, img;

   367

   368

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   369

   370

	x += 33;

   371

	y += 17;

   372

   373

	/* draw default waypoint graphics of ID 0 */

   374

	if (stat_id == 0) {

   375

		const DrawTrackSeqStruct *dtss = _track_depot_layout_table[4];

   376

   377

		img = dtss++->image;

   378

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

   379

		DrawSprite(img, x, y);

   380

   381

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

   382

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

   383

			img = dtss->image;

   384

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

   385

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

   386

		}

   387

		return;

   388

	}

   389

   390

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id - 1);

   391

	assert(stat);

   392

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   393

	// emulate station tile - open with building

   394

	// add 1 to get the other direction

   395

	cust = &stat->renderdata[2];

   396

   397

	img = cust->ground_sprite;

   398

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

   399

   400

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

   401

	DrawSprite(img, x, y);

   402

   403

	foreach_draw_tile_seq(seq, cust->seq) {

   404

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

   405

		uint32 image = seq->image + relocation;

   406

   407

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

   408

	}

   409

}

   410

   411

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

   412

void FixOldWaypoints(void)

   413

{

   414

	Waypoint *wp;

   415

   416

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

   417

	FOR_ALL_WAYPOINTS(wp) {

   418

		if (wp->xy == 0)

   419

			continue;

   420

   421

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

   422

		wp->town_cn = 0;

   423

		if (wp->string & 0xC000) {

   424

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

   425

			wp->string = STR_NULL;

   426

		}

   427

	}

   428

}

   429

   430

void InitializeWaypoints(void)

   431

{

   432

	CleanPool(&_waypoint_pool);

   433

	AddBlockToPool(&_waypoint_pool);

   434

}

   435

   436

static const SaveLoad _waypoint_desc[] = {

   437

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

   438

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

   439

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

   440

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

   441

	SLE_VAR(Waypoint, string, SLE_UINT16),

   442

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   443

   444

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

   445

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

   446

   447

	SLE_END()

   448

};

   449

   450

static void Save_WAYP(void)

   451

{

   452

	Waypoint *wp;

   453

   454

	FOR_ALL_WAYPOINTS(wp) {

   455

		if (wp->xy != 0) {

   456

			SlSetArrayIndex(wp->index);

   457

			SlObject(wp, _waypoint_desc);

   458

		}

   459

	}

   460

}

   461

   462

static void Load_WAYP(void)

   463

{

   464

	int index;

   465

   466

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

   467

		Waypoint *wp;

   468

   469

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   470

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

   471

   472

		wp = GetWaypoint(index);

   473

		SlObject(wp, _waypoint_desc);

   474

	}

   475

}

   476

   477

const ChunkHandler _waypoint_chunk_handlers[] = {

   478

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

   479

};