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 "table/sprites.h"

    18

#include "table/strings.h"

    19

#include "table/track_land.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

/* Fetch a waypoint by tile */

    67

Waypoint *GetWaypointByTile(TileIndex tile)

    68

{

    69

	Waypoint *wp;

    70

    71

	FOR_ALL_WAYPOINTS(wp) {

    72

		if (wp->xy == tile)

    73

			return wp;

    74

	}

    75

    76

	return NULL;

    77

}

    78

    79

/* Update the sign for the waypoint */

    80

void UpdateWaypointSign(Waypoint *wp)

    81

{

    82

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

    83

	SetDParam(0, wp->index);

    84

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

    85

}

    86

    87

/* Redraw the sign of a waypoint */

    88

void RedrawWaypointSign(Waypoint *wp)

    89

{

    90

	MarkAllViewportsDirty(

    91

		wp->sign.left - 6,

    92

		wp->sign.top,

    93

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

    94

		wp->sign.top + 48);

    95

}

    96

    97

/* Update all signs */

    98

void UpdateAllWaypointSigns(void)

    99

{

   100

	Waypoint *wp;

   101

   102

	FOR_ALL_WAYPOINTS(wp) {

   103

		if (wp->xy)

   104

			UpdateWaypointSign(wp);

   105

	}

   106

}

   107

   108

/* Set the default name for a waypoint */

   109

void MakeDefaultWaypointName(Waypoint *wp)

   110

{

   111

	Waypoint *local_wp;

   112

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   113

	int i;

   114

   115

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

   116

   117

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

   118

   119

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

   120

	FOR_ALL_WAYPOINTS(local_wp) {

   121

		if (wp == local_wp)

   122

			continue;

   123

   124

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

   125

			used_waypoint[local_wp->town_cn] = true;

   126

	}

   127

   128

	/* Find an empty spot */

   129

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

   130

   131

	wp->string = STR_NULL;

   132

	wp->town_cn = i;

   133

}

   134

   135

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

   136

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   137

{

   138

	Waypoint *wp, *best = NULL;

   139

	uint thres = 8, cur_dist;

   140

   141

	FOR_ALL_WAYPOINTS(wp) {

   142

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

   143

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

   144

			if (cur_dist < thres) {

   145

				thres = cur_dist;

   146

				best = wp;

   147

			}

   148

		}

   149

	}

   150

   151

	return best;

   152

}

   153

   154

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

   155

 * piece of rail

   156

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

   157

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

   158

 * @param p2 unused

   159

 *

   160

 * @todo When checking for the tile slope,

   161

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

   162

 */

   163

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

   164

{

   165

	TileIndex tile = TileVirtXY(x, y);

   166

	Waypoint *wp;

   167

	uint tileh;

   168

	uint dir;

   169

   170

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   171

   172

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

   173

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

   174

   175

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

   176

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   177

   178

	if (!CheckTileOwnership(tile))

   179

		return CMD_ERROR;

   180

   181

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   182

   183

	tileh = GetTileSlope(tile, NULL);

   184

	if (tileh != 0) {

   185

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

   186

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   187

	}

   188

   189

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

   190

	wp = FindDeletedWaypointCloseTo(tile);

   191

	if (wp == NULL) {

   192

		wp = AllocateWaypoint();

   193

		if (wp == NULL) return CMD_ERROR;

   194

   195

		wp->town_index = 0;

   196

		wp->string = STR_NULL;

   197

		wp->town_cn = 0;

   198

	}

   199

   200

	if (flags & DC_EXEC) {

   201

		ModifyTile(tile, MP_MAP5, RAIL_TYPE_WAYPOINT | dir);

   202

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

   203

			// custom graphics

   204

			_m[tile].m3 |= 16;

   205

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

   206

		}

   207

   208

		wp->deleted = 0;

   209

		wp->xy = tile;

   210

		wp->build_date = _date;

   211

   212

		if (wp->town_index == STR_NULL)

   213

			MakeDefaultWaypointName(wp);

   214

   215

		UpdateWaypointSign(wp);

   216

		RedrawWaypointSign(wp);

   217

	}

   218

   219

	return _price.build_train_depot;

   220

}

   221

   222

/* Internal handler to delete a waypoint */

   223

static void DoDeleteWaypoint(Waypoint *wp)

   224

{

   225

	Order order;

   226

   227

	wp->xy = 0;

   228

   229

	order.type = OT_GOTO_WAYPOINT;

   230

	order.station = wp->index;

   231

	DeleteDestinationFromVehicleOrder(order);

   232

   233

	if (wp->string != STR_NULL)

   234

		DeleteName(wp->string);

   235

   236

	RedrawWaypointSign(wp);

   237

}

   238

   239

/* Daily loop for waypoints */

   240

void WaypointsDailyLoop(void)

   241

{

   242

	Waypoint *wp;

   243

   244

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

   245

	FOR_ALL_WAYPOINTS(wp) {

   246

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

   247

			DoDeleteWaypoint(wp);

   248

		}

   249

	}

   250

}

   251

   252

/* Remove a waypoint */

   253

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

   254

