Merge branch 'feature/SPScenes' into develop

Author: DYLAN-PC\Dylan

SPScenes/SPScenes.csproj

@@ -47,6 +47,7 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Scenes\Enums.cs" />
     <Compile Include="Scenes\Events\i_LoadScene.cs" />
+    <Compile Include="Scenes\ISceneLoadedMessageReceiver.cs" />
     <Compile Include="Scenes\LoadSceneAsyncWaitHandle.cs" />
     <Compile Include="Scenes\SPSceneManager.cs" />
     <Compile Include="Scenes\SceneManagerEventArgs.cs" />

SPScenes/Scenes/Events/i_LoadScene.cs

@@ -20,6 +20,10 @@ public class i_LoadScene : AutoTriggerable
         [SerializeField]
         private LoadSceneBehaviour _behaviour;
 
+        [SerializeField]
+        [Tooltip("A token used to persist data across scenes.")]
+        VariantReference _persistentToken;
+
         #endregion
 
         #region Methods
@@ -30,6 +34,7 @@ public override bool Trigger(object sender, object arg)
             if (string.IsNullOrEmpty(_sceneName)) return false;
 
             var nm = _sceneName;
+            LoadSceneWaitHandle handle;
             if (nm.StartsWith("#"))
             {
                 nm = nm.Substring(1);
@@ -39,27 +44,16 @@ public override bool Trigger(object sender, object arg)
                 if (index < 0 || index >= SceneManager.sceneCountInBuildSettings)
                     return false;
 
-                var manager = Services.Get<ISceneManager>();
-                if (manager != null)
-                {
-                    manager.LoadScene(index, _mode, _behaviour);
-                }
-                else
-                {
-                    SceneManagerUtils.LoadScene(index, _mode, _behaviour);
-                }
+                handle = SceneManagerUtils.LoadScene(index, _mode, _behaviour);
             }
             else
             {
-                var manager = Services.Get<ISceneManager>();
-                if (manager != null)
-                {
-                    manager.LoadScene(_sceneName, _mode, _behaviour);
-                }
-                else
-                {
-                    SceneManagerUtils.LoadScene(_sceneName, _mode, _behaviour);
-                }
+                handle = SceneManagerUtils.LoadScene(_sceneName, _mode, _behaviour);
+            }
+
+            if (handle != null)
+            {
+                handle.PersistentToken = com.spacepuppy.Utils.ObjUtil.ReduceIfProxy(_persistentToken.Value);
             }
 
             return true;

SPScenes/Scenes/ISceneLoadedMessageReceiver.cs

@@ -0,0 +1,13 @@
+using System;
+
+namespace com.spacepuppy.Scenes
+{
+
+    public interface ISceneLoadedMessageReceiver
+    {
+
+        void OnSceneLoaded(LoadSceneWaitHandle handle);
+
+    }
+
+}

SPScenes/Scenes/LoadSceneAsyncWaitHandle.cs

