TopDown Engine  v4.1
MoreMountains.Tools.MMSceneRestarter Class Reference

This component lets you restart a scene by pressing a key More...

Inheritance diagram for MoreMountains.Tools.MMSceneRestarter:

Public Types

enum  RestartModes { RestartModes.ActiveScene, RestartModes.SpecificScene }
 the possible restart modes More...
 

Public Member Functions

virtual void RestartScene ()
 Restarts the scene based on the specified settings More...
 

Public Attributes

RestartModes RestartMode = RestartModes.ActiveScene
 the selected restart mode, either the currently active scene, or one by name More...
 
string SceneName
 the name of the scene to load if we're in specific scene mode More...
 
LoadSceneMode LoadMode = LoadSceneMode.Single
 the load mode More...
 
KeyCode RestarterKeyCode = KeyCode.Backspace
 the key to press to restart manually More...
 

Protected Member Functions

virtual void Update ()
 On Update, looks for input More...
 
virtual void HandleInput ()
 Looks for a key press of the specified key More...
 

Protected Attributes

string _newSceneName
 

Detailed Description

This component lets you restart a scene by pressing a key

Member Enumeration Documentation

◆ RestartModes

the possible restart modes

Enumerator
ActiveScene 
SpecificScene 

Member Function Documentation

◆ HandleInput()

virtual void MoreMountains.Tools.MMSceneRestarter.HandleInput ( )
protectedvirtual

Looks for a key press of the specified key

◆ RestartScene()

virtual void MoreMountains.Tools.MMSceneRestarter.RestartScene ( )
virtual

Restarts the scene based on the specified settings

◆ Update()

virtual void MoreMountains.Tools.MMSceneRestarter.Update ( )
protectedvirtual

On Update, looks for input

Member Data Documentation

◆ _newSceneName

string MoreMountains.Tools.MMSceneRestarter._newSceneName
protected

◆ LoadMode

LoadSceneMode MoreMountains.Tools.MMSceneRestarter.LoadMode = LoadSceneMode.Single

the load mode

◆ RestarterKeyCode

KeyCode MoreMountains.Tools.MMSceneRestarter.RestarterKeyCode = KeyCode.Backspace

the key to press to restart manually

◆ RestartMode

RestartModes MoreMountains.Tools.MMSceneRestarter.RestartMode = RestartModes.ActiveScene

the selected restart mode, either the currently active scene, or one by name

◆ SceneName

string MoreMountains.Tools.MMSceneRestarter.SceneName

the name of the scene to load if we're in specific scene mode


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