AgateLib.Core Class Reference

Class which contains methods commonly used by the entire library. More...

List of all members.

Public Member Functions
delegate void	KeepAliveDelegate ()
	Delegate for types which attach to the KeepAliveEvent.
Static Public Member Functions
static void	Initialize ()
	Initializes Core class. Can be called multiple times without adverse effects.
static void	KeepAlive ()
	Plays nice with the OS, by allowing events to be handled. This also handles user input events associated with the application, and polls joysticks if needed.
static void	ReportError (Exception e, ErrorLevel level)
	Saves an error message to the ErrorFile. Outputs a stack trace and shows a dialog box if the ErrorLevel is Bug or Fatal.
static void	ReportError (ErrorLevel level, string message, Exception e)
	Saves an error message to the ErrorFile. Outputs a stack trace and shows a dialog box if the ErrorLevel is Bug or Fatal.
static void	ReportError (ErrorLevel level, string message, Exception e, bool printStackTrace, bool showDialog)
	Saves an error message to the ErrorFile.
static void	ReportCrossPlatformError (string message)
Properties
static PlatformSpecific.Platform	Platform [get]
	Gets platform-specific methods.
static bool	IsActive [get, set]
	Gets or sets a bool value which indicates whether or not your app is the focused window. This will be automatically set if you created DisplayWindows by specifying a title and size, but not if they are attached to a control.
static bool	AutoPause [get, set]
	Gets or sets a bool value indicating whether or not Agate should automatically pause execution when the application loses focus.
static string	BaseDirectory [get]
	Returns the directory the application that was started resides in.
static string	ErrorFile [get, set]
	Gets or sets the file name to which errors are recorded. Defaults to "errorlog.txt".
static bool	AutoStackTrace [get, set]
	Gets or sets whether or not a stack trace is automatically used.
static CrossPlatformDebugLevel	CrossPlatformDebugLevel [get, set]
	Gets or sets a value indicating how AgateLib should deal with issues that may cause problems when porting to another platform.
Events
static KeepAliveDelegate	KeepAliveEvent
	Event which occurs when KeepAlive is called. This allows subsystems (such as GUI, Input, Sound) to make updates each frame.

---

Detailed Description

Class which contains methods commonly used by the entire library.

---

Member Function Documentation

static void AgateLib.Core.Initialize

(

)

[static]

Initializes Core class. Can be called multiple times without adverse effects.

static void AgateLib.Core.KeepAlive

(

)

[static]

Plays nice with the OS, by allowing events to be handled. This also handles user input events associated with the application, and polls joysticks if needed.

delegate void AgateLib.Core.KeepAliveDelegate

(

)

Delegate for types which attach to the KeepAliveEvent.

static void AgateLib.Core.ReportError	(	ErrorLevel	level,
		string	message,
		Exception	e,
		bool	printStackTrace,
		bool	showDialog
	)			[static]

Saves an error message to the ErrorFile.

Parameters:

	message	A message to print out before the exception's message.
	e
	level
	printStackTrace	Bool value indicating whether or not a stack trace should be written out.
	showDialog	Bool value indicating whether or not a message box should pop up with an OK button, informing the user about the error. If false, the error is silently written to the ErrorFile.

static void AgateLib.Core.ReportError	(	ErrorLevel	level,
		string	message,
		Exception	e
	)			[static]

Saves an error message to the ErrorFile. Outputs a stack trace and shows a dialog box if the ErrorLevel is Bug or Fatal.

Parameters:

	message	A message to print out before the exception's message.
	e
	level

static void AgateLib.Core.ReportError	(	Exception	e,
		ErrorLevel	level
	)			[static]

Saves an error message to the ErrorFile. Outputs a stack trace and shows a dialog box if the ErrorLevel is Bug or Fatal.

Parameters:

	e
	level

---

Property Documentation

bool AgateLib.Core.AutoPause [static, get, set]

Gets or sets a bool value indicating whether or not Agate should automatically pause execution when the application loses focus.

The automatic pause will occur during Core.KeepAlive(). This will prevent the DisplayWindow from being updated at all. As such, this should not be used in production builds if your app is windowed. Instead check the IsActive property and respond accordingly if your application is windowed..

bool AgateLib.Core.AutoStackTrace [static, get, set]

Gets or sets whether or not a stack trace is automatically used.

You may find it useful to turn this on during a debug build, and then turn if off when building the release version. The following code accomplishes that.

            #if _DEBUG
                AgateLib.Core.AutoStackTrace = true;
            #endif

string AgateLib.Core.BaseDirectory [static, get]

Returns the directory the application that was started resides in.

CrossPlatformDebugLevel AgateLib.Core.CrossPlatformDebugLevel [static, get, set]

Gets or sets a value indicating how AgateLib should deal with issues that may cause problems when porting to another platform.

string AgateLib.Core.ErrorFile [static, get, set]

Gets or sets the file name to which errors are recorded. Defaults to "errorlog.txt".

bool AgateLib.Core.IsActive [static, get, set]

Gets or sets a bool value which indicates whether or not your app is the focused window. This will be automatically set if you created DisplayWindows by specifying a title and size, but not if they are attached to a control.

PlatformSpecific.Platform AgateLib.Core.Platform [static, get]

Gets platform-specific methods.

---

Event Documentation

KeepAliveDelegate AgateLib.Core.KeepAliveEvent [static]

Event which occurs when KeepAlive is called. This allows subsystems (such as GUI, Input, Sound) to make updates each frame.

---

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

• Core.cs