Class MenuManager

Namespace

AshesOfVelsingrad.Managers

Assembly

Ashes of Velsingrad.dll

Manages menu navigation and state. Coordinates between different menus following the Manager Pattern.

[ScriptPath("res://scripts/managers/MenuManager.cs")]
public class MenuManager : BaseManager, IDisposable

Inheritance

object

GodotObject

Node

BaseManager

MenuManager

Implements

IDisposable

Inherited Members

BaseManager._Ready()

BaseManager._ExitTree()

BaseManager.Cleanup()

Node.NotificationEnterTree

Node.NotificationExitTree

Node.NotificationMovedInParent

Node.NotificationReady

Node.NotificationPaused

Node.NotificationUnpaused

Node.NotificationPhysicsProcess

Node.NotificationProcess

Node.NotificationParented

Node.NotificationUnparented

Node.NotificationSceneInstantiated

Node.NotificationDragBegin

Node.NotificationDragEnd

Node.NotificationPathRenamed

Node.NotificationChildOrderChanged

Node.NotificationInternalProcess

Node.NotificationInternalPhysicsProcess

Node.NotificationPostEnterTree

Node.NotificationDisabled

Node.NotificationEnabled

Node.NotificationResetPhysicsInterpolation

Node.NotificationEditorPreSave

Node.NotificationEditorPostSave

Node.NotificationWMMouseEnter

Node.NotificationWMMouseExit

Node.NotificationWMWindowFocusIn

Node.NotificationWMWindowFocusOut

Node.NotificationWMCloseRequest

Node.NotificationWMGoBackRequest

Node.NotificationWMSizeChanged

Node.NotificationWMDpiChange

Node.NotificationVpMouseEnter

Node.NotificationVpMouseExit

Node.NotificationWMPositionChanged

Node.NotificationOsMemoryWarning

Node.NotificationTranslationChanged

Node.NotificationWMAbout

Node.NotificationCrash

Node.NotificationOsImeUpdate

Node.NotificationApplicationResumed

Node.NotificationApplicationPaused

Node.NotificationApplicationFocusIn

Node.NotificationApplicationFocusOut

Node.NotificationTextServerChanged

Node.NotificationAccessibilityUpdate

Node.NotificationAccessibilityInvalidate

Node.GetNode<T>(NodePath)

Node.GetNodeOrNull<T>(NodePath)

Node.GetChild<T>(int, bool)

Node.GetChildOrNull<T>(int, bool)

Node.GetOwner<T>()

Node.GetOwnerOrNull<T>()

Node.GetParent<T>()

Node.GetParentOrNull<T>()

Node._EnterTree()

Node._GetAccessibilityConfigurationWarnings()

Node._GetConfigurationWarnings()

Node._GetFocusedAccessibilityElement()

Node._Input(InputEvent)

Node._PhysicsProcess(double)

Node._Process(double)

Node._ShortcutInput(InputEvent)

Node._UnhandledInput(InputEvent)

Node._UnhandledKeyInput(InputEvent)

Node.PrintOrphanNodes()

Node.GetOrphanNodeIds()

Node.AddSibling(Node, bool)

Node.AddChild(Node, bool, Node.InternalMode)

Node.RemoveChild(Node)

Node.Reparent(Node, bool)

Node.GetChildCount(bool)

Node.GetChildren(bool)

Node.GetChild(int, bool)

Node.HasNode(NodePath)

Node.GetNode(NodePath)

Node.GetNodeOrNull(NodePath)

Node.GetParent()

Node.FindChild(string, bool, bool)

Node.FindChildren(string, string, bool, bool)

Node.FindParent(string)

Node.HasNodeAndResource(NodePath)

Node.GetNodeAndResource(NodePath)

Node.IsInsideTree()

Node.IsPartOfEditedScene()

Node.IsAncestorOf(Node)

Node.IsGreaterThan(Node)

Node.GetPath()

Node.GetPathTo(Node, bool)

Node.AddToGroup(StringName, bool)

Node.RemoveFromGroup(StringName)

Node.IsInGroup(StringName)

