-
Notifications
You must be signed in to change notification settings - Fork 0
Node
Home | API by Category | Complete API Index | API Compatibility
| Field | Value |
|---|---|
| Full name | Electron2D.Node |
| Namespace | Electron2D |
| Kind | class |
| Category | Scene Tree |
Represents the node type.
public class Electron2D.Node : Electron2D.ObjectProfile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: Node
Lifecycle, hierarchy, Owner, groups, reparent/move, QueueFree() and GetViewport() baseline.
This type is part of the Electron2D 0.1.0 Preview public API.
Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.
This API is available since Electron2D 0.1.0 Preview.
| Member | Kind | Summary |
|---|---|---|
Name |
Property | Gets or sets the name value. |
Owner |
Property | Gets or sets the owner value. |
ProcessMode |
Property | Gets or sets how this node participates in process, physics-process and input callbacks while its scene tree is paused. |
Electron2D.Node() |
Constructor | Initializes a new instance of the Node type. |
AddChild(Electron2D.Node) |
Method | Adds the child value. |
AddToGroup(System.String, System.Boolean) |
Method | Adds the to group value. |
CreateTween() |
Method | Creates a tween bound to this node. |
GetChild(System.Int32) |
Method | Gets the child value. |
GetChildCount() |
Method | Gets the child count value. |
GetGroups() |
Method | Gets the groups value. |
GetIndex() |
Method | Gets the index value. |
GetNode(Electron2D.NodePath) |
Method | Gets the node value. |
GetNodeOrNull(Electron2D.NodePath) |
Method | Gets the node or null value. |
GetParent() |
Method | Gets the parent value. |
GetTree() |
Method | Gets the tree value. |
GetViewport() |
Method | Gets the nearest viewport that contains this node. |
IsAncestorOf(Electron2D.Node) |
Method | Checks whether ancestor of is true. |
IsInGroup(System.String) |
Method | Checks whether in group is true. |
IsInsideTree() |
Method | Checks whether inside tree is true. |
MoveChild(Electron2D.Node, System.Int32) |
Method | Executes the move child operation. |
QueueFree() |
Method | Executes the queue free operation. |
RemoveChild(Electron2D.Node) |
Method | Removes the child value. |
RemoveFromGroup(System.String) |
Method | Removes the from group value. |
Reparent(Electron2D.Node, System.Boolean) |
Method | Executes the reparent operation. |
_EnterTree() |
Method | Called when this node enters a scene tree. |
_ExitTree() |
Method | Called when this node exits a scene tree. |
_Input(Electron2D.InputEvent) |
Method | Called when an input event is delivered to this node. |
_PhysicsProcess(System.Double) |
Method | Called during a fixed physics update. |
_Process(System.Double) |
Method | Called during an idle frame update. |
_Ready() |
Method | Called when this node and its children are ready. |
Kind: Property
public System.String Name { get; set; }Gets or sets the name value.
This property follows the validation and lifetime rules of its declaring type.
The current name value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Property
public Electron2D.Node Owner { get; set; }Gets or sets the owner value.
This property follows the validation and lifetime rules of its declaring type.
The current owner value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Property
public Electron2D.ProcessMode ProcessMode { get; set; }Gets or sets how this node participates in process, physics-process and input callbacks while its scene tree is paused.
Electron2D.ProcessMode.Inherit follows the effective mode
of the nearest ancestor. A root node without a concrete ancestor falls
back to Electron2D.ProcessMode.Pausable.
The process mode for this node. The default value is
Electron2D.ProcessMode.Inherit.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.SceneTree.Paused
Kind: Constructor
public Electron2D.Node()Initializes a new instance of the Node type.
The new instance follows the lifetime and validation rules of its declaring type.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void AddChild(Electron2D.Node)(Electron2D.Node child)Adds the child value.
This method follows the validation and lifetime rules of its declaring type.
-
child: The child value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void AddToGroup(System.String, System.Boolean)(System.String group, System.Boolean persistent)Adds the to group value.
This method follows the validation and lifetime rules of its declaring type.
-
group: The group value. -
persistent: The persistent value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public Electron2D.Tween CreateTween()()Creates a tween bound to this node.
The node must already be inside a scene tree. The returned tween is processed by that tree and pauses automatic advancement while this node is outside the tree or no longer valid.
Use Electron2D.SceneTree.CreateTween when the tween should not be
bound to a specific node lifetime.
A valid Electron2D.Tween registered in the current
Electron2D.SceneTree and bound to this node.
-
System.InvalidOperationException: Thrown when this node is not currently inside aElectron2D.SceneTree.
This method is not synchronized. Call it on the main scene thread that owns this node.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.SceneTree.CreateTweenElectron2D.Tween.BindNode(Electron2D.Node)
Kind: Method
public Electron2D.Node GetChild(System.Int32)(System.Int32 index)Gets the child value.
This method follows the validation and lifetime rules of its declaring type.
-
index: The index value.
The current child value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Int32 GetChildCount()()Gets the child count value.
This method follows the validation and lifetime rules of its declaring type.
The current child count value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.String[] GetGroups()()Gets the groups value.
This method follows the validation and lifetime rules of its declaring type.
The current groups value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Int32 GetIndex()()Gets the index value.
This method follows the validation and lifetime rules of its declaring type.
The current index value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public Electron2D.Node GetNode(Electron2D.NodePath)(Electron2D.NodePath path)Gets the node value.
This method follows the validation and lifetime rules of its declaring type.
-
path: The path value.
The current node value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public Electron2D.Node GetNodeOrNull(Electron2D.NodePath)(Electron2D.NodePath path)Gets the node or null value.
This method follows the validation and lifetime rules of its declaring type.
-
path: The path value.
The current node or null value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public Electron2D.Node GetParent()()Gets the parent value.
This method follows the validation and lifetime rules of its declaring type.
The current parent value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public Electron2D.SceneTree GetTree()()Gets the tree value.
This method follows the validation and lifetime rules of its declaring type.
The current tree value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public Electron2D.Viewport GetViewport()()Gets the nearest viewport that contains this node.
Use this method from input callbacks when user code needs viewport-local
services, such as Electron2D.Viewport.SetInputAsHandled.
The 0.1.0 Preview scene tree creates a Electron2D.Viewport as its
root node. Future subviewport nodes can make the nearest ancestor rule
observable for nested viewports.
The nearest ancestor Electron2D.Viewport, or the root viewport of the
current Electron2D.SceneTree when this node is inside a tree without
a nearer viewport; otherwise, null.
This method is not synchronized. Call it on the main scene thread that owns this node.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.ViewportElectron2D.Viewport.SetInputAsHandled
Kind: Method
public System.Boolean IsAncestorOf(Electron2D.Node)(Electron2D.Node node)Checks whether ancestor of is true.
This method follows the validation and lifetime rules of its declaring type.
-
node: The node value.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Boolean IsInGroup(System.String)(System.String group)Checks whether in group is true.
This method follows the validation and lifetime rules of its declaring type.
-
group: The group value.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Boolean IsInsideTree()()Checks whether inside tree is true.
This method follows the validation and lifetime rules of its declaring type.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void MoveChild(Electron2D.Node, System.Int32)(Electron2D.Node childNode, System.Int32 toIndex)Executes the move child operation.
This method follows the validation and lifetime rules of its declaring type.
-
childNode: The child node value. -
toIndex: The to index value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void QueueFree()()Executes the queue free operation.
This method follows the validation and lifetime rules of its declaring type.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void RemoveChild(Electron2D.Node)(Electron2D.Node child)Removes the child value.
This method follows the validation and lifetime rules of its declaring type.
-
child: The child value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void RemoveFromGroup(System.String)(System.String group)Removes the from group value.
This method follows the validation and lifetime rules of its declaring type.
-
group: The group value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void Reparent(Electron2D.Node, System.Boolean)(Electron2D.Node newParent, System.Boolean keepGlobalTransform)Executes the reparent operation.
This method follows the validation and lifetime rules of its declaring type.
-
newParent: The new parent value. -
keepGlobalTransform: The keep global transform value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void _EnterTree()()Called when this node enters a scene tree.
This method follows the validation and lifetime rules of its declaring type.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void _ExitTree()()Called when this node exits a scene tree.
This method follows the validation and lifetime rules of its declaring type.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void _Input(Electron2D.InputEvent)(Electron2D.InputEvent inputEvent)Called when an input event is delivered to this node.
This method follows the validation and lifetime rules of its declaring type.
-
inputEvent: The input event value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void _PhysicsProcess(System.Double)(System.Double delta)Called during a fixed physics update.
This method follows the validation and lifetime rules of its declaring type.
-
delta: The elapsed time in seconds.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void _Process(System.Double)(System.Double delta)Called during an idle frame update.
This method follows the validation and lifetime rules of its declaring type.
-
delta: The elapsed time in seconds.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Kind: Method
public System.Void _Ready()()Called when this node and its children are ready.
This method follows the validation and lifetime rules of its declaring type.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Node
Electron2D 0.1.0 Preview API reference. Generated from 175 public runtime types.