MinApp Tutorial #2 - Torque Tools Support

Download Code File

MinApp Tutorial #2 - Torque Tools Support

The purpose of this tutorial is to add in support for the built in Torque tools -- The GUI editor and Mission/Terrain Editor.

Originally this was going to be done in two steps, with the GUI editor and Mission/Terrain editor handled individually. This turned out to not be practical, as the "editors" are all wrapped together in code.

As with tutorial #1, this tutorial will use some pre-existing files from the stock Toqrue demo application. We are obviously not going to recreate the editors.

1) Copy files from stock Torque Demo Application to MinApp
Copy the directory "editor" from the example/common to minapp/common
Copy the following files from example/common/ui to minapp/common/ui:
guiEditorGui.gui
inspectDlg.gui
frameOverlayGui.gui
LoadFileDlg.gui
MessagePopupDlg.gui
MessageBoxYesNoDlg.gui
MessageBoxOkDlg.gui
MessageBoxOkCancelDlg.gui
SaveFileDlg.gui
InspectAddFieldDlg.gui
torqueCheck.png
torqueMenu.png
torqueRadio.png

Copy messageBox.cs from example/common/client to minapp/common/client

In tutorial #1 we added additional default profile code to the file defaultProfiles.cs. A large amount of the default profiles were still missing, and are needed for this step in the process. Instead of going through and adding in every single default profile, I determined it was just better to simply copy the file over, giving us all the default profiles. This really has no effect on us pulling things out later, as we can always leave the default profiles in. They are usefull for things other than our tools.

Copy defaultProfiles.cs from example/common/ui to minapp/common/ui

2) Modify minapp/common/client/canvas.cs

We need to add in the exec() statements for our new UIs as well as one helper script. In the function initCanvas() add the code signified in bold below.

// Commonly used helper scripts
   exec("./cursor.cs");
[b]   exec("./messageBox.cs");[/b]
   
   // Common GUI's
   exec("~/ui/ConsoleDlg.gui");
[b]   exec("~/ui/GuiEditorGui.gui");
   exec("~/ui/InspectDlg.gui");
   exec("~/ui/LoadFileDlg.gui");
   exec("~/ui/SaveFileDlg.gui");
   exec("~/ui/MessageBoxOkDlg.gui");
   exec("~/ui/MessageBoxYesNoDlg.gui");
   exec("~/ui/MessageBoxOKCancelDlg.gui");
   exec("~/ui/MessagePopupDlg.gui");[/b]

What does this do?
What we have done here is pretty much the same thing we did in tutorial #1. We are setting our gui files to be ran at startup. The messageBox.cs file is a helper script for using message boxes in our application.

3) Modify minapp/common/main.cs

In the initCommon() function, we need to add in the script file which sets up all the editor functions. Once again, the code to be added is in bold.

function initCommon()
{
   // All mods need the random seed set
   setRandomSeed();

   // Very basic functions used by everyone
   exec("./client/canvas.cs");
   
[b]   // Editor support
   exec("./editor/editor.cs");[/b]
   
}

What does this do?
The script editor.cs initializes and sets up the editor for use.