Antize

Complete Menu System

Documentation

1
Antize Complete Menu System
List of contents
1) Patch note (Same for the solo and multiplayer) ................................................................................. 4
2) Getting started .................................................................................................................................... 8
1 - Installation ...................................................................................................................................... 8
2 - Use custom Character .................................................................................................................. 10
3 - Use custom GameMode ............................................................................................................... 12
4 - Use custom GameInstance ........................................................................................................... 13
5 - Integrate the Option widget to a parent menu ........................................................................... 14
6 - Generals ....................................................................................................................................... 15
1: Why my Unreal Engine freeze when I start my game ? ............................................................ 15
2: Why do I see my HUD/Character in the Main Menu ? or get the error “Attention, you have
duplicated the option menu ! (Ignore if the game…” ................................................................... 15
3: Why I can’t click on the option menu ? ..................................................................................... 16
4: Fix “Input Axis/Action Event references unknown Axis/Action ‘Name’ for…” .......................... 17
5: Why my Unreal Engine crash when I try to change the Game Name on the W_MainMenu ? 17
3) Add Template to Menus.................................................................................................................... 18
1 - Add new Axis Template ................................................................................................................ 18
2 - Add new Action Template ............................................................................................................ 23
3 - Add new Graphic Template .......................................................................................................... 26
4 - Add new Audio Template ............................................................................................................. 30
5 - Add new Gameplay Template ...................................................................................................... 36
4) Add button to the navigation menu.................................................................................................. 41
1 - Option menu ................................................................................................................................ 41
2 - Main Menu ................................................................................................................................... 42
6) Setting up .......................................................................................................................................... 44
1 - Rename key .................................................................................................................................. 44
2 - Change Confirmation time ........................................................................................................... 45
3 - Configure Option menu (Background & More) ............................................................................ 45
4 - Configure Main menu (Logo, Game Name, Hide buttons & more) ............................................. 46
5 - Block an input type ....................................................................................................................... 46
6 - Configure Intro settings................................................................................................................ 47
7 - Configure Create Server settings.................................................................................................. 47
8 - Configure Credits .......................................................................................................................... 48
9 - Change key to Open/Close Option ............................................................................................... 49
10 - Disable a section in option menu ............................................................................................... 50
11 - Change the Main Menu music and UI sounds ........................................................................... 51

2
Antize Complete Menu System
 12 - Change loading tips .................................................................................................................... 51
13 - Create a new map and change default map .............................................................................. 52
1: Setting up a new map ................................................................................................................ 52
2: Change default map (Singleplayer) ........................................................................................... 52
3: Change default map (Multiplayer) ............................................................................................ 53
14 - Change class sound .................................................................................................................... 54
15 - Add Advanced session plugin ..................................................................................................... 55
16 - Change loading time................................................................................................................... 55
17 - Use Enhanced input ................................................................................................................... 56
1: Action ........................................................................................................................................ 57
2: Axis ............................................................................................................................................ 59
18 - Unlock a level ............................................................................................................................. 61
1: Default ....................................................................................................................................... 61
2: In-Game ..................................................................................................................................... 61
19 - Join a level (In-game).................................................................................................................. 62
7) Add language ..................................................................................................................................... 62

3
Antize Complete Menu System
1) Patch note (Same for the solo and multiplayer)
What's new in v1.31A update? (06/08/2023) - (Step in Google Drive)
• Fixed - GamepadStyle detection problem
• Fixed - Back from Options widget from MainMenu
https://drive.google.com/drive/u/1/folders/1w4cVwpO_1aGuLBEyopWk9KrTIEDCKwyZ

What's new in v1.31 update? (14/07/2023)

• Improved - Options widget is now FadeInOut on the main menu
• Improved - Added graphic settings
• Improved - Reset the mouse position on GamepadStyle
• Fixed - TemplateGraphic doesn't do MakeBackup when IgnoreOnMainMenu is true
• Fixed - The Template navigation is now centered

What's new in v1.30 update? (26/05/2023)

• Added - Choice to hide or disable the level selector
• Added - Save count and tooltips added to load button
• Improved - Hover and gamepad color for level sector (factorized)
• Fixed - Automatically create a save when players are in the main menu
• Fixed - Graphic template, apply won't save on swap

