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"

    19

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

    20

#include "date.h"

    21

    22

enum {

    23

	MAX_TEXTMESSAGE_LENGTH = 200,

    24

	MAX_TEXT_MESSAGES      =  30,

    25

	MAX_CHAT_MESSAGES      =  10,

    26

	MAX_ANIMATED_TILES     = 256,

    27

};

    28

    29

struct TextEffect {

    30

	StringID string_id;

    31

	int32 x;

    32

	int32 y;

    33

	int32 right;

    34

	int32 bottom;

    35

	uint16 duration;

    36

	uint32 params_1;

    37

	uint32 params_2;

    38

};

    39

    40

    41

struct TextMessage {

    42

	char message[MAX_TEXTMESSAGE_LENGTH];

    43

	uint16 color;

    44

	Date end_date;

    45

};

    46

    47

static TextEffect _text_effect_list[MAX_TEXT_MESSAGES];

    48

static TextMessage _textmsg_list[MAX_CHAT_MESSAGES];

    49

TileIndex _animated_tile_list[MAX_ANIMATED_TILES];

    50

    51

static bool _textmessage_dirty = false;

    52

static bool _textmessage_visible = false;

    53

    54

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

    55

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

    56

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

    57

static Pixel _textmessage_backup[150 * 500]; // (height * width)

    58

    59

extern void memcpy_pitch(void *dst, void *src, int w, int h, int srcpitch, int dstpitch);

    60

    61

static inline uint GetTextMessageCount()

    62

{

    63

	uint i;

    64

    65

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

    66

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

    67

	}

    68

    69

	return i;

    70

}

    71

    72

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

    73

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

    74

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

    75

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

    76

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

    77

{

    78

	char buf[MAX_TEXTMESSAGE_LENGTH];

    79

	const char *bufp;

    80

	va_list va;

    81

	uint msg_count;

    82

	uint16 lines;

    83

    84

	va_start(va, message);

    85

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

    86

	va_end(va);

    87

    88

    89

	Utf8TrimString(buf, MAX_TEXTMESSAGE_LENGTH);

    90

    91

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

    92

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

    93

	if (lines >= MAX_CHAT_MESSAGES) return;

    94

    95

	msg_count = GetTextMessageCount();

    96

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

    97

	if (lines > MAX_CHAT_MESSAGES - msg_count) {

    98

		int i = lines - (MAX_CHAT_MESSAGES - msg_count);

    99

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

   100

		msg_count = MAX_CHAT_MESSAGES - lines;

   101

	}

   102

   103

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

   104

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

   105

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

   106

   107

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

   108

		 * white for any additional lines */

   109

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

   110

		tmsg->end_date = _date + duration;

   111

   112

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

   113

	}

   114

   115

	_textmessage_dirty = true;

   116

}

   117

   118

void InitTextMessage()

   119

{

   120

	uint i;

   121

   122

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

   123

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

   124

	}

   125

}

   126

   127

/** Hide the textbox */

   128

void UndrawTextMessage()

   129

{

   130

	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 */

   166

		memcpy_pitch(

   167

			_screen.dst_ptr + x + y * _screen.pitch,

   168

			_textmessage_backup,

   169

			width, height, _textmsg_box.width, _screen.pitch);

   170

   171

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

   172

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

   173

   174

		_textmessage_dirty = true;

   175

	}

   176

}

   177

   178

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

   179

void TextMessageDailyLoop()

   180

{

   181

	uint i;

   182

   183

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

   184

		TextMessage *tmsg = &_textmsg_list[i];

   185

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

   186

   187

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

   188

		if (tmsg->end_date < _date) {

   189

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

   190

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

   191

   192

			/* Mark the last item as empty */

   193

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

   194

			_textmessage_dirty = true;

   195

   196

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

   197

			i--;

   198

		}

   199

	}

   200

}

   201

   202

/** Draw the textmessage-box */

   203

void DrawTextMessage()

   204

{

   205

	if (!_textmessage_dirty) return;

   206

   207

	/* First undraw if needed */

   208

	UndrawTextMessage();

   209

   210

	if (_iconsole_mode == ICONSOLE_FULL) return;

   211

   212

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

   213

	uint count = GetTextMessageCount();

   214

	if (count == 0) return;

   215

   216

	int x      = _textmsg_box.x;

   217

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

   218

	int width  = _textmsg_box.width;

   219

	int height = _textmsg_box.height;

   220

	if (y < 0) {

   221

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

   222

		y = 0;

   223

	}

   224

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

   225

		width = _screen.width - x;

   226

	}

   227

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

   228

   229

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

   230

	memcpy_pitch(

   231

		_textmessage_backup,

   232

		_screen.dst_ptr + x + y * _screen.pitch,

   233

		width, height, _screen.pitch, _textmsg_box.width);

   234

   235

	_cur_dpi = &_screen; // switch to _screen painting

   236

   237

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

   238

	GfxFillRect(

   239

			_textmsg_box.x,

   240

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

   241

			_textmsg_box.x + _textmsg_box.width - 1,

   242

			_screen.height - _textmsg_box.y - 2,

   243

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

   244

		);

   245

   246

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

   247

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

   248

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

   249

	}

   250

   251

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

   252

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

   253

   254

	_textmessage_visible = true;

   255

	_textmessage_dirty = false;

   256

}

   257

   258

static void MarkTextEffectAreaDirty(TextEffect *te)

   259

{

   260

	MarkAllViewportsDirty(

   261

		te->x,

   262

		te->y - 1,

   263

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

   264

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

   265

	);

   266

}

   267

   268

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

   269

{

   270

	TextEffect *te;

   271

	int w;

   272

	char buffer[100];

   273

   274

	if (_game_mode == GM_MENU) return;

   275

   276

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

   277

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

   278

	}

   279

   280

	te->string_id = msg;

   281

	te->duration = duration;

   282

	te->y = y - 5;

   283

	te->bottom = y + 5;

   284

	te->params_1 = GetDParam(0);

   285

	te->params_2 = GetDParam(4);

   286

   287

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

   288

	w = GetStringBoundingBox(buffer).width;

   289

   290

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

   291

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

   292

	MarkTextEffectAreaDirty(te);

   293

}

   294

   295

static void MoveTextEffect(TextEffect *te)

   296

{

   297

	if (te->duration < 8) {

   298

		te->string_id = INVALID_STRING_ID;

   299

	} else {

   300

		te->duration -= 8;

   301

		te->y--;

   302

		te->bottom--;

   303

	}

   304

	MarkTextEffectAreaDirty(te);

   305

}

   306

   307

void MoveAllTextEffects()

   308

{

   309

	TextEffect *te;

   310

   311

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

   312

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

   313

	}

   314

}

   315

   316

void InitTextEffects()

   317

{

   318

	TextEffect *te;

   319

   320

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

   321

		te->string_id = INVALID_STRING_ID;

   322

	}

   323

}

   324

   325

void DrawTextEffects(DrawPixelInfo *dpi)

   326

{

   327

	const TextEffect* te;

   328

   329

	switch (dpi->zoom) {

   330

		case 0:

   331

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

   332

				if (te->string_id != INVALID_STRING_ID &&

   333

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

   334

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

   335

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

   336

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

   337

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

   338

				}

   339

			}

   340

			break;

   341

   342

		case 1:

   343

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

   344

				if (te->string_id != INVALID_STRING_ID &&

   345

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

   346

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

   347

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

   348

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

   349

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

   350

				}

   351

			}

   352

			break;

   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

};