Navigation
API > API/Runtime > API/Runtime/GameMenuBuilder
| Name | FGameMenuItem |
| Type | class |
| Header File | /Engine/Source/Runtime/GameMenuBuilder/Public/GameMenuItem.h |
| Include Path | #include "GameMenuItem.h" |
Syntax
class FGameMenuItem : public TSharedFromThis< FGameMenuItem >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FGameMenuItem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| GameMenuItem.h | |||
FGameMenuItem
(
FText _text |
Constructor accepting menu item text | GameMenuItem.h | |
FGameMenuItem
(
TSharedPtr< SGameMenuItemWidget > InWidget |
Custom widgets cannot contain sub menus, all functionality must be handled by custom widget itself | GameMenuItem.h | |
FGameMenuItem
(
FText InText, |
Constructor for multi-choice item | GameMenuItem.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnConfirmMenuItem | TBaseDelegate_NoParams< void > | Confirm menu item delegate | GameMenuItem.h |
| FOnOptionChanged | TBaseDelegate_TwoParams< void, TSharedPtr< FGameMenuItem >, int32 > | Multi-choice option changed, parameters are menu item itself and new multi-choice index | GameMenuItem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInactive | bool | True if this item is active | GameMenuItem.h | |
| CustomWidget | TSharedPtr< SGameMenuItemWidget > | Shared pointer to actual slate widget representing the custom menu item, ie whole options screen | GameMenuItem.h | |
| MaxMultiChoiceIndex | int32 | Set to other value than -1 to limit the options range | GameMenuItem.h | |
| MenuItemType | EGameMenuItemType::Type | Menu item type | GameMenuItem.h | |
| MinMultiChoiceIndex | int32 | Set to other value than -1 to limit the options range | GameMenuItem.h | |
| MultiChoice | TArray< FText > | Texts for multiple choice menu item (like INF AMMO ON/OFF or difficulty/resolution etc) | GameMenuItem.h | |
| OnConfirmMenuItem | FOnConfirmMenuItem | Delegate, which is executed by SSimpleMenuWidget if user confirms this menu item | GameMenuItem.h | |
| OnOptionChanged | FOnOptionChanged | Multi-choice option changed, parameters are menu item itself and new multi-choice index | GameMenuItem.h | |
| SelectedMultiChoice | int32 | Selected multi-choice index for this menu item | GameMenuItem.h | |
| SubMenu | TSharedPtr< class FGameMenuPage > | Sub menu if present | GameMenuItem.h | |
| Text | FText | Menu item text | GameMenuItem.h | |
| Widget | TSharedPtr< SGameMenuItemWidget > | Shared pointer to actual slate widget representing the menu item | GameMenuItem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ConfirmPressed() |
GameMenuItem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FGameMenuItem > CreateRoot() |
Create special root item | GameMenuItem.h |