MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings Class Reference

A simple class used to store additive loading settings. More...

Public Types
enum	UnloadMethods { None , ActiveScene , AllScenes }
	the possible ways to unload scenes More...

Public Attributes
string	LoadingSceneName = "MMAdditiveLoadingScreen"
	the name of the MMSceneLoadingManager scene you want to use when in additive mode
ThreadPriority	ThreadPriority = ThreadPriority.High
	when in additive loading mode, the thread priority to apply to the loading
bool	SecureLoad = true
	whether or not to make additional sanity checks (better leave this to true)
bool	InterpolateProgress = true
	when in additive loading mode, whether or not to interpolate the progress bar's progress
float	BeforeEntryFadeDelay = 0f
	when in additive loading mode, when in additive loading mode, the duration (in seconds) of the delay before the entry fade
float	EntryFadeDuration = 0.25f
	when in additive loading mode, the duration (in seconds) of the entry fade
float	AfterEntryFadeDelay = 0.1f
	when in additive loading mode, the duration (in seconds) of the delay before the entry fade
float	BeforeSceneActivationDelay = 0.25f
	when in additive loading mode, the duration (in seconds) of the delay before the scene gets activated
float	AfterSceneActivationDelay = 0f
	when in additive loading mode, the duration (in seconds) after the scene is loaded and before the fade starts
float	ExitFadeDuration = 0.2f
	when in additive loading mode, the duration (in seconds) of the exit fade
MMTweenType	EntryFadeTween = null
	when in additive loading mode, when in additive loading mode, the tween to use to fade on entry
MMTweenType	ExitFadeTween = null
	when in additive loading mode, the tween to use to fade on exit
float	ProgressBarSpeed = 5f
	when in additive loading mode, the speed at which the loader's progress bar should move
List< MMSceneLoadingSpeedInterval >	SpeedIntervals
	a list of progress intervals (values should be between 0 and 1) and their associated speeds, letting you have the bar progress less linearly
bool	DebugMode = false
	whether or not to display debug logs of the loading sequence
MMAdditiveSceneLoadingManager.FadeModes	FadeMode = MMAdditiveSceneLoadingManager.FadeModes.FadeInThenOut
	when in additive loading mode, the selective additive fade mode
UnloadMethods	UnloadMethod = UnloadMethods.AllScenes
	the chosen way to unload scenes (none, only the active scene, all loaded scenes)
string	AntiSpillSceneName = ""

Detailed Description

A simple class used to store additive loading settings.

It provides a nice load sequence, entirely customizable, here's the high level sequence breakdown:

• delay before entry fade
• entry fade
• delay after entry fade
• unload origin scene
• load destination scene
• load complete
• delay before scene activation
• scene activation
• delay after scene activation
• exit fade
• unload scene loader

Member Enumeration Documentation

UnloadMethods

enum MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.UnloadMethods

the possible ways to unload scenes

Enumerator
None
ActiveScene
AllScenes

Member Data Documentation

AfterEntryFadeDelay

float MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.AfterEntryFadeDelay = 0.1f

when in additive loading mode, the duration (in seconds) of the delay before the entry fade

AfterSceneActivationDelay

float MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.AfterSceneActivationDelay = 0f

when in additive loading mode, the duration (in seconds) after the scene is loaded and before the fade starts

AntiSpillSceneName

string MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.AntiSpillSceneName = ""

the name of the anti spill scene to use when loading additively. If left empty, that scene will be automatically created, but you can specify any scene to use for that. Usually you'll want your own anti spill scene to be just an empty scene, but you can customize its lighting settings for example.

BeforeEntryFadeDelay

float MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.BeforeEntryFadeDelay = 0f

when in additive loading mode, when in additive loading mode, the duration (in seconds) of the delay before the entry fade

BeforeSceneActivationDelay

float MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.BeforeSceneActivationDelay = 0.25f

when in additive loading mode, the duration (in seconds) of the delay before the scene gets activated

DebugMode

bool MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.DebugMode = false

whether or not to display debug logs of the loading sequence

EntryFadeDuration

float MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.EntryFadeDuration = 0.25f

when in additive loading mode, the duration (in seconds) of the entry fade

EntryFadeTween

MMTweenType MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.EntryFadeTween = null

when in additive loading mode, when in additive loading mode, the tween to use to fade on entry

ExitFadeDuration

float MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.ExitFadeDuration = 0.2f

when in additive loading mode, the duration (in seconds) of the exit fade

ExitFadeTween

MMTweenType MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.ExitFadeTween = null

when in additive loading mode, the tween to use to fade on exit

FadeMode

MMAdditiveSceneLoadingManager.FadeModes MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.FadeMode = MMAdditiveSceneLoadingManager.FadeModes.FadeInThenOut

when in additive loading mode, the selective additive fade mode

InterpolateProgress

bool MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.InterpolateProgress = true

when in additive loading mode, whether or not to interpolate the progress bar's progress

LoadingSceneName

string MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.LoadingSceneName = "MMAdditiveLoadingScreen"

the name of the MMSceneLoadingManager scene you want to use when in additive mode

ProgressBarSpeed

float MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.ProgressBarSpeed = 5f

when in additive loading mode, the speed at which the loader's progress bar should move

SecureLoad

bool MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.SecureLoad = true

whether or not to make additional sanity checks (better leave this to true)

SpeedIntervals

List<MMSceneLoadingSpeedInterval> MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.SpeedIntervals

a list of progress intervals (values should be between 0 and 1) and their associated speeds, letting you have the bar progress less linearly

ThreadPriority

ThreadPriority MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.ThreadPriority = ThreadPriority.High

when in additive loading mode, the thread priority to apply to the loading

UnloadMethod

UnloadMethods MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.UnloadMethod = UnloadMethods.AllScenes

the chosen way to unload scenes (none, only the active scene, all loaded scenes)

---

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

• Assets/CorgiEngine/ThirdParty/MoreMountains/MMTools/Core/MMSceneLoading/Scripts/Managers/MMAdditiveSceneLoadingManager.cs