Feel  3.16
The best way to improve your game's feel and make it extra juicy
MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings Class Reference

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

Public Types

enum  UnloadMethods { UnloadMethods.None, UnloadMethods.ActiveScene, UnloadMethods.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 More...
 
ThreadPriority ThreadPriority = ThreadPriority.High
 when in additive loading mode, the thread priority to apply to the loading More...
 
bool SecureLoad = true
 whether or not to make additional sanity checks (better leave this to true) More...
 
bool InterpolateProgress = true
 when in additive loading mode, whether or not to interpolate the progress bar's progress More...
 
float BeforeEntryFadeDelay = 0f
 when in additive loading mode, when in additive loading mode, the duration (in seconds) of the delay before the entry fade More...
 
float EntryFadeDuration = 0.25f
 when in additive loading mode, the duration (in seconds) of the entry fade More...
 
float AfterEntryFadeDelay = 0.1f
 when in additive loading mode, the duration (in seconds) of the delay before the entry fade More...
 
float BeforeExitFadeDelay = 0.25f
 when in additive loading mode, the duration (in seconds) of the delay before the exit fade More...
 
float ExitFadeDuration = 0.2f
 when in additive loading mode, the duration (in seconds) of the exit fade More...
 
MMTweenType EntryFadeTween = null
 when in additive loading mode, when in additive loading mode, the tween to use to fade on entry More...
 
MMTweenType ExitFadeTween = null
 when in additive loading mode, the tween to use to fade on exit More...
 
float ProgressBarSpeed = 5f
 when in additive loading mode, the speed at which the loader's progress bar should move More...
 
List< MMSceneLoadingSpeedIntervalSpeedIntervals
 a list of progress intervals (values should be between 0 and 1) and their associated speeds, letting you have the bar progress less linearly More...
 
MMAdditiveSceneLoadingManager.FadeModes FadeMode = MMAdditiveSceneLoadingManager.FadeModes.FadeInThenOut
 when in additive loading mode, the selective additive fade mode More...
 
UnloadMethods UnloadMethod = UnloadMethods.AllScenes
 the chosen way to unload scenes (none, only the active scene, all loaded scenes) More...
 
string AntiSpillSceneName = ""
 

Detailed Description

A simple class used to store additive loading settings

Member Enumeration Documentation

◆ 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

◆ 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

◆ BeforeExitFadeDelay

float MoreMountains.Tools.MMAdditiveSceneLoadingManagerSettings.BeforeExitFadeDelay = 0.25f

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

◆ 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: