1

/* $Id$ */

     2

     3

/** @file news_gui.cpp GUI functions related to news messages. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gui.h"

     8

#include "window_gui.h"

     9

#include "viewport_func.h"

    10

#include "news_func.h"

    11

#include "settings_type.h"

    12

#include "transparency.h"

    13

#include "strings_func.h"

    14

#include "window_func.h"

    15

#include "date_func.h"

    16

#include "vehicle_base.h"

    17

#include "sound_func.h"

    18

#include "string_func.h"

    19

#include "widgets/dropdown_func.h"

    20

#include "map_func.h"

    21

#include "statusbar_gui.h"

    22

#include "player_face.h"

    23

    24

#include "table/sprites.h"

    25

#include "table/strings.h"

    26

    27

#define NB_WIDG_PER_SETTING 4

    28

    29

NewsItem _statusbar_news_item;

    30

bool _news_ticker_sound;

    31

    32

static uint MIN_NEWS_AMOUNT = 30;           ///< prefered minimum amount of news messages

    33

static uint _total_news = 0;                ///< current number of news items

    34

static NewsItem *_oldest_news = NULL;       ///< head of news items queue

    35

static NewsItem *_latest_news = NULL;       ///< tail of news items queue

    36

    37

/** Forced news item.

    38

 * Users can force an item by accessing the history or "last message".

    39

 * If the message being shown was forced by the user, a pointer is stored

    40

 * in _forced_news. Otherwise, \a _forced_news variable is NULL. */

    41

static NewsItem *_forced_news = NULL;       ///< item the user has asked for

    42

    43

/** Current news item (last item shown regularly). */

    44

static NewsItem *_current_news = NULL;

    45

    46

    47

typedef void DrawNewsCallbackProc(struct Window *w, const NewsItem *ni);

    48

void DrawNewsNewVehicleAvail(Window *w, const NewsItem *ni);

    49

    50

static void DrawNewsBankrupcy(Window *w, const NewsItem *ni)

    51

{

    52

	Player *p = GetPlayer((PlayerID)(ni->data_b));

    53

	DrawPlayerFace(p->face, p->player_color, 2, 23);

    54

	GfxFillRect(3, 23, 3 + 91, 23 + 118, PALETTE_TO_STRUCT_GREY | (1 << USE_COLORTABLE));

    55

    56

	SetDParam(0, p->index);

    57

    58

	DrawStringMultiCenter(49, 148, STR_7058_PRESIDENT, 94);

    59

    60

	switch (ni->subtype) {

    61

		case NS_COMPANY_TROUBLE:

    62

			DrawStringCentered(w->width >> 1, 1, STR_7056_TRANSPORT_COMPANY_IN_TROUBLE, TC_FROMSTRING);

    63

    64

			SetDParam(0, p->index);

    65

    66

			DrawStringMultiCenter(

    67

				((w->width - 101) >> 1) + 98,

    68

				90,

    69

				STR_7057_WILL_BE_SOLD_OFF_OR_DECLARED,

    70

				w->width - 101);

    71

			break;

    72

    73

		case NS_COMPANY_MERGER:

    74

			DrawStringCentered(w->width >> 1, 1, STR_7059_TRANSPORT_COMPANY_MERGER, TC_FROMSTRING);

    75

			SetDParam(0, ni->params[2]);

    76

			SetDParam(1, p->index);

    77

			SetDParam(2, ni->params[4]);

    78

			DrawStringMultiCenter(

    79

				((w->width - 101) >> 1) + 98,

    80

				90,

    81

				ni->params[4] == 0 ? STR_707F_HAS_BEEN_TAKEN_OVER_BY : STR_705A_HAS_BEEN_SOLD_TO_FOR,

    82

				w->width - 101);

    83

			break;

    84

    85

		case NS_COMPANY_BANKRUPT:

    86

			DrawStringCentered(w->width >> 1, 1, STR_705C_BANKRUPT, TC_FROMSTRING);

    87

			SetDParam(0, p->index);

    88

			DrawStringMultiCenter(

    89

				((w->width - 101) >> 1) + 98,

    90

				90,

    91

				STR_705D_HAS_BEEN_CLOSED_DOWN_BY,

    92

				w->width - 101);

    93

			break;

    94

    95

		case NS_COMPANY_NEW:

    96

			DrawStringCentered(w->width >> 1, 1, STR_705E_NEW_TRANSPORT_COMPANY_LAUNCHED, TC_FROMSTRING);

    97

			SetDParam(0, p->index);

    98

			SetDParam(1, ni->params[3]);

    99

			DrawStringMultiCenter(

   100

				((w->width - 101) >> 1) + 98,

   101

				90,

   102

				STR_705F_STARTS_CONSTRUCTION_NEAR,

   103

				w->width - 101);

   104

			break;

   105

   106

		default:

   107

			NOT_REACHED();

   108

	}

   109

}

   110

   111

   112

