1

/* $Id$ */

     2

     3

/** @file waypoint.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

     8

#include "command.h"

     9

#include "functions.h"

    10

#include "gfx.h"

    11

#include "landscape.h"

    12

#include "map.h"

    13

#include "order.h"

    14

#include "rail_map.h"

    15

#include "bridge_map.h"

    16

#include "saveload.h"

    17

#include "station.h"

    18

#include "tile.h"

    19

#include "town.h"

    20

#include "waypoint.h"

    21

#include "variables.h"

    22

#include "table/strings.h"

    23

#include "vehicle.h"

    24

#include "yapf/yapf.h"

    25

#include "date.h"

    26

#include "newgrf.h"

    27

#include "string.h"

    28

#include "strings.h"

    29

#include "misc/autoptr.hpp"

    30

    31

enum {

    32

	MAX_WAYPOINTS_PER_TOWN = 64,

    33

};

    34

    35

DEFINE_OLD_POOL_GENERIC(Waypoint, Waypoint)

    36

    37

    38

/**

    39

 * Update the sign for the waypoint

    40

 * @param wp Waypoint to update sign */

    41

static void UpdateWaypointSign(Waypoint* wp)

    42

{

    43

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

    44

	SetDParam(0, wp->index);

    45

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

    46

}

    47

    48

/**

    49

 * Redraw the sign of a waypoint

    50

 * @param wp Waypoint to redraw sign */

    51

static void RedrawWaypointSign(const Waypoint* wp)

    52

{

    53

	MarkAllViewportsDirty(

    54

		wp->sign.left - 6,

    55

		wp->sign.top,

    56

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

    57

		wp->sign.top + 48);

    58

}

    59

    60

/**

    61

 * Update all signs

    62

 */

    63

void UpdateAllWaypointSigns()

    64

{

    65

	Waypoint *wp;

    66

    67

	FOR_ALL_WAYPOINTS(wp) {

    68

		UpdateWaypointSign(wp);

    69

	}

    70

}

    71

    72

/**

    73

 * Set the default name for a waypoint

    74

 * @param wp Waypoint to work on

    75

 */

    76

static void MakeDefaultWaypointName(Waypoint* wp)

    77

{

    78

	Waypoint *local_wp;

    79

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

    80

	int i;

    81

    82

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

    83

    84

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

    85

    86

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

    87

	FOR_ALL_WAYPOINTS(local_wp) {

    88

		if (wp == local_wp) continue;

    89

    90

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

    91

			used_waypoint[local_wp->town_cn] = true;

    92

	}

    93

    94

	/* Find an empty spot */

    95

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

    96

    97

	wp->string = STR_NULL;

    98

	wp->town_cn = i;

    99

}

   100

   101

/**

   102

 * Find a deleted waypoint close to a tile.

   103

 * @param tile to search from

   104

 */

   105

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   106

{

   107

	Waypoint *wp, *best = NULL;

   108

	uint thres = 8;

   109

   110

	FOR_ALL_WAYPOINTS(wp) {

   111

		if (wp->deleted) {

   112

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

   113

   114

			if (cur_dist < thres) {

   115

				thres = cur_dist;

   116

				best = wp;

   117

			}

   118

		}

   119

	}

   120

   121

	return best;

   122

}

   123

   124

/**

   125

 * Update waypoint graphics id against saved GRFID/localidx.

   126

 * This is to ensure the chosen graphics are correct if GRF files are changed.

   127

 */

   128

void AfterLoadWaypoints()

   129

{

   130

	Waypoint *wp;

   131

   132

	FOR_ALL_WAYPOINTS(wp) {

   133

		uint i;

   134

   135

		if (wp->grfid == 0) continue;

   136

   137

		for (i = 0; i < GetNumCustomStations(STAT_CLASS_WAYP); i++) {

   138

			const StationSpec *statspec = GetCustomStationSpec(STAT_CLASS_WAYP, i);

   139

			if (statspec != NULL && statspec->grffile->grfid == wp->grfid && statspec->localidx == wp->localidx) {

   140

				wp->stat_id = i;

   141

				break;

   142

			}

   143

		}

   144

	}

   145

}

   146

   147

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

   148

 * piece of rail

   149

 * @param tile tile where waypoint will be built

   150

 * @param flags type of operation

   151

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

   152

 * @param p2 unused

   153

 *

   154

 * @todo When checking for the tile slope,

   155

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

   156

 */

   157

