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

    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

static 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

/* Update the sign for the waypoint */

    67

static void UpdateWaypointSign(Waypoint* wp)

    68

{

    69

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

    70

	SetDParam(0, wp->index);

    71

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

    72

}

    73

    74

/* Redraw the sign of a waypoint */

    75

static void RedrawWaypointSign(const Waypoint* wp)

    76

{

    77

	MarkAllViewportsDirty(

    78

		wp->sign.left - 6,

    79

		wp->sign.top,

    80

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

    81

		wp->sign.top + 48);

    82

}

    83

    84

/* Update all signs */

    85

void UpdateAllWaypointSigns(void)

    86

{

    87

	Waypoint *wp;

    88

    89

	FOR_ALL_WAYPOINTS(wp) {

    90

		if (wp->xy)

    91

			UpdateWaypointSign(wp);

    92

	}

    93

}

    94

    95

/* Set the default name for a waypoint */

    96

static void MakeDefaultWaypointName(Waypoint* wp)

    97

{

    98

	Waypoint *local_wp;

    99

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   100

	int i;

   101

   102

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

   103

   104

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

   105

   106

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

   107

	FOR_ALL_WAYPOINTS(local_wp) {

   108

		if (wp == local_wp)

   109

			continue;

   110

   111

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

   112

			used_waypoint[local_wp->town_cn] = true;

   113

	}

   114

   115

	/* Find an empty spot */

   116

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

   117

   118

	wp->string = STR_NULL;

   119

	wp->town_cn = i;

   120

}

   121

   122

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

   123

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   124

{

   125

	Waypoint *wp, *best = NULL;

   126

	uint thres = 8, cur_dist;

   127

   128

	FOR_ALL_WAYPOINTS(wp) {

   129

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

   130

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

   131

			if (cur_dist < thres) {

   132

				thres = cur_dist;

   133

				best = wp;

   134

			}

   135

		}

   136

	}

   137

   138

	return best;

   139

}

   140

   141

/**

   142

 * Update waypoint graphics id against saved GRFID/localidx.

   143

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

   144

 */

   145

void UpdateAllWaypointCustomGraphics(void)

   146

{

   147

	Waypoint *wp;

   148

   149

	FOR_ALL_WAYPOINTS(wp) {

   150

		uint i;

   151

   152

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

   153

   154

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

   155

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

   156

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

   157

				wp->stat_id = i;

   158

				break;

   159

			}

   160

		}

   161

	}

   162

}

   163

   164

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

   165

 * piece of rail

   166

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

   167

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

   168

 * @param p2 unused

   169

 *

   170

 * @todo When checking for the tile slope,

   171

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

   172

 */

   173

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

   174

{

   175

	TileIndex tile = TileVirtXY(x, y);

   176

	Waypoint *wp;

   177

	uint tileh;

   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

				(axis = AXIS_X, _m[tile].m5 != TRACK_BIT_X) &&

   187

				(axis = AXIS_Y, _m[tile].m5 != TRACK_BIT_Y)

   188

			)) {

   189

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   190

	}

   191

   192

	if (!CheckTileOwnership(tile))

   193

		return CMD_ERROR;

   194

   195

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   196

   197

	tileh = GetTileSlope(tile, NULL);

   198

	if (tileh != 0) {

   199

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

   200

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   201

	}

   202

   203

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

   204

	wp = FindDeletedWaypointCloseTo(tile);

   205

	if (wp == NULL) {

   206

		wp = AllocateWaypoint();

   207

		if (wp == NULL) return CMD_ERROR;

   208

   209

		wp->town_index = 0;

   210

		wp->string = STR_NULL;

   211

		wp->town_cn = 0;

   212

	}

   213

   214

	if (flags & DC_EXEC) {

   215

		const StationSpec *spec = NULL;

   216

		MakeRailWaypoint(tile, GetTileOwner(tile), axis, GB(_m[tile].m3, 0, 4), wp->index);

   217

		MarkTileDirtyByTile(tile);

   218

   219

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

   220

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

   221

   222

		if (spec != NULL) {

   223

			SETBIT(_m[tile].m3, 4);

   224

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

   225

			wp->grfid = spec->grfid;

   226

			wp->localidx = spec->localidx;

   227

		} else {

   228

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

   229

			CLRBIT(_m[tile].m3, 4);

   230

			wp->stat_id = 0;

   231

			wp->grfid = 0;

   232

			wp->localidx = 0;

   233

		}

   234

   235

		wp->deleted = 0;

   236

		wp->xy = tile;

   237

		wp->build_date = _date;

   238

   239

		if (wp->town_index == STR_NULL)

   240

			MakeDefaultWaypointName(wp);

   241

   242

		UpdateWaypointSign(wp);

   243

		RedrawWaypointSign(wp);

   244

	}

   245

   246

	return _price.build_train_depot;

   247

}

   248

   249

