Skip to content

ASMSceneHelper.md

Latest commit

 

History

History
66 lines (58 loc) · 4.2 KB

ASMSceneHelper.md

File metadata and controls

66 lines (58 loc) · 4.2 KB

ASMSceneHelper

class in AdvancedSceneManager.Models / Inherits from: ScriptableObject

Description

Provides helper methods for opening, closing, and managing scenes and collections. Intended for use from Events.UnityEvent.

Static Properties

Member Description
ASMSceneHelper instance Gets the global instance of Models.ASMSceneHelper.

Properties

Member Description
string name _No documentation available._

Methods

Member Description
void _Activate(Scene scene) _No documentation available._
void _CancelPreload() Cancels the preload. All preloaded scenes will be fully loaded (limitation by Unity), then closed. No ASM scene callbacks will be called.
void _Close(SceneCollection collection) _No documentation available._
void _Close(Scene scene) _No documentation available._
void _FinishPreload() _No documentation available._
void _Open(SceneCollection collection) _No documentation available._
void _Open(Scene scene) _No documentation available._
void _OpenAdditive(SceneCollection collection) Opens the collection as additive.
void _OpenAndActivate(Scene scene) _No documentation available._
void _Preload(SceneCollection collection) Preloads the specified collection.
void _Preload(Scene scene) Preloads the specified collection.
void _PreloadAdditive(SceneCollection collection) Preloads the collection as additive.
void _Reopen(SceneCollection collection) _No documentation available._
void _Reopen(Scene scene) _No documentation available._
void _ToggleOpen(SceneCollection collection) Toggles the collection open or closed.
void _ToggleOpen(Scene scene) Toggles the collection open or closed.
void Activate(Scene scene) _No documentation available._
SceneOperation CancelPreload() Cancels the preload. All preloaded scenes will be fully loaded (limitation by Unity), then closed. No ASM scene callbacks will be called.
SceneOperation Close(SceneCollection collection) _No documentation available._
SceneOperation Close(Scene scene) _No documentation available._
SceneOperation CloseWithLoadingScreen(Scene scene, Scene loadingScene) _No documentation available._
SceneOperation FinishPreload() _No documentation available._
void Open(SceneCollection collection) _No documentation available._
SceneOperation Open(SceneCollection collection, bool openAll) Opens the specified collection.
SceneOperation Open(Scene scene) _No documentation available._
SceneOperation OpenAdditive(SceneCollection collection, bool openAll) Opens the collection as additive.
void OpenAdditive(SceneCollection collection) Opens the collection as additive.
SceneOperation OpenAndActivate(Scene scene) _No documentation available._
void OpenWhereNameStartsWith(string name) Opens all scenes whose names start with the specified string.
SceneOperation OpenWithLoadingScreen(Scene scene, Scene loadingScene) _No documentation available._
SceneOperation Preload(SceneCollection collection, bool openAll) Preloads the specified collection.
SceneOperation Preload(Scene scene, Action onPreloaded) Preloads the scene.
SceneOperation PreloadAdditive(SceneCollection collection, bool openAll) Preloads the collection as additive.
void Quit() Quits the application with optional fade effect.
void Reopen(SceneCollection collection) _No documentation available._
SceneOperation Reopen(Scene scene) _No documentation available._
void Restart() Restarts the ASM startup process.
void RestartCollection() Reopens the currently active Runtime.openCollection.
SceneOperation ToggleOpen(SceneCollection collection, bool openAll) Toggles the collection open or closed.
SceneOperation ToggleOpen(SceneCollection collection) Toggles the collection open or closed.
SceneOperation ToggleOpen(Scene scene) _No documentation available._
SceneOperation ToggleOpenState(Scene scene) _No documentation available._