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

    20

#include "vehicle.h"

    21

#include "yapf/yapf.h"

    22

#include "date.h"

    23

#include "newgrf.h"

    24

#include "string.h"

    25

#include "misc/autoptr.hpp"

    26

#include "strings_func.h"

    27

#include "viewport.h"

    28

#include "functions.h"

    29

#include "window_func.h"

    30

#include "economy_func.h"

    31

    32

enum {

    33

	MAX_WAYPOINTS_PER_TOWN = 64,

    34

};

    35

    36

DEFINE_OLD_POOL_GENERIC(Waypoint, Waypoint)

    37

    38

    39

/**

    40

 * Update the sign for the waypoint

    41

 * @param wp Waypoint to update sign */

    42

static void UpdateWaypointSign(Waypoint* wp)

    43

{

    44

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

    45

	SetDParam(0, wp->index);

    46

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

    47

}

    48

    49

/**

    50

 * Redraw the sign of a waypoint

    51

 * @param wp Waypoint to redraw sign */

    52

static void RedrawWaypointSign(const Waypoint* wp)

    53

{

    54

	MarkAllViewportsDirty(

    55

		wp->sign.left - 6,

    56

		wp->sign.top,

    57

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

    58

		wp->sign.top + 48);

    59

}

    60

    61

/**

    62

 * Update all signs

    63

 */

    64

void UpdateAllWaypointSigns()

    65

{

    66

	Waypoint *wp;

    67

    68

	FOR_ALL_WAYPOINTS(wp) {

    69

		UpdateWaypointSign(wp);

    70

	}

    71

}

    72

    73

/**

    74

 * Set the default name for a waypoint

    75

 * @param wp Waypoint to work on

    76

 */

    77

static void MakeDefaultWaypointName(Waypoint* wp)

    78

{

    79

	Waypoint *local_wp;

    80

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

    81

	int i;

    82

    83

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

    84

    85

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

    86

    87

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

    88

	FOR_ALL_WAYPOINTS(local_wp) {

    89

		if (wp == local_wp) continue;

    90

    91

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

    92

			used_waypoint[local_wp->town_cn] = true;

    93

	}

    94

    95

	/* Find an empty spot */

    96

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

    97

    98

	wp->string = STR_NULL;

    99

	wp->town_cn = i;

   100

}

   101

   102

/**

   103

 * Find a deleted waypoint close to a tile.

   104

 * @param tile to search from

   105

 */

   106

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   107

{

   108

	Waypoint *wp, *best = NULL;

   109

	uint thres = 8;

   110

   111

	FOR_ALL_WAYPOINTS(wp) {

   112

		if (wp->deleted) {

   113

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

   114

   115

			if (cur_dist < thres) {

   116

				thres = cur_dist;

   117

				best = wp;

   118

			}

   119

		}

   120

	}

   121

   122

	return best;

   123

}

   124

   125

/**

   126

 * Update waypoint graphics id against saved GRFID/localidx.

   127

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

   128

 */

   129

void AfterLoadWaypoints()

   130

{

   131

	Waypoint *wp;

   132

   133

	FOR_ALL_WAYPOINTS(wp) {

   134

		uint i;

   135

   136

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

   137

   138

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

   139

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

   140

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

   141

				wp->stat_id = i;

   142

				break;

   143

			}

   144

		}

   145

	}

   146

}

   147

   148

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

   149

 * piece of rail

   150

 * @param tile tile where waypoint will be built

   151

 * @param flags type of operation

   152

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

   153

 * @param p2 unused

   154

 *

   155

 * @todo When checking for the tile slope,

   156

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

   157

 */

   158

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

   159

