1

/* $Id$ */

     2

     3

/** @file town_gui.cpp GUI for towns. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "town.h"

     9

#include "viewport_func.h"

    10

#include "gfx_func.h"

    11

#include "gui.h"

    12

#include "window_gui.h"

    13

#include "textbuf_gui.h"

    14

#include "command_func.h"

    15

#include "player_func.h"

    16

#include "player_base.h"

    17

#include "player_gui.h"

    18

#include "network/network.h"

    19

#include "variables.h"

    20

#include "strings_func.h"

    21

#include "sound_func.h"

    22

#include "economy_func.h"

    23

#include "core/alloc_func.hpp"

    24

#include "settings_type.h"

    25

#include "tilehighlight_func.h"

    26

#include "string_func.h"

    27

    28

#include "table/sprites.h"

    29

#include "table/strings.h"

    30

    31

extern bool GenerateTowns();

    32

static int _scengen_town_size = 1; // depress medium-sized towns per default

    33

    34

static const Widget _town_authority_widgets[] = {

    35

{   WWT_CLOSEBOX,   RESIZE_NONE,    13,     0,    10,     0,    13, STR_00C5,                 STR_018B_CLOSE_WINDOW},              // TWA_CLOSEBOX

    36

{    WWT_CAPTION,   RESIZE_NONE,    13,    11,   316,     0,    13, STR_2022_LOCAL_AUTHORITY, STR_018C_WINDOW_TITLE_DRAG_THIS},    // TWA_CAPTION

    37

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   316,    14,   105, 0x0,                      STR_NULL},                           // TWA_RATING_INFO

    38

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   304,   106,   157, 0x0,                      STR_2043_LIST_OF_THINGS_TO_DO_AT},   // TWA_COMMAND_LIST

    39

{  WWT_SCROLLBAR,   RESIZE_NONE,    13,   305,   316,   106,   157, 0x0,                      STR_0190_SCROLL_BAR_SCROLLS_LIST},   // TWA_SCROLLBAR

    40

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   316,   158,   209, 0x0,                      STR_NULL},                           // TWA_ACTION_INFO

    41

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,     0,   316,   210,   221, STR_2042_DO_IT,           STR_2044_CARRY_OUT_THE_HIGHLIGHTED}, // TWA_EXECUTE

    42

{   WIDGETS_END},

    43

};

    44

    45

extern const byte _town_action_costs[8];

    46

    47

enum TownActions {

    48

	TACT_NONE             = 0x00,

    49

    50

	TACT_ADVERTISE_SMALL  = 0x01,

    51

	TACT_ADVERTISE_MEDIUM = 0x02,

    52

	TACT_ADVERTISE_LARGE  = 0x04,

    53

	TACT_ROAD_REBUILD     = 0x08,

    54

	TACT_BUILD_STATUE     = 0x10,

    55

	TACT_FOUND_BUILDINGS  = 0x20,

    56

	TACT_BUY_RIGHTS       = 0x40,

    57

	TACT_BRIBE            = 0x80,

    58

    59

	TACT_ADVERTISE        = TACT_ADVERTISE_SMALL | TACT_ADVERTISE_MEDIUM | TACT_ADVERTISE_LARGE,

    60

	TACT_CONSTRUCTION     = TACT_ROAD_REBUILD | TACT_BUILD_STATUE | TACT_FOUND_BUILDINGS,

    61

	TACT_FUNDS            = TACT_BUY_RIGHTS | TACT_BRIBE,

    62

	TACT_ALL              = TACT_ADVERTISE | TACT_CONSTRUCTION | TACT_FUNDS,

    63

};

    64

    65

DECLARE_ENUM_AS_BIT_SET(TownActions);

    66

    67

/** Get a list of available actions to do at a town.

    68

 * @param nump if not NULL add put the number of available actions in it

    69

 * @param pid the player that is querying the town

    70

 * @param t the town that is queried

    71

 * @return bitmasked value of enabled actions

    72

 */

    73

uint GetMaskOfTownActions(int *nump, PlayerID pid, const Town *t)

    74