Node.MoveChild(Node, int)

Node.GetGroups()

Node.GetIndex(bool)

Node.PrintTree()

Node.PrintTreePretty()

Node.GetTreeString()

Node.GetTreeStringPretty()

Node.PropagateNotification(int)

Node.PropagateCall(StringName, Array, bool)

Node.SetPhysicsProcess(bool)

Node.GetPhysicsProcessDeltaTime()

Node.IsPhysicsProcessing()

Node.GetProcessDeltaTime()

Node.SetProcess(bool)

Node.IsProcessing()

Node.SetProcessInput(bool)

Node.IsProcessingInput()

Node.SetProcessShortcutInput(bool)

Node.IsProcessingShortcutInput()

Node.SetProcessUnhandledInput(bool)

Node.IsProcessingUnhandledInput()

Node.SetProcessUnhandledKeyInput(bool)

Node.IsProcessingUnhandledKeyInput()

Node.CanProcess()

Node.QueueAccessibilityUpdate()

Node.GetAccessibilityElement()

Node.SetDisplayFolded(bool)

Node.IsDisplayedFolded()

Node.SetProcessInternal(bool)

Node.IsProcessingInternal()

Node.SetPhysicsProcessInternal(bool)

Node.IsPhysicsProcessingInternal()

Node.IsPhysicsInterpolated()

Node.IsPhysicsInterpolatedAndEnabled()

Node.ResetPhysicsInterpolation()

Node.CanAutoTranslate()

Node.SetTranslationDomainInherited()

Node.GetWindow()

Node.GetLastExclusiveWindow()

Node.GetTree()

Node.CreateTween()

Node.Duplicate(int)

Node.ReplaceBy(Node, bool)

Node.SetSceneInstanceLoadPlaceholder(bool)

Node.GetSceneInstanceLoadPlaceholder()

Node.SetEditableInstance(Node, bool)

Node.IsEditableInstance(Node)

Node.GetViewport()

Node.QueueFree()

Node.RequestReady()

Node.IsNodeReady()

Node.SetMultiplayerAuthority(int, bool)

Node.GetMultiplayerAuthority()

Node.IsMultiplayerAuthority()

Node.RpcConfig(StringName, Variant)

Node.GetNodeRpcConfig()

Node.Atr(string, StringName)

Node.AtrN(string, StringName, int, StringName)

Node.Rpc(StringName, params Variant[])

Node.Rpc(StringName, ReadOnlySpan<Variant>)

Node.RpcId(long, StringName, params Variant[])

Node.RpcId(long, StringName, ReadOnlySpan<Variant>)

Node.UpdateConfigurationWarnings()

Node.CallDeferredThreadGroup(StringName, params Variant[])

Node.CallDeferredThreadGroup(StringName, ReadOnlySpan<Variant>)

Node.SetDeferredThreadGroup(StringName, Variant)

Node.NotifyDeferredThreadGroup(int)

Node.CallThreadSafe(StringName, params Variant[])

Node.CallThreadSafe(StringName, ReadOnlySpan<Variant>)

Node.SetThreadSafe(StringName, Variant)

Node.NotifyThreadSafe(int)

Node.EmitSignalReady()

Node.EmitSignalRenamed()

Node.EmitSignalTreeEntered()

Node.EmitSignalTreeExiting()

Node.EmitSignalTreeExited()

Node.EmitSignalChildEnteredTree(Node)

Node.EmitSignalChildExitingTree(Node)

Node.EmitSignalChildOrderChanged()

Node.EmitSignalReplacingBy(Node)

Node.EmitSignalEditorDescriptionChanged(Node)

Node.EmitSignalEditorStateChanged()

Node.InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Node.HasGodotClassMethod(in godot_string_name)

Node.HasGodotClassSignal(in godot_string_name)

Node.Name

Node.UniqueNameInOwner

Node.SceneFilePath

Node.Owner

Node.Multiplayer

Node.ProcessMode

Node.ProcessPriority

Node.ProcessPhysicsPriority

Node.ProcessThreadGroup

