Since a lot of you guys are more active here, I would like to take your opinion about documenting the Action#setMask(...)
.
The situation is:
- Normally, the
AnimLayer
is in charge of adjusting the actionAnimationMask
and this is done periodically on each update. - Implementations of the
Action
class changing the behavior of theAction#setMask(...)
method should each override this method and override the documentation if needed, for example: AClipAction
utilized within aBaseAction
when themask propagation
flag is off, in this case only a user can call theAction#setMask(...)
manually. -
BaseAction#setMask(...)
: should also be “Internal use-only” unless wrapped by another BaseAction.
What should be done, in my opinion:
- Mark the abstract
Action#setMask(...)
as an internal use-only. - Override the
Action#setMask(...)
for each Action implementation and adjust the documentation according to the internal behavior.
Let me know your opinions.