MoreMountains.CorgiEngine.StartScreen Class Reference

Simple start screen class. More...

Inheritance diagram for MoreMountains.CorgiEngine.StartScreen:

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...
string	LoadingSceneName = "LoadingScreen"
	the name of the loading screen to use to load NextLevel 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 in of the start screen, in seconds More...
float	FadeOutDuration = 1f
	the duration of the fade out of the start screen, in seconds More...
MMTweenType	Tween
	the tween type this fade should happen on More...
MMSwitch	MusicSwitch
	the switch used to turn music on or off More...
MMSwitch	SfxSwitch
	the switch used to turn sfx on or off More...

Protected Member Functions
virtual void	Awake ()
	Initialization More...
async void	Start ()
	On Start we initialize our 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 Function Documentation

Awake()

virtual void MoreMountains.CorgiEngine.StartScreen.Awake ( )

protectedvirtual

Initialization

ButtonPressed()

virtual void MoreMountains.CorgiEngine.StartScreen.ButtonPressed ( )

virtual

What happens when the main button is pressed

LoadFirstLevel()

virtual IEnumerator MoreMountains.CorgiEngine.StartScreen.LoadFirstLevel ( )

protectedvirtual

Loads the next level.

Returns

The first level.

Start()

async void MoreMountains.CorgiEngine.StartScreen.Start ( )

protected

On Start we initialize our switches

Update()

virtual void MoreMountains.CorgiEngine.StartScreen.Update ( )

protectedvirtual

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

Member Data Documentation

AutoSkipDelay

float MoreMountains.CorgiEngine.StartScreen.AutoSkipDelay = 0f

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

FadeInDuration

float MoreMountains.CorgiEngine.StartScreen.FadeInDuration = 1f

the duration of the fade in of the start screen, in seconds

FadeOutDuration

float MoreMountains.CorgiEngine.StartScreen.FadeOutDuration = 1f

the duration of the fade out of the start screen, in seconds

LoadingSceneName

string MoreMountains.CorgiEngine.StartScreen.LoadingSceneName = "LoadingScreen"

the name of the loading screen to use to load NextLevel

MusicSwitch

MMSwitch MoreMountains.CorgiEngine.StartScreen.MusicSwitch

the switch used to turn music on or off

NextLevel

string MoreMountains.CorgiEngine.StartScreen.NextLevel

the level to load after the start screen

SfxSwitch

MMSwitch MoreMountains.CorgiEngine.StartScreen.SfxSwitch

the switch used to turn sfx on or off

Tween

MMTweenType MoreMountains.CorgiEngine.StartScreen.Tween

the tween type this fade should happen on

---

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

• Assets/CorgiEngine/Common/Scripts/GUI/StartScreen.cs