Debug Gui (simple gui example/to use)

#1 (add this to the .gui file also - was too long for one post)

function HelperGui::onWake(%this)
{
	sceneName.setText("t2dSceneGraph");
	%this.hidden = false;
	%this.mode[%this.convertToNum(BB)] = false;
	%this.mode[%this.convertToNum(ColPoly)] = false;
	%this.mode[%this.convertToNum(MNodes)] = false;
	%this.mode[%this.convertToNum(MLink)] = false;
	%this.mode[%this.convertToNum(WLimit)] = false;
	%this.mode[%this.convertToNum(All)] = false;

	DebugControls.setVisible(true);
}

function HelperGui::convertToNum(%this, %char)
{
	switch$(%char)
	{
	case "BB": 
		return 0;
	case "ColPoly":
		return 1;
	case "MNodes":
		return 2;
	case "MLink":
		return 3;
	case "WLimit":		
		return 4;
	case "ALL":
		return 5;
	}
}

function HelperGui::setMode(%this, %mode)
{
	%this.scene = sceneName.getText();

	if(%mode !$= "ALL")
		if(%this.mode[%this.convertToNum(ALL)] $= true)
		{
			%this.mode[%this.convertToNum(ALL)] = false;
			%this.turnDebugOff(ALL);
		}

	if(%this.mode[%this.convertToNum(%mode)] $= true)
	{
		%this.mode[%this.convertToNum(%mode)] = false;
		echo("turning off:" SPC %mode);
		%this.turnDebugOff(%mode);
	} else
	{
		%this.mode[%this.convertToNum(%mode)] = true;
		echo("turning on:" SPC %mode);

		%this.turnDebugOn(%mode);
	}
	



}

function HelperGui::turnDebugOn(%this, %mode)
{
	switch$(%mode)
	{
	case "BB": 
		(%this.scene).setDebugOn(BIT(1));
	case "ColPoly":
		(%this.scene).setDebugOn(BIT(5));
	case "MNodes":
		(%this.scene).setDebugOn(BIT(2));
	case "MLink":
		(%this.scene).setDebugOn(BIT(3));
	case "WLimit":		
		(%this.scene).setDebugOn(BIT(4));
	case "ALL":
		(%this.scene).setDebugOn(0xFFFFFF);
	}
}

function HelperGui::turnDebugOff(%this, %mode)
{
	switch$(%mode)
	{
	case "BB": 
		(%this.scene).setDebugOff(BIT(1));
	case "ColPoly":
		(%this.scene).setDebugOff(BIT(5));
	case "MNodes":
		(%this.scene).setDebugOff(BIT(2));
	case "MLink":
		(%this.scene).setDebugOff(BIT(3));
	case "WLimit":		
		(%this.scene).setDebugOff(BIT(4));
	case "ALL":
		(%this.scene).setDebugOff(0xFFFFFF);
	}
}

function HelperGui::hide(%this)
{
	if(%this.hidden $= false)
	{
			DebugControls.setVisible(false);
		%this.hidden = true;
	} else
	{
		DebugControls.setVisible(true);
		%this.hidden = false;
	}
}

now go to your "client.cs"


find

// Load-up Datablocks.	
	exec("./datablocks.cs");
	// Load-up GUIs.
	exec("./mainScreenGui.gui");

then add this right after it

exec("./HelperGui.gui");

thats how you add a gui so you can load it ... now go down a couple lines and find

// Set GUI.
	Canvas.setContent(mainScreenGui);
	// Set Cursor.
	Canvas.setCursor(DefaultCursor);
	//Canvas.pushDialog(HelperGui);

and add this

mainScreenGui.add(HelperGui);

this will add it to the main gui so you can use it at the same time... note the hide button that i will hide the buttons out of the way... and the text input box is for whatever you want to set debug modes for... leave it as default if you want to change all and haven't changed your sceneGraph name...

#2 Some pics

#3 Awsome, im adding this in.

Ive been spending all my time trying to learn the gui system and not getting any work done on my lil tool. So today im going to stop and work on the real meat of it.

Where are the docs that can tell you every script function and hopefully with a lil description?

#4 Thanks Matt! You rock. :)

Chris, see this page and look at the "Scripting documentation" section. :)

#5 Pretty cool. What's the purpose of the text field? It eats all of the key presses so I can't control anything in the game while running.

#6 Ouch, sorry Seth did this at work so didn't test it too much, to fix that do change this

modified the first post to include these changes :)

new GuiButtonCtrl() {
      profile = "GuiButtonProfile";
      horizSizing = "right";
      vertSizing = "bottom";
      position = "380 0";
      extent = "40 15";
      minExtent = "8 2";
      visible = "1";
      text = "ALL";
      groupNum = "1";
      buttonType = "PushButton";
	command = "HelperGui.setMode(ALL);";
   };
   };

   new GuiButtonCtrl() {
      profile = "GuiButtonProfile";
      horizSizing = "right";
      vertSizing = "bottom";
      position = "420 0";
      extent = "40 15";
      minExtent = "8 2";
      visible = "1";
      text = "Hide";
      groupNum = "-1";
      buttonType = "PushButton";
	command = "HelperGui.hide();";
   };

   new GuiMLTextEditCtrl(sceneName) {
      profile = "GuiMLTextEditProfile";
      horizSizing = "right";
      vertSizing = "bottom";
      position = "465 0";
      extent = "120 18";
      minExtent = "8 2";
      visible = "1";
      lineSpacing = "2";
      allowColorChars = "0";
      maxChars = "-1";
   };


};
//--- OBJECT WRITE END ---

to

new GuiButtonCtrl() {
      profile = "GuiButtonProfile";
      horizSizing = "right";
      vertSizing = "bottom";
      position = "380 0";
      extent = "40 15";
      minExtent = "8 2";
      visible = "1";
      text = "ALL";
      groupNum = "1";
      buttonType = "PushButton";
	command = "HelperGui.setMode(ALL);";
   };
   

  
   new GuiMLTextEditCtrl(sceneName) {
      profile = "GuiMLTextEditProfile";
      horizSizing = "right";
      vertSizing = "bottom";
      position = "420 0";
      extent = "120 18";
      minExtent = "8 2";
      visible = "1";
      lineSpacing = "2";
      allowColorChars = "0";
      maxChars = "-1";
   };
};
 new GuiButtonCtrl() {
      profile = "GuiButtonProfile";
      horizSizing = "right";
      vertSizing = "bottom";
      position = "540 0";
      extent = "40 15";
      minExtent = "8 2";
      visible = "1";
      text = "Hide";
      groupNum = "-1";
      buttonType = "PushButton";
	command = "HelperGui.hide();";
   };



};
//--- OBJECT WRITE END ---

basically you just moved a bracket so the text field is included in "Debug Controls" and swaping the text field's position with the hide button.... that way when you click hide it will hide the text field too...

#7 Cool. Thanks!

#8 Btw sorry didn't tell you what the text field was for... when you hit debug buttons it applies that mode to the object in there, by default I have it set to the default scengraph which will set it for all.. if you renamed the scengraph you'd put the new name there... or say when you create the player

$player = new fxStaticSprite2D() { scenegraph = t2dSceneGraph; };

if you do

$player = new fxStaticSprite2D(Player) { scenegraph = t2dSceneGraph; };

you then could put "Player" in the text field and apply the debug modes to just that object

#9 Very nice. I've already found it useful

#10 One of the ideas I had for the T2D debug-info was the ability to pass an expression (such as a variable) and have T2D add it to a special section of the debug-info, sort of like a class "tweaker".

Maybe I'll get around to that one day.

Good work Matthew.

- Melv.