What's new in v1.29 update? (11/05/2023)

• Added - Create new save button in options widget
• Added - Join level blueprint template
• Added - Save and level unlocker
• Fixed - Override title colour setting

What's new in v1.28 update? (25/04/2023)

• Improved - Input selector for gamepad

What's new in v1.27 update? (18/04/2023)

• Added - Show/Hide setting for News and Credit buttons
• Hotfix - Reset Option position on close

What's new in v1.26 update? (20/03/2023)

• Added - Load section on pause menu
• Improved - Check for focus on W_Options (Big rework and optimization)
• Hotfix

What's new in v1.25 update? (27/02/2023)

• Added - Show/Hide setting for Load & Continue buttons
• Improved - Integration (Game Instance)

What's new in v1.24 update? (15/01/2023)

• Fixed - Gamepad support
What's new in v1.23 update? (13/01/2023)
• Fixed - Compatibility with UE 5
• Improved - Back to the previous screen with Escape or Gamepad B
• Improved - Added a new button on main menu

4
Antize Complete Menu System
 • Improved - Integration
• Added - Level & map selection
• Hotfix

What's new in v1.22 update? (01/12/2022)

• Fixed - Modifier on inputs
• Fixed - Credits & Loading visibility at pre-construct
• Improved - Integration (Big rework)

What's new in v1.21 update? (11/10/2022)

• Added - Load button on load slot
• Added - Logo settings
• Added - Hide Lan button setting
• Removed - Tooltips on the project name
• Replaced - Music fade on option menu
• Fixed - Navigation on multiplayer page
• Fixed - Click when intro
What's new in v1.20 update? (15/07/2022)
• Added - Position on option
• Removed - Check for Axis gamepad scale
• Fixed - Music missing on main menu error
What's new in v1.19 update? (09/06/2022)
• Fixed - Override color on button

What's new in v1.18 update? (17/07/2021)

• Improved - variable tooltips In MasterInteract
• Improved - Save verification in LevelBP
• Added - LevelName and sample in the MasterSave

What's new in v1.17 update? (27/11/2020)

• Fixed - Hovered style OnClick Save/Resume
• Improved - Now collapse W_Options
• Improved - Loading screen show
• Added - OnClick sound in W_CreateServer

What's new in v1.16 update? (13/05/2020)

• Added - Check for duplicate instance of W_Options
• Added - Check array size
• Added - More option for W_MouseTemplate
• Correction - Misspelled
• Fixed - Now hide difficulty text on Button_BackNewGame
• Fixed - Now hide tip content on an empty tip on W_LoadingScreen

What's new in v1.15 update? (24/04/2020)

• Fixed - Focus on hidden button (Gamepad)

What's new in v1.14 update? (20/04/2020)

• Added - News

5
Antize Complete Menu System
 • Added - Hide username
• Improved - StyleCheck code
• Improved - Set actor in range
• Fixed - Navigation on hide join by IP
• Fixed - Mistake on MaxFPS

What's new in v1.13 update? (06/04/2020)

• Improved - MouseHover and StyleCheck (Collapsed Graph)
• Improved - SetSelectedStyle
• Improved - Get widget by Actual/Before variable
• Improved - Username in multiplayer section
• Added - Tips on loading screen

What's new in v1.12 update? (29/02/2020)

• Correction - Misspelled (Hight to High)
• Fixed - Left mouse on key binding

What's new in v1.11 update? (20/02/2020)

• Added - Can get supported resolutions list

What's new in v1.10 update? (30/01/2019)

• Fixed - Bug on server list with gamepad navigation
• Added - Apply button on graphic settings
• Hovered & UnHovered improvement

What's new in v1.09 update? (01/01/2019)

• Added - Music on menus
• Added - Click & Hovered sound on menus
• Fixed - Mouse clicks blocked on Loading screen
• Added - Skip on intro
• Added - Fade animation on credits

What's new in v1.08 update? (17/12/2019)

• Added - Tooltips to help
• Added - Settings on Loading Screen

What's new in v1.06 update? (21/11/2019)

• Added - Credits (Asked by community)
• Fixed - Bug when leave a server

What's new in v1.05 update? (14/11/2019)

• Mapping simplified

What's new in v1.04 update? (10/11/2019)

