Automated: update Fields, Categories |
Add info |
||
| Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=AvatarRenderSettingsComponent.png | |Image=AvatarRenderSettingsComponent.png | ||
|Name=AvatarRenderSettings | |Name=AvatarRenderSettings | ||
}} | }} | ||
Avatar Render Settings is a component that can be placed anywhere on an avatar for it to work. This component changes the internal camera settings for the first person view for a user wearing an avatar with this component under it by optionally changing the far and/or near clip values of the POV camera. | |||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|NearClip|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv0=true| | |NearClip|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv0=true| If not null, changes the NearClip of the user's POV camera when this component is under the user's avatar hierarchy. | ||
|FarClip|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv1=true| | |FarClip|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv1=true| If not null, changes the FarClip of the user's POV camera when this component is under the user's avatar hierarchy. | ||
}} | }} | ||
<!--T:4--> | <!--T:4--> | ||
== Behavior == | == Behavior == | ||
This component does not start working on an avatar when added, until the avatar is re-equipped. After this, changing values on the component change what the user sees live. This component can be used to extend the distance a user can see, which by default is 4096 meters multipled by user global scale. | |||
<!--T:5--> | <!--T:5--> | ||
== Examples == | == Examples == | ||
Can be used to prevent a user from seeing the snout of an avatar, or the hair on an avatars face. This can also be used to allow a user to be able to see objects outside of normal clipping distance by making <code>FarClip</code> larger than 4096. | |||
<!--T:6--> | <!--T:6--> | ||
| Line 28: | Line 27: | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Avatar Render Settings]] | [[Category:Components{{#translation:}}|Avatar Render Settings]] | ||
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Render Settings]] | [[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Render Settings]] | ||
Latest revision as of 16:58, 14 October 2024
Avatar Render Settings is a component that can be placed anywhere on an avatar for it to work. This component changes the internal camera settings for the first person view for a user wearing an avatar with this component under it by optionally changing the far and/or near clip values of the POV camera.
Usage
| 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. |
NearClip
|
Nullable`1<Float> | If not null, changes the NearClip of the user's POV camera when this component is under the user's avatar hierarchy. |
FarClip
|
Nullable`1<Float> | If not null, changes the FarClip of the user's POV camera when this component is under the user's avatar hierarchy. |
Behavior
This component does not start working on an avatar when added, until the avatar is re-equipped. After this, changing values on the component change what the user sees live. This component can be used to extend the distance a user can see, which by default is 4096 meters multipled by user global scale.
Examples
Can be used to prevent a user from seeing the snout of an avatar, or the hair on an avatars face. This can also be used to allow a user to be able to see objects outside of normal clipping distance by making FarClip larger than 4096.