Component:UserRoot: Difference between revisions

From Resonite Wiki
add remaining info
Added links and usage description.
Line 8: Line 8:


<!--T:2-->
<!--T:2-->
The '''UserRoot''' component can be found on the top slot of a user, this component references the users [[Component:AvatarRenderSettings|AvatarRenderSettings]], [[Component:ScreenController|ScreenController]] and any current [[Component:AvatarUserRootOverrideAssigner|AvatarUserRootOverrideAssigners]].
The '''UserRoot''' component can be found on the top [[Slot|slot]] of a [[User|user]], this component references the user's [[Component:AvatarRenderSettings|AvatarRenderSettings]], [[Component:ScreenController|ScreenController]] and any current [[Component:AvatarUserRootOverrideAssigner|AvatarUserRootOverrideAssigners]].


<!--T:3-->
<!--T:3-->
Line 22: Line 22:
<!--T:4-->
<!--T:4-->
== Usage ==
== Usage ==
Usually users find the slot containing this component by using the [[ProtoFlux]] node [[ProtoFlux:User Root Slot|User Root Slot]].


<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
Found in the user root slot of users in the world.
Found in the user root slot of users in the [[World|world]].


<!--T:6-->
<!--T:6-->

Revision as of 11:43, 5 March 2025

Component image 
User Root component as seen in the Scene Inspector


The UserRoot component can be found on the top slot of a user, this component references the user's AvatarRenderSettings, ScreenController and any current AvatarUserRootOverrideAssigners.

Usage

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.
RenderSettings IRenderSettingsSource The user's render settings. Usually part of an avatar.
ScreenController ScreenController The screen controller that the user is using to control the game.
OverrideRoot Slot The slot currently overriding the user's root position locally for rendering.
OverrideView Slot The slot currently overriding the user's view position locally for rendering.
OverrideEars Slot The slot currently overriding the user's ears position locally for rendering audio.

Usage

Usually users find the slot containing this component by using the ProtoFlux node User Root Slot.

Examples

Found in the user root slot of users in the world.

See Also