1

#include "stdafx.h"

     2

#include "openttd.h"

     3

     4

#include "command.h"

     6

#include "gfx.h"

     7

#include "map.h"

     8

#include "order.h"

     9

#include "saveload.h"

    10

#include "station.h"

    11

#include "tile.h"

    12

#include "town.h"

    13

#include "waypoint.h"

    14

#include "variables.h"

    15

#include "table/sprites.h"

    16

#include "table/strings.h"

    17

#include "table/track_land.h"

    18

    19

enum {

    20

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

    21

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

    22

	WAYPOINT_POOL_MAX_BLOCKS      = 8000,

    23

    24

	MAX_WAYPOINTS_PER_TOWN        = 64,

    25

};

    26

    27

/**

    28

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

    29

 */

    30

static void WaypointPoolNewBlock(uint start_item)

    31

{

    32

	Waypoint *wp;

    33

    34

	FOR_ALL_WAYPOINTS_FROM(wp, start_item)

    35

		wp->index = start_item++;

    36

}

    37

    38

/* Initialize the town-pool */

    39

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

    40

    41

/* Create a new waypoint */

    42

Waypoint *AllocateWaypoint(void)

    43

{

    44

	Waypoint *wp;

    45

    46

	FOR_ALL_WAYPOINTS(wp) {

    47

		if (wp->xy == 0) {

    48

			uint index = wp->index;

    49

    50

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

    51

			wp->index = index;

    52

    53

			return wp;

    54

		}

    55

	}

    56

    57

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

    58

	if (AddBlockToPool(&_waypoint_pool))

    59

		return AllocateWaypoint();

    60

    61

	return NULL;

    62

}

    63

    64

/* Fetch a waypoint by tile */

    65

Waypoint *GetWaypointByTile(TileIndex tile)

    66

{

    67

	Waypoint *wp;

    68

    69

	FOR_ALL_WAYPOINTS(wp) {

    70

		if (wp->xy == tile)

    71

			return wp;

    72

	}

    73

    74

	return NULL;

    75

}

    76

    77

/* Update the sign for the waypoint */

    78

void UpdateWaypointSign(Waypoint *wp)

    79

{

    80

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

    81

	SetDParam(0, wp->index);

    82

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

    83

}

    84

    85

/* Redraw the sign of a waypoint */

    86

void RedrawWaypointSign(Waypoint *wp)

    87

{

    88

	MarkAllViewportsDirty(

    89

		wp->sign.left - 6,

    90

		wp->sign.top,

    91

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

    92

		wp->sign.top + 48);

    93

}

    94

    95

/* Update all signs */

    96

void UpdateAllWaypointSigns(void)

    97

{

    98

	Waypoint *wp;

    99

   100

	FOR_ALL_WAYPOINTS(wp) {

   101

		if (wp->xy)

   102

			UpdateWaypointSign(wp);

   103

	}

   104

}

   105

   106

/* Set the default name for a waypoint */

   107

void MakeDefaultWaypointName(Waypoint *wp)

   108

{

   109

	Waypoint *local_wp;

   110

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   111

	int i;

   112

   113

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

   114

   115

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

   116

   117

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

   118

	FOR_ALL_WAYPOINTS(local_wp) {

   119

		if (wp == local_wp)

   120

			continue;

   121

   122

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

   123

			used_waypoint[local_wp->town_cn] = true;

   124

	}

   125

   126

	/* Find an empty spot */

   127

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

   128

   129

	wp->string = STR_NULL;

   130

	wp->town_cn = i;

   131

}

   132

   133

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

   134

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   135

{

   136

	Waypoint *wp, *best = NULL;

   137

	uint thres = 8, cur_dist;

   138

   139

	FOR_ALL_WAYPOINTS(wp) {

   140

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

   141

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

   142

			if (cur_dist < thres) {

   143

				thres = cur_dist;

   144

				best = wp;

   145

			}

   146

		}

   147

	}

   148

   149

	return best;

   150

}

   151

   152

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

   153

 * piece of rail

   154

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

   155

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

   156

 * @param p2 unused

   157

 *

   158

 * @todo When checking for the tile slope,

   159

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

   160

 */

   161

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

   162

