1

/* $Id$ */

     2

     3

/** @file texteff.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "tile_cmd.h"

     8

#include "landscape.h"

     9

#include "gfx_func.h"

    10

#include "saveload.h"

    11

#include "console.h"

    12

#include "variables.h"

    13

#include "blitter/factory.hpp"

    14

#include "texteff.hpp"

    15

#include "video/video_driver.hpp"

    16

#include "transparency.h"

    17

#include "strings_func.h"

    18

#include "core/alloc_func.hpp"

    19

#include "date_func.h"

    20

#include "functions.h"

    21

#include "viewport_func.h"

    22

#include "settings_type.h"

    23

    24

#include "table/sprites.h"

    25

    26

#include <stdarg.h> /* va_list */

    27

    28

enum {

    29

	MAX_TEXTMESSAGE_LENGTH = 200,

    30

	INIT_NUM_TEXT_MESSAGES =  20,

    31

	MAX_CHAT_MESSAGES      =  10,

    32

};

    33

    34

struct TextEffect {

    35

	StringID string_id;

    36

	int32 x;

    37

	int32 y;

    38

	int32 right;

    39

	int32 bottom;

    40

	uint16 duration;

    41

	uint64 params_1;

    42

	uint64 params_2;

    43

	TextEffectMode mode;

    44

};

    45

    46

    47

struct ChatMessage {

    48

	char message[MAX_TEXTMESSAGE_LENGTH];

    49

	uint16 color;

    50

	Date end_date;

    51

};

    52

    53

/* used for text effects */

    54

static TextEffect *_text_effect_list = NULL;

    55

static uint16 _num_text_effects = INIT_NUM_TEXT_MESSAGES;

    56

    57

/* used for chat window */

    58

static ChatMessage _chatmsg_list[MAX_CHAT_MESSAGES];

    59

static bool _chatmessage_dirty = false;

    60

static bool _chatmessage_visible = false;

    61

    62

/* The chatbox grows from the bottom so the coordinates are pixels from

    63

 * the left and pixels from the bottom. The height is the maximum height */

    64

static const PointDimension _chatmsg_box = {10, 30, 500, 150};

    65

static uint8 _chatmessage_backup[150 * 500 * 6]; // (height * width)

    66

    67

static inline uint GetChatMessageCount()

    68

{

    69

	uint i;

    70

    71

	for (i = 0; i < MAX_CHAT_MESSAGES; i++) {

    72

		if (_chatmsg_list[i].message[0] == '\0') break;

    73

	}

    74

    75

	return i;

    76

}

    77

    78

/* Add a text message to the 'chat window' to be shown

    79

 * @param color The colour this message is to be shown in

    80

 * @param duration The duration of the chat message in game-days

    81

 * @param message message itself in printf() style */

    82

void CDECL AddChatMessage(uint16 color, uint8 duration, const char *message, ...)

    83

{

    84

	char buf[MAX_TEXTMESSAGE_LENGTH];

    85

	const char *bufp;

    86

	va_list va;

    87

	uint msg_count;

    88

	uint16 lines;

    89

    90

	va_start(va, message);

    91

	vsnprintf(buf, lengthof(buf), message, va);

    92

	va_end(va);

    93

    94

    95

	Utf8TrimString(buf, MAX_TEXTMESSAGE_LENGTH);

    96

    97

	/* Force linebreaks for strings that are too long */

    98

	lines = GB(FormatStringLinebreaks(buf, _chatmsg_box.width - 8), 0, 16) + 1;

    99

	if (lines >= MAX_CHAT_MESSAGES) return;

   100

   101

	msg_count = GetChatMessageCount();

   102

	/* We want to add more chat messages than there is free space for, remove 'old' */

   103

	if (lines > MAX_CHAT_MESSAGES - msg_count) {

   104

		int i = lines - (MAX_CHAT_MESSAGES - msg_count);

   105

		memmove(&_chatmsg_list[0], &_chatmsg_list[i], sizeof(_chatmsg_list[0]) * (msg_count - i));

   106

		msg_count = MAX_CHAT_MESSAGES - lines;

   107

	}

   108

   109

	for (bufp = buf; lines != 0; lines--) {

   110

		ChatMessage *cmsg = &_chatmsg_list[msg_count++];

   111

		ttd_strlcpy(cmsg->message, bufp, sizeof(cmsg->message));

   112

   113

		/* The default colour for a message is player colour. Replace this with

   114

		 * white for any additional lines */

   115

		cmsg->color = (bufp == buf && color & IS_PALETTE_COLOR) ? color : (0x1D - 15) | IS_PALETTE_COLOR;

   116

		cmsg->end_date = _date + duration;

   117

   118

		bufp += strlen(bufp) + 1; // jump to 'next line' in the formatted string

   119

	}

   120

   121

	_chatmessage_dirty = true;

   122

}

   123

   124

