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 "rail_map.h"

    12

#include "saveload.h"

    13

#include "station.h"

    14

#include "tile.h"

    15

#include "town.h"

    16

#include "waypoint.h"

    17

#include "variables.h"

    18

#include "table/sprites.h"

    19

#include "table/strings.h"

    20

#include "vehicle.h"

    21

    22

enum {

    23

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

    24

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

    25

	WAYPOINT_POOL_MAX_BLOCKS      = 8000,

    26

    27

	MAX_WAYPOINTS_PER_TOWN        = 64,

    28

};

    29

    30

/**

    31

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

    32

 */

    33

static void WaypointPoolNewBlock(uint start_item)

    34

{

    35

	Waypoint *wp;

    36

    37

	FOR_ALL_WAYPOINTS_FROM(wp, start_item)

    38

		wp->index = start_item++;

    39

}

    40

    41

/* Initialize the town-pool */

    42

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

    43

    44

/* Create a new waypoint */

    45

static Waypoint* AllocateWaypoint(void)

    46

{

    47

	Waypoint *wp;

    48

    49

	FOR_ALL_WAYPOINTS(wp) {

    50

		if (wp->xy == 0) {

    51

			uint index = wp->index;

    52

    53

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

    54

			wp->index = index;

    55

    56

			return wp;

    57

		}

    58

	}

    59

    60

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

    61

	if (AddBlockToPool(&_waypoint_pool))

    62

		return AllocateWaypoint();

    63

    64

	return NULL;

    65

}

    66

    67

/* Update the sign for the waypoint */

    68

static void UpdateWaypointSign(Waypoint* wp)

    69

{

    70

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

    71

	SetDParam(0, wp->index);

    72

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

    73

}

    74

    75

/* Redraw the sign of a waypoint */

    76

static void RedrawWaypointSign(const Waypoint* wp)

    77

{

    78

	MarkAllViewportsDirty(

    79

		wp->sign.left - 6,

    80

		wp->sign.top,

    81

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

    82

		wp->sign.top + 48);

    83

}

    84

    85

/* Update all signs */

    86

void UpdateAllWaypointSigns(void)

    87

{

    88

	Waypoint *wp;

    89

    90

	FOR_ALL_WAYPOINTS(wp) {

    91

		if (wp->xy)

    92

			UpdateWaypointSign(wp);

    93

	}

    94

}

    95

    96

/* Set the default name for a waypoint */

    97

static void MakeDefaultWaypointName(Waypoint* wp)

    98

{

    99

	Waypoint *local_wp;

   100

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   101

	int i;

   102

   103

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

   104

   105

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

   106

   107

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

   108

	FOR_ALL_WAYPOINTS(local_wp) {

   109

		if (wp == local_wp)

   110

			continue;

   111

   112

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

   113

			used_waypoint[local_wp->town_cn] = true;

   114

	}

   115

   116

	/* Find an empty spot */

   117

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

   118

   119

	wp->string = STR_NULL;

   120

	wp->town_cn = i;

   121

}

   122

   123

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

   124

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   125

{

   126

	Waypoint *wp, *best = NULL;

   127

	uint thres = 8, cur_dist;

   128

   129

	FOR_ALL_WAYPOINTS(wp) {

   130

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

   131

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

   132

			if (cur_dist < thres) {

   133

				thres = cur_dist;

   134

				best = wp;

   135

			}

   136

		}

   137

	}

   138

   139

	return best;

   140

}

   141

   142

/**

   143

 * Update waypoint graphics id against saved GRFID/localidx.

   144

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

   145

 */

   146

void UpdateAllWaypointCustomGraphics(void)

   147

{

   148

	Waypoint *wp;

   149

   150

	FOR_ALL_WAYPOINTS(wp) {

   151

		uint i;

   152

   153

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

   154

   155

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

   156

			const StationSpec *spec = GetCustomStation(STAT_CLASS_WAYP, i);

   157

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

   158

				wp->stat_id = i;

   159

				break;

   160

			}

   161

		}

   162

	}

   163

}

   164

   165

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

   166

 * piece of rail

   167

 * @param tile tile where waypoint will be built

   168

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

   169

 * @param p2 unused

   170

 *

   171

 * @todo When checking for the tile slope,

   172

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

   173

 */

   174

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

   175

