Represents the root node (and controller) of a menu system More...
Public Member Functions | |
| delegate void | MenuChangedHandler (Menu menu) |
| Menu event handler More... | |
| void | OpenAsync (Menu menu) |
| Opens a specific Menu More... | |
| void | CloseAsync () |
| Closes the currently open Menu More... | |
Public Attributes | |
| bool | DisableRuntimeMenuTagging = false |
| Disabling runtime menu tagging requires the caller to specify TrackedMenus in order for anything to work More... | |
| string | MenuPrefix = "menu" |
| A custom prefix with which menu components are identified More... | |
| string | OverlayPrefix = "overlay" |
| A custom prefix with which overlay menu components are identified More... | |
| Menu.InteractableType | PrefixDefaultInteractionType = Menu.InteractableType.SelectableInteractive |
| An interactivity value to set on all Menus that are created with prefixing More... | |
| Menu [] | TrackedMenus = null |
| Manually specify Menus that this MenuRoot controls More... | |
| Menu | SelectedMenu = null |
| The initially selected menu More... | |
| RuntimeMenuTagger | Tagger = null |
| Specific tagger to use to tag menus More... | |
Static Public Attributes | |
| static readonly Version | Version = new Version(1, 4, 0) |
| The current Unity-MenuStack version More... | |
Events | |
| MenuChangedHandler | Opened |
| Menu opened event. fired when a menu is opened More... | |
| MenuChangedHandler | Closed |
| Menu closed event. fired when a menu is closed More... | |
Detailed Description
Represents the root node (and controller) of a menu system
Member Function Documentation
◆ CloseAsync()
| void MenuStack.MenuRoot.CloseAsync | ( | ) |
Closes the currently open Menu
◆ MenuChangedHandler()
| delegate void MenuStack.MenuRoot.MenuChangedHandler | ( | Menu | menu | ) |
Menu event handler
- Parameters
-
menu the changed menu
◆ OpenAsync()
| void MenuStack.MenuRoot.OpenAsync | ( | Menu | menu | ) |
Member Data Documentation
◆ DisableRuntimeMenuTagging
| bool MenuStack.MenuRoot.DisableRuntimeMenuTagging = false |
Disabling runtime menu tagging requires the caller to specify TrackedMenus in order for anything to work
The caller may find this useful if they see runtime perf costs of iterating over a large menu system
◆ MenuPrefix
| string MenuStack.MenuRoot.MenuPrefix = "menu" |
A custom prefix with which menu components are identified
This is only used when DisableRuntimeMenuTagging is false
◆ OverlayPrefix
| string MenuStack.MenuRoot.OverlayPrefix = "overlay" |
A custom prefix with which overlay menu components are identified
This is only used when DisableRuntimeMenuTagging is false
◆ PrefixDefaultInteractionType
| Menu.InteractableType MenuStack.MenuRoot.PrefixDefaultInteractionType = Menu.InteractableType.SelectableInteractive |
An interactivity value to set on all Menus that are created with prefixing
◆ SelectedMenu
| Menu MenuStack.MenuRoot.SelectedMenu = null |
The initially selected menu
If this isn't set, the first Menu in the heirarchy will be used
◆ Tagger
| RuntimeMenuTagger MenuStack.MenuRoot.Tagger = null |
Specific tagger to use to tag menus
This is only used when DisableRuntimeMenuTagging is false
◆ TrackedMenus
| Menu [] MenuStack.MenuRoot.TrackedMenus = null |
Manually specify Menus that this MenuRoot controls
Overriden at runtime when DisableRuntimeMenuTagging is false
◆ Version
|
static |
The current Unity-MenuStack version
Event Documentation
◆ Closed
| MenuChangedHandler MenuStack.MenuRoot.Closed |
Menu closed event. fired when a menu is closed
◆ Opened
| MenuChangedHandler MenuStack.MenuRoot.Opened |
Menu opened event. fired when a menu is opened
The documentation for this class was generated from the following file:
- Assets/Scripts/MenuRoot.cs