• Added - Intro
• Added - Lan button for Search server
• Added - Create server page
• Correction on French localization
• Correction on Join Session
• Widgets & loading screen improvement

6
Antize Complete Menu System
What's new in v1.03 update? (07/11/2019)
• Added - Localization (Asked by community)

What's new in v1.02 update? (06/11/2019)

• Added - Loading screen (Asked by community)
• Improved - Resolution and Screen Mode change

7
Antize Complete Menu System
2) Getting started
1 - Installation
1. Open your Epic Games Launcher and go the Library tab in Unreal Engine Section and search menu

2. Click on Add to project and select the project you want to add to. It will create a directory called
AntizeMenuSystem or AntizeMenuSystemSolo in your content folder

2.1. To recover French translation, go to “Add language” at page 65

8
Antize Complete Menu System
3. Now you have to define custom GameInstance and default map in your project settings, open
Project Settings

4. Select BP_MainMenuGameInstance for Game Instance Class and MainMenuMap for Game
Default Map

9
Antize Complete Menu System
2 - Use custom Character
Do this step only if you already have your own Character, otherwise you can use the
BP_MainMenuCharacter of the asset

1. Activate BP_MainMenuInterface in your Character blueprint

2. Open BP_MainMenuCharacter blueprint

10
Antize Complete Menu System
3. Copy all events and the Component as in BP_MainMenuCharacter into your character blueprint
and make the interface (Refresh the added elements if you have a warning message)

Don't forget:
1. Replicate the component
2. Make the interface like in the BP_MainMenuCharacter

4. If you use BPMainMenuGameMode, override the Default Pawn Class by your Character blueprint

11
Antize Complete Menu System
3 - Use custom GameMode
Do this step only if you already have your own GameMode, otherwise you can use the
BP_MainMenuGameMode of the asset.

1. Copy all events from BP_MainMenuGameMode into your GameMode blueprint (Refresh the
added elements if you have a warning message)

12
Antize Complete Menu System
4 - Use custom GameInstance
Do this step only if you already have your own GameInstance, otherwise you can use the
BP_MainMenuGameInstance of the asset

1. Activate BP_MainMenuInterface in your GameInstance blueprint

2. Copy all events and the interface from BP_MainMenuGameInstance into your GameInstance
blueprint (Refresh the added elements if you have a warning message)

Don’t forget:
1. Set the default value of TimeLoadingBeforeContinue, it’s 1.1
2. Recall the loading function
3. Do the GetGameInstanceVariables interface

13
Antize Complete Menu System
5 - Integrate the Option widget to a parent menu
1. If you want to integrate the option in a parent menu, you must give the reference of your widget
when W_Options is created, set Self to ParentWidgetRef (Here is an example of how to do it)

2. To open the option menu from your parent widget you have to call Show/Hide from W_Options
and hide your parent widget (Here is an example of how to do it)

Quit to Desktop and Back to main menu are hidden and Resume become Back

14
Antize Complete Menu System
6 - Generals
1: Why my Unreal Engine freeze when I start my game ?
Just wait for Unreal Engine to start compiling shaders (Can be long on a big project)

2: Why do I see my HUD/Character in the Main Menu ? or get the error “Attention, you have
duplicated the option menu ! (Ignore if the game…”
1. Most of the time people get this error because they use their GameMode in the main menu map,
to solve this problem you have to go in the Project Settings and in the Maps & Modes section, be
sure the Default GameMode is GameModeBase

2. To use your GameMode, go to in the World Settings on your map and select your GameMode

Don't forget to set your GameMode in your map's World Settings

15
Antize Complete Menu System
3. Make sure you have set None or your MainMenu GameMode in the World Settings of the
MainMenuMap

3: Why I can’t click on the option menu ?

Make sure you don't have a widget above the option menu like a HUD, it can look like this :

16
Antize Complete Menu System
4: Fix “Input Axis/Action Event references unknown Axis/Action ‘Name’ for…”
You have to add the inputs that are not yet configured in the project settings, once in the project
settings go to the Input section and add the Inputs you get in the warning message.

5: Why my Unreal Engine crash when I try to change the Game Name on the W_MainMenu ?
I don't know, this bug seems to happen when you're working on an M2, this bug can be easily fixed,
just select GameNameText, GameNameFont & GameNameColor and do a Refresh Nodes.

17
Antize Complete Menu System
3) Add Template to Menus
In this section you will learn how to add a new template into the menu and how configurate it, in the
project you will find all templates you need to configure your key mappings, graphic settings, audio
settings and gameplay settings.

