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"

    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

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

/* Fetch a waypoint by tile */

    67

Waypoint *GetWaypointByTile(TileIndex tile)

    68

{

    69

	Waypoint *wp;

    70

    71

	FOR_ALL_WAYPOINTS(wp) {

    72

		if (wp->xy == tile)

    73

			return wp;

    74

	}

    75

    76

	return NULL;

    77

}

    78

    79

/* Update the sign for the waypoint */

    80

void UpdateWaypointSign(Waypoint *wp)

    81

{

    82

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

    83

	SetDParam(0, wp->index);

    84

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

    85

}

    86

    87

/* Redraw the sign of a waypoint */

    88

void RedrawWaypointSign(Waypoint *wp)

    89

{

    90

	MarkAllViewportsDirty(

    91

		wp->sign.left - 6,

    92

		wp->sign.top,

    93

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

    94

		wp->sign.top + 48);

    95

}

    96

    97

/* Update all signs */

    98

void UpdateAllWaypointSigns(void)

    99

{

   100

	Waypoint *wp;

   101

   102

	FOR_ALL_WAYPOINTS(wp) {

   103

		if (wp->xy)

   104

			UpdateWaypointSign(wp);

   105

	}

   106

}

   107

   108

/* Set the default name for a waypoint */

   109

void MakeDefaultWaypointName(Waypoint *wp)

   110

{

   111

	Waypoint *local_wp;

   112

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   113

	int i;

   114

   115

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

   116

   117

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

   118

   119

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

   120

	FOR_ALL_WAYPOINTS(local_wp) {

   121

		if (wp == local_wp)

   122

			continue;

   123

   124

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

   125

			used_waypoint[local_wp->town_cn] = true;

   126

	}

   127

   128

	/* Find an empty spot */

   129

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

   130

   131

	wp->string = STR_NULL;

   132

	wp->town_cn = i;

   133

}

   134

   135

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

   136

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   137

{

   138

	Waypoint *wp, *best = NULL;

   139

	uint thres = 8, cur_dist;

   140

   141

	FOR_ALL_WAYPOINTS(wp) {

   142

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

   143

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

   144

			if (cur_dist < thres) {

   145

				thres = cur_dist;

   146

				best = wp;

   147

			}

   148

		}

   149

	}

   150

   151

	return best;

   152

}

   153

   154

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

   155

 * piece of rail

   156

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

   157

 * @param p1 graphics for waypoint type, bit 8 signifies custom waypoint gfx (& 0x100)

   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

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

   164

{

   165

	TileIndex tile = TileVirtXY(x, y);

   166

	Waypoint *wp;

   167

	uint tileh;

   168

	uint dir;

   169

   170

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   171

   172

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

   173

	if (p1 > 0x100 + (uint)GetCustomStationsCount(STAT_CLASS_WAYP)) return CMD_ERROR;

   174

   175

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

   176

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   177

   178

	if (!CheckTileOwnership(tile))

   179

		return CMD_ERROR;

   180

   181

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   182

   183

	tileh = GetTileSlope(tile, NULL);

   184

	if (tileh != 0) {

   185

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

   186

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   187

	}

   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 = AllocateWaypoint();

   193

		if (wp == NULL) return CMD_ERROR;

   194

   195

		wp->town_index = 0;

   196

		wp->string = STR_NULL;

   197

		wp->town_cn = 0;

   198

	}

   199

   200

	if (flags & DC_EXEC) {

   202

		ModifyTile(tile, MP_MAP5, RAIL_TYPE_WAYPOINT | dir);

   203

		if (--p1 & 0x100) { // waypoint type 0 uses default graphics

   204

			// custom graphics

   205

			_m[tile].m3 |= 16;

   206

			_m[tile].m4 = p1 & 0xff;

   207

		}

   209

   210

		wp->deleted = 0;

   211

		wp->xy = tile;

   212

		wp->build_date = _date;

   213

   214

		if (wp->town_index == STR_NULL)

   215

			MakeDefaultWaypointName(wp);

   216

   217

		UpdateWaypointSign(wp);

   218

		RedrawWaypointSign(wp);

   219

	}

   220

   221

	return _price.build_train_depot;

   222

}

   223

   224

/* Internal handler to delete a waypoint */

   225

static void DoDeleteWaypoint(Waypoint *wp)

   226

{

   227

	Order order;

   228

   229

	wp->xy = 0;

   230

   231

	order.type = OT_GOTO_WAYPOINT;

   232

	order.station = wp->index;

   233

	DeleteDestinationFromVehicleOrder(order);

   234

   235

	if (wp->string != STR_NULL)

   236

		DeleteName(wp->string);

   237

   238

	RedrawWaypointSign(wp);

   239

}

   240

   241

/* Daily loop for waypoints */

   242

void WaypointsDailyLoop(void)

   243

{

   244

	Waypoint *wp;

   245

   246

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

   247

	FOR_ALL_WAYPOINTS(wp) {

   248

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

   249

			DoDeleteWaypoint(wp);

   250

		}

   251

	}

   252

}

   253

   254

/* Remove a waypoint */

   255

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

   256