CommandCost CmdBuildTrainWaypoint(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   158

{

   159

	Waypoint *wp;

   160

	AutoPtrT<Waypoint> wp_auto_delete;

   161

	Slope tileh;

   162

	Axis axis;

   163

   164

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   165

   166

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

   167

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

   168

   169

	if (!IsTileType(tile, MP_RAILWAY) ||

   170

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   171

				(axis = AXIS_X, GetTrackBits(tile) != TRACK_BIT_X) &&

   172

				(axis = AXIS_Y, GetTrackBits(tile) != TRACK_BIT_Y)

   173

			)) {

   174

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   175

	}

   176

   177

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   179

   180

	tileh = GetTileSlope(tile, NULL);

   181

	if (tileh != SLOPE_FLAT &&

   182

			(!_patches.build_on_slopes || IsSteepSlope(tileh) || !(tileh & (0x3 << axis)) || !(tileh & ~(0x3 << axis)))) {

   183

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   184

	}

   185

   186

	if (MayHaveBridgeAbove(tile) && IsBridgeAbove(tile)) return_cmd_error(STR_5007_MUST_DEMOLISH_BRIDGE_FIRST);

   187

   188

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

   189

	wp = FindDeletedWaypointCloseTo(tile);

   190

	if (wp == NULL) {

   191

		wp = new Waypoint(tile);

   192

		if (wp == NULL) return CMD_ERROR;

   193

   194

		wp_auto_delete = wp;

   195

   196

		wp->town_index = 0;

   197

		wp->string = STR_NULL;

   198

		wp->town_cn = 0;

   199

	} else if (flags & DC_EXEC) {

   214

		RedrawWaypointSign(wp);

   215

		wp->xy = tile;

   216

	}

   217

   218

	if (flags & DC_EXEC) {

   219

		const StationSpec* statspec;

   220

   221

		MakeRailWaypoint(tile, GetTileOwner(tile), axis, GetRailType(tile), wp->index);

   222

		MarkTileDirtyByTile(tile);

   223

   224

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   225

   226

		if (statspec != NULL) {

   227

			wp->stat_id = p1;

   228

			wp->grfid = statspec->grffile->grfid;

   229

			wp->localidx = statspec->localidx;

   230

		} else {

   231

			/* Specified custom graphics do not exist, so use default. */

   232

			wp->stat_id = 0;

   233

			wp->grfid = 0;

   234

			wp->localidx = 0;

   235

		}

   236

   237

		wp->deleted = 0;

   238

		wp->build_date = _date;

   239

   240

		if (wp->town_index == 0) MakeDefaultWaypointName(wp);

   241

   242

		UpdateWaypointSign(wp);

   243

		RedrawWaypointSign(wp);

   244

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   245

		wp_auto_delete.Detach();

   246

	}

   247

   248

	return CommandCost(_price.build_train_depot);

   249

}

   250

   251

/**

   252

 * Daily loop for waypoints

   253

 */

   254

void WaypointsDailyLoop()

   255

{

   256

	Waypoint *wp;

   257

   258

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

   259

	FOR_ALL_WAYPOINTS(wp) {

   260

		if (wp->deleted != 0 && --wp->deleted == 0) DeleteWaypoint(wp);

   261

	}

   262

}

   263

   264

/**

   265

 * Remove a waypoint

   266

 * @param tile from which to remove waypoint

   267

 * @param flags type of operation

   268

 * @param justremove will indicate if it is removed from rail or if rails are removed too

   269

 * @return cost of operation or error

   270

 */

   271

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

   272

{

   273

	Waypoint *wp;

   274

   275

	/* Make sure it's a waypoint */

   276

	if (!IsTileType(tile, MP_RAILWAY) ||

   277

			!IsRailWaypoint(tile) ||

   278

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

   280

		return CMD_ERROR;

   281

	}

   282

   283

	if (flags & DC_EXEC) {

   284

		Track track = GetRailWaypointTrack(tile);

   285

		wp = GetWaypointByTile(tile);

   286

   287

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

   288

		RedrawWaypointSign(wp);

   289

   290

		if (justremove) {

   291

			MakeRailNormal(tile, GetTileOwner(tile), GetRailWaypointBits(tile), GetRailType(tile));

   292

			MarkTileDirtyByTile(tile);

   293

		} else {

   294

			DoClearSquare(tile);

   295

			SetSignalsOnBothDir(tile, track);

   296

		}

   297

		YapfNotifyTrackLayoutChange(tile, track);

   298

	}

   299

   300

	return CommandCost(_price.remove_train_depot);

   301

}

   302

   303

/**

   304

 * Delete a waypoint

   305

 * @param tile tile where waypoint is to be deleted

   306

 * @param flags type of operation

   307

 * @param p1 unused

   308

 * @param p2 unused

   309

 * @return cost of operation or error

   310

 */

   311

