Component:ObjectRoot: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
clean and add sync delegate desc
 
Line 1: Line 1:


{{stub}}
{{Infobox Component
|Image=ObjectRootComponent.png
|Name=Object Root
}}
The '''ObjectRoot''' component marks a [[Slot|slot]] as the root of an object, where an object is the slot itself plus all of its child slots, recursively.
The '''ObjectRoot''' component marks a [[Slot|slot]] as the root of an object, where an object is the slot itself plus all of its child slots, recursively.
== Usage ==
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
}}
}}
Line 8: Line 12:
== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|RemoveChildrenObjectRoots:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|RemoveChildrenObjectRoots:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| will recursively delete any ObjectRoot components from this slot's children.
|RemoveChildrenObjectRoots:[[Type:Func`1|Func`1]]<[[Type:Int|Int]]>|[[Type:Func`1|Func`1]]<[[Type:Int|Int]]>|false|
|RemoveChildrenObjectRoots:[[Type:Func`1|Func`1]]<[[Type:Int|Int]]>|[[Type:Func`1|Func`1]]<[[Type:Int|Int]]>|false| will recursively delete any ObjectRoot components from this slot's children.
}}
}}


The button at the bottom of the component, "Remove all children object roots" will recursively delete any ObjectRoot components from this slot's children.
== Usage ==
 
== Behavior ==


Setting a slot as the ObjectRoot helps the [[Scene Inspector]]'s "up to object root" button find the root of the object.
Setting a slot as the ObjectRoot helps the [[Scene Inspector]]'s "up to object root" button find the root of the object.
== Examples ==
== Examples ==
== Related Components ==
== See Also ==
== Related ProtoFlux nodes ==
== Related ProtoFlux nodes ==


[[Category:Components{{#translation:}}|Object Root]]
[[Category:Components{{#translation:}}|Object Root]]
[[Category:Components:Transform{{#translation:}}|Object Root]]
[[Category:Components:Transform{{#translation:}}|Object Root]]

Latest revision as of 21:20, 7 April 2025

Component image 
File:ObjectRootComponent.png
Object Root component as seen in the Scene Inspector

The ObjectRoot component marks a slot as the root of an object, where an object is the slot itself plus all of its child slots, recursively.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
RemoveChildrenObjectRoots:ButtonEventHandler ButtonEventHandler will recursively delete any ObjectRoot components from this slot's children.
RemoveChildrenObjectRoots:Func`1<Int> Func`1<Int> X will recursively delete any ObjectRoot components from this slot's children.

Usage

Setting a slot as the ObjectRoot helps the Scene Inspector's "up to object root" button find the root of the object.

Examples

See Also

Related ProtoFlux nodes