{

    75

	int num = 0;

    76

	TownActions buttons = TACT_NONE;

    77

    78

	/* Spectators and unwanted have no options */

    79

	if (pid != PLAYER_SPECTATOR && !(_patches.bribe && t->unwanted[pid])) {

    80

    81

		/* Things worth more than this are not shown */

    82

		Money avail = GetPlayer(pid)->player_money + _price.station_value * 200;

    83

		Money ref = _price.build_industry >> 8;

    84

    85

		/* Check the action bits for validity and

    86

		 * if they are valid add them */

    87

		for (uint i = 0; i != lengthof(_town_action_costs); i++) {

    88

			const TownActions cur = (TownActions)(1 << i);

    89

    90

			/* Is the player not able to bribe ? */

    91

			if (cur == TACT_BRIBE && (!_patches.bribe || t->ratings[pid] >= RATING_BRIBE_MAXIMUM))

    92

				continue;

    93

    94

			/* Is the player not able to buy exclusive rights ? */

    95

			if (cur == TACT_BUY_RIGHTS && !_patches.exclusive_rights)

    96

				continue;

    97

    98

			/* Is the player not able to build a statue ? */

    99

			if (cur == TACT_BUILD_STATUE && HasBit(t->statues, pid))

   100

				continue;

   101

   102

			if (avail >= _town_action_costs[i] * ref) {

   103

				buttons |= cur;

   104

				num++;

   105

			}

   106

		}

   107

	}

   108

   109

	if (nump != NULL) *nump = num;

   110

	return buttons;

   111

}

   112

   113

/**

   114

 * Get the position of the Nth set bit.

   115

 *

   116

 * If there is no Nth bit set return -1

   117

 *

   118

 * @param bits The value to search in

   119

 * @param n The Nth set bit from which we want to know the position

   120

 * @return The position of the Nth set bit

   121

 */

   122

static int GetNthSetBit(uint32 bits, int n)

   123

{

   124

	if (n >= 0) {

   125

		uint i;

   126

		FOR_EACH_SET_BIT(i, bits) {

   127

			n--;

   128

			if (n < 0) return i;

   129

		}

   130

	}

   131

	return -1;

   132

}

   133

   134

struct TownAuthorityWindow : Window {

   135

private:

   136

	Town *town;

   137

	int sel_index;

   138

   139

	enum TownAuthorityWidget {

   140

		TWA_CLOSEBOX = 0,

   141

		TWA_CAPTION,

   142

		TWA_RATING_INFO,

   143

		TWA_COMMAND_LIST,

   144

		TWA_SCROLLBAR,

   145

		TWA_ACTION_INFO,

   146

		TWA_EXECUTE,

   147

	};

   148

   149

public:

   150

	TownAuthorityWindow(const WindowDesc *desc, WindowNumber window_number) :

   151

			Window(desc, window_number), sel_index(-1)

   152

	{

   153

		this->town = GetTown(this->window_number);

   154

		this->vscroll.cap = 5;

   155

   156

		this->FindWindowPlacementAndResize(desc);

   157

	}

   158

   159

	virtual void OnPaint()

   160

	{

   161

		int numact;

   162

		uint buttons = GetMaskOfTownActions(&numact, _local_player, this->town);

   163

   164

		SetVScrollCount(this, numact + 1);

   165

   166

		if (this->sel_index != -1 && !HasBit(buttons, this->sel_index)) {

   167

			this->sel_index = -1;

   168

		}

   169

   170

		this->SetWidgetDisabledState(6, this->sel_index == -1);

   171

   172

		SetDParam(0, this->window_number);

   173

		this->DrawWidgets();

   174

   175

		DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   176

   177

		/* Draw list of players */

   178

		int y = 25;

   179

   180

		const Player *p;

   181

		FOR_ALL_PLAYERS(p) {

   182

			if (p->is_active && (HasBit(this->town->have_ratings, p->index) || this->town->exclusivity == p->index)) {

   183

				DrawPlayerIcon(p->index, 2, y);

   184

   185

				SetDParam(0, p->index);

   186

				SetDParam(1, p->index);

   187

   188

				int r = this->town->ratings[p->index];

   189

				StringID str;

   190

				(str = STR_3035_APPALLING, r <= RATING_APPALLING) || // Apalling

   191

				(str++,                    r <= RATING_VERYPOOR)  || // Very Poor

   192

				(str++,                    r <= RATING_POOR)      || // Poor

   193

				(str++,                    r <= RATING_MEDIOCRE)  || // Mediocore

   194

				(str++,                    r <= RATING_GOOD)      || // Good

   195

				(str++,                    r <= RATING_VERYGOOD)  || // Very Good

   196

				(str++,                    r <= RATING_EXCELLENT) || // Excellent

   197

				(str++,                    true);                    // Outstanding

   198

   199

				SetDParam(2, str);

   200

				if (this->town->exclusivity == p->index) { // red icon for player with exclusive rights

   201

					DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   202

				}

   203

   204

				DrawString(28, y, STR_2024, TC_FROMSTRING);

   205

				y += 10;

   206

			}

   207

		}

   208

		y = 107;

   209

		int pos = this->vscroll.pos;

   210

   211

		if (--pos < 0) {

   212

			DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   213

			y += 10;

   214

		}

   215

   216

		for (int i = 0; buttons; i++, buttons >>= 1) {

   217

			if (pos <= -5) break; ///< Draw only the 5 fitting lines

   218

   219

			if ((buttons & 1) && --pos < 0) {

   220

				DrawString(3, y, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i, TC_ORANGE);

   221

				y += 10;

   222

			}

   223

		}

   224

   225

		if (this->sel_index != -1) {

   226

			SetDParam(1, (_price.build_industry >> 8) * _town_action_costs[this->sel_index]);

   227

			SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + this->sel_index);

   228

			DrawStringMultiLine(2, 159, STR_204D_INITIATE_A_SMALL_LOCAL + this->sel_index, 313);

   229

		}

