Component:RectMesh: Difference between revisions

Revision as of 10:53, 21 July 2024

Component image

**Rect Mesh`1** component as seen in the Scene Inspector

The RectMesh component takes in a value (either a dynamic value from an IAudioSource, or a min and max float value) and parameters for the generated rect mesh, then renders it onto the UIX.

This component is currently under investigation for being unstable and causing world crashes. This page will be updated when further information is found out.

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.
`Mesh`	direct M	The mesh parameters used to render this rect mesh.
`Materials`	list of Material	The material to render for this rect mesh.

Usage

This can be used to make fancy audio visuals from a user's Audio Stream Controller.

@@ Line 3: / Line 3: @@
 |Name=Rect Mesh`1
 }}
-{{stub}}
-== Usage ==
+The '''RectMesh''' component takes in a value (either a dynamic value from an [[Type:IAudioSource|IAudioSource]], or a min and max [[Type:float|float]] value) and parameters for the generated rect mesh, then renders it onto the [[UIX]].
+{{Note|This component is currently under investigation for being unstable and causing world crashes. This page will be updated when further information is found out.|warning}}
 {{Table ComponentFields
-|Mesh|{{RootFieldType|(nested)|M}}|TypeAdv0=true|
+|Mesh|{{RootFieldType|(nested)|M}}|TypeAdv0=true|The mesh parameters used to render this rect mesh.
-|Materials|{{RootFieldType|SyncAssetList`1|[[Type:Material|Material]]}}|TypeAdv1=true|
+|Materials|{{RootFieldType|SyncAssetList`1|[[Type:Material|Material]]}}|TypeAdv1=true|The material to render for this rect mesh.
 }}
-== Behavior ==
+== Usage ==
+This can be used to make fancy audio visuals from a user's [[Audio Stream Controller]].
 == Examples ==
 == See Also ==
+* Similar to [[Component:StandaloneRectMesh|StandaloneRectMesh]].
 [[Category:Components:UIX:Graphics{{#translation:}}|Rect Mesh`1]]
 [[Category:Components{{#translation:}}|Rect Mesh`1]]
 [[Category:Generic Components{{#translation:}}|Rect Mesh`1]]
-[[Category:ComponentStubs]]