void InitChatMessage()

   125

{

   126

	uint i;

   127

   128

	for (i = 0; i < MAX_CHAT_MESSAGES; i++) {

   129

		_chatmsg_list[i].message[0] = '\0';

   130

	}

   131

}

   132

   133

/** Hide the chatbox */

   134

void UndrawChatMessage()

   135

{

   136

	if (_chatmessage_visible) {

   137

		Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   138

		/* Sometimes we also need to hide the cursor

   139

		 *   This is because both textmessage and the cursor take a shot of the

   140

		 *   screen before drawing.

   141

		 *   Now the textmessage takes his shot and paints his data before the cursor

   142

		 *   does, so in the shot of the cursor is the screen-data of the textmessage

   143

		 *   included when the cursor hangs somewhere over the textmessage. To

   144

		 *   avoid wrong repaints, we undraw the cursor in that case, and everything

   145

		 *   looks nicely ;)

   146

		 * (and now hope this story above makes sense to you ;))

   147

		 */

   148

   149

		if (_cursor.visible) {

   150

			if (_cursor.draw_pos.x + _cursor.draw_size.x >= _chatmsg_box.x &&

   151

				_cursor.draw_pos.x <= _chatmsg_box.x + _chatmsg_box.width &&

   152

				_cursor.draw_pos.y + _cursor.draw_size.y >= _screen.height - _chatmsg_box.y - _chatmsg_box.height &&

   153

				_cursor.draw_pos.y <= _screen.height - _chatmsg_box.y) {

   154

				UndrawMouseCursor();

   155

			}

   156

		}

   157

   158

		int x      = _chatmsg_box.x;

   159

		int y      = _screen.height - _chatmsg_box.y - _chatmsg_box.height;

   160

		int width  = _chatmsg_box.width;

   161

		int height = _chatmsg_box.height;

   162

		if (y < 0) {

   163

			height = max(height + y, min(_chatmsg_box.height, _screen.height));

   164

			y = 0;

   165

		}

   166

		if (x + width >= _screen.width) {

   167

			width = _screen.width - x;

   168

		}

   169

		if (width <= 0 || height <= 0) return;

   170

   171

		_chatmessage_visible = false;

   172

		/* Put our 'shot' back to the screen */

   173

		blitter->CopyFromBuffer(blitter->MoveTo(_screen.dst_ptr, x, y), _chatmessage_backup, width, height);

   174

		/* And make sure it is updated next time */

   175

		_video_driver->MakeDirty(x, y, width, height);

   176

   177

		_chatmessage_dirty = true;

   178

	}

   179

}

   180

   181

/** Check if a message is expired every day */

   182

void ChatMessageDailyLoop()

   183

{

   184

	uint i;

   185

   186

	for (i = 0; i < MAX_CHAT_MESSAGES; i++) {

   187

		ChatMessage *cmsg = &_chatmsg_list[i];

   188

		if (cmsg->message[0] == '\0') continue;

   189

   190

		/* Message has expired, remove from the list */

   191

		if (cmsg->end_date < _date) {

   192

			/* Move the remaining messages over the current message */

   193

			if (i != MAX_CHAT_MESSAGES - 1) memmove(cmsg, cmsg + 1, sizeof(*cmsg) * (MAX_CHAT_MESSAGES - i - 1));

   194

   195

			/* Mark the last item as empty */

   196

			_chatmsg_list[MAX_CHAT_MESSAGES - 1].message[0] = '\0';

   197

			_chatmessage_dirty = true;

   198

   199

			/* Go one item back, because we moved the array 1 to the left */

   200

			i--;

   201

		}

   202

	}

   203

}

   204

   205

