Component:VoiceModeSync: Difference between revisions

Latest revision as of 19:03, 14 April 2025

Component image

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

The VoiceModeSync component only works in userspace. It allows for getting the status of the user's chosen voice mode options and if they can use certain modes.

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. Some components stop their functionality when this field is disabled, but some don't.
`FocusedWorldVoiceMode`	VoiceMode	The voice mode set for the current world.
`GlobalMute`	Bool	Whether the user is muted for everyone.
`FocusedWorldMaxAllowedVoiceMode`	raw output of VoiceMode	The maximum voice mode their allowed by the role the user has in the current focused world.
`BroadcastAllowed`	raw output of Bool	Whether broadcast is allowed for the user voice modes for the user in the currently focused world.
`ShoutAllowed`	raw output of Bool	Whether shout is allowed for the user voice modes for the user in the currently focused world.
`NormalAllowed`	raw output of Bool	Whether normal is allowed for the user voice modes for the user in the currently focused world.
`WhisperAllowed`	raw output of Bool	Whether whisper is allowed for the user voice modes for the user in the currently focused world.

Usage

Attach to a slot that would exist in userspace, such as a facet. From there, the fields will update depending on the currently focused world.

Examples

Used in the default microphone modes facet.

@@ Line 1: / Line 1: @@
 {{Infobox Component
 |Image=VoiceModeSyncComponent.png
-|Name=Voice Mode Sync
+|Name=VoiceModeSync
 }}
-The '''VoiceModeSync''' component only works in the dash world which the [[Dash Menu]] is located in. It allows for getting the status of the user's chosen voice mode options, and if they can use certain modes.
+The '''VoiceModeSync''' component only works in [[userspace]]. It allows for getting the status of the user's chosen voice mode options and if they can use certain modes.
 == Fields ==
@@ Line 17: / Line 18: @@
 == Usage ==
-Attach to a slot that would exist in the dash world, for example, in a [[facet]]. Then when in the dash world this component will start functioning.
+Attach to a slot that would exist in [[userspace]], such as a [[facet]]. From there, the fields will update depending on the currently focused world.
 == Examples ==
 Used in the default microphone modes facet.
 == See Also ==
-* [[Dash Menu]]
+* [[Userspace]]
+* [[Dash menu]]
 [[Category:Components:Utility{{#translation:}}|Voice Mode Sync]]
 [[Category:Components{{#translation:}}|Voice Mode Sync]]