Visual3D Game Engine API Documentation for XNA, C#, VB, and .NET

Provides configurable access for writing to a log file, making assertions, and handling errors.

Namespace: Visual3D
Assembly: Visual3D (in Visual3D.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


	C#			Visual Basic

public class Logger : INamed

Public Class Logger _
	Implements INamed

Members

All Members

Constructors Public method

Fields

Properties Public property

Methods

Events

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	Logger()()()()	Initializes a new instance of the Logger class
	Logger(String)	Initializes a new instance of the Logger class
	Logger(LogLevel)	Initializes a new instance of the Logger class
	ArgumentInvalid(String, Object, String, array<Object>[]()[][])
	ArgumentNull(String)
	ArgumentNull(String, String, array<Object>[]()[][])
	Assert(Boolean)	DEBUG MODE ONLY. Asserts that the boolean expression is True, else it fails the assertion.
	Assert(Boolean, String)	DEBUG MODE ONLY. Asserts that the boolean expression is True, else it fails the assertion.
	Assert(Boolean, String, array<Object>[]()[][])	DEBUG MODE ONLY. Asserts that the boolean expression is True, else it fails the assertion.
	AssertAlways(Boolean)	In debug and release mode, asserts that the boolean expression is True, else it fails the assertion.
	AssertAlways(Boolean, String)	In debug and release mode, asserts that the boolean expression is True, else it fails the assertion.
	AssertAlways(Boolean, String, array<Object>[]()[][])	In debug and release mode, asserts that the boolean expression is True, else it fails the assertion.
	AssertEquals(Object, Object, String)	DEBUG MODE ONLY. Asserts that the two values are equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertEquals<(Of <<'(T>)>>)(T, T, String)	DEBUG MODE ONLY. Asserts that the two values are equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertEquals<(Of <<'(T>)>>)(T%, T%, String)	DEBUG MODE ONLY. Asserts that the two values are equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertEqualsAlways(Object, Object, String)	In debug and release mode, asserts that the two values are equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertEqualsAlways<(Of <<'(T>)>>)(T, T, String)	In debug or release mode, asserts that the two values are equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertEqualsAlways<(Of <<'(T>)>>)(T%, T%, String)	In debug or release mode, asserts that the two values are equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertIsNull(Object, String)	DEBUG MODE ONLY. Asserts the expression is null.
	AssertIsNullAlways(Object, String)	Asserts the expression is null.
	AssertMode	Mode for handling Assertion Failures.
	AssertNotEquals(Object, Object, String)	DEBUG MODE ONLY. Asserts that the two values are not equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertNotEquals<(Of <<'(T>)>>)(T, T, String)	DEBUG MODE ONLY. Asserts that the two values are not equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertNotEquals<(Of <<'(T>)>>)(T%, T%, String)	DEBUG MODE ONLY. Asserts that the two values are not equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertNotEqualsAlways(Object, Object, String)	In debug and release mode, asserts that the two values are not equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertNotEqualsAlways<(Of <<'(T>)>>)(T, T, String)	In debug or release mode, asserts that the two values are not equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertNotEqualsAlways<(Of <<'(T>)>>)(T%, T%, String)	In debug or release mode, asserts that the two values are not equal, and if they are not equal, than the assertion fails, resulting in it being logged and possibly a notice being shown.
	AssertNotNull(Object, String)	DEBUG MODE ONLY. Asserts the expression is not null.
	AssertNotNullAlways(Object, String)	Asserts the expresion is not null.
	ConsoleWriteLevel
	Critical(Exception)	Logs Critical Error Message.
	Critical(String)	Logs Critical Error Message.
	Critical(Exception, String)	Logs Critical Error Message.
	Critical(String, array<Object>[]()[][])	Logs Critical Error Message.
	Critical(Exception, String, array<Object>[]()[][])	Logs Critical Error Message.
	CriticalDebug(String, array<Object>[]()[][])
	CriticalOrError(Boolean, Exception, String, array<Object>[]()[][])
	Debug(Exception)	DEBUG MODE ONLY: Logs Debug Message.
	Debug(String)	DEBUG MODE ONLY: Logs Debug Message.
	Debug(Exception, String)	DEBUG MODE ONLY: Logs Debug Message.
	Debug(String, array<Object>[]()[][])	DEBUG MODE ONLY: Logs Debug Message.
	Debug(Exception, String, array<Object>[]()[][])	DEBUG MODE ONLY: Logs Debug Message.
	DebugWarnIfDuplicate(MulticastDelegate, Delegate)	DEBUG MODE ONLY: Checks the 'event' to see if the new Listener is already in the list, and if so, will log a Warning along with a stack trace, so that the issue can be resolved.
	DebugWarning(String, array<Object>[]()[][])	DEBUG MODE ONLY: Logs Debug Message as a WARNING.
	DefaultTickThreshold
	Error(Exception)	Logs Error Message.
	Error(String)	Logs Error Message.
	Error(Exception, String)	Logs Error Message.
	Error(String, array<Object>[]()[][])	Logs Error Message.
	Error(ErrorHandling, Exception)	Logs Error Message.
	Error(ErrorHandling, String)	Logs Error Message.
	Error(Exception, String, array<Object>[]()[][])	Logs Error Message.
	Error(ErrorHandling, Exception, String)	Logs Error Message.
	Error(ErrorHandling, String, array<Object>[]()[][])	Logs Error Message.
	Error(ErrorHandling, Exception, String, array<Object>[]()[][])	Logs Error Message.
	ErrorBoxLevel	LogLevel above which Notifications are sent (e.g. might notify user immediately, or it might send message to network listener, etc).
	ErrorDebug(String, array<Object>[]()[][])
	ExceptionCountTimeWindow
	ExceptionsPerSecondThresholdBeforeCriticalErrorMessage
	Flush()()()()
	GetLogLevelFor(ErrorHandling)
	GetLogLevelFor(IssueHandling)
	HandleFailedAssertion	Target this delegate to a method that handles the Failed Assertions.
	HaveDefaultConfiguration
	Info(Exception)	Logs Informative Message.
	Info(String)	Logs Informative Message.
	Info(Exception, String)	Logs Informative Message.
	Info(String, array<Object>[]()[][])	Logs Informative Message.
	Info(Exception, String, array<Object>[]()[][])	Logs Informative Message.
	InfoDebug(String, array<Object>[]()[][])	DEBUG MODE ONLY: Logs Informative Message.
	IsDebugOn	Indicates if this Logger is configured to show Debug Logs by default.
	IsEnabled
	IsErrorOn	Indicates if this Logger is configured to show Error Logs by default.
	IsInfoOn	Indicates if this Logger is configured to show Info Logs by default.
	IsVerboseOn	Indicates if this Logger is configured to show Verbose Logs by default.
	IsWarningOn	Indicates if this Logger is configured to show Warning Logs by default.
	Log(LogLevel, Exception, String, array<Object>[]()[][])	Logs Error Message.
	LogEventHandler
	LogLevel	Default Log Level for this specific Logger instance.
	LogWritten
	MaxExceptionLevelsShown
	Message(LogLevel, Exception)	Logs a message of the specified LogLevel entry type.
	Message(LogLevel, String)	Logs a message of the specified LogLevel entry type.
	Message(LogLevel, Exception, String)	Logs a message of the specified LogLevel entry type.
	Message(LogLevel, String, array<Object>[]()[][])	Logs a message of the specified LogLevel entry type.
	Message(LogLevel, Exception, String, array<Object>[]()[][])	Logs a message of the specified LogLevel entry type.
	Name	Full Name of the logger, often indicates Namespace + LoggerName.
	New()()()()	Creates and Registers the new Logger instance, assuming default fieldname "Log".
	New(String)	Creates and Registers the new Logger instance.
	New(LogLevel)	Creates and Registers the new Logger instance.
	New(String, LogLevel)	Creates and Registers the new Logger instance.
	Null
	PerformanceMon
	RequiresWindowedModeNow	This value is polled by the Engine and will comply with it, if in FullScreen mode when this changes to true -- it will then switch over to Windowed mode. The purpose of this is to enable Windows Form Dialog to actually show up!
	Tick()()()()
	Tick(Int32)
	Tick(String)
	Tick(String, Int32)
	TickMsg(String)
	TickMsg(String, array<Object>[]()[][])
	ToString()()()()	Only output the Name. (Overrides Object..::..ToString()()()().)
	Verbose(Exception)	DEBUG MODE ONLY: Logs Verbose Message.
	Verbose(String)	DEBUG MODE ONLY: Logs Verbose Message.
	Verbose(Exception, String)	DEBUG MODE ONLY: Logs Verbose Message.
	Verbose(String, array<Object>[]()[][])	DEBUG MODE ONLY: Logs Verbose Message.
	Verbose(Exception, String, array<Object>[]()[][])	DEBUG MODE ONLY: Logs Verbose Message.
	Warn(Exception)	Logs Warning Message.
	Warn(String)	Logs Warning Message.
	Warn(Exception, String)	Logs Warning Message.
	Warn(String, array<Object>[]()[][])	Logs Warning Message.
	Warn(Exception, String, array<Object>[]()[][])	Logs Warning Message.
	WarnDebug(String, array<Object>[]()[][])	DEBUG MODE ONLY: Logs Warning Message.
	WarnOrError(Boolean, Exception)	Logs Warning Message.
	WarnOrError(Boolean, String)	Logs Warning Message.
	WarnOrError(Boolean, Exception, String)	Logs Warning Message.
	WarnOrError(Boolean, String, array<Object>[]()[][])	Logs Warning Message.
	WarnOrError(Boolean, Exception, String, array<Object>[]()[][])	Logs Warning Message.
	WarnOrInfo(Boolean, String)	Logs a Warning or Info Message.
	WarnOrInfo(Boolean, String, array<Object>[]()[][])	Logs a Warning or Info Message.
	WarnTrace(String, array<Object>[]()[][])	Logs Warning Message.
	Writer	Global Log Writer used for logging messages.
	WriterName	Name of the Writer to which all log output for this logger are sent.

Inheritance Hierarchy

System..::..Object
Visual3D..::..Logger

Syntax

Members

Inheritance Hierarchy

See Also