Inheritance diagram for Mindshifter.IGameConsole:
Public Member Functions | |
| void | BindCommandHandler (string command, ConsoleCommandHandler handler, params char[] argumentSeparators) |
| Binds a ConsoleCommandHandler to the specified command. | |
| ConsoleCommandHandler | UnbindCommandHandler (string command) |
| Unbinds the ConsoleCommandHandler for the specified command. | |
| void | Open (Keys closeKey) |
| Displays the console. | |
| void | Log (string message, uint level) |
| Logs a message with the specified log level to the console. | |
| void | Log (string message) |
| Logs a message with log level 0 to the console. | |
| void | SetLogLevelCustomColor (uint level, Color color) |
| Sets the custom display color of text for the specified log level. | |
| Color | GetLogLevelCustomColor (uint level) |
| Gets the custom display color of text for the specified log level, or returns the default text color if a custom color is not set for the level. | |
| void | UnsetLogLevelCustomColor (uint level) |
| Unsets the custom display color of text for the specified log level. | |
Public Attributes | |
| event ConsoleInputHandler | TextEntered |
| Event triggered when text is entered into the console. | |
| event ConsoleLogHandler | MessageLogged |
| Event triggered when a message is logged to the console. | |
Properties | |
| Color | TextColor [get, set] |
| Gets or sets the console's text color. | |
| Color | BackgroundColor [get, set] |
| Gets or sets the console's background color. | |
| float | BackgroundAlpha [get, set] |
| Gets or sets the console's background alpha translucency. | |
| ConsoleDisplayOptions | DisplayOptions [get, set] |
| Gets or sets the console's display options. | |
| string | TimestampFormat [get, set] |
| Gets or sets the timestamp format for message timestamps. The following symblols are replaced with their corresponding values when the timestamp for each message is constructed: {Hr} - Hour (in 24 hour format) {Min} - Minute {Sec} - Second {Ms} - Millisecond. | |
| string | Prompt [get, set] |
| Gets or sets the prompt used on the input line of the console. | |
| int | VisibleLineCount [get, set] |
| Gets or sets the number of text lines visible in the console. | |
| float | VerticalLineSpacing [get, set] |
| Gets or sets the vertical spacing between text lines in the console. | |
| float | HorizontalPadding [get, set] |
| Gets or sets the amount by which text in the console will be right offset from the leftmost side of the screen. | |
| bool | AutoScrollOnOutput [get, set] |
| Gets or sets a value indicating whether or not the console should automatically scroll to the last line of the message log whenever a message is output to the console. | |
| bool | AlertOnUnrecognizedCommand [get, set] |
| Gets or sets a value indicating whether or not the console will output the warning "Unrecognized Command" if the user inputs a command not registered with a command handler. | |
| bool | EchoEnabled [get, set] |
| Gets or sets a value indicating whether or not the console should automatically echo and input it receives from the user to the console log. | |
| uint | EchoLogLevel [get, set] |
| Gets or sets the log level of messages echoed automatically if the EchoEnabled property is set to true. | |
| uint | DefaultLogLevel [get, set] |
| Gets or sets the console's default log level which will be assigned to messages logged to the console with no log level defined. | |
| int | LogLevelThreshold [get, set] |
| Gets or sets the console's log level threshold. If a message's whose log level is higher than the threshold is logged to the console, it will be ignored. However, if the value is negative then all messages will be logged regardless of their log level. | |
| int | DisplayLevelThreshold [get, set] |
| Gets or sets the console's display level threshold. The console will only display messages in the log with log levels lower or equal to the display level threshold. However, if the value is negative, then all messages will be displayed regardless of their threshold. | |
| bool | CursorEnabled [get, set] |
| Gets or sets a value indicating whether or not the input cursor is enabled. If enabled, the user can use the arrow keys to navigate the edit position within the current input string. | |
| float | CursorBlinkSpeed [get, set] |
| Gets or sets the blink interval of the input cursor, in seconds. The cursor will not blink if this value is set to 0. | |
| float | NotifyBlinkSpeed [get, set] |
| Gets or sets the blink interval of the notifier that is displayed when the console's current line is not the last line of the log, that is: when the user has used PageUp/Up to scroll upward in the console. The notifier will not blink if this value is set to 0. | |
| ReadOnlyCollection< ConsoleMessage > | MessageLog [get] |
| Gets the console log of messages. | |
| bool | IsOpen [get] |
| Gets a value indicating whether or not the console is currently open. | |
| void Mindshifter.IGameConsole.BindCommandHandler | ( | string | command, | |
| ConsoleCommandHandler | handler, | |||
| params char[] | argumentSeparators | |||
| ) |
Binds a ConsoleCommandHandler to the specified command.
| command | The command to which the command handler will be bound | |
| handler | The command handler to bind to the specified command | |
| argumentSeparators | The characters with which the command argument string will be split into separate arguments |
Implemented in Mindshifter.GameConsole.
| ConsoleCommandHandler Mindshifter.IGameConsole.UnbindCommandHandler | ( | string | command | ) |
Unbinds the ConsoleCommandHandler for the specified command.
| command | The command for which to unbind the current command handler |
Implemented in Mindshifter.GameConsole.
| void Mindshifter.IGameConsole.Open | ( | Keys | closeKey | ) |
Displays the console.
| closeKey | The key that should deactivate the console when pressed |
Implemented in Mindshifter.GameConsole.
| void Mindshifter.IGameConsole.Log | ( | string | message, | |
| uint | level | |||
| ) |
Logs a message with the specified log level to the console.
| message | The message to output to the console | |
| level | The log level of the message |
Implemented in Mindshifter.GameConsole.
| void Mindshifter.IGameConsole.Log | ( | string | message | ) |
Logs a message with log level 0 to the console.
| message | The message to output to the console |
Implemented in Mindshifter.GameConsole.
| void Mindshifter.IGameConsole.SetLogLevelCustomColor | ( | uint | level, | |
| Color | color | |||
| ) |
Sets the custom display color of text for the specified log level.
| level | The log level for which to set the custom text display color | |
| color | The custom color with which to display text for the specified log level |
Implemented in Mindshifter.GameConsole.
| Color Mindshifter.IGameConsole.GetLogLevelCustomColor | ( | uint | level | ) |
Gets the custom display color of text for the specified log level, or returns the default text color if a custom color is not set for the level.
| level | The log level for which to get the custom display color |
Implemented in Mindshifter.GameConsole.
| void Mindshifter.IGameConsole.UnsetLogLevelCustomColor | ( | uint | level | ) |
Unsets the custom display color of text for the specified log level.
| level | The log level for which to unset the custom text color |
Implemented in Mindshifter.GameConsole.
| event ConsoleInputHandler Mindshifter.IGameConsole.TextEntered |
| event ConsoleLogHandler Mindshifter.IGameConsole.MessageLogged |
Color Mindshifter.IGameConsole.TextColor [get, set] |
Color Mindshifter.IGameConsole.BackgroundColor [get, set] |
float Mindshifter.IGameConsole.BackgroundAlpha [get, set] |
ConsoleDisplayOptions Mindshifter.IGameConsole.DisplayOptions [get, set] |
string Mindshifter.IGameConsole.TimestampFormat [get, set] |
Gets or sets the timestamp format for message timestamps. The following symblols are replaced with their corresponding values when the timestamp for each message is constructed: {Hr} - Hour (in 24 hour format) {Min} - Minute {Sec} - Second {Ms} - Millisecond.
Sample timestamp strings: "{Hr}:{Min}:{Sec}" "[{Hr}:{Min}:{Sec}:{Ms}]"
Implemented in Mindshifter.GameConsole.
string Mindshifter.IGameConsole.Prompt [get, set] |
Gets or sets the prompt used on the input line of the console.
Implemented in Mindshifter.GameConsole.
int Mindshifter.IGameConsole.VisibleLineCount [get, set] |
Gets or sets the number of text lines visible in the console.
Implemented in Mindshifter.GameConsole.
float Mindshifter.IGameConsole.VerticalLineSpacing [get, set] |
Gets or sets the vertical spacing between text lines in the console.
Implemented in Mindshifter.GameConsole.
float Mindshifter.IGameConsole.HorizontalPadding [get, set] |
Gets or sets the amount by which text in the console will be right offset from the leftmost side of the screen.
Implemented in Mindshifter.GameConsole.
bool Mindshifter.IGameConsole.AutoScrollOnOutput [get, set] |
Gets or sets a value indicating whether or not the console should automatically scroll to the last line of the message log whenever a message is output to the console.
Implemented in Mindshifter.GameConsole.
bool Mindshifter.IGameConsole.AlertOnUnrecognizedCommand [get, set] |
Gets or sets a value indicating whether or not the console will output the warning "Unrecognized Command" if the user inputs a command not registered with a command handler.
Implemented in Mindshifter.GameConsole.
bool Mindshifter.IGameConsole.EchoEnabled [get, set] |
Gets or sets a value indicating whether or not the console should automatically echo and input it receives from the user to the console log.
Implemented in Mindshifter.GameConsole.
uint Mindshifter.IGameConsole.EchoLogLevel [get, set] |
Gets or sets the log level of messages echoed automatically if the EchoEnabled property is set to true.
Implemented in Mindshifter.GameConsole.
uint Mindshifter.IGameConsole.DefaultLogLevel [get, set] |
Gets or sets the console's default log level which will be assigned to messages logged to the console with no log level defined.
Implemented in Mindshifter.GameConsole.
int Mindshifter.IGameConsole.LogLevelThreshold [get, set] |
Gets or sets the console's log level threshold. If a message's whose log level is higher than the threshold is logged to the console, it will be ignored. However, if the value is negative then all messages will be logged regardless of their log level.
Implemented in Mindshifter.GameConsole.
int Mindshifter.IGameConsole.DisplayLevelThreshold [get, set] |
Gets or sets the console's display level threshold. The console will only display messages in the log with log levels lower or equal to the display level threshold. However, if the value is negative, then all messages will be displayed regardless of their threshold.
Implemented in Mindshifter.GameConsole.
bool Mindshifter.IGameConsole.CursorEnabled [get, set] |
Gets or sets a value indicating whether or not the input cursor is enabled. If enabled, the user can use the arrow keys to navigate the edit position within the current input string.
Implemented in Mindshifter.GameConsole.
float Mindshifter.IGameConsole.CursorBlinkSpeed [get, set] |
Gets or sets the blink interval of the input cursor, in seconds. The cursor will not blink if this value is set to 0.
Implemented in Mindshifter.GameConsole.
float Mindshifter.IGameConsole.NotifyBlinkSpeed [get, set] |
Gets or sets the blink interval of the notifier that is displayed when the console's current line is not the last line of the log, that is: when the user has used PageUp/Up to scroll upward in the console. The notifier will not blink if this value is set to 0.
Implemented in Mindshifter.GameConsole.
ReadOnlyCollection<ConsoleMessage> Mindshifter.IGameConsole.MessageLog [get] |
bool Mindshifter.IGameConsole.IsOpen [get] |
Gets a value indicating whether or not the console is currently open.
Implemented in Mindshifter.GameConsole.
1.5.1-p1