A class to load scenes using a loading screen instead of just the default API This is a new version of the classic LoadingSceneManager (now renamed to MMSceneLoadingManager for consistency)
More...
|
static void | LoadScene (string sceneToLoadName, MMAdditiveSceneLoadingManagerSettings settings) |
| Call this static method to load a scene from anywhere (packed settings signature) More...
|
|
static void | LoadScene (string sceneToLoadName, string loadingSceneName="MMAdditiveLoadingScreen", ThreadPriority threadPriority=ThreadPriority.High, bool secureLoad=true, bool interpolateProgress=true, float beforeEntryFadeDelay=0f, float entryFadeDuration=0.25f, float afterEntryFadeDelay=0.1f, float beforeExitFadeDelay=0.25f, float exitFadeDuration=0.2f, MMTweenType entryFadeTween=null, MMTweenType exitFadeTween=null, float progressBarSpeed=5f, FadeModes fadeMode=FadeModes.FadeInThenOut, MMAdditiveSceneLoadingManagerSettings.UnloadMethods unloadMethod=MMAdditiveSceneLoadingManagerSettings.UnloadMethods.AllScenes) |
| Call this static method to load a scene from anywhere More...
|
|
A class to load scenes using a loading screen instead of just the default API This is a new version of the classic LoadingSceneManager (now renamed to MMSceneLoadingManager for consistency)
◆ FadeModes
The possible orders in which to play fades (depends on the fade you've set in your loading screen.
Enumerator |
---|
FadeInThenOut | |
FadeOutThenIn | |
◆ Awake()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.Awake |
( |
| ) |
|
|
protectedvirtual |
On Start(), we start loading the new level asynchronously
◆ DestinationSceneActivation()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.DestinationSceneActivation |
( |
| ) |
|
|
protectedvirtual |
Activates the destination scene
◆ EntryFade()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.EntryFade |
( |
| ) |
|
|
protectedvirtual |
Calls a fader on entry
- Returns
◆ ExitFade()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.ExitFade |
( |
| ) |
|
|
protectedvirtual |
Requests a fade on exit
- Returns
◆ Initialization()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.Initialization |
( |
| ) |
|
|
protectedvirtual |
Initializes timescale, computes null checks, and starts the load sequence
◆ InitiateLoad()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.InitiateLoad |
( |
| ) |
|
|
protectedvirtual |
Initializes counters and timescale
◆ LoadDestinationScene()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.LoadDestinationScene |
( |
| ) |
|
|
protectedvirtual |
Loads the destination scene
- Returns
◆ LoadScene() [1/2]
Call this static method to load a scene from anywhere (packed settings signature)
- Parameters
-
◆ LoadScene() [2/2]
static void MoreMountains.Tools.MMAdditiveSceneLoadingManager.LoadScene |
( |
string |
sceneToLoadName, |
|
|
string |
loadingSceneName = "MMAdditiveLoadingScreen" , |
|
|
ThreadPriority |
threadPriority = ThreadPriority.High , |
|
|
bool |
secureLoad = true , |
|
|
bool |
interpolateProgress = true , |
|
|
float |
beforeEntryFadeDelay = 0f , |
|
|
float |
entryFadeDuration = 0.25f , |
|
|
float |
afterEntryFadeDelay = 0.1f , |
|
|
float |
beforeExitFadeDelay = 0.25f , |
|
|
float |
exitFadeDuration = 0.2f , |
|
|
MMTweenType |
entryFadeTween = null , |
|
|
MMTweenType |
exitFadeTween = null , |
|
|
float |
progressBarSpeed = 5f , |
|
|
FadeModes |
fadeMode = FadeModes.FadeInThenOut , |
|
|
MMAdditiveSceneLoadingManagerSettings.UnloadMethods |
unloadMethod = MMAdditiveSceneLoadingManagerSettings.UnloadMethods.AllScenes |
|
) |
| |
|
static |
Call this static method to load a scene from anywhere
- Parameters
-
sceneToLoadName | Level name. |
◆ LoadSequence()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.LoadSequence |
( |
| ) |
|
|
protectedvirtual |
Loads the scene to load asynchronously.
◆ LoadTransitionComplete()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.LoadTransitionComplete |
( |
| ) |
|
|
protectedvirtual |
◆ MMLoadingSceneDebug()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.MMLoadingSceneDebug |
( |
string |
message | ) |
|
|
protectedvirtual |
A debug method used to output console messages, for this class only
- Parameters
-
◆ OnDestroy()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnDestroy |
( |
| ) |
|
|
protectedvirtual |
On Destroy we reset our state
◆ OnLoadOperationComplete()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnLoadOperationComplete |
( |
AsyncOperation |
obj | ) |
|
|
protectedvirtual |
A method triggered when the async operation completes
- Parameters
-
◆ ProcessDelayAfterEntryFade()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.ProcessDelayAfterEntryFade |
( |
| ) |
|
|
protectedvirtual |
Waits for the specified AfterEntryFadeDelay
- Returns
◆ ProcessDelayBeforeEntryFade()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.ProcessDelayBeforeEntryFade |
( |
| ) |
|
|
protectedvirtual |
Waits for the specified BeforeEntryFadeDelay duration
- Returns
◆ ProcessDelayBeforeExitFade()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.ProcessDelayBeforeExitFade |
( |
| ) |
|
|
protectedvirtual |
Waits for BeforeExitFadeDelay seconds
- Returns
◆ SetAudioListener()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.SetAudioListener |
( |
bool |
state | ) |
|
|
protectedvirtual |
Turns the loading audio listener on or off
- Parameters
-
◆ UnloadOriginScenes()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.UnloadOriginScenes |
( |
| ) |
|
|
protectedvirtual |
Unloads the original scene(s) and waits for the unload to complete
- Returns
◆ UnloadSceneLoader()
virtual IEnumerator MoreMountains.Tools.MMAdditiveSceneLoadingManager.UnloadSceneLoader |
( |
| ) |
|
|
protectedvirtual |
Unloads the scene loader
- Returns
◆ Update()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.Update |
( |
| ) |
|
|
protectedvirtual |
Every frame, we fill the bar smoothly according to loading progress
◆ UpdateProgress()
virtual void MoreMountains.Tools.MMAdditiveSceneLoadingManager.UpdateProgress |
( |
| ) |
|
|
protectedvirtual |
Sends progress value via UnityEvents
◆ _afterEntryFadeDelay
float MoreMountains.Tools.MMAdditiveSceneLoadingManager._afterEntryFadeDelay |
|
staticprotected |
◆ _antiSpill
◆ _asyncProgressLimit
const float MoreMountains.Tools.MMAdditiveSceneLoadingManager._asyncProgressLimit = 0.9f |
|
staticprotected |
◆ _beforeEntryFadeDelay
float MoreMountains.Tools.MMAdditiveSceneLoadingManager._beforeEntryFadeDelay |
|
staticprotected |
◆ _beforeExitFadeDelay
float MoreMountains.Tools.MMAdditiveSceneLoadingManager._beforeExitFadeDelay |
|
staticprotected |
◆ _entryFadeDuration
float MoreMountains.Tools.MMAdditiveSceneLoadingManager._entryFadeDuration |
|
staticprotected |
◆ _entryFadeTween
MMTweenType MoreMountains.Tools.MMAdditiveSceneLoadingManager._entryFadeTween |
|
staticprotected |
◆ _exitFadeDuration
float MoreMountains.Tools.MMAdditiveSceneLoadingManager._exitFadeDuration |
|
staticprotected |
◆ _exitFadeTween
MMTweenType MoreMountains.Tools.MMAdditiveSceneLoadingManager._exitFadeTween |
|
staticprotected |
◆ _fadeMode
FadeModes MoreMountains.Tools.MMAdditiveSceneLoadingManager._fadeMode |
|
staticprotected |
◆ _initialScenes
Scene [] MoreMountains.Tools.MMAdditiveSceneLoadingManager._initialScenes |
|
staticprotected |
◆ _interpolatedLoadProgress
float MoreMountains.Tools.MMAdditiveSceneLoadingManager._interpolatedLoadProgress |
|
protected |
◆ _interpolateProgress
bool MoreMountains.Tools.MMAdditiveSceneLoadingManager._interpolateProgress |
|
staticprotected |
◆ _loadDestinationAsyncOperation
AsyncOperation MoreMountains.Tools.MMAdditiveSceneLoadingManager._loadDestinationAsyncOperation |
|
protected |
◆ _loadingInProgress
bool MoreMountains.Tools.MMAdditiveSceneLoadingManager._loadingInProgress = false |
|
staticprotected |
◆ _loadingScreenSceneName
string MoreMountains.Tools.MMAdditiveSceneLoadingManager._loadingScreenSceneName |
|
staticprotected |
◆ _loadProgress
float MoreMountains.Tools.MMAdditiveSceneLoadingManager._loadProgress = 0f |
|
protected |
◆ _progressInterpolationSpeed
float MoreMountains.Tools.MMAdditiveSceneLoadingManager._progressInterpolationSpeed |
|
staticprotected |
◆ _scenesInBuild
List<string> MoreMountains.Tools.MMAdditiveSceneLoadingManager._scenesInBuild |
|
staticprotected |
◆ _sceneToLoadName
string MoreMountains.Tools.MMAdditiveSceneLoadingManager._sceneToLoadName = "" |
|
staticprotected |
◆ _setInterpolatedProgressValueIsNull
bool MoreMountains.Tools.MMAdditiveSceneLoadingManager._setInterpolatedProgressValueIsNull |
|
protected |
◆ _setRealtimeProgressValueIsNull
bool MoreMountains.Tools.MMAdditiveSceneLoadingManager._setRealtimeProgressValueIsNull |
|
protected |
◆ _unloadLoadingAsyncOperation
AsyncOperation MoreMountains.Tools.MMAdditiveSceneLoadingManager._unloadLoadingAsyncOperation |
|
protected |
◆ _unloadOriginAsyncOperation
AsyncOperation MoreMountains.Tools.MMAdditiveSceneLoadingManager._unloadOriginAsyncOperation |
|
protected |
◆ DebugMode
bool MoreMountains.Tools.MMAdditiveSceneLoadingManager.DebugMode = false |
whether or not to output debug messages to the console
◆ FaderID
int MoreMountains.Tools.MMAdditiveSceneLoadingManager.FaderID = 500 |
the ID on which to trigger a fade, has to match the ID on the fader in your scene
◆ LoadingAudioListener
AudioListener MoreMountains.Tools.MMAdditiveSceneLoadingManager.LoadingAudioListener |
◆ OnAfterEntryFade
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnAfterEntryFade |
an event that will be invoked when the delay after the entry fade starts
◆ OnBeforeEntryFade
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnBeforeEntryFade |
an event that will be invoked when the delay before the entry fade starts
◆ OnBeforeExitFade
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnBeforeExitFade |
an event that will be invoked when the delay before the exit fade starts
◆ OnDestinationSceneActivation
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnDestinationSceneActivation |
an event that will be invoked when the destination scene gets activated
◆ OnEntryFade
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnEntryFade |
an event that will be invoked when the entry fade starts
◆ OnExitFade
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnExitFade |
an event that will be invoked when the exit fade starts
◆ OnInterpolatedLoadProgressComplete
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnInterpolatedLoadProgressComplete |
an event that will be invoked when the interpolated load of the destination scene is complete
◆ OnLoadDestinationScene
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnLoadDestinationScene |
an event that will be invoked when the destination scene starts loading
◆ OnLoadProgressComplete
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnLoadProgressComplete |
an event that will be invoked when the load of the destination scene is complete
◆ OnLoadStarted
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnLoadStarted |
an event that will be invoked when the load starts
◆ OnLoadTransitionComplete
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnLoadTransitionComplete |
an event that will be invoked when the whole transition is complete
◆ OnUnloadOriginScene
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnUnloadOriginScene |
an event that will be invoked when the origin scene gets unloaded
◆ OnUnloadSceneLoader
UnityEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.OnUnloadSceneLoader |
an event that will be invoked when the scene loader gets unloaded
◆ SetInterpolatedProgressValue
ProgressEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.SetInterpolatedProgressValue |
an event used to update progress with interpolation
◆ SetRealtimeProgressValue
ProgressEvent MoreMountains.Tools.MMAdditiveSceneLoadingManager.SetRealtimeProgressValue |
an event used to update progress
The documentation for this class was generated from the following file: