Support trigger type AnimatorControllerParameter

packages/core/src/animation/Animator.ts

@@ -30,6 +30,8 @@ import { AnimationCurveOwner } from "./internal/animationCurveOwner/AnimationCur
  * The controller of the animation system.
  */
 export class Animator extends Component {
+  private static _tempTriggeredParametersName: string[] = [];
+
   /** Culling mode of this Animator. */
   cullingMode: AnimatorCullingMode = AnimatorCullingMode.None;
   /** The playback speed of the Animator, 1.0 is normal playback speed. */
@@ -244,13 +246,37 @@ export class Animator extends Component {
    * @param name - The name of the parameter
    * @param value - The value of the parameter
    */
-  setParameterValue(name: string, value: AnimatorControllerParameterValue) {
+  setParameterValue(name: string, value: AnimatorControllerParameterValue): void {
     const parameter = this._animatorController?._parametersMap[name];
     if (parameter) {
       this._parametersValueMap[name] = value;
     }
   }
 
+  /**
+   * Activate the trigger parameter by name.
+   * @param name - The name of the trigger parameter
+   */
+  activateTriggerParameter(name: string): void {
+    const parameter = this._animatorController?._parametersMap[name];
+
+    if (parameter?._isTrigger) {
+      this._parametersValueMap[name] = true;
+    }
+  }
+
+  /**
+   * Reset the trigger parameter to deactivate it by name.
+   * @param name - The name of the trigger parameter
+   */
+  deactivateTriggerParameter(name: string): void {
+    const parameter = this._animatorController?._parametersMap[name];
+
+    if (parameter?._isTrigger) {
+      this._parametersValueMap[name] = false;
+    }
+  }
+
   /**
    * @internal
    */
@@ -1271,43 +1297,61 @@ export class Animator extends Component {
         return false;
       }
 
-      switch (mode) {
-        case AnimatorConditionMode.Equals:
-          if (parameterValue === threshold) {
-            pass = true;
-          }
-          break;
-        case AnimatorConditionMode.Greater:
-          if (parameterValue > threshold) {
-            pass = true;
-          }
-          break;
-        case AnimatorConditionMode.Less:
-          if (parameterValue < threshold) {
-            pass = true;
-          }
-          break;
-        case AnimatorConditionMode.NotEquals:
-          if (parameterValue !== threshold) {
-            pass = true;
-          }
-          break;
-        case AnimatorConditionMode.If:
-          if (parameterValue === true) {
-            pass = true;
-          }
-          break;
-        case AnimatorConditionMode.IfNot:
-          if (parameterValue === false) {
-            pass = true;
-          }
-          break;
+      if (parameterValue === true) {
+        const parameter = this.getParameter(name);
+        if (parameter?._isTrigger) {
+          Animator._tempTriggeredParametersName.push(name);
+          pass = true;
+        }
       }
+
+      if (!pass) {
+        switch (mode) {
+          case AnimatorConditionMode.Equals:
+            if (parameterValue === threshold) {
+              pass = true;
+            }
+            break;
+          case AnimatorConditionMode.Greater:
+            if (parameterValue > threshold) {
+              pass = true;
+            }
+            break;
+          case AnimatorConditionMode.Less:
+            if (parameterValue < threshold) {
+              pass = true;
+            }
+            break;
+          case AnimatorConditionMode.NotEquals:
+            if (parameterValue !== threshold) {
+              pass = true;
+            }
+            break;
+          case AnimatorConditionMode.If:
+            if (parameterValue === true) {
+              pass = true;
+            }
+            break;
+          case AnimatorConditionMode.IfNot:
+            if (parameterValue === false) {
+              pass = true;
+            }
+            break;
+        }
+      }
+
       if (!pass) {
         allPass = false;
         break;
       }
     }
+
+    if (allPass) {
+      this._deactivateTriggeredParameters();
+    }
+
+    Animator._tempTriggeredParametersName.length = 0;
+
     return allPass;
   }
 
@@ -1515,6 +1559,13 @@ export class Animator extends Component {
       this._callAnimatorScriptOnUpdate(state, layerIndex);
     }
   }
+
+  private _deactivateTriggeredParameters(): void {
+    const tempTriggeredParametersName = Animator._tempTriggeredParametersName;
+    for (let i = 0, n = tempTriggeredParametersName.length; i < n; i++) {
+      this._parametersValueMap[tempTriggeredParametersName[i]] = false;
+    }
+  }
 }
 
 interface IAnimatorStateInfo {

packages/core/src/animation/AnimatorController.ts

@@ -55,20 +55,15 @@ export class AnimatorController extends ReferResource {
    * @param defaultValue - The default value of the parameter
    */
   addParameter(name: string, defaultValue?: AnimatorControllerParameterValue): AnimatorControllerParameter {
-    if (this._parametersMap[name]) {
-      console.warn(`Parameter ${name} already exists.`);
-      return null;
-    }
-    const param = new AnimatorControllerParameter();
-    param.name = name;
-    param.defaultValue = defaultValue;
-    param._onNameChanged = (oldName, newName) => {
-      delete this._parametersMap[oldName];
-      this._parametersMap[newName] = param as AnimatorControllerParameter;
-    };
-    this._parametersMap[name] = param;
-    this._parameters.push(param);
-    return param;
+    return this._addParameter(name, defaultValue, false);
+  }
+
+  /**
+   * Add a trigger parameter to the controller.
+   * @param name - The name of the parameter
+   */
+  addTriggerParameter(name: string): AnimatorControllerParameter {
+    return this._addParameter(name, false, true);
   }
 
   /**
@@ -84,6 +79,16 @@ export class AnimatorController extends ReferResource {
     }
   }
 
+  /**
+   * Clear parameters.
+   */
+  clearParameters(): void {
+    this._parameters.length = 0;
+    for (let name in this._parametersMap) {
+      delete this._parametersMap[name];
+    }
+  }
+
   /**
    * Get the parameter by name.
    * @param name - The name of the parameter
@@ -138,4 +143,26 @@ export class AnimatorController extends ReferResource {
   _registerChangeFlag(): BoolUpdateFlag {
     return this._updateFlagManager.createFlag(BoolUpdateFlag);
   }
+
+  private _addParameter(
+    name: string,
+    defaultValue: AnimatorControllerParameterValue,
+    isTrigger: boolean = false
+  ): AnimatorControllerParameter {
+    if (this._parametersMap[name]) {
+      console.warn(`Parameter ${name} already exists.`);
+      return null;
+    }
+    const param = new AnimatorControllerParameter();
+    param.name = name;
+    param.defaultValue = defaultValue;
+    param._isTrigger = isTrigger;
+    param._onNameChanged = (oldName, newName) => {
+      delete this._parametersMap[oldName];
+      this._parametersMap[newName] = param as AnimatorControllerParameter;
+    };
+    this._parametersMap[name] = param;
+    this._parameters.push(param);
+    return param;
+  }
 }

packages/core/src/animation/AnimatorControllerParameter.ts

@@ -10,6 +10,9 @@ export class AnimatorControllerParameter {
   /** @internal */
   _onNameChanged: (oldName: string, newName: string) => void = null;
 
+  /** @internal */
+  _isTrigger: boolean = false;
+
   private _name: string;
 
   /**

packages/core/src/animation/AnimatorStateTransition.ts

@@ -69,13 +69,13 @@ export class AnimatorStateTransition {
 
   /**
    * Add a condition to a transition.
-   * @param mode - The AnimatorCondition mode of the condition
    * @param parameterName - The name of the parameter
+   * @param mode - The AnimatorCondition mode of the condition
    * @param threshold - The threshold value of the condition
    */
   addCondition(
-    mode: AnimatorConditionMode,
     parameterName: string,
+    mode: AnimatorConditionMode,
     threshold?: AnimatorControllerParameterValue
   ): AnimatorCondition;
 
@@ -86,17 +86,17 @@ export class AnimatorStateTransition {
   addCondition(animatorCondition: AnimatorCondition): AnimatorCondition;
 
   addCondition(
-    param: AnimatorConditionMode | AnimatorCondition,
-    parameterName?: string,
+    param: string | AnimatorCondition,
+    mode?: AnimatorConditionMode,
     threshold?: AnimatorControllerParameterValue
   ): AnimatorCondition {
     if (typeof param === "object") {
       this._conditions.push(param);
       return param;
     } else {
       const condition = new AnimatorCondition();
-      condition.mode = param;
-      condition.parameterName = parameterName;
+      condition.parameterName = param;
+      condition.mode = mode ?? AnimatorConditionMode.If;
       condition.threshold = threshold;
       this._conditions.push(condition);
       return condition;

packages/loader/src/AnimatorControllerLoader.ts

@@ -99,7 +99,11 @@ class AnimatorControllerLoader extends Loader<AnimatorController> {
             animatorController.addLayer(layer);
           });
           parameters.forEach((parameterData) => {
-            animatorController.addParameter(parameterData.name, parameterData.defaultValue);
+            if (parameterData.isTrigger) {
+              animatorController.addTriggerParameter(parameterData.name);
+            } else {
+              animatorController.addParameter(parameterData.name, parameterData.defaultValue);
+            }
           });
           Promise.all(promises).then((clipData) => {
             clipData.forEach((data) => {
@@ -125,7 +129,7 @@ class AnimatorControllerLoader extends Loader<AnimatorController> {
     transition._isExit = transitionData.isExit;
     transition.destinationState = destinationState;
     transitionData.conditions.forEach((conditionData) => {
-      transition.addCondition(conditionData.mode, conditionData.parameterName, conditionData.threshold);
+      transition.addCondition(conditionData.parameterName, conditionData.mode, conditionData.threshold);
     });
     return transition;
   }