Component:TalkVisualizer: Difference between revisions

Revision as of 21:57, 16 October 2024

Component image

**Talk Visualizer** component as seen in the Scene Inspector

This component takes a float value and a colorX value, and multiplies the float value by the colorX value, and outputs a colorX.

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.
`Input`	RawOutput`1<Float>	A value that constantly changes to visualize the color for. For example, the `Volume` field of a Volume Meter.
`BaseColor`	ColorX	The original color.
`MaterialColor`	reference drive of Sync`1<ColorX>	The color to drive with an amplified `BaseColor` value based on `Input`
`LightIntensity`	reference drive of Sync`1<Float>	How bright the output color is beyond 1 gain.

Examples

This component is used in the default avatar to visualize the talking volume of a user wearing it. This could also be used for an audio visualizer.

@@ Line 3: / Line 3: @@
 |Name=Talk Visualizer
 }}
-{{stub}}
+This component takes a float value and a colorX value, and multiplies the float value by the colorX value, and outputs a colorX.
 == Usage ==
 {{Table ComponentFields
-|Input|'''[[Type:RawOutput`1|RawOutput`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv0=true|
+|Input|'''[[Type:RawOutput`1|RawOutput`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv0=true| A value that constantly changes to visualize the color for. For example, the <code>Volume</code> field of a [[Component:VolumeMeter|Volume Meter]].
-|BaseColor|ColorX|
+|BaseColor|ColorX| The original color.
-|MaterialColor|{{RootFieldType|DriveRef`1|[[Type:Sync`1|Sync`1]]&lt;[[Type:ColorX|ColorX]]&gt;}}|TypeAdv2=true|
+|MaterialColor|{{RootFieldType|DriveRef`1|[[Type:Sync`1|Sync`1]]&lt;[[Type:ColorX|ColorX]]&gt;}}|TypeAdv2=true| The color to drive with an amplified <code>BaseColor</code> value based on <code>Input</code>
-|LightIntensity|{{RootFieldType|DriveRef`1|[[Type:Sync`1|Sync`1]]&lt;[[Type:Float|Float]]&gt;}}|TypeAdv3=true|
+|LightIntensity|{{RootFieldType|DriveRef`1|[[Type:Sync`1|Sync`1]]&lt;[[Type:Float|Float]]&gt;}}|TypeAdv3=true| How bright the output color is beyond 1 gain.
 }}
-== Behavior ==
 == Examples ==
+This component is used in the default avatar to visualize the talking volume of a user wearing it. This could also be used for an audio visualizer.
 == See Also ==
+[[Component:VolumeMeter|Volume Meter]]
 [[Category:Components:Uncategorized{{#translation:}}|Talk Visualizer]]
 [[Category:Components{{#translation:}}|Talk Visualizer]]
-[[Category:ComponentStubs]]