Component:ExitScreen: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
Line 3: Line 3:
|Name=Exit Screen
|Name=Exit Screen
}}
}}
{{stub}}
See [[Dash Menu#Exit|Exit Screen]].


== 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 tab screen.
|_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 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.
|_sponsorName|String|
|_sponsorName|String| The name of a randomly picked sponsor of the game.
|_sponsorIcon|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv11=true|
|_sponsorIcon|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv11=true| The profile icon of the sponsor.
|_shoutouts|'''[[Component:Text|Text]]'''|TypeAdv12=true|
|_shoutouts|'''[[Component:Text|Text]]'''|TypeAdv12=true| Different supporter shoutouts text field.
|_exitMessage|'''[[Component:Text|Text]]'''|TypeAdv13=true|
|_exitMessage|'''[[Component:Text|Text]]'''|TypeAdv13=true| The randomly chosen exit message fidld.
}}
}}


== Behavior ==
== Usage ==
Not used by the user directly.


== Examples ==
== Examples ==
Used in the [[Dash Menu|dash]] for the exit screen.


== See Also ==
== See Also ==
Line 31: Line 33:
[[Category:Components:Uncategorized{{#translation:}}|Exit Screen]]
[[Category:Components:Uncategorized{{#translation:}}|Exit Screen]]
[[Category:Components{{#translation:}}|Exit Screen]]
[[Category:Components{{#translation:}}|Exit Screen]]
[[Category:ComponentStubs]]

Revision as of 19:56, 16 February 2025

Component image 
Exit Screen component as seen in the Scene Inspector

See Exit Screen.

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 tab screen.
_screenRoot Slot The root slot of the desktop screen 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.
_sponsorName String The name of a randomly picked sponsor of the game.
_sponsorIcon StaticTexture2D The profile icon of the sponsor.
_shoutouts Text Different supporter shoutouts text field.
_exitMessage Text The randomly chosen exit message fidld.

Usage

Not used by the user directly.

Examples

Used in the dash for the exit screen.

See Also