1

/* $Id$ */

     2

     3

/** @file texteff.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "macros.h"

     9

#include "strings.h"

    10

#include "gfx.h"

    11

#include "landscape.h"

    12

#include "viewport.h"

    13

#include "saveload.h"

    14

#include "hal.h"

    15

#include "console.h"

    16

#include "string.h"

    17

#include "variables.h"

    18

#include "table/sprites.h"

    20

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

    21

#include "date.h"

    22

    23

enum {

    24

	MAX_TEXTMESSAGE_LENGTH = 200,

    25

	MAX_TEXT_MESSAGES      =  30,

    26

	MAX_CHAT_MESSAGES      =  10,

    27

	MAX_ANIMATED_TILES     = 256,

    28

};

    29

    30

struct TextEffect {

    31

	StringID string_id;

    32

	int32 x;

    33

	int32 y;

    34

	int32 right;

    35

	int32 bottom;

    36

	uint16 duration;

    37

	uint32 params_1;

    38

	uint32 params_2;

    39

};

    40

    41

    42

struct TextMessage {

    43

	char message[MAX_TEXTMESSAGE_LENGTH];

    44

	uint16 color;

    45

	Date end_date;

    46

};

    47

    48

static TextEffect _text_effect_list[MAX_TEXT_MESSAGES];

    49

static TextMessage _textmsg_list[MAX_CHAT_MESSAGES];

    50

TileIndex _animated_tile_list[MAX_ANIMATED_TILES];

    51

    52

static bool _textmessage_dirty = false;

    53

static bool _textmessage_visible = false;

    54

    55

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

    56

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

    57

static const Oblong _textmsg_box = {10, 30, 500, 150};

    59

    60

static inline uint GetTextMessageCount()

    61

{

    62

	uint i;

    63

    64

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

    65

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

    66

	}

    67

    68

	return i;

    69

}

    70

    71

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

    72

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

    73

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

    74

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

    75

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

    76

{

    77

	char buf[MAX_TEXTMESSAGE_LENGTH];

    78

	const char *bufp;

    79

	va_list va;

    80

	uint msg_count;

    81

	uint16 lines;

    82

    83

	va_start(va, message);

    84

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

    85

	va_end(va);

    86

    87

    88

	Utf8TrimString(buf, MAX_TEXTMESSAGE_LENGTH);

    89

    90

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

    91

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

    92

	if (lines >= MAX_CHAT_MESSAGES) return;

    93

    94

	msg_count = GetTextMessageCount();

    95

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

    96

	if (lines > MAX_CHAT_MESSAGES - msg_count) {

    97

		int i = lines - (MAX_CHAT_MESSAGES - msg_count);

    98

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

    99

		msg_count = MAX_CHAT_MESSAGES - lines;

   100

	}

   101

   102

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

   103

		TextMessage *tmsg = &_textmsg_list[msg_count++];

   104

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

   105

   106

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

   107

		 * white for any additional lines */

   108

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

   109

		tmsg->end_date = _date + duration;

   110

   111

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

   112

	}

   113

   114

	_textmessage_dirty = true;

   115

}

   116

   117

void InitTextMessage()

   118

{

   119

	uint i;

   120

   121

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

   122

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

   123

	}

   124

}

   125

   126

/** Hide the textbox */

   127

void UndrawTextMessage()

   128

{

   129

	if (_textmessage_visible) {

   131

		/* Sometimes we also need to hide the cursor

   132

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

   133

		 *   screen before drawing.

   134

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

   135

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

   136

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

   137

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

   138

		 *   looks nicely ;)

   139

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

   140

		 */

   141

   142

		if (_cursor.visible) {

   143

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

   144

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

   145

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

   146

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

   147

				UndrawMouseCursor();

   148

			}

   149

		}

   150

   151

		int x      = _textmsg_box.x;

   152

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

   153

		int width  = _textmsg_box.width;

   154

		int height = _textmsg_box.height;

   155

		if (y < 0) {

   156

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

   157

			y = 0;

   158

		}

   159

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

   160

			width = _screen.width - x;

   161

		}

   162

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

   163

   164

		_textmessage_visible = false;

   165

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

   167

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

   168

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

   169

   170

		_textmessage_dirty = true;

   171

	}

   172

}

   173

   174

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

   175

void TextMessageDailyLoop()

   176

{

   177

	uint i;

   178

   179

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

   180

		TextMessage *tmsg = &_textmsg_list[i];

   181

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

   182

   183

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

   184

		if (tmsg->end_date < _date) {

   185

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

   186

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

   187

   188

			/* Mark the last item as empty */

   189

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

   190

			_textmessage_dirty = true;

   191

   192

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

   193

			i--;

   194

		}

   195

	}

   196

}

   197

   198

/** Draw the textmessage-box */

   199

void DrawTextMessage()

   200

{

   202

	if (!_textmessage_dirty) return;

   203

   204

	/* First undraw if needed */

   205

	UndrawTextMessage();

   206

   207

	if (_iconsole_mode == ICONSOLE_FULL) return;

   208

   209

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

   210

	uint count = GetTextMessageCount();

   211

	if (count == 0) return;

   212

   213

	int x      = _textmsg_box.x;

   214

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

   215

	int width  = _textmsg_box.width;

   216

	int height = _textmsg_box.height;

   217

	if (y < 0) {

   218

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

   219

		y = 0;

   220

	}

   221

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

   222

		width = _screen.width - x;

   223

	}

   224

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

   225

   226

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

   228

   229

	_cur_dpi = &_screen; // switch to _screen painting

   230

   231

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

   232

	GfxFillRect(

   233

			_textmsg_box.x,

   234

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

   235

			_textmsg_box.x + _textmsg_box.width - 1,

   236

			_screen.height - _textmsg_box.y - 2,

   237

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

   238

		);

   239

   240

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

   241

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

   242

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

   243

	}

   244

   245

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

   246

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

   247

   248

	_textmessage_visible = true;

   249

	_textmessage_dirty = false;

   250

}

   251

   252

