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

    12

#include "station.h"

    13

#include "tile.h"

    14

#include "town.h"

    15

#include "waypoint.h"

    16

#include "variables.h"

    17

#include "table/sprites.h"

    18

#include "table/strings.h"

    19

    20

enum {

    21

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

    22

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

    23

	WAYPOINT_POOL_MAX_BLOCKS      = 8000,

    24

    25

	MAX_WAYPOINTS_PER_TOWN        = 64,

    26

};

    27

    28

/**

    29

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

    30

 */

    31

static void WaypointPoolNewBlock(uint start_item)

    32

{

    33

	Waypoint *wp;

    34

    35

	FOR_ALL_WAYPOINTS_FROM(wp, start_item)

    36

		wp->index = start_item++;

    37

}

    38

    39

/* Initialize the town-pool */

    40

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

    41

    42

/* Create a new waypoint */

    43

static Waypoint* AllocateWaypoint(void)

    44

{

    45

	Waypoint *wp;

    46

    47

	FOR_ALL_WAYPOINTS(wp) {

    48

		if (wp->xy == 0) {

    49

			uint index = wp->index;

    50

    51

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

    52

			wp->index = index;

    53

    54

			return wp;

    55

		}

    56

	}

    57

    58

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

    59

	if (AddBlockToPool(&_waypoint_pool))

    60

		return AllocateWaypoint();

    61

    62

	return NULL;

    63

}

    64

    65

/* Update the sign for the waypoint */

    66

static void UpdateWaypointSign(Waypoint* wp)

    67

{

    68

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

    69

	SetDParam(0, wp->index);

    70

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

    71

}

    72

    73

/* Redraw the sign of a waypoint */

    74

static void RedrawWaypointSign(const Waypoint* wp)

    75

{

    76

	MarkAllViewportsDirty(

    77

		wp->sign.left - 6,

    78

		wp->sign.top,

    79

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

    80

		wp->sign.top + 48);

    81

}

    82

    83

/* Update all signs */

    84

void UpdateAllWaypointSigns(void)

    85

{

    86

	Waypoint *wp;

    87

    88

	FOR_ALL_WAYPOINTS(wp) {

    89

		if (wp->xy)

    90

			UpdateWaypointSign(wp);

    91

	}

    92

}

    93

    94

/* Set the default name for a waypoint */

    95

static void MakeDefaultWaypointName(Waypoint* wp)

    96

{

    97

	Waypoint *local_wp;

    98

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

    99

	int i;

   100

   101

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

   102

   103

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

   104

   105

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

   106

	FOR_ALL_WAYPOINTS(local_wp) {

   107

		if (wp == local_wp)

   108

			continue;

   109

   110

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

   111

			used_waypoint[local_wp->town_cn] = true;

   112

	}

   113

   114

	/* Find an empty spot */

   115

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

   116

   117

	wp->string = STR_NULL;

   118

	wp->town_cn = i;

   119

}

   120

   121

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

   122

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   123

{

   124

	Waypoint *wp, *best = NULL;

   125

	uint thres = 8, cur_dist;

   126

   127

	FOR_ALL_WAYPOINTS(wp) {

   128

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

   129

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

   130

			if (cur_dist < thres) {

   131

				thres = cur_dist;

   132

				best = wp;

   133

			}

   134

		}

   135

	}

   136

   137

	return best;

   138

}

   139

   140

/**

   141

 * Update waypoint graphics id against saved GRFID/localidx.

   142

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

   143

 */

   144

void UpdateAllWaypointCustomGraphics(void)

   145

{

   146

	Waypoint *wp;

   147

   148

	FOR_ALL_WAYPOINTS(wp) {

   149

		uint i;

   150

   151

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

   152

   153

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

   154

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

   155

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

   156

				wp->stat_id = i;

   157

				break;

   158

			}

   159

		}

   160

	}

   161

}

   162

   163

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

   164

 * piece of rail

   165

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

   166

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

   167

 * @param p2 unused

   168

 *

   169

 * @todo When checking for the tile slope,

   170

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

   171

 */

   172

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

   173