Node.ProcessThreadGroupOrder

Node.ProcessThreadMessages

Node.PhysicsInterpolationMode

Node.AutoTranslateMode

Node.EditorDescription

Node.Ready

Node.Renamed

Node.TreeEntered

Node.TreeExiting

Node.TreeExited

Node.ChildEnteredTree

Node.ChildExitingTree

Node.ChildOrderChanged

Node.ReplacingBy

Node.EditorDescriptionChanged

Node.EditorStateChanged

GodotObject.NotificationPostinitialize

GodotObject.NotificationPredelete

GodotObject.NotificationExtensionReloaded

GodotObject.InstanceFromId(ulong)

GodotObject.IsInstanceIdValid(ulong)

GodotObject.IsInstanceValid(GodotObject)

GodotObject.WeakRef(GodotObject)

GodotObject.Dispose()

GodotObject.Dispose(bool)

GodotObject.ToString()

GodotObject.ToSignal(GodotObject, StringName)

GodotObject._Get(StringName)

GodotObject._GetPropertyList()

GodotObject._IterGet(Variant)

GodotObject._IterInit(Array)

GodotObject._IterNext(Array)

GodotObject._Notification(int)

GodotObject._PropertyCanRevert(StringName)

GodotObject._PropertyGetRevert(StringName)

GodotObject._Set(StringName, Variant)

GodotObject._ValidateProperty(Dictionary)

GodotObject.Free()

GodotObject.GetClass()

GodotObject.IsClass(string)

GodotObject.Set(StringName, Variant)

GodotObject.Get(StringName)

GodotObject.SetIndexed(NodePath, Variant)

GodotObject.GetIndexed(NodePath)

GodotObject.GetPropertyList()

GodotObject.GetMethodList()

GodotObject.PropertyCanRevert(StringName)

GodotObject.PropertyGetRevert(StringName)

GodotObject.Notification(int, bool)

GodotObject.GetInstanceId()

GodotObject.SetScript(Variant)

GodotObject.GetScript()

GodotObject.SetMeta(StringName, Variant)

GodotObject.RemoveMeta(StringName)

GodotObject.GetMeta(StringName, Variant)

GodotObject.HasMeta(StringName)

GodotObject.GetMetaList()

GodotObject.AddUserSignal(string, Array)

GodotObject.HasUserSignal(StringName)

GodotObject.RemoveUserSignal(StringName)

GodotObject.EmitSignal(StringName, params Variant[])

GodotObject.EmitSignal(StringName, ReadOnlySpan<Variant>)

GodotObject.Call(StringName, params Variant[])

GodotObject.Call(StringName, ReadOnlySpan<Variant>)

GodotObject.CallDeferred(StringName, params Variant[])

GodotObject.CallDeferred(StringName, ReadOnlySpan<Variant>)

GodotObject.SetDeferred(StringName, Variant)

GodotObject.Callv(StringName, Array)

GodotObject.HasMethod(StringName)

GodotObject.GetMethodArgumentCount(StringName)

GodotObject.HasSignal(StringName)

GodotObject.GetSignalList()

GodotObject.GetSignalConnectionList(StringName)

GodotObject.GetIncomingConnections()

GodotObject.Connect(StringName, Callable, uint)

GodotObject.Disconnect(StringName, Callable)

GodotObject.IsConnected(StringName, Callable)

GodotObject.HasConnections(StringName)

GodotObject.SetBlockSignals(bool)

GodotObject.IsBlockingSignals()

GodotObject.NotifyPropertyListChanged()

GodotObject.SetMessageTranslation(bool)

GodotObject.CanTranslateMessages()

GodotObject.Tr(StringName, StringName)

GodotObject.TrN(StringName, StringName, int, StringName)

GodotObject.GetTranslationDomain()

GodotObject.SetTranslationDomain(StringName)

GodotObject.IsQueuedForDeletion()

GodotObject.CancelFree()

GodotObject.EmitSignalScriptChanged()

GodotObject.EmitSignalPropertyListChanged()

GodotObject.NativeInstance