{

   163

	TileIndex tile = TileVirtXY(x, y);

   164

	Waypoint *wp;

   165

	uint tileh;

   166

	uint dir;

   167

   168

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   169

   170

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

   171

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

   172

   173

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

   174

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   175

   176

	if (!CheckTileOwnership(tile))

   177

		return CMD_ERROR;

   178

   179

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   180

   181

	tileh = GetTileSlope(tile, NULL);

   182

	if (tileh != 0) {

   183

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

   184

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   185

	}

   186

   187

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

   188

	wp = FindDeletedWaypointCloseTo(tile);

   189

	if (wp == NULL) {

   190

		wp = AllocateWaypoint();

   191

		if (wp == NULL) return CMD_ERROR;

   192

   193

		wp->town_index = 0;

   194

		wp->string = STR_NULL;

   195

		wp->town_cn = 0;

   196

	}

   197

   198

	if (flags & DC_EXEC) {

   199

		ModifyTile(tile, MP_MAP5, RAIL_TYPE_WAYPOINT | dir);

   200

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

   201

			// custom graphics

   202

			_m[tile].m3 |= 16;

   203

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

   204

		}

   205

   206

		wp->deleted = 0;

   207

		wp->xy = tile;

   208

		wp->build_date = _date;

   209

   210

		if (wp->town_index == STR_NULL)

   211

			MakeDefaultWaypointName(wp);

   212

   213

		UpdateWaypointSign(wp);

   214

		RedrawWaypointSign(wp);

   215

	}

   216

   217

	return _price.build_train_depot;

   218

}

   219

   220

/* Internal handler to delete a waypoint */

   221

static void DoDeleteWaypoint(Waypoint *wp)

   222

{

   223

	Order order;

   224

   225

	wp->xy = 0;

   226

   227

	order.type = OT_GOTO_WAYPOINT;

   228

	order.station = wp->index;

   229

	DeleteDestinationFromVehicleOrder(order);

   230

   231

	if (wp->string != STR_NULL)

   232

		DeleteName(wp->string);

   233

   234

	RedrawWaypointSign(wp);

   235

}

   236

   237

/* Daily loop for waypoints */

   238

void WaypointsDailyLoop(void)

   239

{

   240

	Waypoint *wp;

   241

   242

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

   243

	FOR_ALL_WAYPOINTS(wp) {

   244

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

   245

			DoDeleteWaypoint(wp);

   246

		}

   247

	}

   248

}

   249

   250

/* Remove a waypoint */

   251

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

   252

{

   253

	Waypoint *wp;

   254

   255

	/* Make sure it's a waypoint */

   256

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

   257

		return CMD_ERROR;

   258

   259

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

   260

		return CMD_ERROR;

   261

   262

	if (!EnsureNoVehicle(tile))

   263

		return CMD_ERROR;

   264

   265

	if (flags & DC_EXEC) {

   266

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

   267

   268

		wp = GetWaypointByTile(tile);

   269

   270

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

   271

		RedrawWaypointSign(wp);

   272

   273

		if (justremove) {

   274

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

   275

			_m[tile].m3 &= ~16;

   276

			_m[tile].m4 = 0;

   277

		} else {

   278

			DoClearSquare(tile);

   279

			SetSignalsOnBothDir(tile, direction);

   280

		}

   281

	}

   282

   283

	return _price.remove_train_depot;

   284

}

   285

   286

/** Delete a waypoint

   287

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

   288

 * @param p1 unused

   289

 * @param p2 unused

   290

 */

   291

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

   292

{

   293

	TileIndex tile = TileVirtXY(x, y);

   294

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   295

	return RemoveTrainWaypoint(tile, flags, true);

   296

}

   297

   298

/** Rename a waypoint.

   299

 * @param x,y unused

   300

 * @param p1 id of waypoint

   301

 * @param p2 unused

   302

 */

   303

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

   304

