1

/* $Id$ */

     2

     3

/** @file waypoint.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

     8

#include "command_func.h"

     9

#include "landscape.h"

    10

#include "order.h"

    11

#include "rail_map.h"

    12

#include "rail.h"

    13

#include "bridge_map.h"

    14

#include "saveload.h"

    15

#include "station.h"

    16

#include "town.h"

    17

#include "waypoint.h"

    18

#include "variables.h"

    19

#include "yapf/yapf.h"

    20

#include "newgrf.h"

    21

#include "misc/autoptr.hpp"

    22

#include "strings_func.h"

    23

#include "gfx_func.h"

    24

#include "functions.h"

    25

#include "window_func.h"

    26

#include "economy_func.h"

    27

#include "date_func.h"

    28

#include "vehicle_func.h"

    29

#include "vehicle_base.h"

    30

#include "string_func.h"

    36

    37

enum {

    38

	MAX_WAYPOINTS_PER_TOWN = 64,

    39

};

    40

    41

DEFINE_OLD_POOL_GENERIC(Waypoint, Waypoint)

    42

    43

    44

/**

    45

 * Update the sign for the waypoint

    46

 * @param wp Waypoint to update sign */

    47

static void UpdateWaypointSign(Waypoint* wp)

    48

{

    49

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

    50

	SetDParam(0, wp->index);

    51

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

    52

}

    53

    54

/**

    55

 * Redraw the sign of a waypoint

    56

 * @param wp Waypoint to redraw sign */

    57

static void RedrawWaypointSign(const Waypoint* wp)

    58

{

    59

	MarkAllViewportsDirty(

    60

		wp->sign.left - 6,

    61

		wp->sign.top,

    62

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

    63

		wp->sign.top + 48);

    64

}

    65

    66

/**

    67

 * Update all signs

    68

 */

    69

void UpdateAllWaypointSigns()

    70

{

    71

	Waypoint *wp;

    72

    73

	FOR_ALL_WAYPOINTS(wp) {

    74

		UpdateWaypointSign(wp);

    75

	}

    76

}

    77

    78

/**

    79

 * Set the default name for a waypoint

    80

 * @param wp Waypoint to work on

    81

 */

    82

static void MakeDefaultWaypointName(Waypoint* wp)

    83

{

    84

	Waypoint *local_wp;

    85

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

    86

	int i;

    87

    88

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

    89

    90

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

    91

    92

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

    93

	FOR_ALL_WAYPOINTS(local_wp) {

    94

		if (wp == local_wp) continue;

    95

    97

			used_waypoint[local_wp->town_cn] = true;

    98

	}

    99

   100

	/* Find an empty spot */

   101

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

   102

   104

	wp->town_cn = i;

   105

}

   106

   107

/**

   108

 * Find a deleted waypoint close to a tile.

   109

 * @param tile to search from

   110

 */

   111

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   112

{

   113

	Waypoint *wp, *best = NULL;

   114

	uint thres = 8;

   115

   116

	FOR_ALL_WAYPOINTS(wp) {

   117

		if (wp->deleted) {

   118

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

   119

   120

			if (cur_dist < thres) {

   121

				thres = cur_dist;

   122

				best = wp;

   123

			}

   124

		}

   125

	}

   126

   127

	return best;

   128

}

   129

   130

/**

   131

 * Update waypoint graphics id against saved GRFID/localidx.

   132

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

   133

 */

   134

void AfterLoadWaypoints()

   135

{

   136

	Waypoint *wp;

   137

   138

	FOR_ALL_WAYPOINTS(wp) {

   139

		uint i;

   140

   141

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

   142

   143

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

   144

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

   145

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

   146

				wp->stat_id = i;

   147

				break;

   148

			}

   149

		}

   150

	}

   151

}

   152

   153

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

   154

 * piece of rail

   155

 * @param tile tile where waypoint will be built

   156

 * @param flags type of operation

   157

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

   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

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

   164