GodotObject.ScriptChanged

GodotObject.PropertyListChanged

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

This class is responsible for showing, hiding, and navigating between menus. It maintains a history of menus for back navigation and provides methods to register and unregister menus. It also emits signals when the current menu changes.

Fields

MAIN_MENU

public const string MAIN_MENU = "main_menu"

Field Value

string

OPTIONS_MENU

public const string OPTIONS_MENU = "options_menu"

Field Value

string

PAUSE_MENU

public const string PAUSE_MENU = "pause_menu"

Field Value

string

Properties

Instance

public static MenuManager? Instance { get; protected set; }

Property Value

MenuManager

Methods

ClearHistory()

Clears the menu history stack. This method removes all entries from the history stack, effectively resetting it.

public void ClearHistory()

Remarks

This method is useful when you want to reset the menu navigation state. It clears the history stack, so there are no previous menus to go back to.

EmitSignalMenuChanged(string)

protected void EmitSignalMenuChanged(string menuName)

Parameters

menuName string

GetCurrentMenu()

Gets the name of the current active menu.

public string? GetCurrentMenu()

Returns

string

The name of the current menu, or null if no menu is active.

Remarks

This method returns the name of the currently active menu. If no menu is currently active, it returns null. This can be useful for checking the current state of the menu system.

GoBack()

Goes back to the previous menu in the history stack. If there is no previous menu, it prints a message indicating that.

public void GoBack()

Remarks

This method pops the last menu from the history stack and shows it. If the history stack is empty, it prints a message indicating that there is no previous menu to go back to. It does not add the previous menu back to the history stack when going back.

Initialize()

Initializes the MenuManager singleton instance. Ensures only one instance exists and sets up the initial state.

protected override void Initialize()

Remarks

This method is called automatically by Godot when the node is ready. It checks for duplicate instances and initializes the menu system. If a duplicate instance is found, it removes the duplicate.

IsMenuActive(string)

Checks if a specific menu is currently active.

public bool IsMenuActive(string menuName)

Parameters

menuName string

The unique name of the menu to check.

Returns

bool

True if the specified menu is active, otherwise false.

Remarks

This method checks if the specified menu is currently the active menu. It compares the provided menu name with the current active menu name. This can be useful for UI logic that needs to know if a specific menu is currently displayed.

RegisterMenu(string, Control)

Registers a menu with the MenuManager. Adds the menu to the internal dictionary and hides it by default.

public virtual void RegisterMenu(string menuName, Control menuControl)

Parameters

menuName string

The unique name of the menu to register.

menuControl Control

The Control instance representing the menu.

Remarks

This method checks if the menu is already registered to avoid duplicates. If the menu is already registered, it prints an error message and does not add it again. It also connects back signals for navigation menus, such as OptionsMenu, to handle back navigation.

SetInstanceForTesting(MenuManager?)

FOR TESTING ONLY: Manually sets the singleton instance. This method should only be used in unit tests.

public static void SetInstanceForTesting(MenuManager? instance)

Parameters

instance MenuManager

The instance to set as the singleton.

ShowMenu(string, bool)

Shows a menu by its name. Hides the current menu and shows the specified menu.

public virtual void ShowMenu(string menuName, bool addToHistory = true)

Parameters

menuName string

The unique name of the menu to show.

addToHistory bool

Whether to add the current menu to the history stack for back navigation.

Remarks

This method checks if the specified menu exists in the registered menus. If it does, it hides the current menu and shows the specified menu. If the current menu is not empty, it adds it to the history stack for back navigation. If the specified menu is not found, it prints an error message.

UnregisterMenu(string)

Unregisters a menu from the MenuManager. Removes the menu from the internal dictionary.

public void UnregisterMenu(string menuName)

Parameters

menuName string

The unique name of the menu to unregister.

Remarks

This method checks if the menu exists before attempting to remove it. If the menu is currently active, it will hide it before removing.

Events

MenuChanged

public event MenuManager.MenuChangedEventHandler MenuChanged

Event Type

MenuManager.MenuChangedEventHandler