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

This feedback will request the load of a new scene, using the method of your choice More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_LoadScene:
MoreMountains.Feedbacks.MMF_Feedback

Public Types

enum  LoadingModes { LoadingModes.Direct, LoadingModes.MMSceneLoadingManager, LoadingModes.MMAdditiveSceneLoadingManager, LoadingModes.DirectAdditive }
 sets the inspector color for this feedback More...
 

Public Attributes

string LoadingSceneName = "MMAdditiveLoadingScreen"
 the name of the loading screen scene to use More...
 
string DestinationSceneName = ""
 the name of the destination scene More...
 
LoadingModes LoadingMode = LoadingModes.MMAdditiveSceneLoadingManager
 the loading mode to use More...
 
ThreadPriority Priority = ThreadPriority.High
 the priority to use when loading the new scenes More...
 
bool SecureLoad = true
 whether or not to perform extra checks to make sure the loading screen and destination scene are in the build settings More...
 
MMAdditiveSceneLoadingManagerSettings.UnloadMethods UnloadMethod
 the chosen way to unload scenes (none, only the active scene, all loaded scenes) More...
 
string AntiSpillSceneName = ""
 
float BeforeEntryFadeDelay = 0f
 a delay (in seconds) to apply before the first fade plays More...
 
float EntryFadeDuration = 0.2f
 the duration (in seconds) of the entry fade More...
 
float AfterEntryFadeDelay = 0f
 a delay (in seconds) to apply after the first fade plays More...
 
float BeforeExitFadeDelay = 0f
 a delay (in seconds) to apply before the exit fade plays More...
 
float ExitFadeDuration = 0.2f
 the duration (in seconds) of the exit fade More...
 
bool InterpolateProgress = true
 whether or not to interpolate progress (slower, but usually looks better and smoother) More...
 
float ProgressInterpolationSpeed = 5f
 the speed at which the progress bar should move if interpolated 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
 the order in which to play fades (really depends on the type of fader you have in your loading screen More...
 
MMTweenType EntryFadeTween = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(1, 1)))
 the tween to use on the entry fade More...
 
MMTweenType ExitFadeTween = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(1, 1)))
 the tween to use on the exit fade More...
 

Static Public Attributes

static bool FeedbackTypeAuthorized = true
 a static bool used to disable all feedbacks of this type at once More...
 

Protected Member Functions

override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On play, we request a load of the destination scene using hte specified method More...
 

Additional Inherited Members

Detailed Description

This feedback will request the load of a new scene, using the method of your choice

Member Enumeration Documentation

◆ LoadingModes

sets the inspector color for this feedback

the possible ways to load a new scene :

  • direct : uses Unity's SceneManager API
  • direct additive : uses Unity's SceneManager API, but with additive mode (so loading the scene on top of the current one)
  • MMSceneLoadingManager : the simple, original MM way of loading scenes
  • MMAdditiveSceneLoadingManager : a more advanced way of loading scenes, with (way) more options
Enumerator
Direct 
MMSceneLoadingManager 
MMAdditiveSceneLoadingManager 
DirectAdditive 

Member Function Documentation

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMF_LoadScene.CustomPlayFeedback ( Vector3  position,
float  feedbacksIntensity = 1.0f 
)
protectedvirtual

On play, we request a load of the destination scene using hte specified method

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

Member Data Documentation

◆ AfterEntryFadeDelay

float MoreMountains.Feedbacks.MMF_LoadScene.AfterEntryFadeDelay = 0f

a delay (in seconds) to apply after the first fade plays

◆ AntiSpillSceneName

string MoreMountains.Feedbacks.MMF_LoadScene.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.Feedbacks.MMF_LoadScene.BeforeEntryFadeDelay = 0f

a delay (in seconds) to apply before the first fade plays

◆ BeforeExitFadeDelay

float MoreMountains.Feedbacks.MMF_LoadScene.BeforeExitFadeDelay = 0f

a delay (in seconds) to apply before the exit fade plays

◆ DestinationSceneName

string MoreMountains.Feedbacks.MMF_LoadScene.DestinationSceneName = ""

the name of the destination scene

◆ EntryFadeDuration

float MoreMountains.Feedbacks.MMF_LoadScene.EntryFadeDuration = 0.2f

the duration (in seconds) of the entry fade

◆ EntryFadeTween

MMTweenType MoreMountains.Feedbacks.MMF_LoadScene.EntryFadeTween = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(1, 1)))

the tween to use on the entry fade

◆ ExitFadeDuration

float MoreMountains.Feedbacks.MMF_LoadScene.ExitFadeDuration = 0.2f

the duration (in seconds) of the exit fade

◆ ExitFadeTween

MMTweenType MoreMountains.Feedbacks.MMF_LoadScene.ExitFadeTween = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(1, 1)))

the tween to use on the exit fade

◆ FadeMode

MMAdditiveSceneLoadingManager.FadeModes MoreMountains.Feedbacks.MMF_LoadScene.FadeMode = MMAdditiveSceneLoadingManager.FadeModes.FadeInThenOut

the order in which to play fades (really depends on the type of fader you have in your loading screen

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_LoadScene.FeedbackTypeAuthorized = true
static

a static bool used to disable all feedbacks of this type at once

◆ InterpolateProgress

bool MoreMountains.Feedbacks.MMF_LoadScene.InterpolateProgress = true

whether or not to interpolate progress (slower, but usually looks better and smoother)

◆ LoadingMode

LoadingModes MoreMountains.Feedbacks.MMF_LoadScene.LoadingMode = LoadingModes.MMAdditiveSceneLoadingManager

the loading mode to use

◆ LoadingSceneName

string MoreMountains.Feedbacks.MMF_LoadScene.LoadingSceneName = "MMAdditiveLoadingScreen"

the name of the loading screen scene to use

◆ Priority

ThreadPriority MoreMountains.Feedbacks.MMF_LoadScene.Priority = ThreadPriority.High

the priority to use when loading the new scenes

◆ ProgressInterpolationSpeed

float MoreMountains.Feedbacks.MMF_LoadScene.ProgressInterpolationSpeed = 5f

the speed at which the progress bar should move if interpolated

◆ SecureLoad

bool MoreMountains.Feedbacks.MMF_LoadScene.SecureLoad = true

whether or not to perform extra checks to make sure the loading screen and destination scene are in the build settings

◆ SpeedIntervals

List<MMSceneLoadingSpeedInterval> MoreMountains.Feedbacks.MMF_LoadScene.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

◆ UnloadMethod

MMAdditiveSceneLoadingManagerSettings.UnloadMethods MoreMountains.Feedbacks.MMF_LoadScene.UnloadMethod
Initial value:
=
MMAdditiveSceneLoadingManagerSettings.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: