ConsoleLogEntry Struct Reference

#include <console.h>

Detailed Description

Represents an entry in the log.

Public Types

Normal = 0

Warning

Error

NUM_CLASS

General = 0

Assert

Script

GUI

Network

GGConnect

NUM_TYPE

enum Level {
  Normal = 0,
  Warning,
  Error,
  NUM_CLASS
}

This field indicates the severity of the log entry. More...

enum Type {
  General = 0,
  Assert,
  Script,
  GUI,
  Network,
  GGConnect,
  NUM_TYPE
}

Used to associate a log entry with a module. More...

Public Attributes

enum ConsoleLogEntry::Level mLevel

This field indicates the severity of the log entry.

enum ConsoleLogEntry::Type mType

Used to associate a log entry with a module.

const char * mString

Indicates the actual log entry.

Member Enumeration Documentation

enum ConsoleLogEntry::Level

This field indicates the severity of the log entry.

Log entries are filtered and displayed differently based on their severity. Errors are highlighted red, while normal entries are displayed as normal text. Often times, the engine will be configured to hide all log entries except warnings or errors, or to perform a special notification when it encounters an error.

Enumerator:

Normal
Warning
Error
NUM_CLASS

enum ConsoleLogEntry::Type

Used to associate a log entry with a module.

Log entries can come from different sources; for instance, the scripting engine, or the network code. This allows the logging system to be aware of where different log entries originated from.

Enumerator:

General
Assert
Script
GUI
Network
GGConnect
NUM_TYPE

Member Data Documentation

enum ConsoleLogEntry::Level ConsoleLogEntry::mLevel

This field indicates the severity of the log entry.

enum ConsoleLogEntry::Type ConsoleLogEntry::mType

Used to associate a log entry with a module.

Log entries can come from different sources; for instance, the scripting engine, or the network code. This allows the logging system to be aware of where different log entries originated from.

const char* ConsoleLogEntry::mString

Indicates the actual log entry.

This contains a description of the event being logged. For instance, "unable to access file", or "player connected successfully", or nearly anything else you might imagine.

Typically, the description should contain a concise, descriptive string describing whatever is being logged. Whenever possible, include useful details like the name of the file being accessed, or the id of the player or GuiControl, so that if a log needs to be used to locate a bug, it can be done as painlessly as possible.