Class NullComponentHub
- Namespace
- Cobilas.GodotEngine.Component
- Assembly
- com.cobilas.godot.icomponent.dll
Represents a null ComponentHub.
public class NullComponentHub : Node, IDisposable, IComponentHub, IEnumerable<Node>, IEnumerable, INullObject
- Inheritance
-
ObjectNodeNullComponentHub
- Implements
-
IEnumerable<Node>
- Inherited Members
-
Node.NotificationEnterTreeNode.NotificationExitTreeNode.NotificationMovedInParentNode.NotificationReadyNode.NotificationPausedNode.NotificationUnpausedNode.NotificationPhysicsProcessNode.NotificationProcessNode.NotificationParentedNode.NotificationUnparentedNode.NotificationInstancedNode.NotificationDragBeginNode.NotificationDragEndNode.NotificationPathChangedNode.NotificationChildOrderChangedNode.NotificationInternalProcessNode.NotificationInternalPhysicsProcessNode.NotificationPostEnterTreeNode.NotificationResetPhysicsInterpolationNode.NotificationWmMouseEnterNode.NotificationWmMouseExitNode.NotificationWmFocusInNode.NotificationWmFocusOutNode.NotificationWmQuitRequestNode.NotificationWmGoBackRequestNode.NotificationWmUnfocusRequestNode.NotificationOsMemoryWarningNode.NotificationTranslationChangedNode.NotificationWmAboutNode.NotificationCrashNode.NotificationOsImeUpdateNode.NotificationAppResumedNode.NotificationAppPausedNode.GetNode<T>(NodePath)Node.GetNodeOrNull<T>(NodePath)Node.GetOwner<T>()Node.GetOwnerOrNull<T>()Node.GetParent<T>()Node.GetParentOrNull<T>()Node._EnterTree()Node._ExitTree()Node._GetConfigurationWarning()Node._Input(InputEvent)Node._Ready()Node._UnhandledInput(InputEvent)Node._UnhandledKeyInput(InputEventKey)Node.GetName()Node.RemoveChild(Node)Node.GetChildCount()Node.GetChildren()Node.HasNode(NodePath)Node.GetNode(NodePath)Node.GetNodeOrNull(NodePath)Node.GetParent()Node.HasNodeAndResource(NodePath)Node.GetNodeAndResource(NodePath)Node.IsInsideTree()Node.IsAParentOf(Node)Node.IsGreaterThan(Node)Node.GetPath()Node.GetPathTo(Node)Node.GetGroups()Node.Raise()Node.SetOwner(Node)Node.GetOwner()Node.RemoveAndSkip()Node.GetIndex()Node.PrintTree()Node.PrintTreePretty()Node.GetFilename()Node.GetPhysicsProcessDeltaTime()Node.IsPhysicsProcessing()Node.GetProcessDeltaTime()Node.GetProcessPriority()Node.IsProcessing()Node.IsProcessingInput()Node.IsProcessingUnhandledInput()Node.IsProcessingUnhandledKeyInput()Node.SetPauseMode(Node.PauseModeEnum)Node.GetPauseMode()Node.CanProcess()Node.PrintStrayNodes()Node.GetPositionInParent()Node.IsDisplayedFolded()Node.IsProcessingInternal()Node.IsPhysicsProcessingInternal()Node.SetPhysicsInterpolationMode(Node.PhysicsInterpolationModeEnum)Node.GetPhysicsInterpolationMode()Node.IsPhysicsInterpolated()Node.IsPhysicsInterpolatedAndEnabled()Node.ResetPhysicsInterpolation()Node.GetTree()Node.CreateTween()Node.GetSceneInstanceLoadPlaceholder()Node.IsEditableInstance(Node)Node.GetViewport()Node.QueueFree()Node.RequestReady()Node.IsNodeReady()Node.GetNetworkMaster()Node.IsNetworkMaster()Node.GetMultiplayer()Node.GetCustomMultiplayer()Node.SetCustomMultiplayer(MultiplayerAPI)Node.IsUniqueNameInOwner()Node.UpdateConfigurationWarning()Node.EditorDescriptionNode._ImportPathNode.PauseModeNode.PhysicsInterpolationModeNode.NameNode.UniqueNameInOwnerNode.FilenameNode.OwnerNode.MultiplayerNode.CustomMultiplayerNode.ProcessPriorityObject.NotificationPostinitializeObject.NotificationPredeleteObject.IsInstanceValid(Object)Object.WeakRef(Object)Object.Dispose()Object.ToString()Object._GetPropertyList()Object.Free()Object.GetClass()Object.GetIndexed(NodePath)Object.GetPropertyList()Object.GetMethodList()Object.GetInstanceId()Object.SetScript(Reference)Object.GetScript()Object.GetMetaList()Object.GetSignalList()Object.GetIncomingConnections()Object.IsBlockingSignals()Object.PropertyListChangedNotify()Object.CanTranslateMessages()Object.IsQueuedForDeletion()Object.NativeInstanceObject.DynamicObject
Properties
ComponentsCount
The number of child objects.
public int ComponentsCount { get; }
Property Value
- int
Returns the number of child objects.
Null
A representation of a null ComponentHub.
public static NullComponentHub Null { get; }
Property Value
- NullComponentHub
Returns a representation of a null ComponentHub.
Parent
The parent object.
public Node? Parent { get; }
Property Value
- Node
Returns the parent object.
ParentComponent
The parent object as IComponentHub.
public IComponentHub? ParentComponent { get; }
Property Value
- IComponentHub
Returns the parent object as IComponentHub.
Methods
AddComponent(Type?)
Allows you to add a component by specifying its type.
public Node? AddComponent(Type? component)
Parameters
component
TypeThe type to be added.
Returns
- Node
Returns the type that was added.
AddComponent<T>()
Allows you to add a component by specifying its type.
public T? AddComponent<T>() where T : Node
Returns
- T
Returns the type that was added.
Type Parameters
T
AddComponents(params Type[]?)
Allows you to add multiple components by specifying their type.
public void AddComponents(params Type[]? components)
Parameters
components
Type[]The types to be added.
AddNodeComponent(Node?)
Allows you to add a Godot.Node object to the component list.
public void AddNodeComponent(Node? component)
Parameters
component
NodeThe Godot.Node object to add.
AddNodeComponents(params Node[]?)
Allows you to add multiple Godot.Node objects to the component list.
public void AddNodeComponents(params Node[]? components)
Parameters
components
Node[]The Godot.Node objects to add.
GetComponent(Type?)
Gets the component by the specified type.
public Node? GetComponent(Type? component)
Parameters
component
TypeThe type to be obtained.
Returns
- Node
Returns the component type as node.
GetComponent(Type?, bool)
Gets the component by the specified type.
public Node? GetComponent(Type? component, bool recursive)
Parameters
Returns
- Node
Returns the component type as node.
GetComponent<T>()
Gets the component by the specified type.
public T? GetComponent<T>() where T : Node
Returns
- T
Returns the component type as node.
Type Parameters
T
GetComponent<T>(bool)
Gets the component by the specified type.
public T? GetComponent<T>(bool recursive) where T : Node
Parameters
recursive
boolAllows searching in sub-children.
Returns
- T
Returns the component type as node.
Type Parameters
T
GetComponents(Type?)
Gets components by the specified type.
public Node[]? GetComponents(Type? component)
Parameters
component
TypeThe type to be obtained.
Returns
- Node[]
Returns the component types as a node list.
GetComponents(Type?, bool)
Gets components by the specified type.
public Node[]? GetComponents(Type? component, bool recursive)
Parameters
Returns
- Node[]
Returns the component types as a node list.
GetComponents<T>()
Gets components by the specified type.
public T[]? GetComponents<T>() where T : Node
Returns
- T[]
Returns the component types as a node list.
Type Parameters
T
GetComponents<T>(bool)
Gets components by the specified type.
public T[]? GetComponents<T>(bool recursive) where T : Node
Parameters
recursive
boolAllows searching in sub-children.
Returns
- T[]
Returns the component types as a node list.
Type Parameters
T
GetEnumerator()
Returns an enumerator that iterates through the collection.
public IEnumerator<Node> GetEnumerator()
Returns
- IEnumerator<Node>
An enumerator that can be used to iterate through the collection.
RemoveComponent(Node?)
Allows you to remove a Godot.Node object from the list of components.
public bool RemoveComponent(Node? component)
Parameters
component
NodeThe Godot.Node object to remove.
Returns
- bool
Returns
true
if the operation is successful.
RemoveComponents(params Node[]?)
Allows you to remove several Godot.Node objects from the list of components.
public void RemoveComponents(params Node[]? components)
Parameters
components
Node[]The Godot.Node objects to be removed.