Package Mindshifter

Classes
class	ConsoleKeyMap
	ConsoleKeyMap maps a set of keys and key modifier combinations to ASCII char values. More...
struct	ConsoleMessage
	Defines a message logged to the console. More...
class	GameConsole
	GameConsole is a simple console game component that displays a log of text to the screen and allows the user to enter input (which is also logged). Handling user input can be done in two ways, the first by registering a delegate to the console's 'TextEntered' event, which will trigger any delegates registered to it when the user enters text into the console. Both the text input and current GameTime are passed to the delegate for processing, and the function can handle the raw input any way it wishes to. The second method for handling input is to register a ConsoleCommandHandler with the console through the 'BindCommandHandler' method. ConsoleCommandHandler delegates are registered for a specific command string, and are triggered when that particular string is entered into the console. Any text after the command is considered to be a set of arguments separated by spaces. These arguments are passed to the ConsoleCommandHandler delegate when it is triggered. More...
interface	IGameConsole
Enumerations
enum	KeyModifier { None, None = 0, Shift }
	Defines the key modifier state for a keyboard key. More...
enum	ConsoleDisplayOptions { None, None = 0, TimeStamp = (0x1 << 1), LogLevel = (TimeStamp << 1) }
	A set of flags specifying how to display output in the console. More...
Functions
delegate void	ConsoleInputHandler (string input, GameTime time)
	Delegate called when text is entered into the console.
delegate void	ConsoleLogHandler (ConsoleMessage message)
	Delegate called when a message is logged to the console.
delegate void	ConsoleCommandHandler (GameTime time, string[] args)
	Delegate called when a specific command is entered into the console.

---

Enumeration Type Documentation

enum Mindshifter::ConsoleDisplayOptions

A set of flags specifying how to display output in the console.

Enumerator:

None
None
TimeStamp
LogLevel

enum Mindshifter::KeyModifier

Defines the key modifier state for a keyboard key.

Enumerator:

None
None
Shift

---

Function Documentation

delegate void Mindshifter.ConsoleCommandHandler	(	GameTime	time,
		string[]	args
	)

Delegate called when a specific command is entered into the console.

Parameters:

	time	The time at which the command was entered into the console
	args	The arguments passed to the command (text entered after the command, separated by spaces)

delegate void Mindshifter.ConsoleInputHandler	(	string	input,
		GameTime	time
	)

Delegate called when text is entered into the console.

Parameters:

	input	The text entered into the console
	time	The game time at which the text was entered

delegate void Mindshifter.ConsoleLogHandler

(

ConsoleMessage

message

)

Delegate called when a message is logged to the console.

Parameters:

message

The message that was logged to the console

---