VerticesEngine.vxConsole Class Reference

Console Utility which provides output too both the in-game console window as well as the system console if available. More...

Classes
struct	ScreenDebugLine

Static Public Member Functions
static void	WriteLine (object output)
	Writes a debug line which is outputed to both the engine debug window and the system console.
static void	WriteLine (object output, ConsoleColor consoleColor)
static void	WriteDLCLine (object output)
static void	WriteIODebug (object output)
static void	WriteSettings (object output)
static void	WriteNetworkLine (object output)
static void	WriteMonLine (object output)
static void	NetLog (string text)
	Logs a network message specifiying whether this instance is a server or client.
static void	NetLog (string text, ConsoleColor colour)
	Net logs with a given colour.
static void	WriteWarning (string SourceFile, string output)
	Writes out a warning to the debug and system console.
static void	WriteError (string text)
static void	WriteLine (DebugCommandMessage messageType, object output, ConsoleColor consoleColor)
static void	ResetConsoleColour ()
static void	WriteVerboseLine (string output)
	Writes out a Verbose Line. This line will be written to the console/output window if the Verbose Property is set too true.
static void	WriteVerboseLine (string output, params object[] param)
static void	WriteVerboseLine (string output, ConsoleColor consoleColor)
	Writes out a Verbose Line. This line will be written to the console/output window if the Verbose Property is set too true.
static void	Echo (string text)
	Similar to the WriteLine method. This method writes out a line of text which is is prefixed with a "Networking" tag to the console output line to help distuignish it against regular console output.
static void	WriteException (object sender, Exception ex)
	Writes out an error the error.
static void	WriteException (Exception ex, [System.Runtime.CompilerServices.CallerMemberNameAttribute] string caller="")
static void	WriteException (object sender, Exception ex, string[] extrInfo)
static void	DumpLog ()
static void	DumpException (Exception ex)
	This dumps an exception.
static void	WriteToScreen (object sender, object output)
	Writes to in game debug. Activate the in-game debug window by running the 'cn' command.
static void	WriteToScreen (object sender, object output, Color color)
	Writes to in game debug. Activate the in-game debug window by running the 'cn' command.
static void	WriteToScreen (object text)
static void	WriteToScreen (object text, Color color)
static void	ClearInGameConsole ()
	Clears the Ingame console ahead of the draw call, this is helpful if you have a lot of information being outputed, but only need a certain amount.

Static Public Attributes
static bool	IsVerboseErrorLoggingEnabled = false
static Exception	lastLoggedException
static bool	DumpLogsOnClose = false

Detailed Description

Console Utility which provides output too both the in-game console window as well as the system console if available.

Member Function Documentation

DumpException()

static void VerticesEngine.vxConsole.DumpException ( Exception ex )

static

This dumps an exception.

Parameters

ex

Echo()

static void VerticesEngine.vxConsole.Echo ( string text )

static

Similar to the WriteLine method. This method writes out a line of text which is is prefixed with a "Networking" tag to the console output line to help distuignish it against regular console output.

Parameters

output

The object too be outputed in the console.

This sample shows how to call the WriteNetworkLine method.

vxConsole.WriteNetworkLine("Ping: " + foo.Ping.ToString());

Echos the Text to the Console

Parameters

text

NetLog() [1/2]

static void VerticesEngine.vxConsole.NetLog ( string text )

static

Logs a network message specifiying whether this instance is a server or client.

Parameters

text

NetLog() [2/2]

static void VerticesEngine.vxConsole.NetLog ( string text, ConsoleColor colour )

static

Net logs with a given colour.

Parameters

text
colour

WriteException()

static void VerticesEngine.vxConsole.WriteException ( object sender, Exception ex )

static

Writes out an error the error.

Parameters

SourceFile	Source file where the error is being sent from. Helpful for tracking where error's are being generated.
output	The object holding the error data too be outputed in the console.

This sample shows how to call the WriteError method.

try
{
    foo.bar();
}
catch(Exception ex)
{
    vxConsole.WriteError(this.ToString(), ex.Message);
}

WriteLine()

static void VerticesEngine.vxConsole.WriteLine ( object output )

static

Writes a debug line which is outputed to both the engine debug window and the system console.

If debug information is needed, this method is useful for outputing any object.ToString() value too both the in-engine debug window as well as the system console if it is available.

Parameters

output

The object too be outputed in the console.

This sample shows how to call the WriteLine method.

vxConsole.WriteLine("Output of Foo is: " + foo.Output.ToString());

This sample shows how to call the WriteLine method with different variable types as inputs.

vxConsole.WriteLine(string.Format("X,Y,Z Max: {0}, {1}, {2}", Level_X_Max, Level_Y_Max, Level_Z_Max));

WriteToScreen() [1/2]

static void VerticesEngine.vxConsole.WriteToScreen ( object sender, object output )

static

Writes to in game debug. Activate the in-game debug window by running the 'cn' command.

NOTE: This is different than the Engine Debug console.

Parameters

output

The object holding the error data too be outputed in the console.

This sample shows how to call the WriteToScreen method.

vxConsole.WriteToScreen("Player Position: " + foo.Position.ToString());

WriteToScreen() [2/2]

static void VerticesEngine.vxConsole.WriteToScreen ( object sender, object output, Color color )

static

Writes to in game debug. Activate the in-game debug window by running the 'cn' command.

NOTE: This is different than the Engine Debug console.

Parameters

output

The object holding the error data too be outputed in the console.

This sample shows how to call the WriteToScreen method.

vxConsole.WriteToScreen("Player Position: " + foo.Position.ToString(), Color.White);

WriteVerboseLine() [1/2]

static void VerticesEngine.vxConsole.WriteVerboseLine ( string output )

static

Writes out a Verbose Line. This line will be written to the console/output window if the Verbose Property is set too true.

Parameters

output

WriteVerboseLine() [2/2]

static void VerticesEngine.vxConsole.WriteVerboseLine ( string output, ConsoleColor consoleColor )

static

Writes out a Verbose Line. This line will be written to the console/output window if the Verbose Property is set too true.

Parameters

output
consoleColor

WriteWarning()

static void VerticesEngine.vxConsole.WriteWarning ( string SourceFile, string output )

static

Writes out a warning to the debug and system console.

Parameters

SourceFile	Source file where the warning is being sent from. Helpful for tracking where warning's are being generated.
output	The object holding the warning data too be outputed in the console.

This sample shows how to call the WriteWarning method.

try
{
    foo.bar();
}
catch(Exception ex)
{
    vxConsole.WriteWarning(this.ToString(), ex.Message);
}

---

The documentation for this class was generated from the following file:

• /github/workspace/src/VerticesEngine/src.shared/Utilities/vxConsole.cs