/** Draw the chat message-box */

   206

void DrawChatMessage()

   207

{

   208

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   209

	if (!_chatmessage_dirty) return;

   210

   211

	/* First undraw if needed */

   212

	UndrawChatMessage();

   213

   214

	if (_iconsole_mode == ICONSOLE_FULL) return;

   215

   216

	/* Check if we have anything to draw at all */

   217

	uint count = GetChatMessageCount();

   218

	if (count == 0) return;

   219

   220

	int x      = _chatmsg_box.x;

   221

	int y      = _screen.height - _chatmsg_box.y - _chatmsg_box.height;

   222

	int width  = _chatmsg_box.width;

   223

	int height = _chatmsg_box.height;

   224

	if (y < 0) {

   225

		height = max(height + y, min(_chatmsg_box.height, _screen.height));

   226

		y = 0;

   227

	}

   228

	if (x + width >= _screen.width) {

   229

		width = _screen.width - x;

   230

	}

   231

	if (width <= 0 || height <= 0) return;

   232

   233

	assert(blitter->BufferSize(width, height) < (int)sizeof(_chatmessage_backup));

   234

   235

	/* Make a copy of the screen as it is before painting (for undraw) */

   236

	blitter->CopyToBuffer(blitter->MoveTo(_screen.dst_ptr, x, y), _chatmessage_backup, width, height);

   237

   238

	_cur_dpi = &_screen; // switch to _screen painting

   239

   240

	/* Paint a half-transparent box behind the chat messages */

   241

	GfxFillRect(

   242

			_chatmsg_box.x,

   243

			_screen.height - _chatmsg_box.y - count * 13 - 2,

   244

			_chatmsg_box.x + _chatmsg_box.width - 1,

   245

			_screen.height - _chatmsg_box.y - 2,

   246

			PALETTE_TO_TRANSPARENT | (1 << USE_COLORTABLE) // black, but with some alpha for background

   247

		);

   248

   249

	/* Paint the chat messages starting with the lowest at the bottom */

   250

	for (uint y = 13; count-- != 0; y += 13) {

   251

		DoDrawString(_chatmsg_list[count].message, _chatmsg_box.x + 3, _screen.height - _chatmsg_box.y - y + 1, _chatmsg_list[count].color);

   252

	}

   253

   254

	/* Make sure the data is updated next flush */

   255

	_video_driver->MakeDirty(x, y, width, height);

   256

   257

	_chatmessage_visible = true;

   258

	_chatmessage_dirty = false;

   259

}

   260

   261

/* Text Effects */

   262

/**

   263

 * Mark the area of the text effect as dirty.

   264

 *

   265

 * This function marks the area of a text effect as dirty for repaint.

   266

 *

   267

 * @param te The TextEffect to mark the area dirty

   268

 * @ingroup dirty

   269

 */

   270

static void MarkTextEffectAreaDirty(TextEffect *te)

   271

{

   272

	/* Width and height of the text effect are doubled, so they are correct in both zoom out levels 1x and 2x. */

   273

	MarkAllViewportsDirty(

   274

		te->x,

   275

		te->y - 1,

   276

		(te->right - te->x)*2 + te->x + 1,

   277

		(te->bottom - (te->y - 1)) * 2 + (te->y - 1) + 1

   278

	);

   279

}

   280

   281

TextEffectID AddTextEffect(StringID msg, int x, int y, uint16 duration, TextEffectMode mode)

   282

