Language:
Page Info
Engine Version:

4. Scripting the Main Menu

Choose your OS:

Time to get our hands dirty and script the functionality of our Main Menu. At the end of this step we will be able to launch our game to the Main Menu, start our game as well as change the resolution inside the Options Menu.

  1. Open the MainMenu Widget Blueprint and click the Graph tab.

    Script1.png

  2. In the MyBlueprint window, select the PlayButton then in the Details panel click the plus sign next to On Clicked.

    Script2.png

    This will add a node to the graph that will execute whenever the button is clicked on.

  3. Add On Clicked Events for each of your buttons.

    Buttons.png

    We have arranged our Buttons in the graph to mimic the layout of our menu for clarity.

  4. Off the OnClicked(PlayButton), add a OpenLevel (set to FirstPersonExampleMap) node and a Remove from Parent node.

    PlayButton.png

    The Level Name is where you indicate the name of the level you want to load (in our case the First Person Example map). The Remove from Parent node will remove the target Widget Blueprint from the viewport. It is set to target itself (which is the Main Menu Widget Blueprint that we want to remove from view after the level has loaded).

  5. Hold Ctrl and drag in the MainMenu and OptionsMenu variables.

  6. Drag off MainMenu and add a Set Visibility node. Set In Visibility to Hidden.

  7. Drag off and add a Set Visibility node. Set Invisibility to Visible

  8. Attach target to the OptionsMenu variable.

    OptionsButton.png

    Here we are turning off the Main Menu when the Options Button is clicked and turning on the Options Menu.

  9. Off each of the Settings Buttons add an Execute Console Command node.

  10. For the Command for each, use r.setRes XxY where X and Y are the dimensions to use.

    Resolution.png

    Above we are using the following settings: 640x480, 1280x720 and 1920x1080.

  11. For the Return Button, repeat step 6 but reverse the settings so Main Menu is visible and Options Menu is hidden.

    ReturnButton.png

  12. Off the OnClicked (QuitButton) add an Execute Console Command set to the command Quit.

    QuitButton.png

  13. Compile and Save then close the Widget Blueprint.

  14. In the Content Browser, open the Main Level then open the Level Blueprint.

    OpenLevelBlueprint.png

  15. Right-click in the graph and add an Event Begin Play node and connect a Create Widget (set Class to Main Menu).

    EventBeginPlay.png

  16. Connect an Add to Viewport node and add a Get Player Controller node.

  17. Off Get Player Controller, add the Set Show Mouse Cursor node set to True, then Compile and close the Blueprint.

    FinishedLevel.png

  18. Open the First Person Character Blueprint inside the Content/FirstPersonBP/Blueprints folder.

  19. Following the Event Begin Play script, add a Get Player Controller then add a Set Input Mode Game Only node.

    PlayerCharacterBlueprint.png

    This will turn off the cursor and set the input for the player to Game Only.

  20. Compile and close the Blueprint, then open the World Settings.

    WorldSettings.png

  21. Under Game Mode, set the GameMode Override to FirstPersonGameMode and change the Default Pawn Class to Character.

    Overrides.png

    Here we are assigning a Game Mode for this Map and changing the player's character to use the Engine Default Character inside of the playable FirstPersonCharacter Blueprint as we do not want the player to be able to run around and shoot behind the Main Menu.

  22. Click the Play Button from the Main Toolbar to play in the editor. To test the resolution options, select New Editor Window from the Play-in-Editor dropdown menu.

    Click the image above to play the video.

    We have now created a Main Menu that is functional and allows the player to quit the game, change resolution options or play the game (which loads up the specified level and transitions the player into gameplay).

In the next step we will add an in-game pause menu so that the player can pause gameplay or quit the game and return to this Main Menu.