Release 11.0.2

Guribo · Dec 19, 2024 · c951fc9 · c951fc9
1 parent 062674c
commit c951fc9
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 20 deletions.
diff --git a/Packages/tlp.udonutils/README.md b/Packages/tlp.udonutils/README.md
@@ -36,6 +36,20 @@ The used pattern MAJOR.MINOR.PATCH indicates:
 
 All notable changes to this project will be documented in this file.
 
+### [11.0.2] - 2024-12-19
+
+#### 🐛 Bug Fixes
+
+- *(Pool)* Fix exception when pool object has no UdonSharpBehaviour
+- *(Model)* NotifyIfDirty fails if Model not yet initialized
+- *(Task)* New tasks are in "Finished" state with result "Unknown"
+- *(StateMachine)* Fix null error on invalid state in AllStates
+- *(Model)* Ignore NotifyIfDirty errors if not dirty
+
+#### 🚜 Refactor
+
+- *(Task)* Magic strings to const variables
+
 ### [11.0.1] - 2024-12-13
 
 #### 🐛 Bug Fixes

diff --git a/Packages/tlp.udonutils/Runtime/DesignPatterns/MVC/Model.cs b/Packages/tlp.udonutils/Runtime/DesignPatterns/MVC/Model.cs
@@ -128,13 +128,18 @@ public bool NotifyIfDirty(int delayFrames = 0) {
 #endif
             #endregion
 
-            if (!HasStartedOk) {
+            if (!Dirty) {
+                return true;
+            }
+
+            if (!IsReceivingStart && !HasStartedOk) {
                 Error($"{nameof(NotifyIfDirty)}: Not initialized");
                 return false;
             }
 
-            if (!Dirty) {
-                return true;
+            if (!IsModelInitialized) {
+                Error($"{nameof(NotifyIfDirty)}: Model not initialized");
+                return false;
             }
 
             if (!Utilities.IsValid(ChangeEvent)) {

diff --git a/Packages/tlp.udonutils/Runtime/Experimental/Tasks/Task.cs b/Packages/tlp.udonutils/Runtime/Experimental/Tasks/Task.cs
@@ -1,17 +1,14 @@
-using System;
-using JetBrains.Annotations;
-using TLP.UdonUtils.Runtime.Common;
-using TLP.UdonUtils.Runtime.Player;
+using JetBrains.Annotations;
 using UnityEngine;
 using VRC.SDKBase;
 
 namespace TLP.UdonUtils.Runtime.Experimental.Tasks
 {
     public enum TaskState
     {
+        Finished,
         Pending,
-        Running,
-        Finished
+        Running
     }
 
     public enum TaskResult
@@ -30,15 +27,16 @@ public abstract class Task : TlpBaseBehaviour
         public override int ExecutionOrderReadOnly => ExecutionOrder;
 
         [PublicAPI]
-        public new const int ExecutionOrder = TLP.UdonUtils.Runtime.Pool.Pool.ExecutionOrder + 50;
+        public new const int ExecutionOrder = Runtime.Pool.Pool.ExecutionOrder + 50;
         #endregion
 
-        public TaskState State { get; private set; }
-        public TaskResult Result { get; private set; }
+        public TaskState State { get; private set; } = TaskState.Finished;
+        public TaskResult Result { get; private set; } = TaskResult.Unknown;
 
         internal TaskScheduler DefaultScheduler;
         internal TaskScheduler ActiveScheduler;
         internal TlpBaseBehaviour TaskInstigator;
+
         /// <summary>
         /// In range 0 - 1 (inclusive)
         /// </summary>
@@ -61,7 +59,6 @@ internal bool PrepareForRun() {
             Result = TaskResult.Failed;
             State = TaskState.Finished;
             return false;
-
         }
 
         public bool Abort() {
@@ -83,6 +80,7 @@ public bool Abort() {
                 ActiveScheduler.CancelTask(this);
                 return true;
             }
+
             Error($"{nameof(Abort)}: was not scheduled");
             return false;
         }
@@ -122,6 +120,13 @@ public TaskState Run() {
 
         #region Internal
         protected void SetProgress(float progress) {
+            #region TLP_DEBUG
+#if TLP_DEBUG
+            DebugLog($"{nameof(SetProgress)}: {nameof(progress)}={progress}");
+#endif
+            #endregion
+
+
             Progress = Mathf.Clamp01(progress);
         }
 

diff --git a/Packages/tlp.udonutils/Runtime/Experimental/Tasks/TaskScheduler.cs b/Packages/tlp.udonutils/Runtime/Experimental/Tasks/TaskScheduler.cs
@@ -22,6 +22,8 @@ public class TaskScheduler : TlpSingleton
         public new const int ExecutionOrder = TlpExecutionOrder.RecordingEnd - 2;
         #endregion
 
+        public const string FinishedTaskVariableName = "FinishedTask";
+        public const string FinishedTaskCallbackName = "OnTaskFinished";
         public const string GameObjectName = "TLP_TaskScheduler";
         internal readonly DataList PendingTasks = new DataList();
         internal readonly DataDictionary UniqueTasks = new DataDictionary();
@@ -194,8 +196,10 @@ private void RemoveTask(Task task, int index) {
                         var instigator = (TlpBaseBehaviour)instigatorToken.Reference;
                         if (Utilities.IsValid(instigator)) {
                             instigator.EventInstigator = this;
-                            instigator.OnEvent("OnTaskFinished");
+                            instigator.SetProgramVariable(FinishedTaskVariableName, task);
+                            instigator.OnEvent(FinishedTaskCallbackName);
                             instigator.EventInstigator = null;
+                            instigator.SetProgramVariable(FinishedTaskVariableName, null);
                         } else {
                             Error(
                                     $"{nameof(RemoveTask)}: {nameof(instigator)} invalid, {task.GetScriptPathInScene()} has no owner");

diff --git a/Packages/tlp.udonutils/Runtime/Pool/Pool.cs b/Packages/tlp.udonutils/Runtime/Pool/Pool.cs
@@ -1,12 +1,16 @@
-using System;
-using JetBrains.Annotations;
+using JetBrains.Annotations;
+using TLP.UdonUtils.Runtime.Common;
 using TLP.UdonUtils.Runtime.Events;
 using TLP.UdonUtils.Runtime.Experimental.Tasks;
 using UdonSharp;
 using UnityEngine;
 using UnityEngine.Serialization;
 using VRC.SDKBase;
+
+#if !COMPILER_UDONSHARP && UNITY_EDITOR
+#else
 using VRC.Udon;
+#endif
 
 namespace TLP.UdonUtils.Runtime.Pool
 {
@@ -159,7 +163,8 @@ public void Return(GameObject toReturn) {
 #endif
 
             if (!Utilities.IsValid(instance)) {
-                Warn($"{toReturn.name} has no UdonSharpBehaviour attached and will thus not be de-initialized");
+                Warn(
+                        $"{toReturn.transform.GetPathInScene()} has no UdonSharpBehaviour attached and will thus not be de-initialized");
             } else {
                 instance.SendCustomEvent(nameof(OnPrepareForReturnToPool));
             }
@@ -170,7 +175,9 @@ public void Return(GameObject toReturn) {
                 toReturn.transform.parent = transform;
             }
 
-            instance.SetProgramVariable(nameof(PoolableInUse), false);
+            if (Utilities.IsValid(instance)) {
+                instance.SetProgramVariable(nameof(PoolableInUse), false);
+            }
 
             Pooled++;
         }

diff --git a/Packages/tlp.udonutils/Runtime/StateMachine/StateMachine.cs b/Packages/tlp.udonutils/Runtime/StateMachine/StateMachine.cs
@@ -171,9 +171,14 @@ public bool OwnerSetNewState(int newStateIndex) {
                 StateMachineState.enabled = false;
             }
 
+            var newState = AllStates[newStateIndex];
+            if (!Utilities.IsValid(newState)) {
+                Error($"{nameof(OwnerSetNewState)}: {nameof(AllStates)} is null at index {newStateIndex}");
+                return false;
+            }
+
             LocalStateIndex = newStateIndex;
             WorkingStateIndex = newStateIndex;
-            var newState = AllStates[newStateIndex];
             StateMachineState = newState;
             newState.enabled = true;
             return true;

diff --git a/Packages/tlp.udonutils/package.json b/Packages/tlp.udonutils/package.json
@@ -1,7 +1,7 @@
 {
   "name": "tlp.udonutils",
   "displayName": "TLP UdonUtils",
-  "version": "11.0.1",
+  "version": "11.0.2",
   "description": "Contains the base scripts/tools for TLP packages as well as prefabs and potentially helpful scripts for VRChat worlds.",
   "gitDependencies": {},
   "legacyFolders": {

diff --git a/README.md b/README.md
@@ -36,6 +36,20 @@ The used pattern MAJOR.MINOR.PATCH indicates:
 
 All notable changes to this project will be documented in this file.
 
+### [11.0.2] - 2024-12-19
+
+#### 🐛 Bug Fixes
+
+- *(Pool)* Fix exception when pool object has no UdonSharpBehaviour
+- *(Model)* NotifyIfDirty fails if Model not yet initialized
+- *(Task)* New tasks are in "Finished" state with result "Unknown"
+- *(StateMachine)* Fix null error on invalid state in AllStates
+- *(Model)* Ignore NotifyIfDirty errors if not dirty
+
+#### 🚜 Refactor
+
+- *(Task)* Magic strings to const variables
+
 ### [11.0.1] - 2024-12-13
 
 #### 🐛 Bug Fixes