Class PauseMenu

Namespace

Squiggles.Core.Scenes.UI.Menus

Assembly

SquigglesCommon4X.dll

The pause menu, which is used during gameplay is a "pause_menu_controller" is used (res://Core/Scenes/UI/Menus/pause_menu_controller.tscn). It pauses the game using the scene tree pause feature. It contains options for saving and loading as well as the same options menu as in the main menu. It also blurs the background using a weak box blur effect.

[ScriptPath("res://Core/Scenes/UI/Menus/PauseMenu.cs")]
public class PauseMenu : Control, IDisposable

Inheritance

object

GodotObject

Node

CanvasItem

Control

PauseMenu

Implements

IDisposable

Inherited Members

Control.NotificationResized

Control.NotificationMouseEnter

Control.NotificationMouseExit

Control.NotificationFocusEnter

Control.NotificationFocusExit

Control.NotificationThemeChanged

Control.NotificationScrollBegin

Control.NotificationScrollEnd

Control.NotificationLayoutDirectionChanged

Control._CanDropData(Vector2, Variant)

Control._DropData(Vector2, Variant)

Control._GetDragData(Vector2)

Control._GetMinimumSize()

Control._GetTooltip(Vector2)

Control._GuiInput(InputEvent)

Control._HasPoint(Vector2)

Control._MakeCustomTooltip(string)

Control._StructuredTextParser(Array, string)

Control.AcceptEvent()

Control.GetMinimumSize()

Control.GetCombinedMinimumSize()

Control.SetAnchorsPreset(Control.LayoutPreset, bool)

Control.SetOffsetsPreset(Control.LayoutPreset, Control.LayoutPresetMode, int)

Control.SetAnchorsAndOffsetsPreset(Control.LayoutPreset, Control.LayoutPresetMode, int)

Control.SetAnchor(Side, float, bool, bool)

Control.SetAnchorAndOffset(Side, float, float, bool)

Control.SetBegin(Vector2)

Control.SetEnd(Vector2)

Control.SetPosition(Vector2, bool)

Control.SetSize(Vector2, bool)

Control.ResetSize()

Control.SetGlobalPosition(Vector2, bool)

Control.GetBegin()

Control.GetEnd()

Control.GetParentAreaSize()

Control.GetScreenPosition()

Control.GetRect()

Control.GetGlobalRect()

Control.HasFocus()

Control.GrabFocus()

Control.ReleaseFocus()

Control.FindPrevValidFocus()

Control.FindNextValidFocus()

Control.BeginBulkThemeOverride()

Control.EndBulkThemeOverride()

Control.AddThemeIconOverride(StringName, Texture2D)

Control.AddThemeStyleboxOverride(StringName, StyleBox)

Control.AddThemeFontOverride(StringName, Font)

Control.AddThemeFontSizeOverride(StringName, int)

Control.AddThemeColorOverride(StringName, Color)

Control.AddThemeConstantOverride(StringName, int)

Control.RemoveThemeIconOverride(StringName)

Control.RemoveThemeStyleboxOverride(StringName)

Control.RemoveThemeFontOverride(StringName)

Control.RemoveThemeFontSizeOverride(StringName)

Control.RemoveThemeColorOverride(StringName)

Control.RemoveThemeConstantOverride(StringName)

Control.GetThemeIcon(StringName, StringName)

Control.GetThemeStylebox(StringName, StringName)

Control.GetThemeFont(StringName, StringName)

Control.GetThemeFontSize(StringName, StringName)

Control.GetThemeColor(StringName, StringName)

Control.GetThemeConstant(StringName, StringName)

Control.HasThemeIconOverride(StringName)

Control.HasThemeStyleboxOverride(StringName)

Control.HasThemeFontOverride(StringName)

Control.HasThemeFontSizeOverride(StringName)

Control.HasThemeColorOverride(StringName)

Control.HasThemeConstantOverride(StringName)

Control.HasThemeIcon(StringName, StringName)

Control.HasThemeStylebox(StringName, StringName)

Control.HasThemeFont(StringName, StringName)

Control.HasThemeFontSize(StringName, StringName)

Control.HasThemeColor(StringName, StringName)

Control.HasThemeConstant(StringName, StringName)

Control.GetThemeDefaultBaseScale()

Control.GetThemeDefaultFont()

Control.GetThemeDefaultFontSize()

Control.GetParentControl()

Control.GetTooltip(Vector2?)

Control.GetCursorShape(Vector2?)

Control.ForceDrag(Variant, Control)

Control.GrabClickFocus()

Control.SetDragForwarding(Callable, Callable, Callable)

Control.SetDragPreview(Control)

Control.IsDragSuccessful()

Control.WarpMouse(Vector2)

Control.UpdateMinimumSize()

Control.IsLayoutRtl()

Control.ClipContents

Control.CustomMinimumSize

Control.LayoutDirection

Control.LayoutMode

Control.AnchorsPreset

Control.AnchorLeft

Control.AnchorTop

Control.AnchorRight

Control.AnchorBottom

Control.OffsetLeft

Control.OffsetTop

Control.OffsetRight

Control.OffsetBottom

Control.GrowHorizontal

Control.GrowVertical

Control.Size

Control.Position

Control.GlobalPosition

Control.Rotation

Control.RotationDegrees

Control.Scale

Control.PivotOffset

Control.SizeFlagsHorizontal

Control.SizeFlagsVertical

Control.SizeFlagsStretchRatio

Control.AutoTranslate

Control.LocalizeNumeralSystem

Control.TooltipText

Control.FocusNeighborLeft

Control.FocusNeighborTop

Control.FocusNeighborRight

Control.FocusNeighborBottom

Control.FocusNext

Control.FocusPrevious

Control.FocusMode

Control.MouseFilter

Control.MouseForcePassScrollEvents

Control.MouseDefaultCursorShape

Control.ShortcutContext

Control.Theme

Control.ThemeTypeVariation

Control.Resized

Control.GuiInput

Control.MouseEntered

Control.MouseExited

Control.FocusEntered

Control.FocusExited

Control.SizeFlagsChanged

Control.MinimumSizeChanged

Control.ThemeChanged

CanvasItem.NotificationTransformChanged

CanvasItem.NotificationLocalTransformChanged

CanvasItem.NotificationDraw

CanvasItem.NotificationVisibilityChanged

CanvasItem.NotificationEnterCanvas

CanvasItem.NotificationExitCanvas

CanvasItem.NotificationWorld2DChanged

CanvasItem._Draw()

CanvasItem.GetCanvasItem()

CanvasItem.IsVisibleInTree()

CanvasItem.Show()

CanvasItem.Hide()

CanvasItem.QueueRedraw()

CanvasItem.MoveToFront()

CanvasItem.DrawLine(Vector2, Vector2, Color, float, bool)

CanvasItem.DrawDashedLine(Vector2, Vector2, Color, float, float, bool)

CanvasItem.DrawPolyline(Vector2[], Color, float, bool)

CanvasItem.DrawPolylineColors(Vector2[], Color[], float, bool)

CanvasItem.DrawArc(Vector2, float, float, float, int, Color, float, bool)

CanvasItem.DrawMultiline(Vector2[], Color, float)

CanvasItem.DrawMultilineColors(Vector2[], Color[], float)

CanvasItem.DrawRect(Rect2, Color, bool, float)

CanvasItem.DrawCircle(Vector2, float, Color)

CanvasItem.DrawTexture(Texture2D, Vector2, Color?)

CanvasItem.DrawTextureRect(Texture2D, Rect2, bool, Color?, bool)

CanvasItem.DrawTextureRectRegion(Texture2D, Rect2, Rect2, Color?, bool, bool)

CanvasItem.DrawMsdfTextureRectRegion(Texture2D, Rect2, Rect2, Color?, double, double, double)

CanvasItem.DrawLcdTextureRectRegion(Texture2D, Rect2, Rect2, Color?)

CanvasItem.DrawStyleBox(StyleBox, Rect2)

CanvasItem.DrawPrimitive(Vector2[], Color[], Vector2[], Texture2D)

CanvasItem.DrawPolygon(Vector2[], Color[], Vector2[], Texture2D)

CanvasItem.DrawColoredPolygon(Vector2[], Color, Vector2[], Texture2D)

CanvasItem.DrawString(Font, Vector2, string, HorizontalAlignment, float, int, Color?, TextServer.JustificationFlag, TextServer.Direction, TextServer.Orientation)

CanvasItem.DrawMultilineString(Font, Vector2, string, HorizontalAlignment, float, int, int, Color?, TextServer.LineBreakFlag, TextServer.JustificationFlag, TextServer.Direction, TextServer.Orientation)

CanvasItem.DrawStringOutline(Font, Vector2, string, HorizontalAlignment, float, int, int, Color?, TextServer.JustificationFlag, TextServer.Direction, TextServer.Orientation)

CanvasItem.DrawMultilineStringOutline(Font, Vector2, string, HorizontalAlignment, float, int, int, int, Color?, TextServer.LineBreakFlag, TextServer.JustificationFlag, TextServer.Direction, TextServer.Orientation)

CanvasItem.DrawChar(Font, Vector2, string, int, Color?)

CanvasItem.DrawCharOutline(Font, Vector2, string, int, int, Color?)

CanvasItem.DrawMesh(Mesh, Texture2D, Transform2D?, Color?)

CanvasItem.DrawMultimesh(MultiMesh, Texture2D)

CanvasItem.DrawSetTransform(Vector2, float, Vector2?)

CanvasItem.DrawSetTransformMatrix(Transform2D)

CanvasItem.DrawAnimationSlice(double, double, double, double)

CanvasItem.DrawEndAnimation()

CanvasItem.GetTransform()

CanvasItem.GetGlobalTransform()

CanvasItem.GetGlobalTransformWithCanvas()

CanvasItem.GetViewportTransform()

CanvasItem.GetViewportRect()

CanvasItem.GetCanvasTransform()

CanvasItem.GetScreenTransform()

CanvasItem.GetLocalMousePosition()

CanvasItem.GetGlobalMousePosition()

CanvasItem.GetCanvas()

CanvasItem.GetWorld2D()

CanvasItem.SetNotifyLocalTransform(bool)

CanvasItem.IsLocalTransformNotificationEnabled()

CanvasItem.SetNotifyTransform(bool)

CanvasItem.IsTransformNotificationEnabled()

CanvasItem.ForceUpdateTransform()

CanvasItem.MakeCanvasPositionLocal(Vector2)

CanvasItem.MakeInputLocal(InputEvent)

CanvasItem.SetVisibilityLayerBit(uint, bool)

CanvasItem.GetVisibilityLayerBit(uint)

CanvasItem.Visible

CanvasItem.Modulate

CanvasItem.SelfModulate

CanvasItem.ShowBehindParent

CanvasItem.TopLevel

CanvasItem.ClipChildren

CanvasItem.LightMask

CanvasItem.VisibilityLayer

CanvasItem.ZIndex

CanvasItem.ZAsRelative

CanvasItem.YSortEnabled

CanvasItem.TextureFilter

CanvasItem.TextureRepeat

CanvasItem.Material

CanvasItem.UseParentMaterial

CanvasItem.Draw

CanvasItem.VisibilityChanged

CanvasItem.Hidden

CanvasItem.ItemRectChanged

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.NotificationNodeRecacheRequested

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.NotificationOsMemoryWarning

Node.NotificationTranslationChanged

Node.NotificationWMAbout

Node.NotificationCrash

Node.NotificationOsImeUpdate

Node.NotificationApplicationResumed

Node.NotificationApplicationPaused

Node.NotificationApplicationFocusIn

Node.NotificationApplicationFocusOut

Node.NotificationTextServerChanged

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._ExitTree()

Node._GetConfigurationWarnings()

Node._Input(InputEvent)

Node._PhysicsProcess(double)

Node._Process(double)

Node._ShortcutInput(InputEvent)

Node._UnhandledKeyInput(InputEvent)

Node.PrintOrphanNodes()

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.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.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.SetDisplayFolded(bool)

Node.IsDisplayedFolded()

Node.SetProcessInternal(bool)

Node.IsProcessingInternal()

Node.SetPhysicsProcessInternal(bool)

Node.IsPhysicsProcessingInternal()

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.Rpc(StringName, params Variant[])

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

Node.UpdateConfigurationWarnings()

Node.CallDeferredThreadGroup(StringName, params Variant[])

Node.SetDeferredThreadGroup(StringName, Variant)

Node.NotifyDeferredThreadGroup(int)

Node.CallThreadSafe(StringName, params Variant[])

Node.SetThreadSafe(StringName, Variant)

Node.NotifyThreadSafe(int)

Node._ImportPath

Node.Name

Node.UniqueNameInOwner

Node.SceneFilePath

Node.Owner

Node.Multiplayer

Node.ProcessMode

Node.ProcessPriority

Node.ProcessPhysicsPriority

Node.ProcessThreadGroup

Node.ProcessThreadGroupOrder

Node.ProcessThreadMessages

Node.EditorDescription

Node.Ready

Node.Renamed

Node.TreeEntered

Node.TreeExiting

Node.TreeExited

Node.ChildEnteredTree

Node.ChildExitingTree

Node.ChildOrderChanged

Node.ReplacingBy

GodotObject.NotificationPostinitialize

GodotObject.NotificationPredelete

GodotObject.NativeInstance

GodotObject.ScriptChanged

GodotObject.PropertyListChanged

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

NodeExtensions.EnsureSingleton<T>(Node, ref T)

NodeExtensions.GetComponent<T>(Node)

NodeExtensions.GetNode<T>(Node, NodePath, out T, bool)

NodeExtensions.GetSafe<T>(Node, NodePath, out T, bool)

NodeExtensions.HandleInput(Node)

NodeExtensions.RemoveAllChildren(Node)

Fields

_currentPopup

The current panel that has popped up

private Control _currentPopup

Field Value

Control

_loadLastSaveControl

The control related to loading the last save. Removed if the configration disables loading the last save while playing.

[Export(PropertyHint.None, "")]
private Control _loadLastSaveControl

Field Value

Control

_mainMenuFile

The path to the main menu file

[Export(PropertyHint.File, "*.tscn")]
private string _mainMenuFile

Field Value

string

_menuPanel

The menu panel

[Export(PropertyHint.None, "")]
private Control _menuPanel

Field Value

Control

_optionsMenuFile

The path to the options menu file

[Export(PropertyHint.None, "")]
private PackedScene _optionsMenuFile

Field Value

PackedScene

_saveSlotRelatedElements

The controls which are related to games with multiple save slots. (Removed if SaveSlotSettings.SlotOptions != MULTI_SLOT_SAVE_DATA)

[Export(PropertyHint.None, "")]
private Control[] _saveSlotRelatedElements

Field Value

Control[]

Methods

CreateNewSlidingScene(PackedScene)

private void CreateNewSlidingScene(PackedScene packed)

Parameters

packed PackedScene

ExitToMainMenu()

private void ExitToMainMenu()

OnBtnOptions()

private void OnBtnOptions()

OnBtnReloadLastSave()

private void OnBtnReloadLastSave()

OnBtnSave()

private void OnBtnSave()

ReturnToPlay()

private void ReturnToPlay()

_Ready()

Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their Godot.Node._Ready() callbacks get triggered first, and the parent node will receive the ready notification afterwards.

Corresponds to the Godot.Node.NotificationReady notification in _Notification(int). See also the @onready annotation for variables.

Usually used for initialization. For even earlier initialization, Godot.GodotObject.GodotObject() may be used. See also Godot.Node._EnterTree().

Note: Godot.Node._Ready() may be called only once for each node. After removing a node from the scene tree and adding it again, _ready will not be called a second time. This can be bypassed by requesting another call with Godot.Node.RequestReady(), which may be called anywhere before adding the node again.

public override void _Ready()

_UnhandledInput(InputEvent)

Called when an Godot.InputEvent hasn't been consumed by Godot.Node._Input(Godot.InputEvent) or any GUI Godot.Control item. The input event propagates up through the node tree until a node consumes it.

It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with SetProcessUnhandledInput(bool).

To consume the input event and stop it propagating further to other nodes, Godot.Viewport.SetInputAsHandled() can be called.

For gameplay input, this and Godot.Node._UnhandledKeyInput(Godot.InputEvent) are usually a better fit than Godot.Node._Input(Godot.InputEvent) as they allow the GUI to intercept the events first.

Note: This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).

public override void _UnhandledInput(InputEvent @event)

Parameters

event InputEvent