{

   255

	Waypoint *wp;

   256

   257

	/* Make sure it's a waypoint */

   258

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

   259

		return CMD_ERROR;

   260

   261

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

   262

		return CMD_ERROR;

   263

   264

	if (!EnsureNoVehicle(tile))

   265

		return CMD_ERROR;

   266

   267

	if (flags & DC_EXEC) {

   268

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

   269

   270

		wp = GetWaypointByTile(tile);

   271

   272

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

   273

		RedrawWaypointSign(wp);

   274

   275

		if (justremove) {

   276

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

   277

			_m[tile].m3 &= ~16;

   278

			_m[tile].m4 = 0;

   279

		} else {

   280

			DoClearSquare(tile);

   281

			SetSignalsOnBothDir(tile, direction);

   282

		}

   283

	}

   284

   285

	return _price.remove_train_depot;

   286

}

   287

   288

/** Delete a waypoint

   289

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

   290

 * @param p1 unused

   291

 * @param p2 unused

   292

 */

   293

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

   294

{

   295

	TileIndex tile = TileVirtXY(x, y);

   296

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   297

	return RemoveTrainWaypoint(tile, flags, true);

   298

}

   299

   300

/** Rename a waypoint.

   301

 * @param x,y unused

   302

 * @param p1 id of waypoint

   303

 * @param p2 unused

   304

 */

   305

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

   306

{

   307

	Waypoint *wp;

   308

	StringID str;

   309

   310

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   311

   312

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

   313

		str = AllocateNameUnique(_cmd_text, 0);

   314

		if (str == 0)

   315

			return CMD_ERROR;

   316

   317

		if (flags & DC_EXEC) {

   318

			wp = GetWaypoint(p1);

   319

			if (wp->string != STR_NULL)

   320

				DeleteName(wp->string);

   321

   322

			wp->string = str;

   323

			wp->town_cn = 0;

   324

   325

			UpdateWaypointSign(wp);

   326

			MarkWholeScreenDirty();

   327

		} else {

   328

			DeleteName(str);

   329

		}

   330

	} else {

   331

		if (flags & DC_EXEC) {

   332

			wp = GetWaypoint(p1);

   333

			if (wp->string != STR_NULL)

   334

				DeleteName(wp->string);

   335

   336

			MakeDefaultWaypointName(wp);

   337

			UpdateWaypointSign(wp);

   338

			MarkWholeScreenDirty();

   339

		}

   340

	}

   341

	return 0;

   342

}

   343

   344

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

   345

Station *ComposeWaypointStation(TileIndex tile)

   346

{

   347

	Waypoint *wp = GetWaypointByTile(tile);

   348

	static Station stat;

   349

   350

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

   351

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

   352

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

   353

	stat.build_date = wp->build_date;

   354

	stat.class_id = 6;

   355

	stat.stat_id = wp->stat_id;

   356

   357

	return &stat;

   358

}

   359

   360

extern uint16 _custom_sprites_base;

   361

   362

/* Draw a waypoint */

   363

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

   364

{

   365

	StationSpec *stat;

   366

	uint32 relocation;

   367

	DrawTileSprites *cust;

   368

	DrawTileSeqStruct const *seq;

   369

	uint32 ormod, img;

   370

   371

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   372

   373

	x += 33;

   374

	y += 17;

   375

   376

	/* draw default waypoint graphics of ID 0 */

   377

	if (stat_id == 0) {

   378

		const DrawTrackSeqStruct *dtss = _track_depot_layout_table[4];

   379

   380

		img = dtss++->image;

   382

		DrawSprite(img, x, y);

   383

   384

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

   385

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

   386

			img = dtss->image;

   388

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

   389

		}

   390

		return;

   391

	}

   392

   393

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id - 1);

   394

	assert(stat);

   395

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   396

	// emulate station tile - open with building

   397

	// add 1 to get the other direction

   398

	cust = &stat->renderdata[2];

   399

   400

	img = cust->ground_sprite;

   401

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

   402

   404

	DrawSprite(img, x, y);

   405

   406

	foreach_draw_tile_seq(seq, cust->seq) {

   407

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

   408

		uint32 image = seq->image + relocation;

   409

   411

	}

   412

}

   413

   414

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

   415

void FixOldWaypoints(void)

   416

{

   417

	Waypoint *wp;

   418

   419

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

   420

	FOR_ALL_WAYPOINTS(wp) {

   421

		if (wp->xy == 0)

   422

			continue;

   423

   424

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

   425

		wp->town_cn = 0;

   426

		if (wp->string & 0xC000) {

   427

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

   428

			wp->string = STR_NULL;

   429

		}

   430

	}

   431

}

   432

   433

void InitializeWaypoints(void)

   434

{

   435

	CleanPool(&_waypoint_pool);

   436

	AddBlockToPool(&_waypoint_pool);

   437

}

   438

   439

static const SaveLoad _waypoint_desc[] = {

   440

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

   441

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

   442

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

   443

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

   444

	SLE_VAR(Waypoint, string, SLE_UINT16),

   445

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   446

   447

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

   448

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

   449

   450

	SLE_END()

   451

};

   452

   453

static void Save_WAYP(void)

   454

{

   455

	Waypoint *wp;

   456

   457

	FOR_ALL_WAYPOINTS(wp) {

   458

		if (wp->xy != 0) {

   459

			SlSetArrayIndex(wp->index);

   460

			SlObject(wp, _waypoint_desc);

   461

		}

   462

	}

   463

}

   464

   465

static void Load_WAYP(void)

   466

{

   467

	int index;

   468

   469

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

   470

		Waypoint *wp;

   471

   472

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   473

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

   474

   475

		wp = GetWaypoint(index);

   476

		SlObject(wp, _waypoint_desc);

   477

	}

   478

}

   479

   480

const ChunkHandler _waypoint_chunk_handlers[] = {

   481

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

   482

};