/* Internal handler to delete a waypoint */

   250

static void DoDeleteWaypoint(Waypoint *wp)

   251

{

   252

	Order order;

   253

   254

	wp->xy = 0;

   255

   256

	order.type = OT_GOTO_WAYPOINT;

   257

	order.station = wp->index;

   258

	DeleteDestinationFromVehicleOrder(order);

   259

   260

	if (wp->string != STR_NULL)

   261

		DeleteName(wp->string);

   262

   263

	RedrawWaypointSign(wp);

   264

}

   265

   266

/* Daily loop for waypoints */

   267

void WaypointsDailyLoop(void)

   268

{

   269

	Waypoint *wp;

   270

   271

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

   272

	FOR_ALL_WAYPOINTS(wp) {

   273

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

   274

			DoDeleteWaypoint(wp);

   275

		}

   276

	}

   277

}

   278

   279

/* Remove a waypoint */

   280

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

   281

{

   282

	Waypoint *wp;

   283

   284

	/* Make sure it's a waypoint */

   285

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

   286

		return CMD_ERROR;

   287

   288

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

   289

		return CMD_ERROR;

   290

   291

	if (!EnsureNoVehicle(tile))

   292

		return CMD_ERROR;

   293

   294

	if (flags & DC_EXEC) {

   295

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

   296

   297

		wp = GetWaypointByTile(tile);

   298

   299

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

   300

		RedrawWaypointSign(wp);

   301

   302

		if (justremove) {

   303

			MakeRailNormal(tile, GetTileOwner(tile), GetRailWaypointBits(tile), GB(_m[tile].m3, 0, 4));

   304

			MarkTileDirtyByTile(tile);

   305

		} else {

   306

			DoClearSquare(tile);

   307

			SetSignalsOnBothDir(tile, direction == AXIS_X ? TRACK_X : TRACK_Y);

   308

		}

   309

	}

   310

   311

	return _price.remove_train_depot;

   312

}

   313

   314

/** Delete a waypoint

   315

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

   316

 * @param p1 unused

   317

 * @param p2 unused

   318

 */

   319

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

   320

{

   321

	TileIndex tile = TileVirtXY(x, y);

   322

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   323

	return RemoveTrainWaypoint(tile, flags, true);

   324

}

   325

   326

/** Rename a waypoint.

   327

 * @param x,y unused

   328

 * @param p1 id of waypoint

   329

 * @param p2 unused

   330

 */

   331

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

   332

