Skip to content

Commit

Permalink
BaseAction#setMask(...): JavaDoc refinement
Browse files Browse the repository at this point in the history
* JavaDoc entry refinement.
* Removed copied notes.
* Added `@see` tags.
  • Loading branch information
pavly-gerges authored Jan 22, 2024
1 parent 16969a0 commit 5ed5fb4
Showing 1 changed file with 5 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,14 @@ public void setMaskPropagationEnabled(boolean maskPropagationEnabled) {
}

/**
* Internal use-only.
*
* <p>
* Note: This method can be invoked from the user code only if this Action is wrapped by a {@link BaseAction} and
* the {@link BaseAction#isMaskPropagationEnabled()} is false.
* </p>
* Sets the animation mask which determines which part of the model will
* be animated by the animation layer. If the {@link BaseAction#isMaskPropagationEnabled()} is false, setting
* the mask attribute will not affect the actions under this base action. Setting this to 'null' will animate
* the entire model.
*
* @param mask an animation mask to be applied to this action.
* @see com.jme3.anim.AnimLayer to adjust the animation mask to control which part will be animated
* @see BaseAction#setMaskPropagationEnabled(boolean)
*/
@Override
public void setMask(AnimationMask mask) {
Expand Down

0 comments on commit 5ed5fb4

Please sign in to comment.