   230

	}

   231

   232

	virtual void OnDoubleClick(Point pt, int widget) { HandleClick(pt, widget, true); }

   233

	virtual void OnClick(Point pt, int widget) { HandleClick(pt, widget, false); }

   234

   235

	void HandleClick(Point pt, int widget, bool double_click)

   236

	{

   237

		switch (widget) {

   238

			case TWA_COMMAND_LIST: {

   239

				int y = (pt.y - 0x6B) / 10;

   240

   241

				if (!IsInsideMM(y, 0, 5)) return;

   242

   243

				y = GetNthSetBit(GetMaskOfTownActions(NULL, _local_player, this->town), y + this->vscroll.pos - 1);

   244

				if (y >= 0) {

   245

					this->sel_index = y;

   246

					this->SetDirty();

   247

				}

   248

				/* Fall through to clicking in case we are double-clicked */

   249

				if (!double_click || y < 0) break;

   250

			}

   251

   252

			case TWA_EXECUTE:

   253

				DoCommandP(this->town->xy, this->window_number, this->sel_index, NULL, CMD_DO_TOWN_ACTION | CMD_MSG(STR_00B4_CAN_T_DO_THIS));

   254

				break;

   255

		}

   256

	}

   257

   258

	virtual void OnHundredthTick()

   259

	{

   260

		this->SetDirty();

   261

	}

   262

};

   263

   264

static const WindowDesc _town_authority_desc = {

   265

	WDP_AUTO, WDP_AUTO, 317, 222, 317, 222,

   266

	WC_TOWN_AUTHORITY, WC_NONE,

   267

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   268

	_town_authority_widgets,

   269

};

   270

   271

static void ShowTownAuthorityWindow(uint town)

   272

{

   273

	AllocateWindowDescFront<TownAuthorityWindow>(&_town_authority_desc, town);

   274

}

   275

   276

struct TownViewWindow : Window {

   277

private:

   278

	Town *town;

   279

   280

	enum TownViewWidget {

   281

		TVW_CAPTION = 1,

   282

		TVW_STICKY,

   283

		TVW_VIEWPORTPANEL,

   284

		TVW_INFOPANEL = 5,

   285

		TVW_CENTERVIEW,

   286

		TVW_SHOWAUTORITY,

   287

		TVW_CHANGENAME,

   288

		TVW_EXPAND,

   289

		TVW_DELETE,

   290

	};

   291

   292

public:

   293

	TownViewWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)

   294

	{

   295

		this->town = GetTown(this->window_number);

   296

		bool ingame = _game_mode != GM_EDITOR;

   297

   298

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   299

		InitializeWindowViewport(this, 3, 17, 254, 86, this->town->xy, ZOOM_LVL_TOWN);

   300

   301

		if (this->town->larger_town) this->widget[TVW_CAPTION].data = STR_CITY;

   302

		this->SetWidgetHiddenState(TVW_DELETE, ingame);  // hide delete button on game mode

   303

		this->SetWidgetHiddenState(TVW_EXPAND, ingame);  // hide expand button on game mode

   304

		this->SetWidgetHiddenState(TVW_SHOWAUTORITY, !ingame); // hide autority button on editor mode

   305

   306

		if (ingame) {

   307

			/* resize caption bar */

   308

			this->widget[TVW_CAPTION].right = this->widget[TVW_STICKY].left -1;

   309

			/* move the rename from top on scenario to bottom in game */

   310

			this->widget[TVW_CHANGENAME].top = this->widget[TVW_EXPAND].top;

   311

			this->widget[TVW_CHANGENAME].bottom = this->widget[TVW_EXPAND].bottom;

   312

			this->widget[TVW_CHANGENAME].right = this->widget[TVW_STICKY].right;

   313

		}

   314

   315

		/* Space required for showing noise level information */

   316

		if (_patches.station_noise_level) {

   317

			ResizeWindowForWidget(this, TVW_INFOPANEL, 0, 10);

   318

		}

   319

   320

		this->FindWindowPlacementAndResize(desc);

   321

	}

   322

   323

	virtual void OnPaint()

   324

	{

   325

		/* disable renaming town in network games if you are not the server */

   326

		this->SetWidgetDisabledState(TVW_CHANGENAME, _networking && !_network_server);

   327

   328

		SetDParam(0, this->town->index);

   329

		this->DrawWidgets();

   330

   331

		SetDParam(0, this->town->population);

   332

		SetDParam(1, this->town->num_houses);

   333

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   334

   335

		SetDParam(0, this->town->act_pass);

   336

		SetDParam(1, this->town->max_pass);

   337

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   338

   339

		SetDParam(0, this->town->act_mail);

   340

		SetDParam(1, this->town->max_mail);

   341

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   342

   343

		this->DrawViewport();

   344

   345

		/* only show the town noise, if the noise option is activated. */

   346

		if (_patches.station_noise_level) {

   347

			SetDParam(0, this->town->noise_reached);

   348

			SetDParam(1, this->town->MaxTownNoise());

   349

			DrawString(2, 137, STR_NOISE_IN_TOWN, 0);

   350

		}

   351

	}

   352

   353

	virtual void OnClick(Point pt, int widget)

   354

	{

   355

		switch (widget) {

   356

			case TVW_CENTERVIEW: /* scroll to location */

   357

				if (_ctrl_pressed) {

   358

					ShowExtraViewPortWindow(this->town->xy);

   359

				} else {

   360

					ScrollMainWindowToTile(this->town->xy);

   361

				}

   362

				break;

   363

   364

			case TVW_SHOWAUTORITY: /* town authority */

   365

				ShowTownAuthorityWindow(this->window_number);

   366

				break;

   367

   368

			case TVW_CHANGENAME: /* rename */

   369

				SetDParam(0, this->window_number);

   370

				ShowQueryString(STR_TOWN, STR_2007_RENAME_TOWN, 31, 130, this, CS_ALPHANUMERAL);

   371

				break;

   372

   373

			case TVW_EXPAND: /* expand town - only available on Scenario editor */

   374

				ExpandTown(this->town);

   375

				break;

   376

   377

			case TVW_DELETE: /* delete town - only available on Scenario editor */

   378

				delete this->town;

   379

				break;

   380

		}

   381

	}

   382

   383

	virtual void OnInvalidateData(int data = 0)

   384

	{

   385

		/* Called when setting station noise have changed, in order to resize the window */

   386

		this->SetDirty(); // refresh display for current size. This will allow to avoid glitches when downgrading

   387

   388

		if (_patches.station_noise_level) { // adjust depending

   389

			if (this->height == 150) { // window is smaller, needs to be bigger

   390

				ResizeWindowForWidget(this, TVW_INFOPANEL, 0, 10);

   391

			}

   392

		} else {

   393

			if (this->height != 150) { // window is bigger, needs to be smaller

   394

				ResizeWindowForWidget(this, TVW_INFOPANEL, 0, -10);

   395

			}

   396

		}

   397

	}

   398

   399

	virtual void OnQueryTextFinished(char *str)

   400

	{

   401

		if (!StrEmpty(str)) {

   402

			_cmd_text = str;

   403

			DoCommandP(0, this->window_number, 0, NULL,

   404

				CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   405

		}

   406

	}

   407

};

   408

   409

   410

static const Widget _town_view_widgets[] = {

   411

{   WWT_CLOSEBOX,   RESIZE_NONE,    13,     0,    10,     0,    13, STR_00C5,                 STR_018B_CLOSE_WINDOW},

   412

{    WWT_CAPTION,   RESIZE_NONE,    13,    11,   172,     0,    13, STR_2005,                 STR_018C_WINDOW_TITLE_DRAG_THIS},

   413

{  WWT_STICKYBOX,   RESIZE_NONE,    13,   248,   259,     0,    13, 0x0,                      STR_STICKY_BUTTON},

   414

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   259,    14,   105, 0x0,                      STR_NULL},

   415