{

   174

	TileIndex tile = TileVirtXY(x, y);

   175

	Waypoint *wp;

   176

	uint tileh;

   177

	uint dir;

   178

   179

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   180

   181

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

   182

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

   183

   184

	if (!IsTileType(tile, MP_RAILWAY) || ((dir = 0, _m[tile].m5 != 1) && (dir = 1, _m[tile].m5 != 2)))

   185

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   186

   187

	if (!CheckTileOwnership(tile))

   188

		return CMD_ERROR;

   189

   190

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   191

   192

	tileh = GetTileSlope(tile, NULL);

   193

	if (tileh != 0) {

   194

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

   195

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   196

	}

   197

   198

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

   199

	wp = FindDeletedWaypointCloseTo(tile);

   200

	if (wp == NULL) {

   201

		wp = AllocateWaypoint();

   202

		if (wp == NULL) return CMD_ERROR;

   203

   204

		wp->town_index = 0;

   205

		wp->string = STR_NULL;

   206

		wp->town_cn = 0;

   207

	}

   208

   209

	if (flags & DC_EXEC) {

   210

		const StationSpec *spec = NULL;

   211

		ModifyTile(tile, MP_MAP2 | MP_MAP5, wp->index, RAIL_TYPE_WAYPOINT | dir);

   212

   213

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

   214

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

   215

   216

		if (spec != NULL) {

   217

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

   218

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

   219

			wp->grfid = spec->grfid;

   220

			wp->localidx = spec->localidx;

   221

		} else {

   222

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

   223

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

   224

			wp->stat_id = 0;

   225

			wp->grfid = 0;

   226

			wp->localidx = 0;

   227

		}

   228

   229

		wp->deleted = 0;

   230

		wp->xy = tile;

   231

		wp->build_date = _date;

   232

   233

		if (wp->town_index == STR_NULL)

   234

			MakeDefaultWaypointName(wp);

   235

   236

		UpdateWaypointSign(wp);

   237

		RedrawWaypointSign(wp);

   238

	}

   239

   240

	return _price.build_train_depot;

   241

}

   242

   243

/* Internal handler to delete a waypoint */

   244

static void DoDeleteWaypoint(Waypoint *wp)

   245

{

   246

	Order order;

   247

   248

	wp->xy = 0;

   249

   250

	order.type = OT_GOTO_WAYPOINT;

   251

	order.station = wp->index;

   252

	DeleteDestinationFromVehicleOrder(order);

   253

   254

	if (wp->string != STR_NULL)

   255

		DeleteName(wp->string);

   256

   257

	RedrawWaypointSign(wp);

   258

}

   259

   260

/* Daily loop for waypoints */

   261

void WaypointsDailyLoop(void)

   262

{

   263

	Waypoint *wp;

   264

   265

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

   266

	FOR_ALL_WAYPOINTS(wp) {

   267

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

   268

			DoDeleteWaypoint(wp);

   269

		}

   270

	}

   271

}

   272

   273

/* Remove a waypoint */

   274

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

   275

{

   276

	Waypoint *wp;

   277

   278

	/* Make sure it's a waypoint */

   279

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

   280

		return CMD_ERROR;

   281

   282

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

   283

		return CMD_ERROR;

   284

   285

	if (!EnsureNoVehicle(tile))

   286

		return CMD_ERROR;

   287

   288

	if (flags & DC_EXEC) {

   289

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

   290

   291

		wp = GetWaypointByTile(tile);

   292

   293

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

   294

		RedrawWaypointSign(wp);

   295

   296

		if (justremove) {

   297

			ModifyTile(tile, MP_MAP2_CLEAR | MP_MAP5, 1<<direction);

   298

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

   299

			_m[tile].m4 = 0;

   300

		} else {

   301

			DoClearSquare(tile);

   302

			SetSignalsOnBothDir(tile, direction);

   303

		}

   304

	}

   305

   306

	return _price.remove_train_depot;

   307

}

   308

   309

/** Delete a waypoint

   310

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

   311

 * @param p1 unused

   312

 * @param p2 unused

   313

 */

   314

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

   315

{

   316

	TileIndex tile = TileVirtXY(x, y);

   317

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   318

	return RemoveTrainWaypoint(tile, flags, true);

   319

}

   320

   321

/** Rename a waypoint.

   322

 * @param x,y unused

   323

 * @param p1 id of waypoint

   324

 * @param p2 unused

   325

 */

   326

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

   327