{

   257

	Waypoint *wp;

   258

   259

	/* Make sure it's a waypoint */

   260

	if (!IsTileType(tile, MP_RAILWAY) || !IsRailWaypoint(_m[tile].m5))

   261

		return CMD_ERROR;

   262

   263

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

   264

		return CMD_ERROR;

   265

   266

	if (!EnsureNoVehicle(tile))

   267

		return CMD_ERROR;

   268

   269

	if (flags & DC_EXEC) {

   270

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

   271

   272

		wp = GetWaypointByTile(tile);

   273

   274

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

   275

		RedrawWaypointSign(wp);

   276

   277

		if (justremove) {

   279

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

   280

			_m[tile].m3 &= ~16;

   281

			_m[tile].m4 = 0;

   283

		} else {

   284

			DoClearSquare(tile);

   285

			SetSignalsOnBothDir(tile, direction);

   286

		}

   287

	}

   288

   289

	return _price.remove_train_depot;

   290

}

   291

   292

/** Delete a waypoint

   293

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

   294

 * @param p1 unused

   295

 * @param p2 unused

   296

 */

   297

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

   298

{

   299

	TileIndex tile = TileVirtXY(x, y);

   300

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   301

	return RemoveTrainWaypoint(tile, flags, true);

   302

}

   303

   304

/** Rename a waypoint.

   305

 * @param x,y unused

   306

 * @param p1 id of waypoint

   307

 * @param p2 unused

   308

 */

   309

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

   310

{

   311

	Waypoint *wp;

   312

	StringID str;

   313

   314

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   315

   316

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

   317

		str = AllocateNameUnique(_cmd_text, 0);

   318

		if (str == 0)

   319

			return CMD_ERROR;

   320

   321

		if (flags & DC_EXEC) {

   322

			wp = GetWaypoint(p1);

   323

			if (wp->string != STR_NULL)

   324

				DeleteName(wp->string);

   325

   326

			wp->string = str;

   327

			wp->town_cn = 0;

   328

   329

			UpdateWaypointSign(wp);

   330

			MarkWholeScreenDirty();

   331

		} else {

   332

			DeleteName(str);

   333

		}

   334

	} else {

   335

		if (flags & DC_EXEC) {

   336

			wp = GetWaypoint(p1);

   337

			if (wp->string != STR_NULL)

   338

				DeleteName(wp->string);

   339

   340

			MakeDefaultWaypointName(wp);

   341

			UpdateWaypointSign(wp);

   342

			MarkWholeScreenDirty();

   343

		}

   344

	}

   345

	return 0;

   346

}

   347

   348

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

   349

Station *ComposeWaypointStation(TileIndex tile)

   350

{

   351

	Waypoint *wp = GetWaypointByTile(tile);

   352

	static Station stat;

   353

   354

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

   355

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

   356

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

   357

	stat.build_date = wp->build_date;

   358

	stat.class_id = 6;

   359

	stat.stat_id = wp->stat_id;

   360

   361

	return &stat;

   362

}

   363

   364

extern uint16 _custom_sprites_base;

   365

   366

   367

/* Draw a waypoint */

   368

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

   369

{

   370

	StationSpec *stat;

   371

	uint32 relocation;

   372

	DrawTileSprites *cust;

   373

	DrawTileSeqStruct const *seq;

   374

	const RailtypeInfo *rti = GetRailTypeInfo(railtype);

   375

	uint32 ormod, img;

   376

   377

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   378

   379

	x += 33;

   380

	y += 17;

   381

   382

	/* draw default waypoint graphics of ID 0 */

   383

	if (stat_id == 0) {

   384

		DrawDefaultWaypointSprite(x, y, railtype);

   385

		return;

   386

	}

   387

   388

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id - 1);

   389

	assert(stat);

   390

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   391

	// emulate station tile - open with building

   392

	// add 1 to get the other direction

   393

	cust = &stat->renderdata[2];

   394

   395

	img = cust->ground_sprite;

   396

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

   397

   398

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

   399

	DrawSprite(img, x, y);

   400

   401

	foreach_draw_tile_seq(seq, cust->seq) {

   402

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

   403

		uint32 image = seq->image + relocation;

   404

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

   405

	}

   406

}

   407

   408

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

   409

void FixOldWaypoints(void)

   410

{

   411

	Waypoint *wp;

   412

   413

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

   414

	FOR_ALL_WAYPOINTS(wp) {

   415

		if (wp->xy == 0)

   416

			continue;

   417

   418

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

   419

		wp->town_cn = 0;

   420

		if (wp->string & 0xC000) {

   421

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

   422

			wp->string = STR_NULL;

   423

		}

   424

	}

   425

}

   426

   427

void InitializeWaypoints(void)

   428

{

   429

	CleanPool(&_waypoint_pool);

   430

	AddBlockToPool(&_waypoint_pool);

   431

}

   432

   433

static const SaveLoad _waypoint_desc[] = {

   434

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

   435

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

   436

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

   437

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

   438

	SLE_VAR(Waypoint, string, SLE_UINT16),

   439

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   440

   441

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

   442

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

   443

   444

	SLE_END()

   445

};

   446

   447

static void Save_WAYP(void)

   448

{

   449

	Waypoint *wp;

   450

   451

	FOR_ALL_WAYPOINTS(wp) {

   452

		if (wp->xy != 0) {

   453

			SlSetArrayIndex(wp->index);

   454

			SlObject(wp, _waypoint_desc);

   455

		}

   456

	}

   457

}

   458

   459

static void Load_WAYP(void)

   460

{

   461

	int index;

   462

   463

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

   464

		Waypoint *wp;

   465

   466

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   467

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

   468

   469

		wp = GetWaypoint(index);

   470

		SlObject(wp, _waypoint_desc);

   471

	}

   472

}

   473

   474

const ChunkHandler _waypoint_chunk_handlers[] = {

   475

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

   476

};