{      WWT_INSET,   RESIZE_NONE,    13,     2,   257,    16,   103, 0x0,                      STR_NULL},

   416

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   259,   106,   137, 0x0,                      STR_NULL},

   417

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,     0,    85,   138,   149, STR_00E4_LOCATION,        STR_200B_CENTER_THE_MAIN_VIEW_ON},

   418

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,    86,   171,   138,   149, STR_2020_LOCAL_AUTHORITY, STR_2021_SHOW_INFORMATION_ON_LOCAL},

   419

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,   172,   247,     0,    13, STR_0130_RENAME,          STR_200C_CHANGE_TOWN_NAME},

   420

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,    86,   171,   138,   149, STR_023C_EXPAND,          STR_023B_INCREASE_SIZE_OF_TOWN},

   421

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,   172,   259,   138,   149, STR_0290_DELETE,          STR_0291_DELETE_THIS_TOWN_COMPLETELY},

   422

{   WIDGETS_END},

   423

};

   424

   425

static const WindowDesc _town_view_desc = {

   426

	WDP_AUTO, WDP_AUTO, 260, 150, 260, 150,

   427

	WC_TOWN_VIEW, WC_NONE,

   428

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   429

	_town_view_widgets,

   430

};

   431

   432

void ShowTownViewWindow(TownID town)

   433

{

   434

	AllocateWindowDescFront<TownViewWindow>(&_town_view_desc, town);

   435

}

   436

   437

static const Widget _town_directory_widgets[] = {

   438

{   WWT_CLOSEBOX,   RESIZE_NONE,    13,     0,    10,     0,    13, STR_00C5,               STR_018B_CLOSE_WINDOW},

   439

{    WWT_CAPTION,   RESIZE_NONE,    13,    11,   195,     0,    13, STR_2000_TOWNS,         STR_018C_WINDOW_TITLE_DRAG_THIS},

   440

{  WWT_STICKYBOX,   RESIZE_NONE,    13,   196,   207,     0,    13, 0x0,                    STR_STICKY_BUTTON},

   441

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,     0,    98,    14,    25, STR_SORT_BY_NAME,       STR_SORT_ORDER_TIP},

   442

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,    99,   195,    14,    25, STR_SORT_BY_POPULATION, STR_SORT_ORDER_TIP},

   443

{      WWT_PANEL, RESIZE_BOTTOM,    13,     0,   195,    26,   189, 0x0,                    STR_200A_TOWN_NAMES_CLICK_ON_NAME},

   444

{  WWT_SCROLLBAR, RESIZE_BOTTOM,    13,   196,   207,    14,   189, 0x0,                    STR_0190_SCROLL_BAR_SCROLLS_LIST},

   445

{      WWT_PANEL,     RESIZE_TB,    13,     0,   195,   190,   201, 0x0,                    STR_NULL},

   446

{  WWT_RESIZEBOX,     RESIZE_TB,    13,   196,   207,   190,   201, 0x0,                    STR_RESIZE_BUTTON},

   447

{   WIDGETS_END},

   448

};

   449

   450

   451

/* used to get a sorted list of the towns */

   452

static uint _num_town_sort;

   453

   454

static char _bufcache[64];

   455

static const Town* _last_town;

   456

   457

static int CDECL TownNameSorter(const void *a, const void *b)

   458

{

   459

	const Town* ta = *(const Town**)a;

   460

	const Town* tb = *(const Town**)b;

   461

	char buf1[64];

   462

	int r;

   463

   464

	SetDParam(0, ta->index);

   465

	GetString(buf1, STR_TOWN, lastof(buf1));

   466

   467

	/* If 'b' is the same town as in the last round, use the cached value

   468

	 *  We do this to speed stuff up ('b' is called with the same value a lot of

   469

	 *  times after eachother) */

   470

	if (tb != _last_town) {

   471

		_last_town = tb;

   472

		SetDParam(0, tb->index);

   473

		GetString(_bufcache, STR_TOWN, lastof(_bufcache));

   474

	}

   475

   476

	r = strcmp(buf1, _bufcache);

   477

	if (_town_sort_order & 1) r = -r;

   478

	return r;

   479

}

   480

   481

static int CDECL TownPopSorter(const void *a, const void *b)

   482

{

   483

	const Town* ta = *(const Town**)a;

   484

	const Town* tb = *(const Town**)b;

   485

	int r = ta->population - tb->population;

   486

	if (_town_sort_order & 1) r = -r;

   487

	return r;

   488

}

   489