{

   160

	Waypoint *wp;

   161

	AutoPtrT<Waypoint> wp_auto_delete;

   162

	Slope tileh;

   163

	Axis axis;

   164

   165

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   166

   167

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

   168

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

   169

   170

	if (!IsTileType(tile, MP_RAILWAY) ||

   171

			GetRailTileType(tile) != RAIL_TILE_NORMAL || (

   172

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

   173

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

   174

			)) {

   175

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   176

	}

   177

   178

	if (!CheckTileOwnership(tile)) return CMD_ERROR;

   179

	if (!EnsureNoVehicleOnGround(tile)) return CMD_ERROR;

   180

   181

	tileh = GetTileSlope(tile, NULL);

   182

	if (tileh != SLOPE_FLAT &&

   183

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

   184

		return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   185

	}

   186

   187

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

   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 = new Waypoint(tile);

   193

		if (wp == NULL) return CMD_ERROR;

   194

   195

		wp_auto_delete = wp;

   196

   197

		wp->town_index = 0;

   198

		wp->string = STR_NULL;

   199

		wp->town_cn = 0;

   200

	} else if (flags & DC_EXEC) {

   201

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

   202

   203

		/* First we update the destination for all vehicles that

   204

		 * have the old waypoint in their orders. */

   205

		Vehicle *v;

   206

		FOR_ALL_VEHICLES(v) {

   207

			if (v->type == VEH_TRAIN &&

   208

					v->First() == v &&

   209

					v->current_order.type == OT_GOTO_WAYPOINT &&

   210

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

   211

				v->dest_tile = tile;

   212

			}

   213

		}

   214

   215

		RedrawWaypointSign(wp);

   216

		wp->xy = tile;

   217

	}

   218

   219

	if (flags & DC_EXEC) {

   220

		const StationSpec* statspec;

   221

   222

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

   223

		MarkTileDirtyByTile(tile);

   224

   225

		statspec = GetCustomStationSpec(STAT_CLASS_WAYP, p1);

   226

   227

		if (statspec != NULL) {

   228

			wp->stat_id = p1;

   229

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

   230

			wp->localidx = statspec->localidx;

   231

		} else {

   232

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

   233

			wp->stat_id = 0;

   234

			wp->grfid = 0;

   235

			wp->localidx = 0;

   236

		}

   237

   238

		wp->deleted = 0;

   239

		wp->build_date = _date;

   240

   241

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

   242

   243

		UpdateWaypointSign(wp);

   244

		RedrawWaypointSign(wp);

   245

		YapfNotifyTrackLayoutChange(tile, AxisToTrack(axis));

   246

		wp_auto_delete.Detach();

   247

	}

   248

   249

	return CommandCost(_price.build_train_depot);

   250

}

   251

   252

/**

   253

 * Daily loop for waypoints

   254

 */

   255

void WaypointsDailyLoop()

   256

{

   257

	Waypoint *wp;

   258

   259

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

   260

	FOR_ALL_WAYPOINTS(wp) {

   261

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

   262

	}

   263

}

   264

   265

/**

   266

 * Remove a waypoint

   267

 * @param tile from which to remove waypoint

   268

 * @param flags type of operation

   269

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

   270

 * @return cost of operation or error

   271

 */

   272

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

   273

{

   274

	Waypoint *wp;

   275

   276

	/* Make sure it's a waypoint */

   277

	if (!IsTileType(tile, MP_RAILWAY) ||

   278

			!IsRailWaypoint(tile) ||

   279

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

   280

			!EnsureNoVehicleOnGround(tile)) {

   281

		return CMD_ERROR;

   282

	}

   283

   284

	if (flags & DC_EXEC) {

   285

		Track track = GetRailWaypointTrack(tile);

   286

		wp = GetWaypointByTile(tile);

   287

   288

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

   289

		RedrawWaypointSign(wp);

   290

   291

		if (justremove) {

   292

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

   293

			MarkTileDirtyByTile(tile);

   294

		} else {

   295

			DoClearSquare(tile);

   296

			SetSignalsOnBothDir(tile, track);

   297

		}

   298

		YapfNotifyTrackLayoutChange(tile, track);

   299

	}

   300

   301

	return CommandCost(_price.remove_train_depot);

   302

}

   303

   304

/**

   305

 * Delete a waypoint

   306

 * @param tile tile where waypoint is to be deleted

   307

 * @param flags type of operation

   308

 * @param p1 unused

   309

 * @param p2 unused

   310

 * @return cost of operation or error

   311

 */

   312

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

   313

{

   314

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   315

	return RemoveTrainWaypoint(tile, flags, true);

   316

}

   317

   318

static bool IsUniqueWaypointName(const char *name)

   319

{

   320

	const Waypoint *wp;

   321

	char buf[512];

   322

   323

	FOR_ALL_WAYPOINTS(wp) {

   324

		SetDParam(0, wp->index);

   325

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

   326

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

   327

	}

   328

   329

	return true;

   330

}

   331

   332

