HamstarHelpers.Helpers.Debug.DebugHelpers Class Reference

Assorted static "helper" functions pertaining to debugging and debug outputs. More...

Static Public Member Functions
static IList< string >	GetContextSlice (int stackFrameIdx=1, bool omitNamespace=false, int max=-1, string until="Unknown Context")
	Gets a slice of the current method call (context) stack trace beginning at the specified frame (stack depth). More...
static string	GetCurrentContext (int stackFrameIdx=1)
	Gets the current method call (context) of a stack trace at the specified frame (stack depth). More...
static void	Print (string labelAndMsg)
	Prints a message to the screen for the given tick duration. Message overlaps chat area. Repeat calls to display a message of a given label merely update that existing message. More...
static void	Print (string msgLabel, string msg)
	Prints a message to the screen for the given tick duration. Message overlaps chat area. Repeat calls to display a message of a given label merely update that existing message. More...
static void	Print (string msgLabel, string msg, int tickDuration)
	Prints a message to the screen for the given tick duration. Message overlaps chat area. Repeat calls to display a message of a given label merely update that existing message. More...
static void	DrawRect (string id, Rectangle rect, bool isWorldPos, int duration)
	Draws a rectangle to screen. More...

Detailed Description

Assorted static "helper" functions pertaining to debugging and debug outputs.

Definition at line 11 of file DebugHelpers.cs.

Member Function Documentation

DrawRect()

static void HamstarHelpers.Helpers.Debug.DebugHelpers.DrawRect ( string  id, Rectangle  rect, bool  isWorldPos, int  duration  )

static

Draws a rectangle to screen.

Parameters

id	Unique identifier.
rect
isWorldPos
duration

Definition at line 35 of file DebugHelpers_Rect.cs.

GetContextSlice()

static IList<string> HamstarHelpers.Helpers.Debug.DebugHelpers.GetContextSlice ( int  stackFrameIdx = 1, bool  omitNamespace = false, int  max = -1, string  until = "Unknown Context"  )

static

Gets a slice of the current method call (context) stack trace beginning at the specified frame (stack depth).

Parameters

stackFrameIdx	Depth within the current call stack.
omitNamespace
max
until

Returns

Definition at line 21 of file DebugHelpers.cs.

GetCurrentContext()

static string HamstarHelpers.Helpers.Debug.DebugHelpers.GetCurrentContext ( int  stackFrameIdx = 1 )

static

Gets the current method call (context) of a stack trace at the specified frame (stack depth).

Parameters

stackFrameIdx

Depth within the current call stack.

Returns

Method, class, and namespace of the given frame of the current call stack.

Definition at line 66 of file DebugHelpers.cs.

Print() [1/3]

static void HamstarHelpers.Helpers.Debug.DebugHelpers.Print ( string  labelAndMsg )

static

Prints a message to the screen for the given tick duration. Message overlaps chat area. Repeat calls to display a message of a given label merely update that existing message.

Parameters

labelAndMsg

Identifier and message to display. Identifier is delineated by first occurrence of . in the string. Calling Print(...) with this same identifier replaces any existing displayed message of this identifier.

Definition at line 34 of file DebugHelpers_Print.cs.

Print() [2/3]

static void HamstarHelpers.Helpers.Debug.DebugHelpers.Print ( string  msgLabel, string  msg  )

static

Prints a message to the screen for the given tick duration. Message overlaps chat area. Repeat calls to display a message of a given label merely update that existing message.

Parameters

msgLabel	Identifier of the given message. Calling Print(...) with this same identifier replaces any existing displayed message of this identifier.
msg	Message to display.

Definition at line 49 of file DebugHelpers_Print.cs.

Print() [3/3]

static void HamstarHelpers.Helpers.Debug.DebugHelpers.Print ( string  msgLabel, string  msg, int  tickDuration  )

static

Prints a message to the screen for the given tick duration. Message overlaps chat area. Repeat calls to display a message of a given label merely update that existing message.

Parameters

msgLabel	Identifier of the given message. Calling Print(...) with this same identifier replaces any existing displayed message of this identifier.
msg	Message to display.
tickDuration	Tick duration to display the given message.

Definition at line 61 of file DebugHelpers_Print.cs.

---

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

• Project/HamstarHelpers/Helpers/Debugging/DebugHelpers.cs
• Project/HamstarHelpers/Helpers/Debugging/DebugHelpers_Print.cs
• Project/HamstarHelpers/Helpers/Debugging/DebugHelpers_Rect.cs