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

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

/* Fetch a waypoint by tile */

    66

Waypoint *GetWaypointByTile(TileIndex tile)

    67

{

    68

	Waypoint *wp;

    69

    70

	FOR_ALL_WAYPOINTS(wp) {

    71

		if (wp->xy == tile)

    72

			return wp;

    73

	}

    74

    75

	return NULL;

    76

}

    77

    78

/* Update the sign for the waypoint */

    79

void UpdateWaypointSign(Waypoint *wp)

    80

{

    81

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

    82

	SetDParam(0, wp->index);

    83

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

    84

}

    85

    86

/* Redraw the sign of a waypoint */

    87

void RedrawWaypointSign(Waypoint *wp)

    88

{

    89

	MarkAllViewportsDirty(

    90

		wp->sign.left - 6,

    91

		wp->sign.top,

    92

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

    93

		wp->sign.top + 48);

    94

}

    95

    96

/* Update all signs */

    97

void UpdateAllWaypointSigns(void)

    98

{

    99

	Waypoint *wp;

   100

   101

	FOR_ALL_WAYPOINTS(wp) {

   102

		if (wp->xy)

   103

			UpdateWaypointSign(wp);

   104

	}

   105

}

   106

   107

/* Set the default name for a waypoint */

   108

void MakeDefaultWaypointName(Waypoint *wp)

   109

{

   110

	Waypoint *local_wp;

   111

	bool used_waypoint[MAX_WAYPOINTS_PER_TOWN];

   112

	int i;

   113

   114

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

   115

   116

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

   117

   118

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

   119

	FOR_ALL_WAYPOINTS(local_wp) {

   120

		if (wp == local_wp)

   121

			continue;

   122

   123

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

   124

			used_waypoint[local_wp->town_cn] = true;

   125

	}

   126

   127

	/* Find an empty spot */

   128

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

   129

   130

	wp->string = STR_NULL;

   131

	wp->town_cn = i;

   132

}

   133

   134

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

   135

static Waypoint *FindDeletedWaypointCloseTo(TileIndex tile)

   136

{

   137

	Waypoint *wp, *best = NULL;

   138

	uint thres = 8, cur_dist;

   139

   140

	FOR_ALL_WAYPOINTS(wp) {

   141

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

   142

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

   143

			if (cur_dist < thres) {

   144

				thres = cur_dist;

   145

				best = wp;

   146

			}

   147

		}

   148

	}

   149

   150

	return best;

   151

}

   152

   153

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

   154

 * piece of rail

   155

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

   156

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

   157

 * @param p2 unused

   158

 *

   159

 * @todo When checking for the tile slope,

   160

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

   161

 */

   162

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

   163

{

   164

	TileIndex tile = TileVirtXY(x, y);

   165

	Waypoint *wp;

   166

	uint tileh;

   167

	uint dir;

   168

   169

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   170

   171

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

   172

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

   173

   174

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

   175

		return_cmd_error(STR_1005_NO_SUITABLE_RAILROAD_TRACK);

   176

   177

	if (!CheckTileOwnership(tile))

   178

		return CMD_ERROR;

   179

   180

	if (!EnsureNoVehicle(tile)) return CMD_ERROR;

   181

   182

	tileh = GetTileSlope(tile, NULL);

   183

	if (tileh != 0) {

   184

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

   185

			return_cmd_error(STR_0007_FLAT_LAND_REQUIRED);

   186

	}

   187

   188

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

   189

	wp = FindDeletedWaypointCloseTo(tile);

   190

	if (wp == NULL) {

   191

		wp = AllocateWaypoint();

   192

		if (wp == NULL) return CMD_ERROR;

   193

   194

		wp->town_index = 0;

   195

		wp->string = STR_NULL;

   196

		wp->town_cn = 0;

   197

	}

   198

   199

	if (flags & DC_EXEC) {

   200

		ModifyTile(tile, MP_MAP5, RAIL_TYPE_WAYPOINT | dir);

   201

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

   202

			// custom graphics

   203

			_m[tile].m3 |= 16;

   204

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

   205

		}

   206

   207

		wp->deleted = 0;

   208

		wp->xy = tile;

   209

		wp->build_date = _date;

   210

   211

		if (wp->town_index == STR_NULL)

   212

			MakeDefaultWaypointName(wp);

   213

   214

		UpdateWaypointSign(wp);

   215

		RedrawWaypointSign(wp);

   216

	}

   217

   218

	return _price.build_train_depot;

   219

}

   220

   221

