OpenTTD
error_gui.cpp
Go to the documentation of this file.
1 /* $Id$ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "stdafx.h"
13 #include "landscape.h"
14 #include "newgrf_text.h"
15 #include "error.h"
16 #include "viewport_func.h"
17 #include "gfx_func.h"
18 #include "string_func.h"
19 #include "company_base.h"
20 #include "company_manager_face.h"
21 #include "strings_func.h"
22 #include "zoom_func.h"
23 #include "window_func.h"
24 #include "console_func.h"
25 #include "window_gui.h"
26 
27 #include "widgets/error_widget.h"
28 
29 #include "table/strings.h"
30 #include <list>
31 
32 #include "safeguards.h"
33 
34 static const NWidgetPart _nested_errmsg_widgets[] = {
36  NWidget(WWT_CLOSEBOX, COLOUR_RED),
37  NWidget(WWT_CAPTION, COLOUR_RED, WID_EM_CAPTION), SetDataTip(STR_ERROR_MESSAGE_CAPTION, STR_NULL),
38  EndContainer(),
39  NWidget(WWT_PANEL, COLOUR_RED),
40  NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_MESSAGE), SetPadding(0, 2, 0, 2), SetMinimalSize(236, 32),
41  EndContainer(),
42 };
43 
44 static WindowDesc _errmsg_desc(
45  WDP_MANUAL, "error", 0, 0,
47  0,
48  _nested_errmsg_widgets, lengthof(_nested_errmsg_widgets)
49 );
50 
51 static const NWidgetPart _nested_errmsg_face_widgets[] = {
53  NWidget(WWT_CLOSEBOX, COLOUR_RED),
54  NWidget(WWT_CAPTION, COLOUR_RED, WID_EM_CAPTION), SetDataTip(STR_ERROR_MESSAGE_CAPTION_OTHER_COMPANY, STR_NULL),
55  EndContainer(),
56  NWidget(WWT_PANEL, COLOUR_RED),
57  NWidget(NWID_HORIZONTAL), SetPIP(2, 1, 2),
58  NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_FACE), SetMinimalSize(92, 119), SetFill(0, 1), SetPadding(2, 0, 1, 0),
59  NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_MESSAGE), SetFill(0, 1), SetMinimalSize(238, 123),
60  EndContainer(),
61  EndContainer(),
62 };
63 
64 static WindowDesc _errmsg_face_desc(
65  WDP_MANUAL, "error_face", 0, 0,
67  0,
68  _nested_errmsg_face_widgets, lengthof(_nested_errmsg_face_widgets)
69 );
70 
76  duration(data.duration), textref_stack_grffile(data.textref_stack_grffile), textref_stack_size(data.textref_stack_size),
77  summary_msg(data.summary_msg), detailed_msg(data.detailed_msg), position(data.position), face(data.face)
78 {
79  memcpy(this->textref_stack, data.textref_stack, sizeof(this->textref_stack));
80  memcpy(this->decode_params, data.decode_params, sizeof(this->decode_params));
81  memcpy(this->strings, data.strings, sizeof(this->strings));
82  for (size_t i = 0; i < lengthof(this->strings); i++) {
83  if (this->strings[i] != nullptr) {
84  this->strings[i] = stredup(this->strings[i]);
85  this->decode_params[i] = (size_t)this->strings[i];
86  }
87  }
88 }
89 
92 {
93  for (size_t i = 0; i < lengthof(this->strings); i++) free(this->strings[i]);
94 }
95 
108  duration(duration),
109  textref_stack_grffile(textref_stack_grffile),
110  textref_stack_size(textref_stack_size),
111  summary_msg(summary_msg),
112  detailed_msg(detailed_msg),
114 {
115  this->position.x = x;
116  this->position.y = y;
117 
118  memset(this->decode_params, 0, sizeof(this->decode_params));
119  memset(this->strings, 0, sizeof(this->strings));
120 
121  if (textref_stack_size > 0) MemCpyT(this->textref_stack, textref_stack, textref_stack_size);
122 
123  assert(summary_msg != INVALID_STRING_ID);
124 }
125 
130 {
131  /* Reset parameters */
132  for (size_t i = 0; i < lengthof(this->strings); i++) free(this->strings[i]);
133  memset(this->decode_params, 0, sizeof(this->decode_params));
134  memset(this->strings, 0, sizeof(this->strings));
135 
136  /* Get parameters using type information */
139  if (this->textref_stack_size > 0) StopTextRefStackUsage();
140 
141  if (this->detailed_msg == STR_ERROR_OWNED_BY) {
142  CompanyID company = (CompanyID)GetDParamX(this->decode_params, 2);
143  if (company < MAX_COMPANIES) face = company;
144  }
145 }
146 
152 void ErrorMessageData::SetDParam(uint n, uint64 v)
153 {
154  this->decode_params[n] = v;
155 }
156 
162 void ErrorMessageData::SetDParamStr(uint n, const char *str)
163 {
164  free(this->strings[n]);
165  this->strings[n] = stredup(str);
166 }
167 
169 typedef std::list<ErrorMessageData> ErrorList;
171 ErrorList _error_list;
174 
177 private:
180 
181 public:
182  ErrmsgWindow(const ErrorMessageData &data) : Window(data.HasFace() ? &_errmsg_face_desc : &_errmsg_desc), ErrorMessageData(data)
183  {
184  this->InitNested();
185  }
186 
187  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
188  {
189  switch (widget) {
190  case WID_EM_MESSAGE: {
193 
194  int text_width = max(0, (int)size->width - WD_FRAMETEXT_LEFT - WD_FRAMETEXT_RIGHT);
195  this->height_summary = GetStringHeight(this->summary_msg, text_width);
196  this->height_detailed = (this->detailed_msg == INVALID_STRING_ID) ? 0 : GetStringHeight(this->detailed_msg, text_width);
197 
198  if (this->textref_stack_size > 0) StopTextRefStackUsage();
199 
200  uint panel_height = WD_FRAMERECT_TOP + this->height_summary + WD_FRAMERECT_BOTTOM;
201  if (this->detailed_msg != INVALID_STRING_ID) panel_height += this->height_detailed + WD_PAR_VSEP_WIDE;
202 
203  size->height = max(size->height, panel_height);
204  break;
205  }
206  case WID_EM_FACE: {
207  Dimension face_size = GetSpriteSize(SPR_GRADIENT);
208  size->width = max(size->width, face_size.width);
209  size->height = max(size->height, face_size.height);
210  break;
211  }
212  }
213  }
214 
215  Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
216  {
217  /* Position (0, 0) given, center the window. */
218  if (this->position.x == 0 && this->position.y == 0) {
219  Point pt = {(_screen.width - sm_width) >> 1, (_screen.height - sm_height) >> 1};
220  return pt;
221  }
222 
223  /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
224  * Add a fixed distance 20 to make it less cluttered.
225  */
226  int scr_top = GetMainViewTop() + 20;
227  int scr_bot = GetMainViewBottom() - 20;
228 
229  Point pt = RemapCoords2(this->position.x, this->position.y);
231  if (this->face == INVALID_COMPANY) {
232  /* move x pos to opposite corner */
233  pt.x = UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left;
234  pt.x = (pt.x < (_screen.width >> 1)) ? _screen.width - sm_width - 20 : 20; // Stay 20 pixels away from the edge of the screen.
235 
236  /* move y pos to opposite corner */
237  pt.y = UnScaleByZoom(pt.y - vp->virtual_top, vp->zoom) + vp->top;
238  pt.y = (pt.y < (_screen.height >> 1)) ? scr_bot - sm_height : scr_top;
239  } else {
240  pt.x = Clamp(UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left - (sm_width / 2), 0, _screen.width - sm_width);
241  pt.y = Clamp(UnScaleByZoom(pt.y - vp->virtual_top, vp->zoom) + vp->top - (sm_height / 2), scr_top, scr_bot - sm_height);
242  }
243  return pt;
244  }
245 
251  void OnInvalidateData(int data = 0, bool gui_scope = true) override
252  {
253  /* If company gets shut down, while displaying an error about it, remove the error message. */
254  if (this->face != INVALID_COMPANY && !Company::IsValidID(this->face)) delete this;
255  }
256 
257  void SetStringParameters(int widget) const override
258  {
259  if (widget == WID_EM_CAPTION) CopyInDParam(0, this->decode_params, lengthof(this->decode_params));
260  }
261 
262  void DrawWidget(const Rect &r, int widget) const override
263  {
264  switch (widget) {
265  case WID_EM_FACE: {
266  const Company *c = Company::Get(this->face);
267  DrawCompanyManagerFace(c->face, c->colour, r.left, r.top);
268  break;
269  }
270 
271  case WID_EM_MESSAGE:
274 
275  if (this->detailed_msg == INVALID_STRING_ID) {
277  this->summary_msg, TC_FROMSTRING, SA_CENTER);
278  } else {
279  int extra = (r.bottom - r.top + 1 - this->height_summary - this->height_detailed - WD_PAR_VSEP_WIDE) / 2;
280 
281  /* Note: NewGRF supplied error message often do not start with a colour code, so default to white. */
282  int top = r.top + WD_FRAMERECT_TOP;
283  int bottom = top + this->height_summary + extra;
284  DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, top, bottom, this->summary_msg, TC_WHITE, SA_CENTER);
285 
286  bottom = r.bottom - WD_FRAMERECT_BOTTOM;
287  top = bottom - this->height_detailed - extra;
288  DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, top, bottom, this->detailed_msg, TC_WHITE, SA_CENTER);
289  }
290 
291  if (this->textref_stack_size > 0) StopTextRefStackUsage();
292  break;
293 
294  default:
295  break;
296  }
297  }
298 
299  void OnMouseLoop() override
300  {
301  /* Disallow closing the window too easily, if timeout is disabled */
302  if (_right_button_down && this->duration != 0) delete this;
303  }
304 
305  void OnHundredthTick() override
306  {
307  /* Timeout enabled? */
308  if (this->duration != 0) {
309  this->duration--;
310  if (this->duration == 0) delete this;
311  }
312  }
313 
314  ~ErrmsgWindow()
315  {
317  if (_window_system_initialized) ShowFirstError();
318  }
319 
320  EventState OnKeyPress(WChar key, uint16 keycode) override
321  {
322  if (keycode != WKC_SPACE) return ES_NOT_HANDLED;
323  delete this;
324  return ES_HANDLED;
325  }
326 
331  bool IsCritical()
332  {
333  return this->duration == 0;
334  }
335 };
336 
341 {
343  _error_list.clear();
344 }
345 
348 {
349  _window_system_initialized = true;
350  if (!_error_list.empty()) {
351  new ErrmsgWindow(_error_list.front());
352  _error_list.pop_front();
353  }
354 }
355 
362 {
364  if (_window_system_initialized && w != nullptr) {
365  if (w->IsCritical()) _error_list.push_front(*w);
366  _window_system_initialized = false;
367  delete w;
368  }
369 }
370 
383 {
384  assert(textref_stack_size == 0 || (textref_stack_grffile != nullptr && textref_stack != nullptr));
385  if (summary_msg == STR_NULL) summary_msg = STR_EMPTY;
386 
387  if (wl != WL_INFO) {
388  /* Print message to console */
389  char buf[DRAW_STRING_BUFFER];
390 
391  if (textref_stack_size > 0) StartTextRefStackUsage(textref_stack_grffile, textref_stack_size, textref_stack);
392 
393  char *b = GetString(buf, summary_msg, lastof(buf));
394  if (detailed_msg != INVALID_STRING_ID) {
395  b += seprintf(b, lastof(buf), " ");
396  GetString(b, detailed_msg, lastof(buf));
397  }
398 
399  if (textref_stack_size > 0) StopTextRefStackUsage();
400 
401  switch (wl) {
402  case WL_WARNING: IConsolePrint(CC_WARNING, buf); break;
403  default: IConsoleError(buf); break;
404  }
405  }
406 
407  bool no_timeout = wl == WL_CRITICAL;
408 
409  if (_settings_client.gui.errmsg_duration == 0 && !no_timeout) return;
410 
411  ErrorMessageData data(summary_msg, detailed_msg, no_timeout ? 0 : _settings_client.gui.errmsg_duration, x, y, textref_stack_grffile, textref_stack_size, textref_stack);
412  data.CopyOutDParams();
413 
415  if (w != nullptr && w->IsCritical()) {
416  /* A critical error is currently shown. */
417  if (wl == WL_CRITICAL) {
418  /* Push another critical error in the queue of errors,
419  * but do not put other errors in the queue. */
420  _error_list.push_back(data);
421  }
422  } else {
423  /* Nothing or a non-critical error was shown. */
424  delete w;
425  new ErrmsgWindow(data);
426  }
427 }
428 
434 void ScheduleErrorMessage(ErrorList &datas)
435 {
436  _error_list.splice(_error_list.end(), datas);
437 }
438 
445 {
446  _error_list.push_back(data);
447 }
EventState
State of handling an event.
Definition: window_type.h:713
Functions related to OTTD&#39;s strings.
Owner
Enum for all companies/owners.
Definition: company_type.h:20
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:48
void ShowFirstError()
Show the first error of the queue.
Definition: error_gui.cpp:347
Definition of stuff that is very close to a company, like the company struct itself.
int virtual_left
Virtual left coordinate.
Definition: viewport_type.h:30
uint textref_stack_size
Number of uint32 values to put on the TextRefStack for the error message.
Definition: error.h:36
void SetDParamStr(uint n, const char *str)
Set a rawstring parameter.
Definition: error_gui.cpp:162
High level window description.
Definition: window_gui.h:168
static uint64 GetDParamX(const uint64 *s, uint n)
Get the current string parameter at index n from parameter array s.
Definition: strings_func.h:221
Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
Compute the initial position of the window.
Definition: error_gui.cpp:215
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
void OnHundredthTick() override
Called once every 100 (game) ticks.
Definition: error_gui.cpp:305
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:409
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:42
ErrorMessageData(const ErrorMessageData &data)
Copy the given data into our instance.
Definition: error_gui.cpp:75
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
Horizontal container.
Definition: widget_type.h:75
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1114
The passed event is not handled.
Definition: window_type.h:715
static int UnScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL) When shifting right...
Definition: zoom_func.h:36
void SetDParam(uint n, uint64 v)
Set a error string parameter.
Definition: error_gui.cpp:152
void OnMouseLoop() override
Called for every mouse loop run, which is at least once per (game) tick.
Definition: error_gui.cpp:299
void CopyInDParam(int offs, const uint64 *src, int num)
Copy num string parameters from array src into the global string parameter array. ...
Definition: strings.cpp:140
CompanyID face
Company belonging to the face being shown. INVALID_COMPANY if no face present.
Definition: error.h:41
void DrawCompanyManagerFace(CompanyManagerFace cmf, int colour, int x, int y)
Draws the face of a company manager&#39;s face.
bool IsCritical()
Check whether the currently shown error message was critical or not.
Definition: error_gui.cpp:331
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:547
Close box (at top-left of a window)
Definition: widget_type.h:69
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:85
byte errmsg_duration
duration of error message
Definition: settings_type.h:94
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:26
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: error_gui.cpp:187
Large amount of vertical space between two paragraphs of text.
Definition: window_gui.h:140
void CopyOutDParams()
Copy error parameters from current DParams.
Definition: error_gui.cpp:129
Functions, definitions and such used only by the GUI.
~ErrorMessageData()
Free all the strings.
Definition: error_gui.cpp:91
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition: window.cpp:2173
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
Functions related to (drawing on) viewports.
uint32 textref_stack[16]
Values to put on the TextRefStack for the error message.
Definition: error.h:37
Data structure for an opened window.
Definition: window_gui.h:278
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1046
Critical errors, the MessageBox is shown in all cases.
Definition: error.h:26
Types related to the error widgets.
Header of Action 04 "universal holder" structure and functions.
Main window; Window numbers:
Definition: window_type.h:46
Functions related to low-level strings.
Other information.
Definition: error.h:24
Functions related to errors.
Error message; Window numbers:
Definition: window_type.h:105
void SetRedErrorSquare(TileIndex tile)
Set a tile to display a red error square.
Definition: viewport.cpp:2426
void UnshowCriticalError()
Unshow the critical error.
Definition: error_gui.cpp:361
void IConsolePrint(TextColour colour_code, const char *string)
Handle the printing of text entered into the console or redirected there by any other means...
Definition: console.cpp:86
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
Functions related to the gfx engine.
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:80
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:947
Definition of base types and functions in a cross-platform compatible way.
ErrorList _error_list
The actual queue with errors.
Definition: error_gui.cpp:171
Center both horizontally and vertically.
Definition: gfx_func.h:106
int GetMainViewTop()
Return the top of the main view available for general use.
Definition: window.cpp:2162
A number of safeguards to prevent using unsafe methods.
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: error_gui.cpp:257
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: error_gui.cpp:251
void CopyOutDParam(uint64 *dst, int offs, int num)
Copy num string parameters from the global string parameter array to the dst array.
Definition: strings.cpp:151
Simple depressed panel.
Definition: widget_type.h:50
StringID detailed_msg
Detailed error message showed in second line. Can be INVALID_STRING_ID.
Definition: error.h:39
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:138
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: error_gui.cpp:262
Console functions used outside of the console code.
bool _window_system_initialized
Whether the window system is initialized or not.
Definition: error_gui.cpp:173
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1114
StringID summary_msg
General error message showed in first line. Must be valid.
Definition: error.h:38
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x, int y, const GRFFile *textref_stack_grffile, uint textref_stack_size, const uint32 *textref_stack)
Display an error message in a window.
Definition: error_gui.cpp:382
uint height_summary
Height of the summary_msg string in pixels in the WID_EM_MESSAGE widget.
Definition: error_gui.cpp:178
Right offset of the text of the frame.
Definition: window_gui.h:73
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
const char * strings[20]
Copies of raw strings that were used.
Definition: error.h:34
EventState OnKeyPress(WChar key, uint16 keycode) override
A key has been pressed.
Definition: error_gui.cpp:320
Left offset of the text of the frame.
Definition: window_gui.h:72
void StartTextRefStackUsage(const GRFFile *grffile, byte numEntries, const uint32 *values)
Start using the TTDP compatible string code parsing.
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
CompanyManagerFace face
Face description of the president.
Definition: company_base.h:65
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:139
static void MemCpyT(T *destination, const T *source, size_t num=1)
Type-safe version of memcpy().
Definition: mem_func.hpp:25
bool HasFace() const
Check whether error window shall display a company manager face.
Definition: error.h:49
int left
Screen coordinate left edge of the viewport.
Definition: viewport_type.h:25
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:40
An invalid company.
Definition: company_type.h:32
The data of the error message.
Definition: error.h:30
Functionality related to the company manager&#39;s face.
GUISettings gui
settings related to the GUI
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
Data structure for viewport, display of a part of the world.
Definition: viewport_type.h:24
uint duration
Length of display of the message. 0 means forever,.
Definition: error.h:32
void ClearErrorMessages()
Clear all errors from the queue.
Definition: error_gui.cpp:340
Window class for displaying an error message window.
Definition: error_gui.cpp:176
Error message.
Definition: error_widget.h:19
byte colour
Company colour.
Definition: company_base.h:71
void IConsoleError(const char *string)
It is possible to print error information to the console.
Definition: console.cpp:169
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:999
Functions related to zooming.
Maximum number of companies.
Definition: company_type.h:25
const GRFFile * textref_stack_grffile
NewGRF that filled the TextRefStack for the error message.
Definition: error.h:35
Functions related to OTTD&#39;s landscape.
Error title.
Definition: error_widget.h:18
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:767
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:235
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:19
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:131
ZoomLevel zoom
The zoom level of the viewport.
Definition: viewport_type.h:35
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:23
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:85
int virtual_top
Virtual top coordinate.
Definition: viewport_type.h:31
Specification of a rectangle with absolute coordinates of all edges.
The passed event is handled.
Definition: window_type.h:714
uint64 decode_params[20]
Parameters of the message strings.
Definition: error.h:33
Window functions not directly related to making/drawing windows.
void ScheduleErrorMessage(ErrorList &datas)
Schedule a list of errors.
Definition: error_gui.cpp:434
int top
Screen coordinate top edge of the viewport.
Definition: viewport_type.h:26
Manually align the window (so no automatic location finding)
Definition: window_gui.h:155
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:328
Caption of the window.
Definition: error_widget.h:17
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:37
std::list< ErrorMessageData > ErrorList
Define a queue with errors.
Definition: error_gui.cpp:169
static Point RemapCoords2(int x, int y)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap...
Definition: landscape.h:100
static const TextColour CC_WARNING
Colour for warning lines.
Definition: console_type.h:27
Dimensions (a width and height) of a rectangle in 2D.
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1076
Point position
Position of the error message window.
Definition: error.h:40
uint height_detailed
Height of the detailed_msg string in pixels in the WID_EM_MESSAGE widget.
Definition: error_gui.cpp:179
void StopTextRefStackUsage()
Stop using the TTDP compatible string code parsing.
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:620
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:107
WarningLevel
Message severity/type.
Definition: error.h:22