Use scene index to destroy tweens on scene unload

Author: adamgraham

Runtime/Extensions/Misc/RectOffsetTweens.cs

@@ -7,22 +7,22 @@ public static class RectOffsetTweens
         public static Tween TweenLeft(this RectOffset offset, int to, float duration) =>
             Tweening.To(getter: () => offset.left,
                         setter: left => offset.left = left,
-                        to, duration).SetTarget(offset);
+                        to, duration);
 
         public static Tween TweenRight(this RectOffset offset, int to, float duration) =>
             Tweening.To(getter: () => offset.right,
                         setter: right => offset.right = right,
-                        to, duration).SetTarget(offset);
+                        to, duration);
 
         public static Tween TweenTop(this RectOffset offset, int to, float duration) =>
             Tweening.To(getter: () => offset.top,
                         setter: top => offset.top = top,
-                        to, duration).SetTarget(offset);
+                        to, duration);
 
         public static Tween TweenBottom(this RectOffset offset, int to, float duration) =>
             Tweening.To(getter: () => offset.bottom,
                         setter: bottom => offset.bottom = bottom,
-                        to, duration).SetTarget(offset);
+                        to, duration);
 
     }
 

Runtime/Extensions/Physics/PhysicMaterialTweens.cs

@@ -7,17 +7,17 @@ public static class PhysicMaterialTweens
         public static Tween TweenBounciness(this PhysicMaterial material, float to, float duration) =>
             Tweening.To(getter: () => material.bounciness,
                         setter: bounciness => material.bounciness = bounciness,
-                        to, duration).SetTarget(material);
+                        to, duration);
 
         public static Tween TweenDynamicFriction(this PhysicMaterial material, float to, float duration) =>
             Tweening.To(getter: () => material.dynamicFriction,
                         setter: friction => material.dynamicFriction = friction,
-                        to, duration).SetTarget(material);
+                        to, duration);
 
         public static Tween TweenStaticFriction(this PhysicMaterial material, float to, float duration) =>
             Tweening.To(getter: () => material.staticFriction,
                         setter: friction => material.staticFriction = friction,
-                        to, duration).SetTarget(material);
+                        to, duration);
 
     }
 

Runtime/Extensions/Physics2D/PhysicsMaterial2DTweens.cs

@@ -7,12 +7,12 @@ public static class PhysicsMaterial2DTweens
         public static Tween TweenBounciness(this PhysicsMaterial2D material, float to, float duration) =>
             Tweening.To(getter: () => material.bounciness,
                         setter: bounciness => material.bounciness = bounciness,
-                        to, duration).SetTarget(material);
+                        to, duration);
 
         public static Tween TweenFriction(this PhysicsMaterial2D material, float to, float duration) =>
             Tweening.To(getter: () => material.friction,
                         setter: friction => material.friction = friction,
-                        to, duration).SetTarget(material);
+                        to, duration);
 
     }
 

Runtime/Extensions/Rendering/MaterialTweens.cs

@@ -7,22 +7,22 @@ public static class MaterialTweens
         public static Tween TweenColor(this Material material, Color to, float duration) =>
             Tweening.To(getter: () => material.color,
                         setter: color => material.color = color,
-                        to, duration).SetTarget(material);
+                        to, duration);
 
         public static Tween TweenAlpha(this Material material, float to, float duration) =>
             Tweening.To(getter: () => material.color.a,
                         setter: alpha => material.color = new Color(material.color.r, material.color.g, material.color.b, alpha),
-                        to, duration).SetTarget(material);
+                        to, duration);
 
         public static Tween TweenMainTextureScale(this Material material, Vector2 to, float duration) =>
             Tweening.To(getter: () => material.mainTextureScale,
                         setter: mainTextureScale => material.mainTextureScale = mainTextureScale,
-                        to, duration).SetTarget(material);
+                        to, duration);
 
         public static Tween TweenMainTextureOffset(this Material material, Vector2 to, float duration) =>
             Tweening.To(getter: () => material.mainTextureOffset,
                         setter: mainTextureOffset => material.mainTextureOffset = mainTextureOffset,
-                        to, duration).SetTarget(material);
+                        to, duration);
 
     }
 

Runtime/PropertyChaining.cs

@@ -1,3 +1,5 @@
+using UnityEngine;
+
 namespace Zigurous.Tweening
 {
     /// <summary>
@@ -7,13 +9,23 @@ namespace Zigurous.Tweening
     /// </summary>
     public static class PropertyChaining
     {
-        /// <summary>
-        /// Sets the id of the tween such that it can be identified by the given
-        /// target object.
-        /// </summary>
-        public static T SetTarget<T, U>(this T tween, U target) where T: Tween
+        public static T SetTarget<T>(this T tween, Component target) where T: Tween
+        {
+            if (target != null)
+            {
+                tween.id = target.GetHashCode();
+                tween.sceneIndex = target.gameObject.scene.buildIndex;
+            }
+            return tween;
+        }
+
+        public static T SetTarget<T>(this T tween, GameObject target) where T: Tween
         {
-            tween.id = target.GetHashCode();
+            if (target != null)
+            {
+                tween.id = target.GetHashCode();
+                tween.sceneIndex = target.scene.buildIndex;
+            }
             return tween;
         }
 

Runtime/Tween.cs

@@ -14,6 +14,12 @@ public abstract class Tween
         /// </summary>
         public int id;
 
+        /// <summary>
+        /// The index of the scene that contains the object being animated by
+        /// the tween. The is used to kill the tween when the scene is unloaded.
+        /// </summary>
+        internal int sceneIndex = -1;
+
         /// <summary>
         /// The template type used by the tween, if relevant.
         /// </summary>
@@ -398,6 +404,8 @@ public void Restart()
         internal void Reset()
         {
             this.id = -1;
+            this.sceneIndex = -1;
+
             this.state = TweenState.Ready;
             this.internalState = InternalTweenState.Queued;
 

Runtime/TweenManager.cs

@@ -185,12 +185,15 @@ internal void Track(Tween tween)
         }
 
         /// <summary>
-        /// Kills all tweens when the active scene is unloaded.
+        /// Kills all tweens that are animating objects on the unloaded scene.
         /// </summary>
         private void SceneUnloaded(Scene scene)
         {
-            if (Tweening.killTweensOnSceneUnload) {
-                Tweening.KillAll();
+            foreach (Tween tween in this.tweens)
+            {
+                if (tween.sceneIndex == -1 || tween.sceneIndex == scene.buildIndex) {
+                    tween.Kill();
+                }
             }
         }
 

Runtime/Tweening.cs

@@ -43,11 +43,6 @@ public static class Tweening
         /// </summary>
         public static float overshoot = 1.70158f;
 
-        /// <summary>
-        /// Kills all tweens when the active scene is unloaded.
-        /// </summary>
-        public static bool killTweensOnSceneUnload = true;
-
         /// <summary>
         /// The initial amount of tweens that memory is allocated for when the
         /// system starts. Additional memory will be allocated as needed.