/* Internal handler to delete a waypoint */

   222

static void DoDeleteWaypoint(Waypoint *wp)

   223

{

   224

	Order order;

   225

   226

	wp->xy = 0;

   227

   228

	order.type = OT_GOTO_WAYPOINT;

   229

	order.station = wp->index;

   230

	DeleteDestinationFromVehicleOrder(order);

   231

   232

	if (wp->string != STR_NULL)

   233

		DeleteName(wp->string);

   234

   235

	RedrawWaypointSign(wp);

   236

}

   237

   238

/* Daily loop for waypoints */

   239

void WaypointsDailyLoop(void)

   240

{

   241

	Waypoint *wp;

   242

   243

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

   244

	FOR_ALL_WAYPOINTS(wp) {

   245

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

   246

			DoDeleteWaypoint(wp);

   247

		}

   248

	}

   249

}

   250

   251

/* Remove a waypoint */

   252

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

   253

{

   254

	Waypoint *wp;

   255

   256

	/* Make sure it's a waypoint */

   257

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

   258

		return CMD_ERROR;

   259

   260

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

   261

		return CMD_ERROR;

   262

   263

	if (!EnsureNoVehicle(tile))

   264

		return CMD_ERROR;

   265

   266

	if (flags & DC_EXEC) {

   267

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

   268

   269

		wp = GetWaypointByTile(tile);

   270

   271

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

   272

		RedrawWaypointSign(wp);

   273

   274

		if (justremove) {

   275

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

   276

			_m[tile].m3 &= ~16;

   277

			_m[tile].m4 = 0;

   278

		} else {

   279

			DoClearSquare(tile);

   280

			SetSignalsOnBothDir(tile, direction);

   281

		}

   282

	}

   283

   284

	return _price.remove_train_depot;

   285

}

   286

   287

/** Delete a waypoint

   288

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

   289

 * @param p1 unused

   290

 * @param p2 unused

   291

 */

   292

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

   293

{

   294

	TileIndex tile = TileVirtXY(x, y);

   295

	SET_EXPENSES_TYPE(EXPENSES_CONSTRUCTION);

   296

	return RemoveTrainWaypoint(tile, flags, true);

   297

}

   298

   299

/** Rename a waypoint.

   300

 * @param x,y unused

   301

 * @param p1 id of waypoint

   302

 * @param p2 unused

   303

 */

   304

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

   305

{

   306

	Waypoint *wp;

   307

	StringID str;

   308

   309

	if (!IsWaypointIndex(p1)) return CMD_ERROR;

   310

   311

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

   312

		str = AllocateNameUnique(_cmd_text, 0);

   313

		if (str == 0)

   314

			return CMD_ERROR;

   315

   316

		if (flags & DC_EXEC) {

   317

			wp = GetWaypoint(p1);

   318

			if (wp->string != STR_NULL)

   319

				DeleteName(wp->string);

   320

   321

			wp->string = str;

   322

			wp->town_cn = 0;

   323

   324

			UpdateWaypointSign(wp);

   325

			MarkWholeScreenDirty();

   326

		} else {

   327

			DeleteName(str);

   328

		}

   329

	} else {

   330

		if (flags & DC_EXEC) {

   331

			wp = GetWaypoint(p1);

   332

			if (wp->string != STR_NULL)

   333

				DeleteName(wp->string);

   334

   335

			MakeDefaultWaypointName(wp);

   336

			UpdateWaypointSign(wp);

   337

			MarkWholeScreenDirty();

   338

		}

   339

	}

   340

	return 0;

   341

}

   342

   343

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

   344