{

   165

	Waypoint *wp;

   166

	AutoPtrT<Waypoint> wp_auto_delete;

   167

	Slope tileh;

   168

	Axis axis;

   169

   170

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

   171

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

   172

   173

	if (!IsTileType(tile, MP_RAILWAY) ||

   174

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   175

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

   176

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

   177

			)) {

   178

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   179

	}

   180

   181

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   182

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   183

   184

	tileh = GetTileSlope(tile, NULL);

   185

	if (tileh != SLOPE_FLAT &&

   186

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

   187

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   188

	}

   189

   190

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

   191

   192

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

   193

	wp = FindDeletedWaypointCloseTo(tile);

   194

	if (wp == NULL) {

   195

		wp = new Waypoint(tile);

   196

		if (wp == NULL) return CMD_ERROR;

   197

   198

		wp_auto_delete = wp;

   199

   200

		wp->town_index = 0;

   202

		wp->town_cn = 0;

   203

	} else if (flags & DC_EXEC) {

   204

		/* Move existing (recently deleted) waypoint to the new location */

   205

   206

		/* First we update the destination for all vehicles that

   207

		 * have the old waypoint in their orders. */

   208

		Vehicle *v;

   209

		FOR_ALL_VEHICLES(v) {

   210

			if (v->type == VEH_TRAIN &&

   211

					v->First() == v &&

   212

					v->current_order.type == OT_GOTO_WAYPOINT &&

   213

					v->dest_tile == wp->xy) {

   214

				v->dest_tile = tile;

   215

			}

   216

		}

   217

   218

		RedrawWaypointSign(wp);

   219

		wp->xy = tile;

   220

	}

   221

   222

	if (flags & DC_EXEC) {

   223

		const StationSpec* statspec;

   224

   225

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

   226

		MarkTileDirtyByTile(tile);

   227

   228

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   229

   230

		if (statspec != NULL) {

   231

			wp->stat_id = p1;

   232

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

   233

			wp->localidx = statspec->localidx;

   234

		} else {

   235

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

   236

			wp->stat_id = 0;

   237

			wp->grfid = 0;

   238

			wp->localidx = 0;

   239

		}

   240

   241

		wp->deleted = 0;

   242

		wp->build_date = _date;

   243

   244

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

   245

   246

		UpdateWaypointSign(wp);

   247

		RedrawWaypointSign(wp);

   248

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   249

		wp_auto_delete.Detach();

   250

	}

   251

   252

	return CommandCost(EXPENSES_CONSTRUCTION, _price.build_train_depot);

   253

}

   254

   255

/**

   256

 * Daily loop for waypoints

   257

 */

   258

void WaypointsDailyLoop()

   259

{

   260

	Waypoint *wp;

   261

   262

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

   263

	FOR_ALL_WAYPOINTS(wp) {

   264

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

   265

	}

   266

}

   267

   268

/**

   269

 * Remove a waypoint

   270

 * @param tile from which to remove waypoint

   271

 * @param flags type of operation

   272

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

   273

 * @return cost of operation or error

   274

 */

   275

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

   276

{

   277

	Waypoint *wp;

   278

   279

	/* Make sure it's a waypoint */

   280

	if (!IsTileType(tile, MP_RAILWAY) ||

   281

			!IsRailWaypoint(tile) ||

   282

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

   283

			!EnsureNoVehicleOnGround(tile)) {

   284

		return CMD_ERROR;

   285

	}

   286

   287

	if (flags & DC_EXEC) {

   288

		Track track = GetRailWaypointTrack(tile);

   290

		wp = GetWaypointByTile(tile);

   291

   292

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

   293

		RedrawWaypointSign(wp);

   294

   295

		if (justremove) {

   296

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

   297

			MarkTileDirtyByTile(tile);

   298

		} else {

   299

			DoClearSquare(tile);

   301

		}

   302

		YapfNotifyTrackLayoutChange(tile, track);

   303

	}

   304

   305

	return CommandCost(EXPENSES_CONSTRUCTION, _price.remove_train_depot);

   306

}

   307

   308

/**

   309

 * Delete a waypoint

   310

 * @param tile tile where waypoint is to be deleted

   311

 * @param flags type of operation

   312

 * @param p1 unused

   313

 * @param p2 unused

   314

 * @return cost of operation or error

   315

 */

   316

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

   317

