Component:TutorialScreen

From Resonite Wiki
Component image 
Tutorial Screen component as seen in the Scene Inspector

The TutorialScreen component controls a screen prompting the user to go through the tutorial in their dash.

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 for this dialogue screen.
ActiveColor Nullable`1<ColorX> The color when this screen is selected and active.
Label String The label of this dash screen.
ScreenEnabled Bool Whether this dash screen is enabled or not.
BaseResolution Float2 The resolution this screen renders at.
_screenRoot Slot The root slot of this screen's visual elements.
_screenCanvas Canvas The canvas Component used to render this dash screen.
_modalOverlayManager ModalOverlayManager This is the Overlay manager that handles editing mode on this screen.
_button RadiantDashButton This is the button to switch to viewing this screen.
_iconTexture Texture2D This is the texture Component showing the icon for the tab of this screen.
_swapRegion SlideSwapRegion This is the swap region used to show the screen and slide it away/in when it is switched from/to.
_currentScreen TutorialScreen.Screen The current screen this tutorial screen dialog is showing.
_heightField QuantityTextEditorParser`2<Distance, Float> The field used to enter in and store the user's height setting.
_nextEnabled Bool Whether the next button is enabled or not so the user can continue.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnNext:ButtonEventHandler ButtonEventHandler Handles when the next screen button is enabled.
OnCreateAccount:ButtonEventHandler ButtonEventHandler Handles when the user asks to create an account.
OnLoginAccount:ButtonEventHandler ButtonEventHandler Handles when the user logs into an account.
OnSkipAccount:ButtonEventHandler ButtonEventHandler Handles when the user skips setting up an account.
OnStartTutorial:ButtonEventHandler ButtonEventHandler Handles when the user asks to start the tutorial world.

Screen

Values
Name Value Description
Welcome 0 Screen is currently showing the welcome to resonite screen.
Language 1 Screen is currently showing the select your language screen.
Audio 2 Screen is currently showing the select audio devices screen.
BasicSettings 3 Screen is currently showing the basic settings screen.
Account 4 Screen is currently showing the create or skip creating account screen.
StartTutorial 5 Screen is currently showing the start tutorial screen.

Usage

Examples

Used to show the tutorial screen in the dash when the user starts the game for the first time (or wipes their cache)

See Also