Station *ComposeWaypointStation(TileIndex tile)

   345

{

   346

	Waypoint *wp = GetWaypointByTile(tile);

   347

	static Station stat;

   348

   349

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

   350

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

   351

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

   352

	stat.build_date = wp->build_date;

   353

	stat.class_id = 6;

   354

	stat.stat_id = wp->stat_id;

   355

   356

	return &stat;

   357

}

   358

   359

extern uint16 _custom_sprites_base;

   360

   361

   362

/* Draw a waypoint */

   363

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

   364

{

   365

	StationSpec *stat;

   366

	uint32 relocation;

   367

	DrawTileSprites *cust;

   368

	DrawTileSeqStruct const *seq;

   369

	const RailtypeInfo *rti = GetRailTypeInfo(railtype);

   370

	uint32 ormod, img;

   371

   372

	ormod = SPRITE_PALETTE(PLAYER_SPRITE_COLOR(_local_player));

   373

   374

	x += 33;

   375

	y += 17;

   376

   377

	/* draw default waypoint graphics of ID 0 */

   378

	if (stat_id == 0) {

   379

		DrawDefaultWaypointSprite(x, y, railtype);

   380

		return;

   381

	}

   382

   383

	stat = GetCustomStation(STAT_CLASS_WAYP, stat_id - 1);

   384

	assert(stat);

   385

	relocation = GetCustomStationRelocation(stat, NULL, 1);

   386

	// emulate station tile - open with building

   387

	// add 1 to get the other direction

   388

	cust = &stat->renderdata[2];

   389

   390

	img = cust->ground_sprite;

   391

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

   392

   393

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

   394

	DrawSprite(img, x, y);

   395

   396

	foreach_draw_tile_seq(seq, cust->seq) {

   397

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

   398

		uint32 image = seq->image + relocation;

   399

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

   400

	}

   401

}

   402

   403

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

   404

void FixOldWaypoints(void)

   405

{

   406

	Waypoint *wp;

   407

   408

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

   409

	FOR_ALL_WAYPOINTS(wp) {

   410

		if (wp->xy == 0)

   411

			continue;

   412

   413

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

   414

		wp->town_cn = 0;

   415

		if (wp->string & 0xC000) {

   416

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

   417

			wp->string = STR_NULL;

   418

		}

   419

	}

   420

}

   421

   422

void InitializeWaypoints(void)

   423

{

   424

	CleanPool(&_waypoint_pool);

   425

	AddBlockToPool(&_waypoint_pool);

   426

}

   427

   428

static const SaveLoad _waypoint_desc[] = {

   429

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

   430

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

   431

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

   432

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

   433

	SLE_VAR(Waypoint, string, SLE_UINT16),

   434

	SLE_VAR(Waypoint, deleted, SLE_UINT8),

   435

   436

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

   437

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

   438

   439

	SLE_END()

   440

};

   441

   442

static void Save_WAYP(void)

   443

{

   444

	Waypoint *wp;

   445

   446

	FOR_ALL_WAYPOINTS(wp) {

   447

		if (wp->xy != 0) {

   448

			SlSetArrayIndex(wp->index);

   449

			SlObject(wp, _waypoint_desc);

   450

		}

   451

	}

   452

}

   453

   454

static void Load_WAYP(void)

   455

{

   456

	int index;

   457

   458

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

   459

		Waypoint *wp;

   460

   461

		if (!AddBlockIfNeeded(&_waypoint_pool, index))

   462

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

   463

   464

		wp = GetWaypoint(index);

   465

		SlObject(wp, _waypoint_desc);

   466

	}

   467

}

   468

   469

const ChunkHandler _waypoint_chunk_handlers[] = {

   470

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

   471

};