/**

   113

 * Data common to all news items of a given subtype (structure)

   114

 */

   115

struct NewsSubtypeData {

   116

	NewsType type;         ///< News category @see NewsType

   117

	NewsMode display_mode; ///< Display mode value @see NewsMode

   118

	NewsFlag flags;        ///< Initial NewsFlags bits @see NewsFlag

   119

	DrawNewsCallbackProc *callback; ///< Call-back function

   120

};

   121

   122

/**

   123

 * Data common to all news items of a given subtype (actual data)

   124

 */

   125

static const struct NewsSubtypeData _news_subtype_data[NS_END] = {

   126

	/* type,             display_mode, flags,                  callback */

   127

	{ NT_ARRIVAL_PLAYER,  NM_THIN,     NF_VIEWPORT|NF_VEHICLE, NULL                    }, ///< NS_ARRIVAL_PLAYER

   128

	{ NT_ARRIVAL_OTHER,   NM_THIN,     NF_VIEWPORT|NF_VEHICLE, NULL                    }, ///< NS_ARRIVAL_OTHER

   129

	{ NT_ACCIDENT,        NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_ACCIDENT_TILE

   130

	{ NT_ACCIDENT,        NM_THIN,     NF_VIEWPORT|NF_VEHICLE, NULL                    }, ///< NS_ACCIDENT_VEHICLE

   131

	{ NT_COMPANY_INFO,    NM_NORMAL,   NF_NONE,                DrawNewsBankrupcy       }, ///< NS_COMPANY_TROUBLE

   132

	{ NT_COMPANY_INFO,    NM_NORMAL,   NF_NONE,                DrawNewsBankrupcy       }, ///< NS_COMPANY_MERGER

   133

	{ NT_COMPANY_INFO,    NM_NORMAL,   NF_NONE,                DrawNewsBankrupcy       }, ///< NS_COMPANY_BANKRUPT

   134

	{ NT_COMPANY_INFO,    NM_NORMAL,   NF_TILE,                DrawNewsBankrupcy       }, ///< NS_COMPANY_NEW

   135

	{ NT_OPENCLOSE,       NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_OPENCLOSE

   136

	{ NT_ECONOMY,         NM_NORMAL,   NF_NONE,                NULL                    }, ///< NS_ECONOMY

   137

	{ NT_INDUSTRY_PLAYER, NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_INDUSTRY_PLAYER

   138

	{ NT_INDUSTRY_OTHER,  NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_INDUSTRY_OTHER

   139

	{ NT_INDUSTRY_NOBODY, NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_INDUSTRY_NOBODY

   140

	{ NT_ADVICE,          NM_SMALL,    NF_VIEWPORT|NF_VEHICLE, NULL                    }, ///< NS_ADVICE

   141

	{ NT_NEW_VEHICLES,    NM_NORMAL,   NF_NONE,                DrawNewsNewVehicleAvail }, ///< NS_NEW_VEHICLES

   142

	{ NT_ACCEPTANCE,      NM_SMALL,    NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_ACCEPTANCE

   143

	{ NT_SUBSIDIES,       NM_NORMAL,   NF_TILE|NF_TILE2,       NULL                    }, ///< NS_SUBSIDIES

   144

	{ NT_GENERAL,         NM_NORMAL,   NF_TILE,                NULL                    }, ///< NS_GENERAL

   145

};

   146

   147

/**

   148

 * Per-NewsType data

   149

 */

   150

NewsTypeData _news_type_data[NT_END] = {

   151

	/* name,              age, sound,           display */

   152

	{ "arrival_player",    60, SND_1D_APPLAUSE, ND_FULL },  ///< NT_ARRIVAL_PLAYER

   153

	{ "arrival_other",     60, SND_1D_APPLAUSE, ND_FULL },  ///< NT_ARRIVAL_OTHER

   154

	{ "accident",          90, SND_BEGIN,       ND_FULL },  ///< NT_ACCIDENT

   155

	{ "company_info",      60, SND_BEGIN,       ND_FULL },  ///< NT_COMPANY_INFO

   156

	{ "openclose",         90, SND_BEGIN,       ND_FULL },  ///< NT_OPENCLOSE

   157

	{ "economy",           30, SND_BEGIN,       ND_FULL },  ///< NT_ECONOMY

   158

	{ "production_player", 30, SND_BEGIN,       ND_FULL },  ///< NT_INDUSTRY_PLAYER

   159

	{ "production_other",  30, SND_BEGIN,       ND_FULL },  ///< NT_INDUSTRY_OTHER

   160

	{ "production_nobody", 30, SND_BEGIN,       ND_FULL },  ///< NT_INDUSTRY_NOBODY

   161

	{ "advice",           150, SND_BEGIN,       ND_FULL },  ///< NT_ADVICE

   162

	{ "new_vehicles",      30, SND_1E_OOOOH,    ND_FULL },  ///< NT_NEW_VEHICLES

   163

	{ "acceptance",        90, SND_BEGIN,       ND_FULL },  ///< NT_ACCEPTANCE

   164

	{ "subsidies",        180, SND_BEGIN,       ND_FULL },  ///< NT_SUBSIDIES

   165

	{ "general",           60, SND_BEGIN,       ND_FULL },  ///< NT_GENERAL

   166

};

   167

   168

struct NewsWindow : Window {

   169

	uint16 chat_height;

   170

	NewsItem *ni;

   171

	static uint duration;

   172

   173

	NewsWindow(const WindowDesc *desc, NewsItem *ni) : Window(desc), ni(ni)

   174

	{

   175

		NewsWindow::duration = 555;

   176

		const Window *w = FindWindowById(WC_SEND_NETWORK_MSG, 0);

   177

		this->chat_height = (w != NULL) ? w->height : 0;

   178

   179

		this->ni = _forced_news == NULL ? _current_news : _forced_news;

   180

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   181

   182

		this->FindWindowPlacementAndResize(desc);

   183

	}

   184

   185

	void DrawNewsBorder()

   186

	{

   187

		int left = 0;

   188

		int right = this->width - 1;

   189

		int top = 0;

   190

		int bottom = this->height - 1;

   191

   192

		GfxFillRect(left, top, right, bottom, 0xF);

   193

   194

		GfxFillRect(left, top, left, bottom, 0xD7);

   195

		GfxFillRect(right, top, right, bottom, 0xD7);

   196

		GfxFillRect(left, top, right, top, 0xD7);

   197

		GfxFillRect(left, bottom, right, bottom, 0xD7);

   198

   199

		DrawString(left + 2, top + 1, STR_00C6, TC_FROMSTRING);

   200

	}

   201

   202

	virtual void OnPaint()

   203

	{

   204

		const NewsMode display_mode = _news_subtype_data[this->ni->subtype].display_mode;

   205

   206

		switch (display_mode) {

   207

			case NM_NORMAL:

   208

			case NM_THIN: {

   209

				this->DrawNewsBorder();

   210

   211

				if (_news_subtype_data[this->ni->subtype].callback != NULL) {

   212

					(_news_subtype_data[this->ni->subtype].callback)(this, ni);

   213

					break;

   214

				}

   215

   216

				DrawString(2, 1, STR_00C6, TC_FROMSTRING);

   217

   218

				SetDParam(0, this->ni->date);

   219

				DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   220

   221

				if (!(this->ni->flags & NF_VIEWPORT)) {

   222

					CopyInDParam(0, this->ni->params, lengthof(this->ni->params));

   223

					DrawStringMultiCenter(215, display_mode == NM_NORMAL ? 76 : 56,

   224

						this->ni->string_id, this->width - 4);

   225

				} else {

   226

					/* Back up transparency options to draw news view */

   227

					TransparencyOptionBits to_backup = _transparency_opt;

   228

					_transparency_opt = 0;

   229

					this->DrawViewport();

   230

					_transparency_opt = to_backup;

   231

   232

					/* Shade the viewport into gray, or color*/

   233

					ViewPort *vp = this->viewport;

   234

					GfxFillRect(vp->left - this->left, vp->top - this->top,

   235

						vp->left - this->left + vp->width - 1, vp->top - this->top + vp->height - 1,

   236

						(this->ni->flags & NF_INCOLOR ? PALETTE_TO_TRANSPARENT : PALETTE_TO_STRUCT_GREY) | (1 << USE_COLORTABLE)

   237

					);

   238

   239

					CopyInDParam(0, this->ni->params, lengthof(this->ni->params));

   240

					DrawStringMultiCenter(this->width / 2, 20, this->ni->string_id, this->width - 4);

   241

				}

   242

				break;

   243

			}

   244

   245

			default:

   246

				this->DrawWidgets();

   247

				if (!(this->ni->flags & NF_VIEWPORT)) {

   248

					CopyInDParam(0, this->ni->params, lengthof(this->ni->params));

   249

					DrawStringMultiCenter(140, 38, this->ni->string_id, 276);

   250

				} else {

   251

					this->DrawViewport();

   252

					CopyInDParam(0, this->ni->params, lengthof(this->ni->params));

   253

					DrawStringMultiCenter(this->width / 2, this->height - 16, this->ni->string_id, this->width - 4);

   254

				}

   255

				break;

   256

		}

   257

	}

   258

   259

	virtual void OnClick(Point pt, int widget)

   260

	{

   261

		switch (widget) {

   262

			case 1:

   263

				NewsWindow::duration = 0;

   264

				delete this;

   265

				_forced_news = NULL;

   266

				break;

   267

   268

			case 0:

   269

				if (this->ni->flags & NF_VEHICLE) {

   270

					Vehicle *v = GetVehicle(this->ni->data_a);

   271

					ScrollMainWindowTo(v->x_pos, v->y_pos);

   272

				} else if (this->ni->flags & NF_TILE) {

   273

					if (_ctrl_pressed) {

   274

						ShowExtraViewPortWindow(this->ni->data_a);

   275

						if (this->ni->flags & NF_TILE2) {

   276

							ShowExtraViewPortWindow(this->ni->data_b);

   277

						}

   278

					} else {

   279

						if (!ScrollMainWindowToTile(this->ni->data_a) && this->ni->flags & NF_TILE2) {

   280

							ScrollMainWindowToTile(this->ni->data_b);

   281

						}

   282

					}

   283

				}

   284

				break;

   285

		}

   286

	}

   287

   288

	virtual EventState OnKeyPress(uint16 key, uint16 keycode)

   289

	{

   290

		if (keycode == WKC_SPACE) {

   291

			/* Don't continue. */

   292

			delete this;

   293

			return ES_HANDLED;

   294

		}

   295

		return ES_NOT_HANDLED;

   296

	}

   297

   298

	virtual void OnInvalidateData(int data)

   299

	{

   300

		/* The chatbar has notified us that is was either created or closed */

   301

		this->chat_height = data;

   302

	}

   303

   304

	virtual void OnTick()

   305

	{

   306

		/* Scroll up newsmessages from the bottom in steps of 4 pixels */

   307

		int y = max(this->top - 4, _screen.height - this->height - 12 - this->chat_height);

   308

		if (y == this->top) return;

   309

   310

		if (this->viewport != NULL) this->viewport->top += y - this->top;

   311

   312

		int diff = Delta(this->top, y);

   313

		this->top = y;

   314

   315

		SetDirtyBlocks(this->left, this->top - diff, this->left + this->width, this->top + this->height);

   316

	}

   317

};

   318

   319

/* static */ uint NewsWindow::duration; ///< Remaining time for showing current news message

   320

   321

   322

static const Widget _news_type13_widgets[] = {

   323

{      WWT_PANEL,   RESIZE_NONE,    15,     0,   429,     0,   169, 0x0, STR_NULL},

   324

{      WWT_PANEL,   RESIZE_NONE,    15,     0,    10,     0,    11, 0x0, STR_NULL},

   325

{   WIDGETS_END},

   326

};

   327

   328

static WindowDesc _news_type13_desc = {

   329

	WDP_CENTER, 476, 430, 170, 430, 170,

   330

	WC_NEWS_WINDOW, WC_NONE,

   331

	WDF_DEF_WIDGET,

   332

	_news_type13_widgets,

   333

};

   334

   335

static const Widget _news_type2_widgets[] = {

   336

{      WWT_PANEL,   RESIZE_NONE,    15,     0,   429,     0,   129, 0x0, STR_NULL},

   337

{      WWT_PANEL,   RESIZE_NONE,    15,     0,    10,     0,    11, 0x0, STR_NULL},

   338

{   WIDGETS_END},

   339

};

   340

   341

static WindowDesc _news_type2_desc = {

   342

	WDP_CENTER, 476, 430, 130, 430, 130,

   343

	WC_NEWS_WINDOW, WC_NONE,

   344

	WDF_DEF_WIDGET,

   345

	_news_type2_widgets,

   346

};

   347

   348

static const Widget _news_type0_widgets[] = {

   349

{      WWT_PANEL,   RESIZE_NONE,     5,     0,   279,    14,    86, 0x0,              STR_NULL},

   350

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

   351

{    WWT_CAPTION,   RESIZE_NONE,     5,    11,   279,     0,    13, STR_012C_MESSAGE, STR_NULL},

   352

{      WWT_INSET,   RESIZE_NONE,     5,     2,   277,    16,    64, 0x0,              STR_NULL},

   353

{   WIDGETS_END},

   354

};

   355

   356

static WindowDesc _news_type0_desc = {

   357

	WDP_CENTER, 476, 280, 87, 280, 87,

   358

	WC_NEWS_WINDOW, WC_NONE,

   359

	WDF_DEF_WIDGET,

   360

	_news_type0_widgets,

   361

};

   362

   363

   364

/** Open up an own newspaper window for the news item */

   365

static void ShowNewspaper(NewsItem *ni)

   366

{

   367

	SoundFx sound = _news_type_data[_news_subtype_data[ni->subtype].type].sound;

   368

	if (sound != 0) SndPlayFx(sound);

   369

   370

	int top = _screen.height;

   371

	Window *w;

   372

	switch (_news_subtype_data[ni->subtype].display_mode) {

   373

		case NM_NORMAL:

   374

			_news_type13_desc.top = top;

   375

			w = new NewsWindow(&_news_type13_desc, ni);

   376

			if (ni->flags & NF_VIEWPORT) {

   377

				InitializeWindowViewport(w, 2, 58, 426, 110,

   378

					ni->data_a | (ni->flags & NF_VEHICLE ? 0x80000000 : 0), ZOOM_LVL_NEWS);

   379

			}

   380

			break;

   381

   382

		case NM_THIN:

   383

			_news_type2_desc.top = top;

   384

			w = new NewsWindow(&_news_type2_desc, ni);

   385

			if (ni->flags & NF_VIEWPORT) {

   386

				InitializeWindowViewport(w, 2, 58, 426, 70,

   387

					ni->data_a | (ni->flags & NF_VEHICLE ? 0x80000000 : 0), ZOOM_LVL_NEWS);

   388

			}

   389

			break;

   390

   391

		default:

   392

			_news_type0_desc.top = top;

   393

			w = new NewsWindow(&_news_type0_desc, ni);

   394

			if (ni->flags & NF_VIEWPORT) {

   395

				InitializeWindowViewport(w, 3, 17, 274, 47,

   396

					ni->data_a | (ni->flags & NF_VEHICLE ? 0x80000000 : 0), ZOOM_LVL_NEWS);

   397

			}

   398

			break;

   399

	}

   400

}

   401

   402

/** Show news item in the ticker */

   403

static void ShowTicker(const NewsItem *ni)

   404

{

   405

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   406

   407

	_statusbar_news_item = *ni;

   408

	InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_TICKER);

   409

}

   410

   411

/** Initialize the news-items data structures */

   412

void InitNewsItemStructs()

   413

{

   414

	for (NewsItem *ni = _oldest_news; ni != NULL; ) {

   415

		NewsItem *next = ni->next;

   416

		delete ni;

   417

		ni = next;

   418

	}

   419

   420

	_total_news = 0;

   421

	_oldest_news = NULL;

   422

	_latest_news = NULL;

   423

	_forced_news = NULL;

   424

	_current_news = NULL;

   425

}

   426

   427

/**

   428

 * Are we ready to show another news item?

   429

 * Only if nothing is in the newsticker and no newspaper is displayed

   430

 */

   431

static bool ReadyForNextItem()

   432

{

   433

	NewsItem *ni = _forced_news == NULL ? _current_news : _forced_news;

   434

	if (ni == NULL) return true;

   435

   436

	/* Ticker message

   437

	 * Check if the status bar message is still being displayed? */

   438

	if (IsNewsTickerShown()) return false;

   439

   440

	/* Newspaper message, decrement duration counter */

   441

	if (NewsWindow::duration != 0) NewsWindow::duration--;

   442

   443

	/* neither newsticker nor newspaper are running */

   444

	return (NewsWindow::duration == 0 || FindWindowById(WC_NEWS_WINDOW, 0) == NULL);

   445

}

   446

   447

/** Move to the next news item */

   448

static void MoveToNextItem()

   449

{

   450

	DeleteWindowById(WC_NEWS_WINDOW, 0);

   451

	_forced_news = NULL;

   452

   453

	/* if we're not at the last item, then move on */

   454

	if (_current_news != _latest_news) {

   455

		_current_news = (_current_news == NULL) ? _oldest_news : _current_news->next;

   456

		NewsItem *ni = _current_news;

   457

		const NewsType type = _news_subtype_data[ni->subtype].type;

   458

   459

		/* check the date, don't show too old items */

   460

		if (_date - _news_type_data[type].age > ni->date) return;

   461

   462

		switch (_news_type_data[type].display) {

   463

			default: NOT_REACHED();

   464

			case ND_OFF: // Off - show nothing only a small reminder in the status bar

   465

				InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_REMINDER);

   466

				break;

   467

   468

			case ND_SUMMARY: // Summary - show ticker

   469

				ShowTicker(ni);

   470

				break;

   471

   472

			case ND_FULL: // Full - show newspaper

   473

				ShowNewspaper(ni);

   474

				break;

   475

		}

   476

	}

   477

}

   478

   479

/**

   480

 * Add a new newsitem to be shown.

   481

 * @param string String to display

   482

 * @param subtype news category, any of the NewsSubtype enums (NS_)

   483

 * @param data_a news-specific value based on news type

   484

 * @param data_b news-specific value based on news type

   485

 *

   486

 * @see NewsSubype

   487

 */

   488

void AddNewsItem(StringID string, NewsSubtype subtype, uint data_a, uint data_b)

   489