Skip to content

Commit

Permalink
BaseAction#setMask(...): usage assertive note
Browse files Browse the repository at this point in the history
An assertive note about the only condition this method could be invoked from the user code.
  • Loading branch information
pavly-gerges authored Jun 3, 2023
1 parent d82fab2 commit 16969a0
Showing 1 changed file with 5 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,12 @@ public void setMaskPropagationEnabled(boolean maskPropagationEnabled) {

/**
* Internal use-only.
*
* Dispatched from {@link com.jme3.anim.AnimLayer#update(float)}. Applies an animation mask to this action,
* if the {@link BaseAction#maskPropagationEnabled} is enabled, the animation mask is propagated to the child actions (or wrapped actions).
*
* <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>
*
* @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
*/
Expand Down

0 comments on commit 16969a0

Please sign in to comment.