1 - Add new Axis Template

1. Open Project Settings - Go into Input - Add a new Axis Mappings and Name it

2. Open E_TemplateControlAxis in Logics folder

18
Antize Complete Menu System
3. Add two new rows (Axis work in pairs) - Set your axis mapping setting name and save

4. Open W_Options in Widgets folder

19
Antize Complete Menu System
5. Search ScrollBox_Controls

6. Search Template and Drag and Drop Template_Title into ScrollBox_Controls

20
Antize Complete Menu System
7. Change widget name (Clean work) and set Show title

8. Search Template and Drag and Drop Template_Axis into ScrollBox_Controls

21
Antize Complete Menu System
9. Change widget name (Clean work) and set your settings

General index is auto generated, 2 because index 0 and 1 is already use for character move, one
index for two axis (Left and Right - Forward and Backward).

MappingName is auto selected with SettingName (Work in pairs, be sure Left become Right -
Backward become Forward - Forward is Forward - Right is Right, if error, in Enum is not in pairs).

10. Add a new Template_Axis, change widget name (Clean work) and set your settings

General index is auto generated, 2 because index 0 and 1 is already use for character move (index
work in pairs: Left and Right - Forward and Backward).

You can see MappingName is automatically set to VehicleForward (Work in pairs, be sure Left
become Right - Backward become Forward - Forward is Forward - Right is Right).

22
Antize Complete Menu System
2 - Add new Action Template
1. Open Project Settings - Go into Input - Add a new Action Mappings and Name it

2. Open E_TemplateAction in Logics folder

23
Antize Complete Menu System
3. Add a new row - Set your action mapping setting name and save

4. Open W_Options in Widgets folder

24
Antize Complete Menu System
5. Search ScrollBox_Controls

6. Search Template and Drag and Drop Template_Action into ScrollBox_Controls

25
Antize Complete Menu System
7. Change widget name (Clean work) - Drag and Drop to desired place - set your action settings

3 - Add new Graphic Template

1. Open E_TemplateGraphic in Logics folder.

26
Antize Complete Menu System
2. Add a new row - Set your graphic setting name and save

3. Open Options in Widgets folder

27
Antize Complete Menu System
4. Search ScrollBox_Graphics

5. Search Template and Drag and Drop Template_Graphic into ScrollBox_Graphics

28
Antize Complete Menu System
6. Change widget name (Clean work) and set your graphic settings, don’t forget to set your enum to
the SettingName (I added a link because the texture setting overwrites the PoolSize)

29
Antize Complete Menu System
4 - Add new Audio Template
1. Open E_TemplateAudio in Logics folder

2. Add a new row - Set your audio setting name and save

30
Antize Complete Menu System
3. Open W_Options in Widgets folder

4. Search Scrollbox_Audio

31
Antize Complete Menu System
5. Search Template and Drag and Drop Template_Audio into Scrollbox_Audio

6. Change widget name (Clean work) and set your audio settings

32
Antize Complete Menu System
7. Create a new Sound Class

8. Create a new Sound Mixer and open it

33
Antize Complete Menu System
9. In your Sound mixer add new element to array - Unscroll element - Select Sound Class you have
created and save

10. Open SC_Master

34
Antize Complete Menu System
11. Add new element to array - Select Sound Class you have created and save

12. Open your Cue - Set your Class and save

35
Antize Complete Menu System
13. Open W_TemplateAudio and search Event_MSG_Change_Sound - Select your Sound Mixer and
Sound Class you have created - Compile and Save

5 - Add new Gameplay Template

1. Open E_TemplateUI in Logics folder

36
Antize Complete Menu System
2. Add a new row - Set your gameplay setting name and save

3. Open W_Options in Widgets folder

37
Antize Complete Menu System
4. Search ScrollBox_UI

5. Search Template and Drag and Drop Template_UI into ScrollBox_UI

38
Antize Complete Menu System
6. Change widget name (Clean work) and set your settings, don’t forget to set your enum to the
SettingName

