Component:UserRoot: Difference between revisions

Revision as of 18:30, 6 February 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 users 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

Examples

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

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=UserRootComponent.png
-|Name=UserRoot
+|Name=User Root
 }}
 <!--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 of a user, this component references the users [[Component:AvatarRenderSettings|AvatarRenderSettings]], [[Component:ScreenController|ScreenController]] and any current [[Component:AvatarUserRootOverrideAssigner|AvatarUserRootOverrideAssigners]].
 <!--T:3-->
 == Usage ==
 {{Table ComponentFields
-|RenderSettings|IRenderSettingsSource|
+|RenderSettings|IRenderSettingsSource| The user's render settings. Usually part of an avatar.
-|ScreenController|'''[[Component:ScreenController|ScreenController]]'''|TypeAdv1=true|
+|ScreenController|'''[[Component:ScreenController|ScreenController]]'''|TypeAdv1=true| The screen controller that the user is using to control the game.
-|OverrideRoot|Slot|
+|OverrideRoot|Slot| The slot currently overriding the user's root position locally for rendering.
-|OverrideView|Slot|
+|OverrideView|Slot| The slot currently overriding the user's view position locally for rendering.
-|OverrideEars|Slot|
+|OverrideEars|Slot| The slot currently overriding the user's ears position locally for rendering audio.
 }}
 <!--T:4-->
-== Behavior ==
+== Usage ==
 <!--T:5-->
 == Examples ==
+Found in the user root slot of users in the world.
 <!--T:6-->
-== Related Components ==
+== See Also ==
 </translate>
 [[Category:Components{{#translation:}}|User Root]]
-[[Category:ComponentStubs]]
 [[Category:Components:Users{{#translation:}}|User Root]]