OpenTTD
error.h
Go to the documentation of this file.
1 /* $Id: error.h 26241 2014-01-12 18:00:39Z frosch $ */
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 #ifndef ERROR_H
13 #define ERROR_H
14 
15 #include "strings_type.h"
16 #include "company_type.h"
17 #include "core/geometry_type.hpp"
18 
19 struct GRFFile;
20 
27 };
28 
31 protected:
32  uint duration;
33  uint64 decode_params[20];
34  const char *strings[20];
37  uint32 textref_stack[16];
42 
43 public:
46  ErrorMessageData(StringID summary_msg, StringID detailed_msg, uint duration = 0, int x = 0, int y = 0, const GRFFile *textref_stack_grffile = NULL, uint textref_stack_size = 0, const uint32 *textref_stack = NULL);
47 
49  bool HasFace() const { return face != INVALID_COMPANY; }
50 
51  void SetDParam(uint n, uint64 v);
52  void SetDParamStr(uint n, const char *str);
53 
54  void CopyOutDParams();
55 };
56 
57 void ScheduleErrorMessage(const ErrorMessageData &data);
58 
59 void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x = 0, int y = 0, const GRFFile *textref_stack_grffile = NULL, uint textref_stack_size = 0, const uint32 *textref_stack = NULL);
60 void ClearErrorMessages();
61 void ShowFirstError();
62 void UnshowCriticalError();
63 
64 #endif /* ERROR_H */
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:158
ErrorMessageData(const ErrorMessageData &data)
Copy the given data into our instance.
Definition: error_gui.cpp:75
void SetDParam(uint n, uint64 v)
Set a error string parameter.
Definition: error_gui.cpp:148
CompanyID face
Company belonging to the face being shown. INVALID_COMPANY if no face present.
Definition: error.h:41
void CopyOutDParams()
Copy error parameters from current DParams.
Definition: error_gui.cpp:125
~ErrorMessageData()
Free all the strings.
Definition: error_gui.cpp:87
uint32 textref_stack[16]
Values to put on the TextRefStack for the error message.
Definition: error.h:37
Critical errors, the MessageBox is shown in all cases.
Definition: error.h:26
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=NULL, uint textref_stack_size=0, const uint32 *textref_stack=NULL)
Display an error message in a window.
Definition: error_gui.cpp:378
Other information.
Definition: error.h:24
StringID detailed_msg
Detailed error message showed in second line. Can be INVALID_STRING_ID.
Definition: error.h:39
void ScheduleErrorMessage(const ErrorMessageData &data)
Schedule an error.
Definition: error_gui.cpp:440
StringID summary_msg
General error message showed in first line. Must be valid.
Definition: error.h:38
const char * strings[20]
Copies of raw strings that were used.
Definition: error.h:34
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
bool HasFace() const
Check whether error window shall display a company manager face.
Definition: error.h:49
void UnshowCriticalError()
Unshow the critical error.
Definition: error_gui.cpp:357
The data of the error message.
Definition: error.h:30
void ClearErrorMessages()
Clear all errors from the queue.
Definition: error_gui.cpp:336
uint duration
Length of display of the message. 0 means forever,.
Definition: error.h:32
const GRFFile * textref_stack_grffile
NewGRF that filled the TextRefStack for the error message.
Definition: error.h:35
All geometry types in OpenTTD.
Coordinates of a point in 2D.
Types related to companies.
Types related to strings.
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:23
uint64 decode_params[20]
Parameters of the message strings.
Definition: error.h:33
Owner
Enum for all companies/owners.
Definition: company_type.h:20
Errors (eg. saving/loading failed)
Definition: error.h:25
An invalid company.
Definition: company_type.h:32
Point position
Position of the error message window.
Definition: error.h:40
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:104
WarningLevel
Message severity/type.
Definition: error.h:22
void ShowFirstError()
Show the first error of the queue.
Definition: error_gui.cpp:343