{

   328

	Waypoint *wp;

   329

	StringID str;

   330

   331

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   332

   333

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

   334

		str = AllocateNameUnique(_cmd_text, 0);

   335

		if (str == 0)

   336

			return CMD_ERROR;

   337

   338

		if (flags & DC_EXEC) {

   339

			wp = GetWaypoint(p1);

   340

			if (wp->string != STR_NULL)

   341

				DeleteName(wp->string);

   342

   343

			wp->string = str;

   344

			wp->town_cn = 0;

   345

   346

			UpdateWaypointSign(wp);

   347

			MarkWholeScreenDirty();

   348

		} else {

   349

			DeleteName(str);

   350

		}

   351

	} else {

   352

		if (flags & DC_EXEC) {

   353

			wp = GetWaypoint(p1);

   354

			if (wp->string != STR_NULL)

   355

				DeleteName(wp->string);

   356

   357

			MakeDefaultWaypointName(wp);

   358

			UpdateWaypointSign(wp);

   359

			MarkWholeScreenDirty();

   360

		}

   361

	}

   362

	return 0;

   363

}

   364

   365

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

   366

Station *ComposeWaypointStation(TileIndex tile)

   367

{

   368

	Waypoint *wp = GetWaypointByTile(tile);

   369

	static Station stat;

   370

   371

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

   372

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

   373

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

   374

	stat.build_date = wp->build_date;

   375

	stat.class_id = 6;

   376

	stat.stat_id = wp->stat_id;

   377

   378

	return &stat;

   379

}

   380

   381

extern uint16 _custom_sprites_base;

   382

   383

   384

/* Draw a waypoint */

   385

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

   386

{

   387

	const StationSpec *stat;

   388

	uint32 relocation;

   389

	const DrawTileSprites *cust;

   390

	DrawTileSeqStruct const *seq;

   391

	const RailtypeInfo *rti = GetRailTypeInfo(railtype);

   392

	uint32 ormod, img;

   393

   394

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   395

   396

	x += 33;

   397

	y += 17;

   398

   399

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id);

   400

	if (stat == NULL) {

   401

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

   402

		// not loaded.

   403

		DrawDefaultWaypointSprite(x, y, railtype);

   404

		return;

   405

	}

   406

   407

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   408

	// emulate station tile - open with building

   409

	// add 1 to get the other direction

   410

	cust = &stat->renderdata[2];

   411

   412

	img = cust->ground_sprite;

   413

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

   414

   415

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

   416

	DrawSprite(img, x, y);

   417

   418

	foreach_draw_tile_seq(seq, cust->seq) {

   419

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

   420

		uint32 image = seq->image + relocation;

   421

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

   422

	}

   423

}

   424

   425

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

   426

void FixOldWaypoints(void)

   427

{

   428

	Waypoint *wp;

   429

   430

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

   431

	FOR_ALL_WAYPOINTS(wp) {

   432

		if (wp->xy == 0)

   433

			continue;

   434

   435

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

   436

		wp->town_cn = 0;

   437

		if (wp->string & 0xC000) {

   438

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

   439

			wp->string = STR_NULL;

   440

		}

   441

	}

   442

}

   443

   444

void InitializeWaypoints(void)

   445

{

   446

	CleanPool(&_waypoint_pool);

   447

	AddBlockToPool(&_waypoint_pool);

   448

}

   449

   450

static const SaveLoad _waypoint_desc[] = {

   451

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

   452

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

   453

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

   454

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

   455

	SLE_VAR(Waypoint, string, SLE_UINT16),

   456

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   457

   458

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

   459

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

   460

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

   461

   462

	SLE_END()

   463

};

   464

   465

static void Save_WAYP(void)

   466

{

   467

	Waypoint *wp;

   468

   469

	FOR_ALL_WAYPOINTS(wp) {

   470

		if (wp->xy != 0) {

   471

			SlSetArrayIndex(wp->index);

   472

			SlObject(wp, _waypoint_desc);

   473

		}

   474

	}

   475

}

   476

   477

static void Load_WAYP(void)

   478

{

   479

	int index;

   480

   481

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

   482

		Waypoint *wp;

   483

   484

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   485

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

   486

   487

		wp = GetWaypoint(index);

   488

		SlObject(wp, _waypoint_desc);

   489

	}

   490

}

   491

   492

const ChunkHandler _waypoint_chunk_handlers[] = {

   493

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

   494

};