Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Login Screen | |Name=Login Screen | ||
}} | }} | ||
The '''LoginScreen''' component is used to handle the dash screen for logging into the game. | |||
== | == 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 tab screen. | ||
|_screenRoot|Slot| | |_screenRoot|Slot| The root slot of the dash menu tab view. | ||
|_screenCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv6=true| | |_screenCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv6=true| The canvas being used for the tab 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. | ||
}} | }} | ||
== | == Usage == | ||
Used for logging in. | |||
== Examples == | == Examples == | ||
Log in screen. Used internally. | |||
== See Also == | == See Also == | ||
| Line 27: | Line 29: | ||
[[Category:Components:Uncategorized{{#translation:}}|Login Screen]] | [[Category:Components:Uncategorized{{#translation:}}|Login Screen]] | ||
[[Category:Components{{#translation:}}|Login Screen]] | [[Category:Components{{#translation:}}|Login Screen]] | ||
Latest revision as of 20:05, 25 June 2025
Component image 
Login Screen component as seen in the Scene Inspector
The LoginScreen component is used to handle the dash screen for logging into the game.
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 tab screen. |
_screenRoot
|
Slot | The root slot of the dash menu tab view. |
_screenCanvas
|
Canvas | The canvas being used for the tab 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 for logging in.
Examples
Log in screen. Used internally.