7. Open W_TemplateUI in Widgets folder

39
Antize Complete Menu System
8. Open MakeActionUI and add you action on TemplateUI switch

40
Antize Complete Menu System
4) Add button to the navigation menu
There you will know how add a new button to left menu

1 - Option menu
1. Open W_Options and search VerticalBox_Nav

2. Copy a button and paste into VerticalBox_Nav

41
Antize Complete Menu System
3. Rename Text in the button and implement the OnClicked of your button to make your code

2 - Main Menu
1. Open W_MainMenu and search VerticalBox_NavMain

Add only buttons and not a widget or anything else (widget clicked), array creation searches only for
buttons

42
Antize Complete Menu System
2. Copy a button and paste into VerticalBox_NavMain

3. Rename Text in the button and implement the OnClicked of your button to make your code

43
Antize Complete Menu System
6) Setting up
1 - Rename key
1. Open D_KeysName in Database folder

2. Add a new row - Set Default name and Rename - Save

44
Antize Complete Menu System
2 - Change Confirmation time
Select Confirmation in W_Options and set the desired setting in the right panel

3 - Configure Option menu (Background & More)

Be sure W_Options is selected in the left panel and set the desired settings in the right panel

Here you can change a lot of settings and interface settings

45
Antize Complete Menu System
4 - Configure Main menu (Logo, Game Name, Hide buttons & more)
Be sure W_MainMenu is selected in the left panel and set the desired settings in the right panel

Here you can change a lot of settings and interface settings, you can hide Multiplayer/Solo buttons,
hide and choose the default difficulty, show/hide the level selector, set your game logo, game name,
the background, etc…

5 - Block an input type

Open the Character blueprint, select the variable MyInputMode and set your input mode, the
InputMode can be changed at runtime

46
Antize Complete Menu System
6 - Configure Intro settings
Be sure W_Intro is selected and set the desired settings in the right panel

7 - Configure Create Server settings

In the Main Menu widget, select W_CreateServer and set the desired settings in the right panel

47
Antize Complete Menu System
8 - Configure Credits
Select W_Credits and in the right panel you will find some settings:

• StartAt and EndAt - Need to be configured if you uncheck Invert and/if you add/remove
something in Credits.
• AnimSpeed - Control the scrolling speed.
• TimerSpeed - Optimisation.

To add a text, you can use the W_CreditsTitleName widget, in the right panel you can define Name,
Color, Font and a custom HeightSize & BottomSize to choose your space between title and text.

48
Antize Complete Menu System
9 - Change key to Open/Close Option
1. In W_Options and other widgets, go to the OnKeyDown function and you can remove or add a
new key

2. In the PlayerCharacter blueprint, you can remove or add keys here

49
Antize Complete Menu System
10 - Disable a section in option menu
1. Select a button of the section you want to disable and set its visibility to Collapsed

2. Select MySwitcher and set the default section you want in Active Widget Index

50
Antize Complete Menu System
11 - Change the Main Menu music and UI sounds
Select UI_Audio and in the left panel you have the settings for the main menu music and UI sounds

12 - Change loading tips

In the LoadingScreen widget, make sure W_LoadingScreen is selected and set the desired Tips in the
right panel

51
Antize Complete Menu System
13 - Create a new map and change default map
1: Setting up a new map
In the World Settings of your map, select your GameMode blueprint

Don’t define the GameMode in the project settings otherwise your character and controller will be
loaded in the main menu map...

2: Change default map (Singleplayer)

1 | Without map selector
In the BP_MySaveGame blueprint, select LevelName variable and set your Level Name
Only works if you don’t use the level selector

52
Antize Complete Menu System
2 | With map selector
In the W_LevelSelector widget, select or add a new W_LevelCard, and define the desired settings of
the selected W_LevelCard in the right panel

3: Change default map (Multiplayer)

1 | Without map selector
In Main Menu widget, make sure W_MainMenu is selected and set your level name to the Default
Mult Level variable in the right panel
Only works if you don’t use the map selector

53
Antize Complete Menu System
2 | With map selector
In the Main Menu widget, select W_CreateServer and define the desired map settings in the right
panel

14 - Change class sound

In your cue, set the desired sound class in the left panel