{

   318

	return RemoveTrainWaypoint(tile, flags, true);

   319

}

   320

   321

static bool IsUniqueWaypointName(const char *name)

   322

{

   323

	const Waypoint *wp;

   324

	char buf[512];

   325

   326

	FOR_ALL_WAYPOINTS(wp) {

   327

		SetDParam(0, wp->index);

   328

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

   329

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

   330

	}

   331

   332

	return true;

   333

}

   334

   335

/**

   336

 * Rename a waypoint.

   337

 * @param tile unused

   338

 * @param flags type of operation

   339

 * @param p1 id of waypoint

   340

 * @param p2 unused

   341

 * @return cost of operation or error

   342

 */

   343

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

   344

{

   345

	Waypoint *wp;

   346

   347

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   348

   349

	wp = GetWaypoint(p1);

   350

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

   351

   352

	if (!StrEmpty(_cmd_text)) {

   353

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

   354

   355

		if (flags & DC_EXEC) {

   358

			wp->town_cn = 0;

   359

   360

			UpdateWaypointSign(wp);

   361

			MarkWholeScreenDirty();

   362

		}

   363

	} else {

   364

		if (flags & DC_EXEC) {

   366

   367

			MakeDefaultWaypointName(wp);

   368

			UpdateWaypointSign(wp);

   369

			MarkWholeScreenDirty();

   370

		}

   371

	}

   372

	return CommandCost();

   373

}

   374

   375

/**

   376

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

   377

 * @param tile on which to work

   378

 * @return pointer to a Station

   379

 */

   380

Station *ComposeWaypointStation(TileIndex tile)

   381

{

   382

	Waypoint *wp = GetWaypointByTile(tile);

   383

   384

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

   385

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

   386

	static byte stat_raw[sizeof(Station)];

   387

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

   388

   389

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

   390

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

   391

	stat.build_date = wp->build_date;

   392

   393

	return &stat;

   394

}

   395

   396

/**

   397

 * Draw a waypoint

   398

 * @param x coordinate

   399

 * @param y coordinate

   400

 * @param stat_id station id

   401

 * @param railtype RailType to use for

   402

 */

   403

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

   404

{

   405

	x += 33;

   406

	y += 17;

   407

   408

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

   409

		DrawDefaultWaypointSprite(x, y, railtype);

   410

	}

   411

}

   412

   413

Waypoint::Waypoint(TileIndex tile)

   414

{

   415

	this->xy = tile;

   416

}

   417

   418

Waypoint::~Waypoint()

   419

{

   421

   422

	if (CleaningPool()) return;

   423

   424

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, this->index);

   425

   426

	RedrawWaypointSign(this);

   427

	this->xy = 0;

   428

}

   429

   430

/**

   431

 * Fix savegames which stored waypoints in their old format

   432

 */

   433

void FixOldWaypoints()

   434

{

   435

	Waypoint *wp;

   436

   437

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

   438

	FOR_ALL_WAYPOINTS(wp) {

   439

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

   440

		wp->town_cn = 0;

   441

		if (wp->string & 0xC000) {

   442

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

   443

			wp->string = STR_NULL;

   444

		}

   445

	}

   446

}

   447

   448

void InitializeWaypoints()

   449

{

   450

	_Waypoint_pool.CleanPool();

   451

	_Waypoint_pool.AddBlockToPool();

   452

}

   453

   454

static const SaveLoad _waypoint_desc[] = {

   455

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

   456

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

   457

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

   458

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

   461

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   462

   463

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

   464

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

   465

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

   466

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

   467

   468

	SLE_END()

   469

};

   470

   471

static void Save_WAYP()

   472

{

   473

	Waypoint *wp;

   474

   475

	FOR_ALL_WAYPOINTS(wp) {

   476

		SlSetArrayIndex(wp->index);

   477

		SlObject(wp, _waypoint_desc);

   478

	}

   479

}

   480

   481

static void Load_WAYP()

   482

{

   483

	int index;

   484

   485

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

   486

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

   487

		SlObject(wp, _waypoint_desc);

   488

	}

   489

}

   490

   491

extern const ChunkHandler _waypoint_chunk_handlers[] = {

   492

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

   493

};