{

   176

	Waypoint *wp;

   178

	Axis axis;

   179

   180

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   181

   182

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

   183

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

   184

   185

	if (!IsTileType(tile, MP_RAILWAY) ||

   186

			GetRailTileType(tile) != RAIL_TYPE_NORMAL || (

   187

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

   188

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

   189

			)) {

   190

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   191

	}

   192

   193

	if (!CheckTileOwnership(tile))

   194

		return CMD_ERROR;

   195

   196

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   197

   198

	tileh = GetTileSlope(tile, NULL);

   201

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   202

	}

   203

   204

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

   205

	wp = FindDeletedWaypointCloseTo(tile);

   206

	if (wp == NULL) {

   207

		wp = AllocateWaypoint();

   208

		if (wp == NULL) return CMD_ERROR;

   209

   210

		wp->town_index = 0;

   211

		wp->string = STR_NULL;

   212

		wp->town_cn = 0;

   213

	}

   214

   215

	if (flags & DC_EXEC) {

   216

		const StationSpec *spec = NULL;

   217

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

   218

		MarkTileDirtyByTile(tile);

   219

   220

		if (GB(p1, 0, 8) < GetNumCustomStations(STAT_CLASS_WAYP))

   221

			spec = GetCustomStation(STAT_CLASS_WAYP, GB(p1, 0, 8));

   222

   223

		if (spec != NULL) {

   224

			SetCustomWaypointSprite(tile);

   225

			wp->stat_id = GB(p1, 0, 8);

   226

			wp->grfid = spec->grfid;

   227

			wp->localidx = spec->localidx;

   228

		} else {

   229

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

   230

			ClearCustomWaypointSprite(tile);

   231

			wp->stat_id = 0;

   232

			wp->grfid = 0;

   233

			wp->localidx = 0;

   234

		}

   235

   236

		wp->deleted = 0;

   237

		wp->xy = tile;

   238

		wp->build_date = _date;

   239

   240

		if (wp->town_index == 0)

   241

			MakeDefaultWaypointName(wp);

   242

   243

		UpdateWaypointSign(wp);

   244

		RedrawWaypointSign(wp);

   245

	}

   246

   247

	return _price.build_train_depot;

   248

}

   249

   250

/* Internal handler to delete a waypoint */

   251

static void DoDeleteWaypoint(Waypoint *wp)

   252

{

   253

	Order order;

   254

   255

	wp->xy = 0;

   256

   257

	order.type = OT_GOTO_WAYPOINT;

   258

	order.station = wp->index;

   259

	DeleteDestinationFromVehicleOrder(order);

   260

   261

	if (wp->string != STR_NULL)

   262

		DeleteName(wp->string);

   263

   264

	RedrawWaypointSign(wp);

   265

}

   266

   267

/* Daily loop for waypoints */

   268

void WaypointsDailyLoop(void)

   269

{

   270

	Waypoint *wp;

   271

   272

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

   273

	FOR_ALL_WAYPOINTS(wp) {

   274

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

   275

			DoDeleteWaypoint(wp);

   276

		}

   277

	}

   278

}

   279

   280

/* Remove a waypoint */

   281

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

   282

{

   283

	Waypoint *wp;

   284

   285

	/* Make sure it's a waypoint */

   286

	if (!IsTileType(tile, MP_RAILWAY) || !IsRailWaypoint(tile))

   287

		return CMD_ERROR;

   288

   289

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

   290

		return CMD_ERROR;

   291

   292

	if (!EnsureNoVehicle(tile))

   293

		return CMD_ERROR;

   294

   295

	if (flags & DC_EXEC) {

   296

		wp = GetWaypointByTile(tile);

   297

   298

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

   299

		RedrawWaypointSign(wp);

   300

   301

		if (justremove) {

   302

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

   303

			MarkTileDirtyByTile(tile);

   304

		} else {

   305

			DoClearSquare(tile);

   306

			SetSignalsOnBothDir(tile, GetRailWaypointTrack(tile));

   307

		}

   308

	}

   309

   310

	return _price.remove_train_depot;

   311

}

   312

   313

/** Delete a waypoint

   314

 * @param tile tile where waypoint is to be deleted

   315

 * @param p1 unused

   316

 * @param p2 unused

   317

 */

   318

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

   319

{

   320

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   321

	return RemoveTrainWaypoint(tile, flags, true);

   322

}

   323

   324

/** Rename a waypoint.

   325

 * @param tile unused

   326

 * @param p1 id of waypoint

   327

 * @param p2 unused

   328

 */

   329

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

   330