54
Antize Complete Menu System
15 - Add Advanced session plugin
Create session: In the BP_MainMenuGameInstance blueprint, replace the Create Session by the
Create Advanced Session (You can search Create Session)

Find Sessions: In the W_MainMenu widget, replace the Find Sessions by the Find Sessions Advanced
(You can search Find Sessions)

16 - Change loading time

In the Game Instance blueprint, select TimeLoadingBeforeContinue variable and set the desired
time in the right panel

55
Antize Complete Menu System
17 - Use Enhanced input
Enhanced input is not automatically integrated for people who want to use the old system

You will have to name the Enhanced Action with the same name as in the Enumeration

56
Antize Complete Menu System
1: Action
1. Create a new function called RefreshActionByNameEIS in the BP_MainMenuFunction blueprint
and do the following parts:

You can try copying the text available in this link into the function you created to generate the
function, don’t forget to save before:
https://drive.google.com/file/d/1KN5p4HBYCpJUf3ZVSlXh55-BKahMefXw/view

1. Part 1 (Don’t forget to set your Input Mapping Context to the ControllerMapping variable)

• NewMapping param = InputActionKeyMapping array & Local_Key = Key array

• Local_ControllerMapping = InputMappingContext & Local_InputAction = InputAction

1. Part 2

57
Antize Complete Menu System
2. Add the RefreshActionByNameEIS function after the Add new mappings foreach in the
SetMappingsActionArray function

3. Add the RefreshActionByNameEIS function at the end of the RefreshMappingsActionArray

function

58
Antize Complete Menu System
2: Axis
1. Create a new function called RefreshAxisByNameEIS in the BP_MainMenuFunction blueprint and
do the following parts:

You can try copying the text available in this link into the function you created to generate the
function, don’t forget to save before:
https://drive.google.com/file/d/1upkCJY6cJTiEWDgfI9IlSsQVtsvmKUrX/view

1. Part 1 (Don’t forget to set your Input Mapping Context to the variable)

• NewMapping param = InputAxisKeyMapping array & Local_Key = Key array

• Local_ControllerMapping = InputMappingContext & Local_InputAction = InputAction

1. Part 2

59
Antize Complete Menu System
1. Part 3 (Get (a ref) on the Mappings)

2. Add the RefreshAxisByNameEIS function after the Add new mappings foreach in the
SetMappingsAxis function

60
Antize Complete Menu System
3. Add the RefreshAxisByNameEIS function at the end of the RefreshMappingsAxisArray function

18 - Unlock a level
The index is linked to the position of the W_LevelCard widget in the scroll box in the
W_LevelSelector widget

1: Default
To lock/unlock the default levels, in the BP_UnlockedLevelSave blueprint, add/remove the elements
in the UnlockedLevel array and set the Boolean value

If you have made changes and nothing happens, remember to delete the save file
(YourPorject\Saved\SaveGames\UnlockedLevel.sav)

2: In-Game
You can call the function UnlockLevel and specify the index of the widget level selector to be
unlocked, index starting from 0

61
Antize Complete Menu System
19 - Join a level (In-game)
To join a level when you're in-game, you can call the interface associated with the GameInstance
MSG_JoinLevel

7) Add language
1. Open Localization Dashboard

62
Antize Complete Menu System
2. Check Gather from Packages - Add an element - Set Content/*

3. Add New Culture and choose your language - Be sure English is selected for Native (Keep in mind
language prefix, here ru)

63
Antize Complete Menu System
3.1. To recover French translation during the modification Culture to English, be sure French culture
has been added

3.2. Reinstall asset

This action will overwrite all your changes made on the main menu

64
Antize Complete Menu System
3.3. French translation will be recovered

65
Antize Complete Menu System
4. Click on Gather Text wait and click Okay - Click on Edit translations for this culture

5. Go to in Untranslated or Completed - Make your translations - Close

66
Antize Complete Menu System
6. Click on Gather Text wait and click Okay - Click on Compile Text wait and click Okay - Close

7. Select UI_Language in W_Options - Add an element and Name it (Keep in mind index, here 2)

67
Antize Complete Menu System
8. Open MakeActionUI and add your prefix language into Select

8. Launch in Standalone Game (Debug mode won’t change language correctly)

68
Antize Complete Menu System