Pause Game Function and in-game menu

The timer goes off. Oh no! you forgot that you have to take the pizza out of the oven! But you can't leave your precious game: you're in the middle of a boss battle-The final! If you stop now, you have to go all the way back to the beginning of the level. But on the other hand, that pizza looks pretty delicious... If only you could have your pizza and destroy the boss... Well with this resource, you can!


Hello! I am going to teach you how to simply make a pause game menu that will be accessed with "escape."

First, without any further ado, let's make a new test project so we don't have to worry about interfering codes.

So, Click "File > New Project..." on the top. Name your game (Ha ha!) and choose the "Platformer" template. Magnifique!

Next, we need to make the pause GUI. This part is rather easy if you follow my directions. So what you need to do is go to the GUI editor. The shortcut is (function)F10. So once you see the checkerboard pattern, press "Command N" to make a new GUI. It will ask you for the name you want, so write "PauseGameGui." Click create, making sure that the GUI Class is GuiControl.
Now we are at the part were you need to read carefully.
1. Click Toggle Palette next to "Snap to grid" on the top right.
2. Drag GuiWindowControl from the box that popped up and place it in the middle of the checkerboard.
3. Having done that, Refer to the text for best results.
If I didn't include a feild, that means that it isn't important.
---------------
-Text: Paused
-MaxLength: 1024
-ResizeWidth: Checked
-ResizeHeight: Checked
-CanMove: Checked
-CanClose: Checked
-CanMinimize: Checked
-CanMaximize: Checked
-MinSize: 5050
---------------
-ParentGroup: PauseGameGui
---------------
---------------
-IsContainer: Checked
---------------
This next section is the most important!
-Profile: GuiWindowProfile
-HorizSizing: Center
VertSizing: Center
-Position: 160 288
-Extent: 688 144
-MinExtent: 8 2
-CanSave: Checked
-Visible: Checked
---------------

Now you have a nice long box, right? The most important parts were the size and positioning. So now we need to make the buttons that will preform functions. I only am including an exit game, close menu and options dialog, but the rest is up to you, if you have a save function or something.
Back at the "Toggle Palette" button, click it if it's not still open and drag "GuiButtonControl" to the window you just made. The window should light up blue around the edges, so let go of the button. Set this button's position to "16 104"
Now, go to the bottom right were there is a field (text box) named "Text." edit it by clicking it and name the button to "Options."
Good! Now hit enter/return and the name should be updated.
Now we need to make it so the button opens up the "Options" menu. Edit "Command" which is above "Alt Command" and below "Variable."
Write in the box this exact script:
view plaincopy to clipboardprint?
Canvas.pushDialog(OptionsMenuGui);
Next, let's put in the "Exit Game" button. Let's make things simple and copy and paste the "Options Button." Position it to "536 104"
Rename it to "Exit Game." Set the command to
view plaincopy to clipboardprint?
endGame();
Now we need to make a close button, because nobody ever uses the "X" because it's too small. To substitute, just make a little button and name it "Close." but it on the top left. Extent "64 32" position, "16 24" Now the command must be
view plaincopy to clipboardprint?
pauseModeDeactive();
Under "Accelerator" write "escape (or a button of your choice to be the pause button"
Now we are done with that gui so press "Command S" and save it as "PauseGameGui". The extension *.gui should be added automatically so don't bother writing it. Now in the drop down menu on the top left, select "MainScreenGui"
Make a new button, and drag it off the screen to the left. (You can always gain access to the button again by looking at the GUI element tree on the top right)

Command:
view plaincopy to clipboardprint?
pauseModeActive();
Make the accelerator be the same button as the "close" button's accelerator.

Command S, Save and Replace...

Now close the gui editor. It's time to do some actual scripting. Go to this directory: "(Game Name)/game/gameScripts/MenuSytem/MainMenu.cs"
NOTE: If this directory and this file do not exist, please make sure to [u]create[/u] them. Afterwards, place this code in (Game Name)/game/gameScripts/game.cs:
view plaincopy to clipboardprint?
exec("./MenuSystem/MainMenu.cs");


So now, we need to make the actual code. Go to your gameScripts folder (in "game") and duplicate any of the *.cs files. Rename the copied file to "PauseScript.cs". Open PauseScript.cs and copy and paste the following code:

view plaincopy to clipboardprint?
///Function for pausing the game

function pauseModeActive()
{
$mainSceneGraph = sceneWindow2D.getSceneGraph();
$mainSceneGraph.setScenePause(true);
Canvas.pushDialog(SelectLevelGui);
Canvas.CursorOn();
Canvas.ShowCursor();
}
///Function for unpausing the game

function pauseModeDeactive()
{
$mainSceneGraph = sceneWindow2D.getSceneGraph();
$mainSceneGraph.setScenePause(false);
Canvas.popDialog(SelectLevelGui);
Canvas.CursorOff();
Canvas.HideCursor();
}

Great! now we need to make sure the game reads the pause script so it can use the functions. So in game/main.cs do this:
right below where it says
view plaincopy to clipboardprint?
exec("./gameScripts/game.cs");
write
view plaincopy to clipboardprint?
exec("./gameScripts/PauseScript.cs");
and also,
view plaincopy to clipboardprint?
exec("~/gui/PauseGameGui");

You're done! Launch the game, load a level and press escape. Note! If when you press the escape button the level ends, try removing this line from the second-to-last function in MainMenu.cs in "game/gameScripts/MenuSystem":
view plaincopy to clipboardprint?
GlobalActionMap.unbind(keyboard, "escape");

Thank you for reading this and please post a comment if this function is not working for you.

UPDATE: 1.1

Gave instructions to add an important directory.

-----------------

UPDATE 1.2

Fixed a problem with the quotes being replaced with
Quote: �. Please report this problem if it persists.

----------------

~AJPCEO