Component:VoiceModeSync: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
userspace
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Infobox Component
{{Infobox Component
|Image=VoiceModeSyncComponent.png
|Image=VoiceModeSyncComponent.png
|Name=Voice Mode Sync
|Name=VoiceModeSync
}}
}}
{{stub}}


== Usage ==
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 ==
{{Table ComponentFields
{{Table ComponentFields
|FocusedWorldVoiceMode|VoiceMode|
|FocusedWorldVoiceMode|VoiceMode| The voice mode set for the current world.
|GlobalMute|Bool|
|GlobalMute|Bool| Whether the user is muted for everyone.
|FocusedWorldMaxAllowedVoiceMode|{{RootFieldType|RawOutput`1|[[Type:VoiceMode|VoiceMode]]}}|TypeAdv2=true|
|FocusedWorldMaxAllowedVoiceMode|{{RootFieldType|RawOutput`1|[[Type:VoiceMode|VoiceMode]]}}|TypeAdv2=true| The maximum voice mode their allowed by the role the user has in the current focused world.
|BroadcastAllowed|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv3=true|
|BroadcastAllowed|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv3=true| Whether broadcast is allowed for the user voice modes for the user in the currently focused world.
|ShoutAllowed|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv4=true|
|ShoutAllowed|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv4=true| Whether shout is allowed for the user voice modes for the user in the currently focused world.
|NormalAllowed|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv5=true|
|NormalAllowed|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv5=true| Whether normal is allowed for the user voice modes for the user in the currently focused world.
|WhisperAllowed|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv6=true|
|WhisperAllowed|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv6=true| Whether whisper is allowed for the user voice modes for the user in the currently focused world.
}}
}}


== Behavior ==
== 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 ==
== Examples ==
Used in the default microphone modes facet.


== See Also ==
== See Also ==
* [[Userspace]]
* [[Dash menu]]


[[Category:Components:Utility{{#translation:}}|Voice Mode Sync]]
[[Category:Components:Utility{{#translation:}}|Voice Mode Sync]]
[[Category:Components{{#translation:}}|Voice Mode Sync]]
[[Category:Components{{#translation:}}|Voice Mode Sync]]
[[Category:ComponentStubs]]

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.

See Also