Class SlidingPanelComponent

Namespace

Squiggles.Core.Scenes.UI

Assembly

SquigglesCommon4X.dll

A component used heavily in the main menu elements. It is designed to create cascading panels that slide in and out smoothly. See the default main menu for examples.

[GlobalClass]
[ScriptPath("res://Core/Modules/GUI/SlidingPanelComponent.cs")]
public class SlidingPanelComponent : Node, IDisposable

Inheritance

object

GodotObject

Node

SlidingPanelComponent

Implements

IDisposable

Inherited Members

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

_easingHide

The ease type to use when hiding

[Export(PropertyHint.None, "")]
private Tween.EaseType _easingHide

Field Value

Tween.EaseType

_easingShow

The ease type to use when showing

[Export(PropertyHint.None, "")]
private Tween.EaseType _easingShow

Field Value

Tween.EaseType

_isStable

private bool _isStable

Field Value

bool

_pathSubSlidingRoot

The path where child sliding panels should be added

[Export(PropertyHint.None, "")]
private NodePath _pathSubSlidingRoot

Field Value

NodePath

_popInDuration

The time this panel takes to slide in

[Export(PropertyHint.None, "")]
private float _popInDuration

Field Value

float

_popOutDuration

The time this panel takes to slide out

[Export(PropertyHint.None, "")]
private float _popOutDuration

Field Value

float

_target

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

Field Value

Control

_transHide

The transition type to use when hiding

[Export(PropertyHint.None, "")]
private Tween.TransitionType _transHide

Field Value

Tween.TransitionType

_transShow

The transition type to use when showing

[Export(PropertyHint.None, "")]
private Tween.TransitionType _transShow

Field Value

Tween.TransitionType

Methods

RemoveScene()

An async function that clears this sliding panel. It is async because first it must clear child panels (cascade style) and once they are cleared this one can slide out and them finally return. Await this function to remove the panel and then do something once its gone.

public Task RemoveScene()

Returns

Task

nothing! It's async

_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