Automated: create new component page |
add info |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{UserspaceComponent}} | |||
{{Infobox Component | {{Infobox Component | ||
|Image=ScreenModeControllerComponent.png | |Image=ScreenModeControllerComponent.png | ||
|Name=Screen Mode Controller | |Name=Screen Mode Controller | ||
}} | }} | ||
The '''ScreenModeController''' component is used to control the interactions of the user within user space also known as the dash world. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|_dash|'''[[Component:UserspaceRadiantDash|UserspaceRadiantDash]]'''|TypeAdv0=true| | |_dash|'''[[Component:UserspaceRadiantDash|UserspaceRadiantDash]]'''|TypeAdv0=true| The dash of the dash world. | ||
|_muteSound|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv1=true| | |_muteSound|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv1=true| The audio clip to play when the user mutes themselves. | ||
|_unmuteSound|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv2=true| | |_unmuteSound|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv2=true| The audio clip to play when the user unmutes themselves. | ||
|_startTalkSound|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv3=true| | |_startTalkSound|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv3=true| The audio clip to play when the user starts to record a voice message. | ||
|_stopTalkSound|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv4=true| | |_stopTalkSound|{{RootFieldType|AssetRef`1|[[Type:AudioClip|AudioClip]]}}|TypeAdv4=true| The audio clip to play when the user stops recording a voice message. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
| Line 22: | Line 23: | ||
[[Category:Components:Uncategorized{{#translation:}}|Screen Mode Controller]] | [[Category:Components:Uncategorized{{#translation:}}|Screen Mode Controller]] | ||
[[Category:Components{{#translation:}}|Screen Mode Controller]] | [[Category:Components{{#translation:}}|Screen Mode Controller]] | ||
Latest revision as of 23:16, 2 August 2025
Component image File:ScreenModeControllerComponent.pngScreen Mode Controller component as seen in the Scene Inspector
The ScreenModeController component is used to control the interactions of the user within user space also known as the dash world.
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. |
_dash
|
UserspaceRadiantDash | The dash of the dash world. |
_muteSound
|
AudioClip | The audio clip to play when the user mutes themselves. |
_unmuteSound
|
AudioClip | The audio clip to play when the user unmutes themselves. |
_startTalkSound
|
AudioClip | The audio clip to play when the user starts to record a voice message. |
_stopTalkSound
|
AudioClip | The audio clip to play when the user stops recording a voice message. |