CommandCost CmdRemoveTrainWaypoint(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   312

{

   313

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   314

	return RemoveTrainWaypoint(tile, flags, true);

   315

}

   316

   317

static bool IsUniqueWaypointName(const char *name)

   318

{

   319

	const Waypoint *wp;

   320

	char buf[512];

   321

   322

	FOR_ALL_WAYPOINTS(wp) {

   323

		SetDParam(0, wp->index);

   324

		GetString(buf, STR_WAYPOINT_RAW, lastof(buf));

   325

		if (strcmp(buf, name) == 0) return false;

   326

	}

   327

   328

	return true;

   329

}

   330

   331

/**

   332

 * Rename a waypoint.

   333

 * @param tile unused

   334

 * @param flags type of operation

   335

 * @param p1 id of waypoint

   336

 * @param p2 unused

   337

 * @return cost of operation or error

   338

 */

   339

CommandCost CmdRenameWaypoint(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   340

{

   341

	Waypoint *wp;

   342

   343

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   344

   345

	wp = GetWaypoint(p1);

   346

	if (!CheckTileOwnership(wp->xy)) return CMD_ERROR;

   347

   348

	if (!StrEmpty(_cmd_text)) {

   349

		if (!IsUniqueWaypointName(_cmd_text)) return_cmd_error(STR_NAME_MUST_BE_UNIQUE);

   350

   351

		StringID str = AllocateName(_cmd_text, 0);

   352

   353

		if (str == 0) return CMD_ERROR;

   354

   355

		if (flags & DC_EXEC) {

   356

			if (wp->string != STR_NULL) DeleteName(wp->string);

   357

   358

			wp->string = str;

   359

			wp->town_cn = 0;

   360

   361

			UpdateWaypointSign(wp);

   362

			MarkWholeScreenDirty();

   363

		} else {

   364

			DeleteName(str);

   365

		}

   366

	} else {

   367

		if (flags & DC_EXEC) {

   368

			if (wp->string != STR_NULL) DeleteName(wp->string);

   369

   370

			MakeDefaultWaypointName(wp);

   371

			UpdateWaypointSign(wp);

   372

			MarkWholeScreenDirty();

   373

		}

   374

	}

   375

	return CommandCost();

   376

}

   377

   378

/**

   379

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

   380

 * @param tile on which to work

   381

 * @return pointer to a Station

   382

 */

   383

Station *ComposeWaypointStation(TileIndex tile)

   384

{

   385

	Waypoint *wp = GetWaypointByTile(tile);

   386

   387

	/* instead of 'static Station stat' use byte array to avoid Station's destructor call upon exit. As

   388

	 * a side effect, the station is not constructed now. */

   389

	static byte stat_raw[sizeof(Station)];

   390

	static Station &stat = *(Station*)stat_raw;

   391

   392

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

   393

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

   394

	stat.string_id = wp->string;

   395

	stat.build_date = wp->build_date;

   396

   397

	return &stat;

   398

}

   399

   400

/**

   401

 * Draw a waypoint

   402

 * @param x coordinate

   403

 * @param y coordinate

   404

 * @param stat_id station id

   405

 * @param railtype RailType to use for

   406

 */

   407

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

   408

{

   409

	x += 33;

   410

	y += 17;

   411

   412

	if (!DrawStationTile(x, y, railtype, AXIS_X, STAT_CLASS_WAYP, stat_id)) {

   413

		DrawDefaultWaypointSprite(x, y, railtype);

   414

	}

   415

}

   416

   417

Waypoint::Waypoint(TileIndex tile)

   418

{

   419

	this->xy = tile;

   420

}

   421

   422

Waypoint::~Waypoint()

   423

{

   424

	if (this->string != STR_NULL) DeleteName(this->string);

   425

   426

	if (CleaningPool()) return;

   427

   428

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, this->index);

   429

   430

	RedrawWaypointSign(this);

   431

	this->xy = 0;

   432

}

   433

   434

/**

   435

 * Fix savegames which stored waypoints in their old format

   436

 */

   437

void FixOldWaypoints()

   438

{

   439

	Waypoint *wp;

   440

   441

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

   442

	FOR_ALL_WAYPOINTS(wp) {

   443

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

   444

		wp->town_cn = 0;

   445

		if (wp->string & 0xC000) {

   446

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

   447

			wp->string = STR_NULL;

   448

		}

   449

	}

   450

}

   451

   452

void InitializeWaypoints()

   453

{

   454

	_Waypoint_pool.CleanPool();

   455

	_Waypoint_pool.AddBlockToPool();

   456

}

   457

   458

static const SaveLoad _waypoint_desc[] = {

   459

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

   460

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

   461

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

   462

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

   463

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   464

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   465

   466

	SLE_CONDVAR(Waypoint, build_date, SLE_FILE_U16 | SLE_VAR_I32,  3, 30),

   467

	SLE_CONDVAR(Waypoint, build_date, SLE_INT32,                  31, SL_MAX_VERSION),

   468

	SLE_CONDVAR(Waypoint, localidx,   SLE_UINT8,                   3, SL_MAX_VERSION),

   469

	SLE_CONDVAR(Waypoint, grfid,      SLE_UINT32,                 17, SL_MAX_VERSION),

   470

   471

	SLE_END()

   472

};

   473

   474

static void Save_WAYP()

   475

{

   476

	Waypoint *wp;

   477

   478

	FOR_ALL_WAYPOINTS(wp) {

   479

		SlSetArrayIndex(wp->index);

   480

		SlObject(wp, _waypoint_desc);

   481

	}

   482

}

   483

   484

static void Load_WAYP()

   485

{

   486

	int index;

   487

   488

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

   489

		Waypoint *wp = new (index) Waypoint();

   490

		SlObject(wp, _waypoint_desc);

   491

	}

   492

}

   493

   494

extern const ChunkHandler _waypoint_chunk_handlers[] = {

   495

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

   496

};