MoreMountains.TopDownEngine.StartScreen Class Reference

Simple start screen class. More...

Inheritance diagram for MoreMountains.TopDownEngine.StartScreen:

Public Types
enum	LoadingSceneModes { LoadingSceneModes.Regular, LoadingSceneModes.Additive }

Public Member Functions
virtual void	ButtonPressed ()
	What happens when the main button is pressed More...

Public Attributes
string	NextLevel
	the level to load after the start screen More...
LoadingSceneModes	LoadingSceneMode = LoadingSceneModes.Regular
	whether to load the scene normally or additively More...
string	LoadingSceneName = ""
	the name of the MMSceneLoadingManager scene you want to use More...
float	AutoSkipDelay = 0f
	the delay after which the level should auto skip (if less than 1s, won't autoskip) More...
float	FadeInDuration = 1f
	the duration of the fade from black at the start of the level More...
float	FadeOutDuration = 1f
	the duration of the fade to black at the end of the level More...
MMTweenType	Tween = new MMTweenType(MMTween.MMTweenCurve.EaseInOutCubic)
	the tween type to use to fade the startscreen in and out More...
MMSwitch	MusicSwitch
	the switch used to turn the music on or off More...
MMSwitch	SfxSwitch
	the switch used to turn the SFX on or off More...

Protected Member Functions
virtual void	Awake ()
	Initialization More...
async void	Start ()
	On Start, initializes the music and sfx switches More...
virtual void	Update ()
	During update we simply wait for the user to press the "jump" button. More...
virtual IEnumerator	LoadFirstLevel ()
	Loads the next level. More...

Detailed Description

Simple start screen class.

Member Enumeration Documentation

LoadingSceneModes

enum MoreMountains.TopDownEngine.StartScreen.LoadingSceneModes

strong

Enumerator
Regular
Additive

Member Function Documentation

Awake()

virtual void MoreMountains.TopDownEngine.StartScreen.Awake ( )

protectedvirtual

Initialization

ButtonPressed()

virtual void MoreMountains.TopDownEngine.StartScreen.ButtonPressed ( )

virtual

What happens when the main button is pressed

LoadFirstLevel()

virtual IEnumerator MoreMountains.TopDownEngine.StartScreen.LoadFirstLevel ( )

protectedvirtual

Loads the next level.

Returns

The first level.

Start()

async void MoreMountains.TopDownEngine.StartScreen.Start ( )

protected

On Start, initializes the music and sfx switches

Update()

virtual void MoreMountains.TopDownEngine.StartScreen.Update ( )

protectedvirtual

During update we simply wait for the user to press the "jump" button.

Member Data Documentation

AutoSkipDelay

float MoreMountains.TopDownEngine.StartScreen.AutoSkipDelay = 0f

the delay after which the level should auto skip (if less than 1s, won't autoskip)

FadeInDuration

float MoreMountains.TopDownEngine.StartScreen.FadeInDuration = 1f

the duration of the fade from black at the start of the level

FadeOutDuration

float MoreMountains.TopDownEngine.StartScreen.FadeOutDuration = 1f

the duration of the fade to black at the end of the level

LoadingSceneMode

LoadingSceneModes MoreMountains.TopDownEngine.StartScreen.LoadingSceneMode = LoadingSceneModes.Regular

whether to load the scene normally or additively

LoadingSceneName

string MoreMountains.TopDownEngine.StartScreen.LoadingSceneName = ""

the name of the MMSceneLoadingManager scene you want to use

MusicSwitch

MMSwitch MoreMountains.TopDownEngine.StartScreen.MusicSwitch

the switch used to turn the music on or off

NextLevel

string MoreMountains.TopDownEngine.StartScreen.NextLevel

the level to load after the start screen

SfxSwitch

MMSwitch MoreMountains.TopDownEngine.StartScreen.SfxSwitch

the switch used to turn the SFX on or off

Tween

MMTweenType MoreMountains.TopDownEngine.StartScreen.Tween = new MMTweenType(MMTween.MMTweenCurve.EaseInOutCubic)

the tween type to use to fade the startscreen in and out

---

The documentation for this class was generated from the following file:

• F:/Github/Store/TopDownEngine/Assets/TopDownEngine/Common/Scripts/GUI/StartScreen.cs