{

   331

	Waypoint *wp;

   332

	StringID str;

   333

   334

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   335

   336

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

   337

		str = AllocateNameUnique(_cmd_text, 0);

   338

		if (str == 0)

   339

			return CMD_ERROR;

   340

   341

		if (flags & DC_EXEC) {

   342

			wp = GetWaypoint(p1);

   343

			if (wp->string != STR_NULL)

   344

				DeleteName(wp->string);

   345

   346

			wp->string = str;

   347

			wp->town_cn = 0;

   348

   349

			UpdateWaypointSign(wp);

   350

			MarkWholeScreenDirty();

   351

		} else {

   352

			DeleteName(str);

   353

		}

   354

	} else {

   355

		if (flags & DC_EXEC) {

   356

			wp = GetWaypoint(p1);

   357

			if (wp->string != STR_NULL)

   358

				DeleteName(wp->string);

   359

   360

			MakeDefaultWaypointName(wp);

   361

			UpdateWaypointSign(wp);

   362

			MarkWholeScreenDirty();

   363

		}

   364

	}

   365

	return 0;

   366

}

   367

   368

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

   369

Station *ComposeWaypointStation(TileIndex tile)

   370

{

   371

	Waypoint *wp = GetWaypointByTile(tile);

   372

	static Station stat;

   373

   374

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

   375

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

   376

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

   377

	stat.build_date = wp->build_date;

   378

   379

	return &stat;

   380

}

   381

   382

extern uint16 _custom_sprites_base;

   383

   384

   385

/* Draw a waypoint */

   386

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

   387

{

   388

	const StationSpec *stat;

   389

	uint32 relocation;

   390

	const DrawTileSprites *cust;

   391

	DrawTileSeqStruct const *seq;

   392

	const RailtypeInfo *rti = GetRailTypeInfo(railtype);

   393

	uint32 ormod, img;

   394

   395

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   396

   397

	x += 33;

   398

	y += 17;

   399

   400

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id);

   401

	if (stat == NULL) {

   402

		// stat is NULL for default waypoints and when waypoint graphics are

   403

		// not loaded.

   404

		DrawDefaultWaypointSprite(x, y, railtype);

   405

		return;

   406

	}

   407

   408

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   409

	// emulate station tile - open with building

   410

	// add 1 to get the other direction

   411

	cust = &stat->renderdata[2];

   412

   413

	img = cust->ground_sprite;

   414

	img += (img < _custom_sprites_base) ? rti->total_offset : rti->custom_ground_offset;

   415

   416

	if (img & PALETTE_MODIFIER_COLOR) img = (img & SPRITE_MASK);

   417

	DrawSprite(img, x, y);

   418

   419

	foreach_draw_tile_seq(seq, cust->seq) {

   420

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

   421

		uint32 image = seq->image + relocation;

   422

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

   423

	}

   424

}

   425

   426

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

   427

void FixOldWaypoints(void)

   428

{

   429

	Waypoint *wp;

   430

   431

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

   432

	FOR_ALL_WAYPOINTS(wp) {

   433

		if (wp->xy == 0)

   434

			continue;

   435

   436

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

   437

		wp->town_cn = 0;

   438

		if (wp->string & 0xC000) {

   439

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

   440

			wp->string = STR_NULL;

   441

		}

   442

	}

   443

}

   444

   445

void InitializeWaypoints(void)

   446

{

   447

	CleanPool(&_waypoint_pool);

   448

	AddBlockToPool(&_waypoint_pool);

   449

}

   450

   451

static const SaveLoad _waypoint_desc[] = {

   452

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

   453

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

   454

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

   455

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

   456

	SLE_VAR(Waypoint, string, SLE_UINT16),

   457

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   458

   459

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

   460

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

   461

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

   462

   463

	SLE_END()

   464

};

   465

   466

static void Save_WAYP(void)

   467

{

   468

	Waypoint *wp;

   469

   470

	FOR_ALL_WAYPOINTS(wp) {

   471

		if (wp->xy != 0) {

   472

			SlSetArrayIndex(wp->index);

   473

			SlObject(wp, _waypoint_desc);

   474

		}

   475

	}

   476

}

   477

   478

static void Load_WAYP(void)

   479

{

   480

	int index;

   481

   482

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

   483

		Waypoint *wp;

   484

   485

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   486

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

   487

   488

		wp = GetWaypoint(index);

   489

		SlObject(wp, _waypoint_desc);

   490

	}

   491

}

   492

   493

const ChunkHandler _waypoint_chunk_handlers[] = {

   494

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

   495

};