{

   283

	TextEffect *te;

   284

	int w;

   285

	char buffer[100];

   286

	TextEffectID i;

   287

   288

	if (_game_mode == GM_MENU) return INVALID_TE_ID;

   289

   290

	/* Look for a free spot in the text effect array */

   291

	for (i = 0; i < _num_text_effects; i++) {

   292

		if (_text_effect_list[i].string_id == INVALID_STRING_ID) break;

   293

	}

   294

   295

	/* If there is none found, we grow the array */

   296

	if (i == _num_text_effects) {

   297

		_num_text_effects += 25;

   298

		_text_effect_list = ReallocT<TextEffect>(_text_effect_list, _num_text_effects);

   299

		for (; i < _num_text_effects; i++) _text_effect_list[i].string_id = INVALID_STRING_ID;

   300

		i = _num_text_effects - 1;

   301

	}

   302

   303

	te = &_text_effect_list[i];

   304

   305

	/* Start defining this object */

   306

	te->string_id = msg;

   307

	te->duration = duration;

   308

	te->y = y - 5;

   309

	te->bottom = y + 5;

   310

	te->params_1 = GetDParam(0);

   311

	te->params_2 = GetDParam(4);

   312

	te->mode = mode;

   313

   314

	GetString(buffer, msg, lastof(buffer));

   315

	w = GetStringBoundingBox(buffer).width;

   316

   317

	te->x = x - (w >> 1);

   318

	te->right = x + (w >> 1) - 1;

   319

	MarkTextEffectAreaDirty(te);

   320

   321

	return i;

   322

}

   323

   324

void UpdateTextEffect(TextEffectID te_id, StringID msg)

   325

{

   326

	assert(te_id < _num_text_effects);

   327

	TextEffect *te;

   328

   329

	/* Update details */

   330

	te = &_text_effect_list[te_id];

   331

	te->string_id = msg;

   332

	te->params_1 = GetDParam(0);

   333

	te->params_2 = GetDParam(4);

   334

   335

	/* Update width of text effect */

   336

	char buffer[100];

   337

	GetString(buffer, msg, lastof(buffer));

   338

	int w = GetStringBoundingBox(buffer).width;

   339

   340

	/* Only allow to make it broader, so it completely covers the old text. That avoids remnants of the old text. */

   341

	int right_new = te->x + w;

   342

	if (te->right < right_new) te->right = right_new;

   343

   344

	MarkTextEffectAreaDirty(te);

   345

}

   346

   347

void RemoveTextEffect(TextEffectID te_id)

   348

{

   349

	assert(te_id < _num_text_effects);

   350

	TextEffect *te;

   351

   352

	te = &_text_effect_list[te_id];

   353

	MarkTextEffectAreaDirty(te);

   354

	te->string_id = INVALID_STRING_ID;

   355

}

   356

   357

static void MoveTextEffect(TextEffect *te)

   358

{

   359

	/* Never expire for duration of 0xFFFF */

   360

	if (te->duration == 0xFFFF) return;

   361

	if (te->duration < 8) {

   362

		te->string_id = INVALID_STRING_ID;

   363

	} else {

   364

		te->duration -= 8;

   365

		te->y--;

   366

		te->bottom--;

   367

	}

   368

	MarkTextEffectAreaDirty(te);

   369

}

   370

   371

void MoveAllTextEffects()

   372

{

   373

	for (TextEffectID i = 0; i < _num_text_effects; i++) {

   374

		TextEffect *te = &_text_effect_list[i];

   375

		if (te->string_id != INVALID_STRING_ID && te->mode == TE_RISING) MoveTextEffect(te);

   376

	}

   377

}

   378

   379

void InitTextEffects()

   380

{

   381

	if (_text_effect_list == NULL) _text_effect_list = MallocT<TextEffect>(_num_text_effects);

   382

   383

	for (TextEffectID i = 0; i < _num_text_effects; i++) _text_effect_list[i].string_id = INVALID_STRING_ID;

   384

}

   385

   386

void DrawTextEffects(DrawPixelInfo *dpi)

   387

