An in-game debugging system to make every developer happy. More...

Inheritance diagram for hDebug:

Classes
class	WatchedItem

Public Types
enum	DisplayLocation { DisplayLocation.Top = 1, DisplayLocation.Bottom = 2 }

enum	DisplayMode { DisplayMode.Off = 0, DisplayMode.Stats = 1, DisplayMode.Console = 2 }

Public Member Functions
void	ToggleMode ()

void	PageUp ()

void	PageDown ()

void	ScrollLeft ()

void	ScrollRight ()

Static Public Member Functions
static bool	Exists ()
	Does the Console already exist? More...

static void	Error (object obj)

static void	Error (string text)

static void	Error (string text, params object[] args)

static void	Initialize ()

static void	Log (object obj)

static void	Log (string text)

static void	Log (string text, params object[] args)

static void	Print (int x, int y, object obj)

static void	Print (int x, int y, string text)

static void	Print (int x, int y, string text, params object[] args)

static void	Print (int x, int y, Color color, object obj)

static void	Print (int x, int y, Color color, string text)

static void	Print (int x, int y, Color color, string text, params object[] args)

static void	Warn (object obj)

static void	Warn (string text)

static void	Warn (string text, params object[] args)

static void	Watch (string key, bool value)

static void	Watch (string key, string value)

static void	Watch (string key, int value)

static void	Watch (string key, float value)

static void	UnWatch (string key)

Public Attributes
const int	GlyphHeight = 8
	Height of a character from our fontImage. More...

const int	GlyphWidth = 8
	Width of a character from our fontImage. More...

bool	CheckForInput = true
	Should we monitor for input? More...

DisplayLocation	Location = DisplayLocation.Top
	Where should the console be displayed on the screen. More...

DisplayMode	Mode = DisplayMode.Off
	What should be displayed? Stats or Console? More...

KeyCode	ToggleKey = KeyCode.BackQuote
	What key should be used to toggle between modes. More...

Static Public Attributes
static Color	Shadow = Color.black

static bool	EchoToUnityLog = true

Properties
static hDebug	Instance `[get]`
	Gets the console instance, creating one if none is found. More...

int	ConsoleHeight `[get, set]`

Detailed Description

An in-game debugging system to make every developer happy.

This component does not follow our normal component/base model.

TODO: This is getting massively reworked.

Definition at line 38 of file hDebug.cs.

Member Enumeration Documentation

enum hDebug.DisplayLocation

Enumerator
Top
Bottom

Definition at line 191 of file hDebug.cs.

         {
                 Top = 1,
                 Bottom = 2,
         }

enum hDebug.DisplayMode

Enumerator
Off
Stats
Console

Definition at line 197 of file hDebug.cs.

         {
                 Off = 0,
                 Stats = 1,
                 Console = 2
         }

Member Function Documentation

static void hDebug.Error ( object obj )

static

Definition at line 243 of file hDebug.cs.

         {
                 hDebug.PushLog (obj.ToString (), LogType.Error);
         }

static void hDebug.Error ( string text )

static

Definition at line 248 of file hDebug.cs.

         {
                 hDebug.PushLog (text, LogType.Error);
         }

static void hDebug.Error	(	string	text,
		params object[]	args
	)

static

Definition at line 253 of file hDebug.cs.

         {
                 hDebug.PushLog (string.Format (text, args), LogType.Error);
         }

static bool hDebug.Exists ( )

static

Does the Console already exist?

Definition at line 238 of file hDebug.cs.

         {
                 return _staticInstance != null;
         }

static void hDebug.Initialize ( )

static

Definition at line 258 of file hDebug.cs.

         {
                 var foundConsole = FindObjectOfType (typeof(hDebug)) as hDebug;
                 if (foundConsole == null) {
                         var go = GameObject.Find (Hydrogen.Components.DefaultSingletonName) ??
                                  new GameObject (Hydrogen.Components.DefaultSingletonName);
                         go.AddComponent<hDebug> ();
                         _staticInstance = go.GetComponent<hDebug> ();
                 }
         }

static void hDebug.Log ( object obj )

static

Definition at line 269 of file hDebug.cs.

         {
                 hDebug.PushLog (obj.ToString (), LogType.Log);
         }

static void hDebug.Log ( string text )

static

Definition at line 274 of file hDebug.cs.

         {
                 hDebug.PushLog (text, LogType.Log);
         }

static void hDebug.Log	(	string	text,
		params object[]	args
	)

static

Definition at line 279 of file hDebug.cs.

         {
                 hDebug.PushLog (string.Format (text, args), LogType.Log);
         }

void hDebug.PageDown ( )

Definition at line 757 of file hDebug.cs.

         {
                 _logOffsetV -= ConsoleMaxDisplayedLines;
                 if (_logOffsetV < 0) {
                         _logOffsetV = 0;
                 }
         }

void hDebug.PageUp ( )

Definition at line 748 of file hDebug.cs.

         {
                 _logOffsetV += ConsoleMaxDisplayedLines;
                 int num = hDebug._logMessages.Count - ConsoleMaxDisplayedLines;
                 if (_logOffsetV > num) {
                         _logOffsetV = num;
                 }
         }

static void hDebug.Print	(	int	x,
		int	y,
		object	obj
	)

static

Definition at line 284 of file hDebug.cs.

         {
                 hDebug._printedText.Add (new hDebug.PrintedText (obj.ToString (), x, y, Color.white));
         }

static void hDebug.Print	(	int	x,
		int	y,
		string	text
	)

static

Definition at line 289 of file hDebug.cs.

         {
                 hDebug._printedText.Add (new hDebug.PrintedText (text, x, y, Color.white));
         }

static void hDebug.Print	(	int	x,
		int	y,
		string	text,
		params object[]	args
	)