{

   305

	Waypoint *wp;

   306

	StringID str;

   307

   308

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   309

   310

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

   311

		str = AllocateNameUnique(_cmd_text, 0);

   312

		if (str == 0)

   313

			return CMD_ERROR;

   314

   315

		if (flags & DC_EXEC) {

   316

			wp = GetWaypoint(p1);

   317

			if (wp->string != STR_NULL)

   318

				DeleteName(wp->string);

   319

   320

			wp->string = str;

   321

			wp->town_cn = 0;

   322

   323

			UpdateWaypointSign(wp);

   324

			MarkWholeScreenDirty();

   325

		} else {

   326

			DeleteName(str);

   327

		}

   328

	} else {

   329

		if (flags & DC_EXEC) {

   330

			wp = GetWaypoint(p1);

   331

			if (wp->string != STR_NULL)

   332

				DeleteName(wp->string);

   333

   334

			MakeDefaultWaypointName(wp);

   335

			UpdateWaypointSign(wp);

   336

			MarkWholeScreenDirty();

   337

		}

   338

	}

   339

	return 0;

   340

}

   341

   342

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

   343

Station *ComposeWaypointStation(TileIndex tile)

   344

{

   345

	Waypoint *wp = GetWaypointByTile(tile);

   346

	static Station stat;

   347

   348

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

   349

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

   350

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

   351

	stat.build_date = wp->build_date;

   352

	stat.class_id = 6;

   353

	stat.stat_id = wp->stat_id;

   354

   355

	return &stat;

   356

}

   357

   358

extern uint16 _custom_sprites_base;

   359

   360

/* Draw a waypoint */

   361

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

   362

{

   363

	StationSpec *stat;

   364

	uint32 relocation;

   365

	DrawTileSprites *cust;

   366

	DrawTileSeqStruct const *seq;

   367

	uint32 ormod, img;

   368

   369

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   370

   371

	x += 33;

   372

	y += 17;

   373

   374

	/* draw default waypoint graphics of ID 0 */

   375

	if (stat_id == 0) {

   376

		const DrawTrackSeqStruct *dtss = _track_depot_layout_table[4];

   377

   378

		img = dtss++->image;

   379

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

   380

		DrawSprite(img, x, y);

   381

   382

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

   383

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

   384

			img = dtss->image;

   385

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

   386

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

   387

		}

   388

		return;

   389

	}

   390

   391

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id - 1);

   392

	assert(stat);

   393

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   394

	// emulate station tile - open with building

   395

	// add 1 to get the other direction

   396

	cust = &stat->renderdata[2];

   397

   398

	img = cust->ground_sprite;

   399

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

   400

   401

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

   402

	DrawSprite(img, x, y);

   403

   404

	foreach_draw_tile_seq(seq, cust->seq) {

   405

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

   406

		uint32 image = seq->image + relocation;

   407

   408

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

   409

	}

   410

}

   411

   412

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

   413

void FixOldWaypoints(void)

   414

{

   415

	Waypoint *wp;

   416

   417

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

   418

	FOR_ALL_WAYPOINTS(wp) {

   419

		if (wp->xy == 0)

   420

			continue;

   421

   422

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

   423

		wp->town_cn = 0;

   424

		if (wp->string & 0xC000) {

   425

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

   426

			wp->string = STR_NULL;

   427

		}

   428

	}

   429

}

   430

   431

void InitializeWaypoints(void)

   432

{

   433

	CleanPool(&_waypoint_pool);

   434

	AddBlockToPool(&_waypoint_pool);

   435

}

   436

   437

static const SaveLoad _waypoint_desc[] = {

   438

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

   439

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

   440

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

   441

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

   442

	SLE_VAR(Waypoint, string, SLE_UINT16),

   443

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   444

   445

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

   446

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

   447

   448

	SLE_END()

   449

};

   450

   451

static void Save_WAYP(void)

   452

{

   453

	Waypoint *wp;

   454

   455

	FOR_ALL_WAYPOINTS(wp) {

   456

		if (wp->xy != 0) {

   457

			SlSetArrayIndex(wp->index);

   458

			SlObject(wp, _waypoint_desc);

   459

		}

   460

	}

   461

}

   462

   463

static void Load_WAYP(void)

   464

{

   465

	int index;

   466

   467

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

   468

		Waypoint *wp;

   469

   470

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   471

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

   472

   473

		wp = GetWaypoint(index);

   474

		SlObject(wp, _waypoint_desc);

   475

	}

   476

}

   477

   478

const ChunkHandler _waypoint_chunk_handlers[] = {

   479

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

   480

};