Automated: update Fields, Categories |
Add info |
||
Line 7: | Line 7: | ||
|Name=AvatarVoiceRangeVisualizer | |Name=AvatarVoiceRangeVisualizer | ||
}} | }} | ||
The '''AvatarVoiceRangeVisualizer''' component is used to generate and maintain the whisper bubble that appears when a user enables their whisper bubble mode. | |||
<!--T:3--> | <!--T:3--> | ||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|VolumeSource|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv0=true| | |VolumeSource|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv0=true| A float representing audio change. Usually the <code>Volume</code> field from a [[Component:VolumeMeter]] | ||
|AudioOutput|{{RootFieldType|RelayRef`1|[[Component:AudioOutput|AudioOutput]]}}|TypeAdv1=true| | |AudioOutput|{{RootFieldType|RelayRef`1|[[Component:AudioOutput|AudioOutput]]}}|TypeAdv1=true| An audio output to read info from to make the bubble size | ||
|WhisperColorMin|ColorX| | |WhisperColorMin|ColorX| The color the bubble should glow at when the user is not speaking during whisper mode. | ||
|WhisperColorMax|ColorX| | |WhisperColorMax|ColorX| The color the bubble should glow at when the user is speaking at max volume during whisper mode. | ||
|WhisperColorRecordingMessage|ColorX| | |WhisperColorRecordingMessage|ColorX| The color the bubble should be when the user is recording a message. | ||
|VisualRoot|Slot| | |VisualRoot|Slot| The root slot of the visual generated for this component to function | ||
|_activeUser|User| | |_activeUser|User| The user controlling and updating this component's logic. | ||
|_visualSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv7=true| | |_visualSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv7=true| The field to use when driving the size of this visual to match the range of the user's whisper mode. Uses <code>AudioOutput</code>'s range for the source of the data. | ||
|_visualColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv8=true| | |_visualColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv8=true| The field to drive to a color in an inclusive range of <code>WhisperColorMin</code> and <code>WhisperColorMax</code> depending on volume output. | ||
}} | }} | ||
<!--T:4--> | <!--T:4--> | ||
== | == Usage == | ||
<!--T:5--> | <!--T:5--> | ||
Line 32: | Line 30: | ||
<!--T:6--> | <!--T:6--> | ||
== | == See Also == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Avatar Voice Range Visualizer]] | [[Category:Components{{#translation:}}|Avatar Voice Range Visualizer]] | ||
[[Category:Components:Users:Common Avatar System:Audio{{#translation:}}|Avatar Voice Range Visualizer]] | [[Category:Components:Users:Common Avatar System:Audio{{#translation:}}|Avatar Voice Range Visualizer]] |
Latest revision as of 19:59, 10 November 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
The AvatarVoiceRangeVisualizer component is used to generate and maintain the whisper bubble that appears when a user enables their whisper bubble mode.
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. |
VolumeSource
|
IField`1<Float> | A float representing audio change. Usually the Volume field from a Component:VolumeMeter
|
AudioOutput
|
direct RelayRef`1<AudioOutput> | An audio output to read info from to make the bubble size |
WhisperColorMin
|
ColorX | The color the bubble should glow at when the user is not speaking during whisper mode. |
WhisperColorMax
|
ColorX | The color the bubble should glow at when the user is speaking at max volume during whisper mode. |
WhisperColorRecordingMessage
|
ColorX | The color the bubble should be when the user is recording a message. |
VisualRoot
|
Slot | The root slot of the visual generated for this component to function |
_activeUser
|
User | The user controlling and updating this component's logic. |
_visualSize
|
field drive of Float3 | The field to use when driving the size of this visual to match the range of the user's whisper mode. Uses AudioOutput 's range for the source of the data.
|
_visualColor
|
field drive of ColorX | The field to drive to a color in an inclusive range of WhisperColorMin and WhisperColorMax depending on volume output.
|