{

   388

	switch (dpi->zoom) {

   389

		case ZOOM_LVL_NORMAL:

   390

			for (TextEffectID i = 0; i < _num_text_effects; i++) {

   391

				TextEffect *te = &_text_effect_list[i];

   392

				if (te->string_id != INVALID_STRING_ID &&

   393

						dpi->left <= te->right &&

   394

						dpi->top  <= te->bottom &&

   395

						dpi->left + dpi->width  > te->x &&

   396

						dpi->top  + dpi->height > te->y) {

   397

					if (te->mode == TE_RISING || (_patches.loading_indicators && !IsTransparencySet(TO_LOADING))) {

   398

						AddStringToDraw(te->x, te->y, te->string_id, te->params_1, te->params_2);

   399

					}

   400

				}

   401

			}

   402

			break;

   403

   404

		case ZOOM_LVL_OUT_2X:

   405

			for (TextEffectID i = 0; i < _num_text_effects; i++) {

   406

				TextEffect *te = &_text_effect_list[i];

   407

				if (te->string_id != INVALID_STRING_ID &&

   408

						dpi->left <= te->right  * 2 - te->x &&

   409

						dpi->top  <= te->bottom * 2 - te->y &&

   410

						dpi->left + dpi->width  > te->x &&

   411

						dpi->top  + dpi->height > te->y) {

   412

					if (te->mode == TE_RISING || (_patches.loading_indicators && !IsTransparencySet(TO_LOADING))) {

   413

						AddStringToDraw(te->x, te->y, (StringID)(te->string_id - 1), te->params_1, te->params_2);

   414

					}

   415

				}

   416

			}

   417

			break;

   418

   419

		case ZOOM_LVL_OUT_4X:

   420

		case ZOOM_LVL_OUT_8X:

   421

			break;

   422

   423

		default: NOT_REACHED();

   424

	}

   425

}

   426

   427

/** The table/list with animated tiles. */

   428

TileIndex *_animated_tile_list = NULL;

   429

/** The number of animated tiles in the current state. */

   430

uint _animated_tile_count = 0;

   431

/** The number of slots for animated tiles allocated currently. */

   432

static uint _animated_tile_allocated = 0;

   433

   434

/**

   435

 * Removes the given tile from the animated tile table.

   436

 * @param tile the tile to remove

   437

 */

   438

void DeleteAnimatedTile(TileIndex tile)

   439

{

   440

	for (TileIndex *ti = _animated_tile_list; ti < _animated_tile_list + _animated_tile_count; ti++) {

   441

		if (tile == *ti) {

   442

			/* Remove the hole

   443

			 * The order of the remaining elements must stay the same, otherwise the animation loop

   444

			 * may miss a tile; that's why we must use memmove instead of just moving the last element.

   445

			 */

   446

			memmove(ti, ti + 1, (_animated_tile_list + _animated_tile_count - (ti + 1)) * sizeof(*ti));

   447

			_animated_tile_count--;

   448

			MarkTileDirtyByTile(tile);

   449

			return;

   450

		}

   451

	}

   452

}

   453

   454

/**

   455

 * Add the given tile to the animated tile table (if it does not exist

   456

 * on that table yet). Also increases the size of the table if necessary.

   457

 * @param tile the tile to make animated

   458

 */

   459

void AddAnimatedTile(TileIndex tile)

   460

{

   461

	MarkTileDirtyByTile(tile);

   462

   463

	for (const TileIndex *ti = _animated_tile_list; ti < _animated_tile_list + _animated_tile_count; ti++) {

   464

		if (tile == *ti) return;

   465

	}

   466

   467

	/* Table not large enough, so make it larger */

   468

	if (_animated_tile_count == _animated_tile_allocated) {

   469

		_animated_tile_allocated *= 2;

   470

		_animated_tile_list = ReallocT<TileIndex>(_animated_tile_list, _animated_tile_allocated);

   471

	}

   472

   473

	_animated_tile_list[_animated_tile_count] = tile;

   474

	_animated_tile_count++;

   475

}

   476

   477

/**

   478

 * Animate all tiles in the animated tile list, i.e.\ call AnimateTile on them.

   479

 */

   480

void AnimateAnimatedTiles()

   481

{

   482

	const TileIndex *ti = _animated_tile_list;

   483

	while (ti < _animated_tile_list + _animated_tile_count) {

   484

		const TileIndex curr = *ti;

   485

		AnimateTile(curr);