/**

   333

 * Rename a waypoint.

   334

 * @param tile unused

   335

 * @param flags type of operation

   336

 * @param p1 id of waypoint

   337

 * @param p2 unused

   338

 * @return cost of operation or error

   339

 */

   340

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

   341

{

   342

	Waypoint *wp;

   343

   344

	if (!IsValidWaypointID(p1)) return CMD_ERROR;

   345

   346

	wp = GetWaypoint(p1);

   347

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

   348

   349

	if (!StrEmpty(_cmd_text)) {

   350

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

   351

   352

		StringID str = AllocateName(_cmd_text, 0);

   353

   354

		if (str == 0) return CMD_ERROR;

   355

   356

		if (flags & DC_EXEC) {

   357

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

   358

   359

			wp->string = str;

   360

			wp->town_cn = 0;

   361

   362

			UpdateWaypointSign(wp);

   363

			MarkWholeScreenDirty();

   364

		} else {

   365

			DeleteName(str);

   366

		}

   367

	} else {

   368

		if (flags & DC_EXEC) {

   369

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

   370

   371

			MakeDefaultWaypointName(wp);

   372

			UpdateWaypointSign(wp);

   373

			MarkWholeScreenDirty();

   374

		}

   375

	}

   376

	return CommandCost();

   377

}

   378

   379

/**

   380

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

   381

 * @param tile on which to work

   382

 * @return pointer to a Station

   383

 */

   384

Station *ComposeWaypointStation(TileIndex tile)

   385

{

   386

	Waypoint *wp = GetWaypointByTile(tile);

   387

   388

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

   389

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

   390

	static byte stat_raw[sizeof(Station)];

   391

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

   392

   393

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

   394

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

   395

	stat.string_id = wp->string;

   396

	stat.build_date = wp->build_date;

   397

   398

	return &stat;

   399

}

   400

   401

/**

   402

 * Draw a waypoint

   403

 * @param x coordinate

   404

 * @param y coordinate

   405

 * @param stat_id station id

   406

 * @param railtype RailType to use for

   407

 */

   408

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

   409

{

   410

	x += 33;

   411

	y += 17;

   412

   413

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

   414

		DrawDefaultWaypointSprite(x, y, railtype);

   415

	}

   416

}

   417

   418

Waypoint::Waypoint(TileIndex tile)

   419

{

   420

	this->xy = tile;

   421

}

   422

   423

Waypoint::~Waypoint()

   424

{

   425

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

   426

   427

	if (CleaningPool()) return;

   428

   429

	RemoveOrderFromAllVehicles(OT_GOTO_WAYPOINT, this->index);

   430

   431

	RedrawWaypointSign(this);

   432

	this->xy = 0;

   433

}

   434

   435

/**

   436

 * Fix savegames which stored waypoints in their old format

   437

 */

   438

void FixOldWaypoints()

   439

{

   440

	Waypoint *wp;

   441

   442

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

   443

	FOR_ALL_WAYPOINTS(wp) {

   444

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

   445

		wp->town_cn = 0;

   446

		if (wp->string & 0xC000) {

   447

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

   448

			wp->string = STR_NULL;

   449

		}

   450

	}

   451

}

   452

   453

void InitializeWaypoints()

   454

{

   455

	_Waypoint_pool.CleanPool();

   456

	_Waypoint_pool.AddBlockToPool();

   457

}

   458

   459

static const SaveLoad _waypoint_desc[] = {

   460

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

   461

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

   462

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

   463

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

   464

	    SLE_VAR(Waypoint, string,     SLE_UINT16),

   465

	    SLE_VAR(Waypoint, deleted,    SLE_UINT8),

   466

   467

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

   468

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

   469

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

   470

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

   471

   472

	SLE_END()

   473

};

   474

   475

static void Save_WAYP()

   476

{

   477

	Waypoint *wp;

   478

   479

	FOR_ALL_WAYPOINTS(wp) {

   480

		SlSetArrayIndex(wp->index);

   481

		SlObject(wp, _waypoint_desc);

   482

	}

   483

}

   484

   485

static void Load_WAYP()

   486

{

   487

	int index;

   488

   489

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

   490

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

   491

		SlObject(wp, _waypoint_desc);

   492

	}

   493

}

   494

   495

extern const ChunkHandler _waypoint_chunk_handlers[] = {

   496

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