TopDown Engine  v3.6
MoreMountains.TopDownEngine.LevelSelector Class Reference

This component allows the definition of a level that can then be accessed and loaded. Used mostly in the level map scene. More...

Inheritance diagram for MoreMountains.TopDownEngine.LevelSelector:
MoreMountains.TopDownEngine.TopDownMonoBehaviour MoreMountains.Tools.MMMonoBehaviour

Public Member Functions

virtual void GoToLevel ()
 Loads the level specified in the inspector More...
 
virtual void RestartLevel ()
 Restarts the current level, without reloading the whole scene More...
 
virtual void ReloadLevel ()
 Reloads the current level More...
 

Public Attributes

string LevelName
 the exact name of the target level More...
 
bool DoNotUseLevelManager = false
 if this is true, GoToLevel will ignore the LevelManager and do a direct call More...
 
bool DestroyPersistentCharacter = false
 if this is true, any persistent character will be destroyed when loading the new level More...
 

Protected Member Functions

virtual void LoadScene (string newSceneName)
 Loads a new scene, either via the LevelManager or not More...
 

Detailed Description

This component allows the definition of a level that can then be accessed and loaded. Used mostly in the level map scene.

Member Function Documentation

◆ GoToLevel()

virtual void MoreMountains.TopDownEngine.LevelSelector.GoToLevel ( )
virtual

Loads the level specified in the inspector

◆ LoadScene()

virtual void MoreMountains.TopDownEngine.LevelSelector.LoadScene ( string  newSceneName)
protectedvirtual

Loads a new scene, either via the LevelManager or not

Parameters
newSceneName

◆ ReloadLevel()

virtual void MoreMountains.TopDownEngine.LevelSelector.ReloadLevel ( )
virtual

Reloads the current level

◆ RestartLevel()

virtual void MoreMountains.TopDownEngine.LevelSelector.RestartLevel ( )
virtual

Restarts the current level, without reloading the whole scene

Member Data Documentation

◆ DestroyPersistentCharacter

bool MoreMountains.TopDownEngine.LevelSelector.DestroyPersistentCharacter = false

if this is true, any persistent character will be destroyed when loading the new level

◆ DoNotUseLevelManager

bool MoreMountains.TopDownEngine.LevelSelector.DoNotUseLevelManager = false

if this is true, GoToLevel will ignore the LevelManager and do a direct call

◆ LevelName

string MoreMountains.TopDownEngine.LevelSelector.LevelName

the exact name of the target level


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