Component:AvatarUserMeshHider: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
add info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarUserMeshHiderComponent.png
|Image=AvatarUserMeshHiderComponent.png
|Name=AvatarUserMeshHider
|Name=AvatarUserMeshHider
}}
}}
 
The '''AvatarUserMeshHider''' component makes non Skinned meshes invisible or only cast shadows according to the active user's perspective. It does this by making value User overrides for all MeshRenderers except for those in <code>Exclude</code>. It restores the fields back to normal after dequipping.
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Method|'''[[#HideMethod|HideMethod]]'''|TypeAdv0=true|
|Method|'''[[#HideMethod|HideMethod]]'''|TypeAdv0=true| How to hide the meshes for the active user under the avatar.
|Exclude|{{RootFieldType|SyncRefList`1|[[Component:MeshRenderer|MeshRenderer]]}}|TypeAdv1=true|
|Exclude|{{RootFieldType|SyncRefList`1|[[Component:MeshRenderer|MeshRenderer]]}}|TypeAdv1=true| Which meshes to not hide for the active user.
}}
 
== HideMethod ==
{{Table EnumValues
|ShadowOnly|0| Hide the meshes by value user overriding them to Shadow Only for the active user
|Deactivate|1| Hide the meshes by value user overriding their active field to false only for the active user.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
{{stub}}


<!--T:5-->
<!--T:5-->
Line 25: Line 29:


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar User Mesh Hider]]
[[Category:Components{{#translation:}}|Avatar User Mesh Hider]]
[[Category:ComponentStubs]]
[[Category:Components With Nested Enums{{#translation:}}|Avatar User Mesh Hider]]
[[Category:Components With Nested Enums{{#translation:}}|Avatar User Mesh Hider]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar User Mesh Hider]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar User Mesh Hider]]

Latest revision as of 21:07, 29 December 2024

Component image 
AvatarUserMeshHider component as seen in the Scene Inspector

The AvatarUserMeshHider component makes non Skinned meshes invisible or only cast shadows according to the active user's perspective. It does this by making value User overrides for all MeshRenderers except for those in Exclude. It restores the fields back to normal after dequipping.

Fields

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.
Method HideMethod How to hide the meshes for the active user under the avatar.
Exclude list of MeshRenderer Which meshes to not hide for the active user.

HideMethod

Values
Name Value Description
ShadowOnly 0 Hide the meshes by value user overriding them to Shadow Only for the active user
Deactivate 1 Hide the meshes by value user overriding their active field to false only for the active user.


Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Examples

See Also