flexable GuiFadeCtrl

Download Code File

The .zip file contains guiFade.cc, guiFade.h, Ice-Dragon.jpg, init.cs, StartupGui.gui and Install.txt.

To install, simply follow the instructions in Install.txt or follow along here. I had to make changes to GuiCanvas.cc to resolve a bug introduced in the latest head. Currently the onSleep() function is called 2 times which causes issues. This might not be a valid fix in the eyes of GG; I added it to my copy of TGE roughly a week after the release of 1.2 and have had no ill effects.

The zip file contains a .cc, .h, .gui and a install.txt file

To install just follow the .txt or

Please make a backup before you proceed

Replace your StartupGui.gui file with the one in the .zip file

Open up engine\gui\guiControl.cc and comment out line 487

void GuiControl::onSleep()
{
   AssertFatal(mAwake, "GuiControl::onSleep: control is not awake");
   if(!mAwake)
      return;

   //decrement the profile reference
   mProfile->decRefCount();
   clearFirstResponder();
   mouseUnlock();
      
   //set the flag
// RJY : This causes a double call to onSleep() which crashes the game
//   Con::executef(this, 1, "onSleep");
   mAwake = false;
}

and add the following around line 913 in function GuiCanvas::popDialogControl

if(didSleep)
		Con::executef(ctrl,1, "onSleep");

the function should look like

void GuiCanvas::popDialogControl(GuiControl *gui)
{
   if (size() < 1)
      return;
   
   //first, find the dialog, and call the "onDialogPop()" method
   GuiControl *ctrl = NULL;
   if (gui)
   {
      //make sure the gui really exists on the stack
      iterator i;
      bool found = false;
      for(i = begin(); i != end(); i++)
      {
         GuiControl *check = static_cast<GuiControl *>(*i);
         if (check == gui)
         {
            ctrl = check;
            found = true;
         }
      }
      if (! found)
         return;
   }
   else
      ctrl = static_cast<GuiControl*>(last());
   
   //call the "on pop" function   
   ctrl->onDialogPop();
   
   // sleep the object
   bool didSleep = ctrl->isAwake();
   
   //now pop the last child (will sleep if awake)
   removeObject(ctrl);
   
   // Save the old responder:
   GuiControl *oldResponder = mFirstResponder;

	if(didSleep)
		Con::executef(ctrl,1, "onSleep");

   Sim::getGuiGroup()->addObject(ctrl);
   
   if (size() > 0)
   {
      GuiControl *ctrl = static_cast<GuiControl *>(last());
      mFirstResponder = ctrl->mFirstResponder;
   }
   else
   {
      mFirstResponder = NULL;
   }
   
   if (oldResponder && oldResponder != mFirstResponder)
      oldResponder->onLoseFirstResponder();
         
   //refresh the entire gui
   resetUpdateRegions();
   
   //rebuild the accelerator map
   mAcceleratorMap.clear();
   if (size() > 0)
   {
      GuiControl *ctrl = static_cast<GuiControl*>(last());
      ctrl->buildAcceleratorMap();
   }
   refreshMouseControl();
}

place the Ice-Dragon.jpg in the client\ui directory

Open up client\init.cs
Change

if ($JoinGameAddress !$= "") {
      // If we are instantly connecting to an address, load the
      // main menu then attempt the connect.
      loadMainMenu();
      connect($JoinGameAddress, "", $Pref::Player::Name);
   }
   else {
      // Otherwise go to the splash screen.
      Canvas.setCursor("DefaultCursor");
      loadStartup();
   }

to

if ($JoinGameAddress !$= "") {
      // If we are instantly connecting to an address, load the
      // main menu then attempt the connect.
      loadMainMenu();
      connect($JoinGameAddress, "", $Pref::Player::Name);
   }
   else {
      // Otherwise go to the splash screen.
      Canvas.setCursor("DefaultCursor");
      loadFadeImages();
   }

replace

function loadMainMenu()
{
   // Startup the client with the Main menu...
   Canvas.setContent( MainMenuGui );
   // Make sure the audio initialized.
   if($Audio::initFailed) {
      MessageBoxOK("Audio Initialization Failed", 
         "The OpenAL audio system failed to initialize.  " @
         "You can get the most recent OpenAL drivers <a:www.garagegames.com/docs/torque/gstarted/openal.html>here</a>.");
   }

   Canvas.setCursor("DefaultCursor");
}

with

function loadMainMenu()
{
	echo("loadMainMenu()");
   // Startup the client with the Main menu...
		if( $currentMod $= "show" )
		{
			Canvas.setContent( TSShowGui );		 
		} else {
		  	Canvas.setContent( MainMenuGui );
		}
		if($Audio::initFailed) {
			MessageBoxOK("Audio Initialization Failed", 
			"The OpenAL audio system failed to initialize.  " @
			"You can get the most recent OpenAL drivers <a:www.garagegames.com/docs/torque/gstarted/openal.html>here</a>.");
		}
   Canvas.setCursor("DefaultCursor");
}

add the following after the loadMainMenu function

function StartupGui::onWake(%this)
{
   echo("onWake()");
}

function StartupInputCtrl::onInputEvent(%this, %dev, %evt, %make)
{
	echo("onInputEvent()");
	if(%make)
	{
		loadMainMenu();
	}
}

function loadFadeImages()
{
// Startup the client with the Main menu...
   echo("loadFadeImages()"); 
   Canvas.setContent( StartupGui );
}

function StartupGui::onSleep()
{
	echo("StartupGui::onSleep()");
	loadMainMenu();
}
function MainMenuGui::onWake(%this)
{
   if($missionArg !$= "") {
      %mis = $missionArg;
      $missionArg = "";
      SM_StartMission(%mis);
      return;
   }
}

;

I applied the above against a pull of the latest head and using the script files under starter.fps. If you find errors or that I have missed a step let me know.

-Ron