Action#getMask(): clarification of null returns

jMonkeyEngine · May 31, 2023 · 599623d · 599623d
1 parent fe89763
commit 599623d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/jme3-core/src/main/java/com/jme3/anim/tween/action/Action.java b/jme3-core/src/main/java/com/jme3/anim/tween/action/Action.java
@@ -141,7 +141,8 @@ public void setSpeed(double speed) {
      * The animation mask controls which part of the model would be animated. A model part can be
      * registered using a {@link com.jme3.anim.Joint}.
      *
-     * @return the animation mask instance.
+     * @return the animation mask instance, or null if this action will animate the entire model
+     * @see com.jme3.anim.AnimLayer to adjust the animation mask that controls which part will be animated
      */
     public AnimationMask getMask() {
         return mask;