Navigation
API > API/Runtime > API/Runtime/GameMenuBuilder
| Name | FGameMenuPage |
| Type | class |
| Header File | /Engine/Source/Runtime/GameMenuBuilder/Public/GameMenuPage.h |
| Include Path | #include "GameMenuPage.h" |
Syntax
class FGameMenuPage : public TSharedFromThis< FGameMenuPage >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FGameMenuPage
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGameMenuPage() |
GameMenuPage.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnMenuGoBack | TBaseDelegate_NoParams< void > | Delegate for when user is going back from submenu. | GameMenuPage.h |
| FOnMenuHidden | TBaseDelegate_NoParams< void > | Delegate for when menu is hidden. | GameMenuPage.h |
| FOnMenuOpening | TBaseDelegate_NoParams< void > | Delegate for when menu is about to open. | GameMenuPage.h |
| MenuItemList | TArray< TSharedPtr< FGameMenuItem > > | Array of menu items that represents the menu. | GameMenuPage.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MenuTitle | FText | The menu title. | GameMenuPage.h | |
| PCOwner | TWeakObjectPtr< APlayerController > | Weak pointer to Owning player controller. | GameMenuPage.h | |
| RootMenuPageWidget | TSharedPtr< SGameMenuPageWidget > | The widget that is the menu. | GameMenuPage.h | |
| SelectedIndex | int32 | Current selection in this menu. | GameMenuPage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< FGameMenuItem > AddCustomMenuItem
(
const FText& Text, |
Add a custom menu entry | GameMenuPage.h | |
TSharedRef< FGameMenuItem > AddMenuItem
(
const FText& Text, |
Add a menu item. | GameMenuPage.h | |
TSharedRef< FGameMenuItem > AddMenuItem
(
const FText& InText, |
Add a menu item. | GameMenuPage.h | |
TSharedRef< FGameMenuItem > AddMenuItemWithOptions
(
const FText& Text, |
Add a menu entry with a variable number of selectable options | GameMenuPage.h | |
void DestroyRootMenu() |
GameMenuPage.h | ||
TSharedPtr< FGameMenuItem > GetItem
(
int32 Index |
Get the specified item in the menu item list. Will assert if the value is out of range. | GameMenuPage.h | |
void HideMenu() |
Hide the menu. | GameMenuPage.h | |
bool InitialiseRootMenu
(
APlayerController* InPCOwner, |
Initialize the menu page widget and set this menu as root. | GameMenuPage.h | |
bool IsValidMenuEntryIndex
(
int32 Index |
Is the supplied index with the valid range of menu items. Returns false if it is not. | GameMenuPage.h | |
void LockControls
(
bool bLockState |
Lock/Unlock the menu and prevent user interaction. | GameMenuPage.h | |
void MenuGoBack() |
Executed when user want's to go back to previous menu. | GameMenuPage.h | |
void MenuGoBackCancel() |
Called when user want's to CANCEL and go back to previous menu. | GameMenuPage.h | |
void MenuHidden() |
Called when the menu has finished hiding. | GameMenuPage.h | |
void MenuOpening() |
Called when the menu is about to be opened. | GameMenuPage.h | |
int32 NumItems() |
Return the number of items in menu item list. | GameMenuPage.h | |
void RemoveAllItems() |
Remove all the items from the item array. | GameMenuPage.h | |
void SetAcceptHandler
(
UserClass* InObj, |
Add a handler for the menu being accepted. | GameMenuPage.h | |
void SetCancelHandler
(
UserClass* InObj, |
Add a handler for the menu being canceled. | GameMenuPage.h | |
void SetOnHiddenHandler
(
UserClass* InObj, |
Add a handler for the menu being canceled. | GameMenuPage.h | |
void SetOnOpenHandler
(
UserClass* InObj, |
Add a handler for the menu being opened. | GameMenuPage.h | |
void ShowRootMenu() |
Builds the menu widget and shows the menu. | GameMenuPage.h |