static

Definition at line 294 of file hDebug.cs.

         {
                 hDebug._printedText.Add (new hDebug.PrintedText (string.Format (text, args), x, y, Color.white));
         }

static void hDebug.Print	(	int	x,
		int	y,
		Color	color,
		object	obj
	)

static

Definition at line 299 of file hDebug.cs.

         {
                 hDebug._printedText.Add (new hDebug.PrintedText (obj.ToString (), x, y, color));
         }

static void hDebug.Print	(	int	x,
		int	y,
		Color	color,
		string	text
	)

static

Definition at line 304 of file hDebug.cs.

         {
                 hDebug._printedText.Add (new hDebug.PrintedText (text, x, y, color));
         }

static void hDebug.Print	(	int	x,
		int	y,
		Color	color,
		string	text,
		params object[]	args
	)

static

Definition at line 309 of file hDebug.cs.

         {
                 hDebug._printedText.Add (new hDebug.PrintedText (string.Format (text, args), x, y, color));
         }

void hDebug.ScrollLeft ( )

Definition at line 765 of file hDebug.cs.

         {
                 _logOffsetH--;
 
         }

void hDebug.ScrollRight ( )

Definition at line 771 of file hDebug.cs.

         {
                 _logOffsetH++;
                 if (_logOffsetH > 0)
                         _logOffsetH = 0;
         }

void hDebug.ToggleMode ( )

Definition at line 733 of file hDebug.cs.

         {
                 switch (Mode) {
                 case DisplayMode.Off:
                         Mode = DisplayMode.Stats;
                         break;
                 case DisplayMode.Stats:
                         Mode = DisplayMode.Console;
                         break;
                 case DisplayMode.Console:
                         Mode = DisplayMode.Off;
                         break;
                 }
         }

static void hDebug.UnWatch ( string key )

static

Definition at line 366 of file hDebug.cs.

         {
                 if (_watchedItems.ContainsKey (key))
                         _watchedItems.Remove (key);
         }

static void hDebug.Warn ( object obj )

static

Definition at line 314 of file hDebug.cs.

         {
                 hDebug.PushLog (obj.ToString (), LogType.Warning);
         }

static void hDebug.Warn ( string text )

static

Definition at line 319 of file hDebug.cs.

         {
                 hDebug.PushLog (text, LogType.Warning);
         }

static void hDebug.Warn	(	string	text,
		params object[]	args
	)

static

Definition at line 324 of file hDebug.cs.

         {
                 hDebug.PushLog (string.Format (text, args), LogType.Warning);
         }

static void hDebug.Watch	(	string	key,
		bool	value
	)

static

Definition at line 329 of file hDebug.cs.

         {
                 if (_watchedItems.ContainsKey (key) && _watchedItems [key].Type == WatchedItem.ItemType.Boolean) {
                         _watchedItems [key].Data = value.ToString ();
 
                 } else {
                         _watchedItems [key] = new WatchedItem (WatchedItem.ItemType.Boolean, key, value.ToString ());
                 }
         }

static void hDebug.Watch	(	string	key,
		string	value
	)

static

Definition at line 339 of file hDebug.cs.

         {
                 if (_watchedItems.ContainsKey (key) && _watchedItems [key].Type == WatchedItem.ItemType.String) {
                         _watchedItems [key].Data = value;
                 } else {
                         _watchedItems [key] = new WatchedItem (WatchedItem.ItemType.String, key, value);
                 }
         }

static void hDebug.Watch	(	string	key,
		int	value
	)

static

Definition at line 348 of file hDebug.cs.

         {
                 if (_watchedItems.ContainsKey (key) && _watchedItems [key].Type == WatchedItem.ItemType.Integer) {
                         _watchedItems [key].Data = value.ToString ();
                 } else {
                         _watchedItems [key] = new WatchedItem (WatchedItem.ItemType.Integer, key, value.ToString ());
                 }
         }

static void hDebug.Watch	(	string	key,
		float	value
	)

static

Definition at line 357 of file hDebug.cs.

         {
                 if (_watchedItems.ContainsKey (key) && _watchedItems [key].Type == WatchedItem.ItemType.Float) {
                         _watchedItems [key].Data = value.ToString ();
                 } else {
                         _watchedItems [key] = new WatchedItem (WatchedItem.ItemType.Float, key, value.ToString ());
                 }
         }

Member Data Documentation

bool hDebug.CheckForInput = true

Should we monitor for input?

Turn this off if your binding your own keys to the input methods.

Definition at line 87 of file hDebug.cs.

bool hDebug.EchoToUnityLog = true

static

Definition at line 117 of file hDebug.cs.

const int hDebug.GlyphHeight = 8

Height of a character from our fontImage.

Definition at line 43 of file hDebug.cs.

const int hDebug.GlyphWidth = 8

Width of a character from our fontImage.

Definition at line 47 of file hDebug.cs.

DisplayLocation hDebug.Location = DisplayLocation.Top

Where should the console be displayed on the screen.

Top or Bottom?

Definition at line 92 of file hDebug.cs.

DisplayMode hDebug.Mode = DisplayMode.Off

What should be displayed? Stats or Console?

Definition at line 96 of file hDebug.cs.

Color hDebug.Shadow = Color.black

static

Definition at line 116 of file hDebug.cs.

KeyCode hDebug.ToggleKey = KeyCode.BackQuote

What key should be used to toggle between modes.

Available where Keyboard input is received.

Definition at line 101 of file hDebug.cs.

Property Documentation

int hDebug.ConsoleHeight

getset

Definition at line 230 of file hDebug.cs.

hDebug hDebug.Instance

staticget

Gets the console instance, creating one if none is found.

The Object Pool.

Definition at line 210 of file hDebug.cs.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

Property Documentation