MoreMountains.HighroadEngine.LoadingSceneManager Class Reference

A class used to load new scenes while displaying a loading screen More...

Inheritance diagram for MoreMountains.HighroadEngine.LoadingSceneManager:

Static Public Member Functions
static void	LoadScene (string sceneToLoad)
	Call this static method to load a scene from anywhere More...

Public Attributes
Text	LoadingText
CanvasGroup	LoadingProgressBar
CanvasGroup	LoadingAnimation
CanvasGroup	LoadingCompleteAnimation
float	StartFadeDuration =0.2f
float	ProgressBarSpeed =2f
float	ExitFadeDuration =0.2f
float	LoadCompleteDelay =0.5f
bool	SceneActivationASAP = false

Static Public Attributes
static string	LoadingScreenSceneName = "LoadingScreen"

Protected Member Functions
virtual void	Start ()
	On Start(), we start loading the new level asynchronously More...
virtual void	Update ()
	Every frame, we fill the bar smoothly according to loading progress More...
virtual IEnumerator	LoadAsynchronously ()
	Loads the scene to load asynchronously. More...
virtual void	LoadingSetup ()
	Sets up all visual elements, fades from black at the start More...
virtual void	LoadingComplete ()
	Triggered when the actual loading is done, replaces the progress bar with the complete animation More...

Protected Attributes
AsyncOperation	_asyncOperation
float	_fadeDuration = 0.5f
float	_fillTarget =0f
string	_loadingTextValue

Static Protected Attributes
static string	_sceneToLoad = ""

Detailed Description

A class used to load new scenes while displaying a loading screen

Member Function Documentation

LoadAsynchronously()

virtual IEnumerator MoreMountains.HighroadEngine.LoadingSceneManager.LoadAsynchronously ( )

protectedvirtual

Loads the scene to load asynchronously.

LoadingComplete()

virtual void MoreMountains.HighroadEngine.LoadingSceneManager.LoadingComplete ( )

protectedvirtual

Triggered when the actual loading is done, replaces the progress bar with the complete animation

LoadingSetup()

virtual void MoreMountains.HighroadEngine.LoadingSceneManager.LoadingSetup ( )

protectedvirtual

Sets up all visual elements, fades from black at the start

LoadScene()

static void MoreMountains.HighroadEngine.LoadingSceneManager.LoadScene ( string  sceneToLoad )

static

Call this static method to load a scene from anywhere

Parameters

sceneToLoad

Level name.

Start()

virtual void MoreMountains.HighroadEngine.LoadingSceneManager.Start ( )

protectedvirtual

On Start(), we start loading the new level asynchronously

Update()

virtual void MoreMountains.HighroadEngine.LoadingSceneManager.Update ( )

protectedvirtual

Every frame, we fill the bar smoothly according to loading progress

Member Data Documentation

_asyncOperation

AsyncOperation MoreMountains.HighroadEngine.LoadingSceneManager._asyncOperation

protected

_fadeDuration

float MoreMountains.HighroadEngine.LoadingSceneManager._fadeDuration = 0.5f

protected

_fillTarget

float MoreMountains.HighroadEngine.LoadingSceneManager._fillTarget =0f

protected

_loadingTextValue

string MoreMountains.HighroadEngine.LoadingSceneManager._loadingTextValue

protected

_sceneToLoad

string MoreMountains.HighroadEngine.LoadingSceneManager._sceneToLoad = ""

staticprotected

ExitFadeDuration

float MoreMountains.HighroadEngine.LoadingSceneManager.ExitFadeDuration =0.2f

LoadCompleteDelay

float MoreMountains.HighroadEngine.LoadingSceneManager.LoadCompleteDelay =0.5f

LoadingAnimation

CanvasGroup MoreMountains.HighroadEngine.LoadingSceneManager.LoadingAnimation

LoadingCompleteAnimation

CanvasGroup MoreMountains.HighroadEngine.LoadingSceneManager.LoadingCompleteAnimation

LoadingProgressBar

CanvasGroup MoreMountains.HighroadEngine.LoadingSceneManager.LoadingProgressBar

LoadingScreenSceneName

string MoreMountains.HighroadEngine.LoadingSceneManager.LoadingScreenSceneName = "LoadingScreen"

static

LoadingText

Text MoreMountains.HighroadEngine.LoadingSceneManager.LoadingText

ProgressBarSpeed

float MoreMountains.HighroadEngine.LoadingSceneManager.ProgressBarSpeed =2f

SceneActivationASAP

bool MoreMountains.HighroadEngine.LoadingSceneManager.SceneActivationASAP = false

StartFadeDuration

float MoreMountains.HighroadEngine.LoadingSceneManager.StartFadeDuration =0.2f

---

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

• E:/Github/Store/HighroadEngine/Assets/HighroadEngine/Common/Scripts/Managers/LoadingSceneManager.cs