{

   333

	Waypoint *wp;

   334

	StringID str;

   335

   336

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   337

   338

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

   339

		str = AllocateNameUnique(_cmd_text, 0);

   340

		if (str == 0)

   341

			return CMD_ERROR;

   342

   343

		if (flags & DC_EXEC) {

   344

			wp = GetWaypoint(p1);

   345

			if (wp->string != STR_NULL)

   346

				DeleteName(wp->string);

   347

   348

			wp->string = str;

   349

			wp->town_cn = 0;

   350

   351

			UpdateWaypointSign(wp);

   352

			MarkWholeScreenDirty();

   353

		} else {

   354

			DeleteName(str);

   355

		}

   356

	} else {

   357

		if (flags & DC_EXEC) {

   358

			wp = GetWaypoint(p1);

   359

			if (wp->string != STR_NULL)

   360

				DeleteName(wp->string);

   361

   362

			MakeDefaultWaypointName(wp);

   363

			UpdateWaypointSign(wp);

   364

			MarkWholeScreenDirty();

   365

		}

   366

	}

   367

	return 0;

   368

}

   369

   370

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

   371

Station *ComposeWaypointStation(TileIndex tile)

   372

{

   373

	Waypoint *wp = GetWaypointByTile(tile);

   374

	static Station stat;

   375

   376

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

   377

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

   378

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

   379

	stat.build_date = wp->build_date;

   380

	stat.class_id = 6;

   381

	stat.stat_id = wp->stat_id;

   382

   383

	return &stat;

   384

}

   385

   386

extern uint16 _custom_sprites_base;

   387

   388

   389

/* Draw a waypoint */

   390

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

   391

{

   392

	const StationSpec *stat;

   393

	uint32 relocation;

   394

	const DrawTileSprites *cust;

   395

	DrawTileSeqStruct const *seq;

   396

	const RailtypeInfo *rti = GetRailTypeInfo(railtype);

   397

	uint32 ormod, img;

   398

   399

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   400

   401

	x += 33;

   402

	y += 17;

   403

   404

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id);

   405

	if (stat == NULL) {

   406

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

   407

		// not loaded.

   408

		DrawDefaultWaypointSprite(x, y, railtype);

   409

		return;

   410

	}

   411

   412

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   413

	// emulate station tile - open with building

   414

	// add 1 to get the other direction

   415

	cust = &stat->renderdata[2];

   416

   417

	img = cust->ground_sprite;

   418

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

   419

   420

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

   421

	DrawSprite(img, x, y);

   422

   423

	foreach_draw_tile_seq(seq, cust->seq) {

   424

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

   425

		uint32 image = seq->image + relocation;

   426

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

   427

	}

   428

}

   429

   430

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

   431

void FixOldWaypoints(void)

   432

{

   433

	Waypoint *wp;

   434

   435

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

   436

	FOR_ALL_WAYPOINTS(wp) {

   437

		if (wp->xy == 0)

   438

			continue;

   439

   440

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

   441

		wp->town_cn = 0;

   442

		if (wp->string & 0xC000) {

   443

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

   444

			wp->string = STR_NULL;

   445

		}

   446

	}

   447

}

   448

   449

void InitializeWaypoints(void)

   450

{

   451

	CleanPool(&_waypoint_pool);

   452

	AddBlockToPool(&_waypoint_pool);

   453

}

   454

   455

static const SaveLoad _waypoint_desc[] = {

   456

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

   457

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

   458

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

   459

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

   460

	SLE_VAR(Waypoint, string, SLE_UINT16),

   461

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   462

   463

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

   464

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

   465

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

   466

   467

	SLE_END()

   468

};

   469

   470

static void Save_WAYP(void)

   471

{

   472

	Waypoint *wp;

   473

   474

	FOR_ALL_WAYPOINTS(wp) {

   475

		if (wp->xy != 0) {

   476

			SlSetArrayIndex(wp->index);

   477

			SlObject(wp, _waypoint_desc);

   478

		}

   479

	}

   480

}

   481

   482

static void Load_WAYP(void)

   483

{

   484

	int index;

   485

   486

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

   487

		Waypoint *wp;

   488

   489

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   490

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

   491

   492

		wp = GetWaypoint(index);

   493

		SlObject(wp, _waypoint_desc);

   494

	}

   495

}

   496

   497

const ChunkHandler _waypoint_chunk_handlers[] = {

   498

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

   499

};