Component:DesktopScreen: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
Line 3: Line 3:
|Name=Desktop Screen
|Name=Desktop Screen
}}
}}
{{stub}}
The '''DesktopScreen''' component is used to make the behavior of the desktop tab on the [[Dash Menu]].


== Usage ==
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Icon|Uri|
|Icon|Uri| The icon of the dash menu tab.
|ActiveColor|'''[[Type:Nullable`1|Nullable`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv1=true|
|ActiveColor|'''[[Type:Nullable`1|Nullable`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv1=true| The color when this dash menu screen tab is selected.
|Label|String|
|Label|String| The text for this dash menu Screen tab.
|ScreenEnabled|Bool|
|ScreenEnabled|Bool| Whether the screen is enabled for viewing.
|BaseResolution|Float2|
|BaseResolution|Float2| The default resolution of the desktop view.
|_screenRoot|Slot|
|_screenRoot|Slot| The root slot of the desktop screen view.
|_screenCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv6=true|
|_screenCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv6=true| The canvas being used for the desktop screen view.
|_modalOverlayManager|'''[[Component:ModalOverlayManager|ModalOverlayManager]]'''|TypeAdv7=true|
|_modalOverlayManager|'''[[Component:ModalOverlayManager|ModalOverlayManager]]'''|TypeAdv7=true| The Overlay manager being used for handling edit mode.
|_button|'''[[Component:RadiantDashButton|RadiantDashButton]]'''|TypeAdv8=true|
|_button|'''[[Component:RadiantDashButton|RadiantDashButton]]'''|TypeAdv8=true| The button to select this dash menu screen tab.
|_iconTexture|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv9=true|
|_iconTexture|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv9=true| The texture being used for the icon of this dash menu tab.
}}
}}


== Behavior ==
== Usage ==
Used in the dash menu. Not used by the user directly.


== Examples ==
== Examples ==
Used in the dash menu.


== See Also ==
== See Also ==
Line 27: Line 30:
[[Category:Components:Uncategorized{{#translation:}}|Desktop Screen]]
[[Category:Components:Uncategorized{{#translation:}}|Desktop Screen]]
[[Category:Components{{#translation:}}|Desktop Screen]]
[[Category:Components{{#translation:}}|Desktop Screen]]
[[Category:ComponentStubs]]

Revision as of 17:03, 16 February 2025

Component image 
Desktop Screen component as seen in the Scene Inspector

The DesktopScreen component is used to make the behavior of the desktop tab on the Dash Menu.


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.
Icon Uri The icon of the dash menu tab.
ActiveColor Nullable`1<ColorX> The color when this dash menu screen tab is selected.
Label String The text for this dash menu Screen tab.
ScreenEnabled Bool Whether the screen is enabled for viewing.
BaseResolution Float2 The default resolution of the desktop view.
_screenRoot Slot The root slot of the desktop screen view.
_screenCanvas Canvas The canvas being used for the desktop screen view.
_modalOverlayManager ModalOverlayManager The Overlay manager being used for handling edit mode.
_button RadiantDashButton The button to select this dash menu screen tab.
_iconTexture Texture2D The texture being used for the icon of this dash menu tab.

Usage

Used in the dash menu. Not used by the user directly.

Examples

Used in the dash menu.

See Also