Added links and usage description. |
add missing enum |
||
Line 11: | Line 11: | ||
<!--T:3--> | <!--T:3--> | ||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|RenderSettings|IRenderSettingsSource| The user's render settings. Usually part of an avatar. | |RenderSettings|IRenderSettingsSource| The user's render settings. Usually part of an avatar. | ||
Line 18: | Line 18: | ||
|OverrideView|Slot| The slot currently overriding the user's view 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. | |OverrideEars|Slot| The slot currently overriding the user's ears position locally for rendering audio. | ||
}} | |||
== UserNode == | |||
{{Table EnumValues | |||
|None|0| Do operations based off of no user node. | |||
|Root|1| Do operations based off of the user root slot. | |||
|GroundProjectedHead|2| Do operations based off of the user's head projected to the ground and use the hit normal too. | |||
|Head|3| Do operations based off of user head. | |||
|Hips|4| Do operations based off of user hips. | |||
|Feet|5| Do operations based off of between user feet. | |||
|View|6| Do operations based off of user view. | |||
}} | }} | ||
Latest revision as of 22:48, 17 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.
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. |
UserNode
Name | Value | Description |
---|---|---|
None
|
0 | Do operations based off of no user node. |
Root
|
1 | Do operations based off of the user root slot. |
GroundProjectedHead
|
2 | Do operations based off of the user's head projected to the ground and use the hit normal too. |
Head
|
3 | Do operations based off of user head. |
Hips
|
4 | Do operations based off of user hips. |
Feet
|
5 | Do operations based off of between user feet. |
View
|
6 | Do operations based off of user view. |
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.