Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Desktop Controller | |Name=Desktop Controller | ||
}} | }} | ||
The '''DesktopController''' component is used to control the desktop through the game dash. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|FollowCursor|Bool| | |FollowCursor|Bool| whether the desktop cursor should follow the Resonite dash cursor when not clicking. | ||
|LegacyInputMode|Bool| | |LegacyInputMode|Bool| Whether to use the legacy input system for desktop interaction. | ||
|Brightness|Float| | |Brightness|Float|how bright the desktop display should be in the dash. | ||
|Opacity|Float| | |Opacity|Float| how transparent the desktop display should be in the dash. | ||
|_displayColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv4=true| | |_displayColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv4=true| The color of the display texture to drive | ||
|_displayRect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv5=true| | |_displayRect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv5=true| The UIX size rectangle for the display texture. | ||
|_desktopTexture|'''[[Component:DesktopTextureProvider|DesktopTextureProvider]]'''|TypeAdv6=true| | |_desktopTexture|'''[[Component:DesktopTextureProvider|DesktopTextureProvider]]'''|TypeAdv6=true| The texture displaying the desktop. | ||
|_interactionRelay|'''[[Component:DesktopInteractionRelay|DesktopInteractionRelay]]'''|TypeAdv7=true| | |_interactionRelay|'''[[Component:DesktopInteractionRelay|DesktopInteractionRelay]]'''|TypeAdv7=true| The relay allowing for system Desktop interaction. | ||
|_currentControl|'''[[Component:DesktopControlDialog|DesktopControlDialog]]'''|TypeAdv8=true| | |_currentControl|'''[[Component:DesktopControlDialog|DesktopControlDialog]]'''|TypeAdv8=true| The current dialogue being used to change settings for this component. | ||
}} | }} | ||
== Examples == | == Examples == | ||
Used in the desktop dash tab to control and view the desktop. | |||
== See Also == | == See Also == | ||
| Line 26: | Line 25: | ||
[[Category:Components:Input:Desktop{{#translation:}}|Desktop Controller]] | [[Category:Components:Input:Desktop{{#translation:}}|Desktop Controller]] | ||
[[Category:Components{{#translation:}}|Desktop Controller]] | [[Category:Components{{#translation:}}|Desktop Controller]] | ||
Latest revision as of 20:43, 15 January 2025
Component image 
Desktop Controller component as seen in the Scene Inspector
The DesktopController component is used to control the desktop through the game dash.
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. |
FollowCursor
|
Bool | whether the desktop cursor should follow the Resonite dash cursor when not clicking. |
LegacyInputMode
|
Bool | Whether to use the legacy input system for desktop interaction. |
Brightness
|
Float | how bright the desktop display should be in the dash. |
Opacity
|
Float | how transparent the desktop display should be in the dash. |
_displayColor
|
field drive of ColorX | The color of the display texture to drive |
_displayRect
|
RectTransform | The UIX size rectangle for the display texture. |
_desktopTexture
|
DesktopTextureProvider | The texture displaying the desktop. |
_interactionRelay
|
DesktopInteractionRelay | The relay allowing for system Desktop interaction. |
_currentControl
|
DesktopControlDialog | The current dialogue being used to change settings for this component. |
Examples
Used in the desktop dash tab to control and view the desktop.