GuiConsole
The on-screen, in-game console. Calls getLog() to get the on-screen console entries, then renders them as needed.
Callbacks
void
onMessageSelected(ConsoleLogEntry::Level level, string message)
Called when a message in the log is clicked.
void
onNewMessage(uint errorCount, uint warnCount, uint normalCount)
Called when a new message is logged.
Public Functions
bool
Returns if the error filter is on or not.
bool
Returns if the normal message filter is on or not.
bool
Returns if the warning filter is on or not.
void
refresh()
Refreshes the displayed messages.
void
setDisplayFilters(bool errors, bool warns, bool normal)
Sets the current display filters for the console gui. Allows you to indicate if it should display errors, warns and/or normal messages.
void
Toggles the error filter.
void
Toggles the normal messages filter.
void
Toggles the warning filter.
Detailed Description
The on-screen, in-game console. Calls getLog() to get the on-screen console entries, then renders them as needed.
new GuiConsole() { //Properties not specific to this control have been omitted from this example. };
Callbacks
onMessageSelected(ConsoleLogEntry::Level level, string message)
Called when a message in the log is clicked.
Parameters:
| level | Diagnostic level of the message. |
| message | Message text. |
onNewMessage(uint errorCount, uint warnCount, uint normalCount)
Called when a new message is logged.
Parameters:
| errorCount | The number of error messages logged. |
| warnCount | The number of warning messages logged. |
| normalCount | The number of normal messages logged. |
Public Functions
getErrorFilter()
Returns if the error filter is on or not.
getNormalFilter()
Returns if the normal message filter is on or not.
getWarnFilter()
Returns if the warning filter is on or not.
refresh()
Refreshes the displayed messages.
setDisplayFilters(bool errors, bool warns, bool normal)
Sets the current display filters for the console gui. Allows you to indicate if it should display errors, warns and/or normal messages.
Parameters:
| errors | If true, the console gui will display any error messages that were emitted. |
| warns | If true, the console gui will display any warning messages that were emitted. |
| normal | If true, the console gui will display any regular messages that were emitted. |
toggleErrorFilter()
Toggles the error filter.
toggleNormalFilter()
Toggles the normal messages filter.
toggleWarnFilter()
Toggles the warning filter.