ProtoFlux:Get Object Root: Difference between revisions

From Resonite Wiki
m fix titles
m Links, minor rewordings
 
Line 13: Line 13:
|}}
|}}


Returns the root [[Slot|slot]] of an object from one slot input which is a child of the specified object.
Returns the "root" [[Slot|slot]] of an object, from a slot child input.


== Inputs ==
== Inputs ==
Line 23: Line 23:
=== OnlyExplicit ([[Type:Bool|bool]]) ===
=== OnlyExplicit ([[Type:Bool|bool]]) ===


If this is true, it will explicitly look for slots which have a ObjectRoot component.
If this is true, only slots with an [[Component:ObjectRoot|ObjectRoot]] component will be considered a root.  


If this is false, it will look for slots containing a component which implements IObjectRoot. These include:
If this is false, slots containing a component implementing <code>IObjectRoot</code> are also considered roots. These are:


* LegacyPanel
* [[Component:LegacyPanel|LegacyPanel]]
* SceneInspector
* [[Component:SceneInspector|SceneInspector]]
* ObjectRoot
* [[Component:ObjectRoot|ObjectRoot]]
* Grabbable
* [[Component:Grabbable|Grabbable]]
* ProtoFluxNode
* [[Component:ProtoFluxNode|ProtoFluxNode]]


== Outputs ==
== Outputs ==
Line 37: Line 37:
=== * ([[Slot|Slot]]) ===
=== * ([[Slot|Slot]]) ===


Will return a [[Slot|slot]] being the root of the object.
Will return a [[Slot|slot]] being the root of the object. If no slot was found, the input slot is returned.
 
If no such component is found, the initial slot itself will be returned.


== Examples ==
== Examples ==

Latest revision as of 07:10, 4 March 2024

Get Object Root
Instance
*
OnlyExplicit
Slots

Returns the "root" slot of an object, from a slot child input.

Inputs

Instance (Slot)

A slot within the object you want the root of.

OnlyExplicit (bool)

If this is true, only slots with an ObjectRoot component will be considered a root.

If this is false, slots containing a component implementing IObjectRoot are also considered roots. These are:

Outputs

* (Slot)

Will return a slot being the root of the object. If no slot was found, the input slot is returned.

Examples

Using this node on a hit collider slot of a Grabbable object with OnlyExplicit set to false you can get the slot containing the Grabbable component which is most likely going to be the object's root, even if the object doesn't have a explicit ObjectRoot component.