static void MarkTextEffectAreaDirty(TextEffect *te)

   253

{

   254

	MarkAllViewportsDirty(

   255

		te->x,

   256

		te->y - 1,

   257

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

   258

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

   259

	);

   260

}

   261

   262

void AddTextEffect(StringID msg, int x, int y, uint16 duration)

   263

{

   264

	TextEffect *te;

   265

	int w;

   266

	char buffer[100];

   267

   268

	if (_game_mode == GM_MENU) return;

   269

   270

	for (te = _text_effect_list; te->string_id != INVALID_STRING_ID; ) {

   271

		if (++te == endof(_text_effect_list)) return;

   272

	}

   273

   274

	te->string_id = msg;

   275

	te->duration = duration;

   276

	te->y = y - 5;

   277

	te->bottom = y + 5;

   278

	te->params_1 = GetDParam(0);

   279

	te->params_2 = GetDParam(4);

   280

   281

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

   282

	w = GetStringBoundingBox(buffer).width;

   283

   284

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

   285

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

   286

	MarkTextEffectAreaDirty(te);

   287

}

   288

   289

static void MoveTextEffect(TextEffect *te)

   290

{

   291

	if (te->duration < 8) {

   292

		te->string_id = INVALID_STRING_ID;

   293

	} else {

   294

		te->duration -= 8;

   295

		te->y--;

   296

		te->bottom--;

   297

	}

   298

	MarkTextEffectAreaDirty(te);

   299

}

   300

   301

void MoveAllTextEffects()

   302

{

   303

	TextEffect *te;

   304

   305

	for (te = _text_effect_list; te != endof(_text_effect_list); te++) {

   306

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

   307

	}

   308

}

   309

   310

void InitTextEffects()

   311

{

   312

	TextEffect *te;

   313

   314

	for (te = _text_effect_list; te != endof(_text_effect_list); te++) {

   315

		te->string_id = INVALID_STRING_ID;

   316

	}

   317

}

   318

   319

void DrawTextEffects(DrawPixelInfo *dpi)

   320

{

   321

	const TextEffect* te;

   322

   323

	switch (dpi->zoom) {

   324

		case ZOOM_LVL_NORMAL:

   325

			for (te = _text_effect_list; te != endof(_text_effect_list); te++) {

   326

				if (te->string_id != INVALID_STRING_ID &&

   327

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

   328

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

   329

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

   330

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

   331

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

   332

				}

   333

			}

   334

			break;

   335

   336

		case ZOOM_LVL_OUT_2X:

   337

			for (te = _text_effect_list; te != endof(_text_effect_list); te++) {

   338

				if (te->string_id != INVALID_STRING_ID &&

   339

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

   340

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

   341

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

   342

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

   343

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

   344

				}

   345

			}

   346

			break;

   347

   348

		case ZOOM_LVL_OUT_4X:

   349

		case ZOOM_LVL_OUT_8X:

   350

			break;

   351

   352

		default: NOT_REACHED();

   353

	}

   354

}

   355

   356

void DeleteAnimatedTile(TileIndex tile)

   357

{

   358

	TileIndex *ti;

   359

   360

	for (ti = _animated_tile_list; ti != endof(_animated_tile_list); ti++) {

   361

		if (tile == *ti) {

   362

			/* remove the hole */

   363

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

   364

			/* and clear last item */

   365

			*lastof(_animated_tile_list) = 0;

   366

			MarkTileDirtyByTile(tile);

   367

			return;

   368

		}

   369

	}

   370

}

   371

   372

bool AddAnimatedTile(TileIndex tile)

   373

{

   374

	TileIndex *ti;

   375

   376

	for (ti = _animated_tile_list; ti != endof(_animated_tile_list); ti++) {

   377

		if (tile == *ti || *ti == 0) {

   378

			*ti = tile;

   379

			MarkTileDirtyByTile(tile);

   380

			return true;

   381

		}

   382

	}

   383

   384

	return false;

   385

}

   386

   387

void AnimateAnimatedTiles()

   388

{

   389

	const TileIndex* ti;

   390

   391

	for (ti = _animated_tile_list; ti != endof(_animated_tile_list) && *ti != 0; ti++) {

   392

		AnimateTile(*ti);

   393

	}

   394

}

   395

   396

void InitializeAnimatedTiles()

   397

{

   398

	memset(_animated_tile_list, 0, sizeof(_animated_tile_list));

   399

}

   400

   401

static void SaveLoad_ANIT()

   402

{

   403

	/* In pre version 6, we has 16bit per tile, now we have 32bit per tile, convert it ;) */

   404

	if (CheckSavegameVersion(6)) {

   405

		SlArray(_animated_tile_list, lengthof(_animated_tile_list), SLE_FILE_U16 | SLE_VAR_U32);

   406

	} else {

   407

		SlArray(_animated_tile_list, lengthof(_animated_tile_list), SLE_UINT32);

   408

	}

   409

}

   410

   411

   412

extern const ChunkHandler _animated_tile_chunk_handlers[] = {

   413

	{ 'ANIT', SaveLoad_ANIT, SaveLoad_ANIT, CH_RIFF | CH_LAST},

   414

};