@@ -5,7 +5,7 @@
 namespace com.spacepuppy.Scenes
 {
 
-    public class LoadSceneWaitHandle : System.EventArgs, IProgressingYieldInstruction
+    public class LoadSceneWaitHandle : System.EventArgs, IProgressingYieldInstruction, ISPDisposable
     {
 
         #region Fields
@@ -34,13 +34,29 @@ public LoadSceneWaitHandle(string sceneName, LoadSceneMode mode, LoadSceneBehavi
 
         public void Init(Scene sc, AsyncOperation op)
         {
+            if (_disposed) throw new System.InvalidOperationException("LoadSceneAsyncWaitHandle was disposed.");
+            if (_initialized) throw new System.InvalidOperationException("LoadSceneAsyncWaitHandle has already been initialized.");
             _initialized = true;
             _scene = sc;
             _op = op;
-            if(_behaviour == LoadSceneBehaviour.AsyncAndWait && _op != null && !_op.isDone)
+            if (_behaviour == LoadSceneBehaviour.AsyncAndWait && _op != null && !_op.isDone)
             {
                 _op.allowSceneActivation = false;
             }
+            SceneManager.sceneLoaded += this.OnSceneLoaded;
+        }
+
+        /// <summary>
+        /// Initialize the handle after load for use as an EventArgs.
+        /// </summary>
+        /// <param name="sc"></param>
+        public void FalseInit(Scene sc)
+        {
+            if (_disposed) throw new System.InvalidOperationException("LoadSceneAsyncWaitHandle was disposed.");
+            if (_initialized) throw new System.InvalidOperationException("LoadSceneAsyncWaitHandle has already been initialized.");
+            _initialized = true;
+            _scene = sc;
+            _op = null;
         }
 
         #endregion
@@ -72,16 +88,27 @@ public bool ReadyAndWaitingToActivate
             get { return !object.ReferenceEquals(_op, null) && _op.progress >= 0.9f && !_op.isDone; }
         }
 
+        /// <summary>
+        /// Use this to pass some token between scenes. 
+        /// Anything that handles the ISceneLoadedMessageReceiver will receiver a reference to this handle, and therefore this token.
+        /// The token should not be something that is destroyed by the load process.
+        /// </summary>
+        public object PersistentToken
+        {
+            get;
+            set;
+        }
+
         #endregion
 
         #region Methods
-        
+
         public void WaitToActivate()
         {
-            if(_behaviour >= LoadSceneBehaviour.Async)
+            if (_behaviour >= LoadSceneBehaviour.Async)
             {
                 _behaviour = LoadSceneBehaviour.AsyncAndWait;
-                if(_op != null && !_op.isDone)
+                if (_op != null && !_op.isDone)
                 {
                     _op.allowSceneActivation = false;
                 }
@@ -93,6 +120,16 @@ public void ActivateScene()
             if (_op != null) _op.allowSceneActivation = true;
         }
 
+        private void OnSceneLoaded(Scene scene, LoadSceneMode mode)
+        {
+            //note Scene == Scene compares the handle and works just fine
+            if (_scene == scene)
+            {
+                SceneManager.sceneLoaded -= this.OnSceneLoaded;
+                com.spacepuppy.Utils.Messaging.FindAndBroadcast<ISceneLoadedMessageReceiver>((o) => o.OnSceneLoaded(this));
+            }
+        }
+
         #endregion
 
         #region IProgressingAsyncOperation Interface
@@ -101,7 +138,7 @@ public float Progress
         {
             get
             {
-                switch(_behaviour)
+                switch (_behaviour)
                 {
                     case LoadSceneBehaviour.Standard:
                         return _initialized ? 0f : 1f;
@@ -139,16 +176,16 @@ public bool IsComplete
 
         bool IRadicalYieldInstruction.Tick(out object yieldObject)
         {
-            if(!_initialized)
+            if (!_initialized)
             {
                 yieldObject = null;
                 return false;
             }
 
-            switch(_behaviour)
+            switch (_behaviour)
             {
                 case LoadSceneBehaviour.Standard:
-                    if(_initialized)
+                    if (_initialized)
                     {
                         yieldObject = null;
                         return false;
@@ -170,12 +207,12 @@ bool IRadicalYieldInstruction.Tick(out object yieldObject)
                         return true;
                     }
                 case LoadSceneBehaviour.AsyncAndWait:
-                    if(object.ReferenceEquals(_op, null))
+                    if (object.ReferenceEquals(_op, null))
                     {
                         yieldObject = null;
                         return false;
                     }
-                    else if(_op.isDone || this.ReadyAndWaitingToActivate)
+                    else if (_op.isDone || this.ReadyAndWaitingToActivate)
                     {
                         yieldObject = null;
                         return false;
@@ -193,91 +230,34 @@ bool IRadicalYieldInstruction.Tick(out object yieldObject)
 
         #endregion
 
-    }
-
-
-    public class LoadSceneAsyncWaitHandle : IProgressingYieldInstruction
-    {
-
-        #region Fields
-
-        private AsyncOperation _op;
-        private Scene _scene;
-        private bool _waitingForHandle;
-
-        #endregion
-
-        #region CONSTRUCTOR
-
-        public LoadSceneAsyncWaitHandle(AsyncOperation op, Scene scene)
-        {
-            //if (op == null) throw new System.ArgumentNullException("op");
-            _op = op;
-            _scene = scene; 
-        }
-
-        internal LoadSceneAsyncWaitHandle()
-        {
-            _waitingForHandle = true;
-        }
-        internal void Init(AsyncOperation op, Scene scene)
-        {
-            //if (op == null) throw new System.ArgumentNullException("op");
-            _op = op;
-            _scene = scene;
-            _waitingForHandle = false;
-        }
-
-        #endregion
-
-        #region Properties
+        #region IDisposable Interface
 
-        public Scene Scene
+        private bool _disposed;
+        public bool IsDisposed
         {
-            get { return _scene; }
+            get { return _disposed; }
         }
 
-        #endregion
-
-        #region IProgressingAsyncOperation Interface
-
-        public float Progress
+        public void Dispose()
         {
-            get
+            if (!_disposed)
             {
-                if (_waitingForHandle)
-                    return 0f;
-                else
-                    return _op.progress;
+                _sceneName = null;
+                _op = null;
+                SceneManager.sceneLoaded -= this.OnSceneLoaded;
             }
-        }
 
-        public bool IsComplete
-        {
-            get
-            {
-                if (_waitingForHandle)
-                    return false;
-                else
-                    return _op.isDone;
-            }
+            _disposed = true;
         }
 
-        bool IRadicalYieldInstruction.Tick(out object yieldObject)
+        ~LoadSceneWaitHandle()
         {
-            if (!_waitingForHandle && _op.isDone)
-            {
-                yieldObject = null;
-                return false;
-            }
-            else
-            {
-                yieldObject = _op;
-                return true;
-            }
+            //make sure we clean ourselves up
+            this.Dispose();
         }
 
         #endregion
 
     }
+
 }