Component:AvatarRenderSettings

This page contains changes which are not marked for translation.

Component image

**AvatarRenderSettings** component as seen in the Scene Inspector

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

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.
`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.

Driving or setting NearClip to be zero without null can cause strange visual effects.

Examples

Traditionally this component has be used to prevent a user from seeing the snout(muzzle) or the hair on an avatars face due to it's simplicity of use. However this comes with the downside that it affects anything within it's set distance, including your own hands, menus, and other effects(The Default Avatar uses this you wish to play) so is no longer recommended, with RenderTransformOverride (Component) being suggested instead.

If desired, it can be still be used this way by adding a slot with the to the avatar and set the NearClip field to 0.1, from there check if the view is clear, and slowly reduce the value until it just removes the problem geometry.

Another common use is to to allow a user to be able to see objects outside of normal clipping distance by making FarClip larger than 4096. This is handy in very large worlds, such as some AGRA tracks.

The component can be driven dynamically, the example detects if the user's Head Proxy is pulled away from the head by more than a set amount(such as when anchored in a vehicle seat and attempting to move in just the wrong way) to automatically turn on no clip to clear the user's vision.

Usage

Behavior

Examples

See Also