Files
JiboOs/docs/bt/behaviors/PlayAnimation.js
2026-03-16 13:53:01 +02:00

15 lines
1.0 KiB
JavaScript

/**
* @class PlayAnimation
* @extends jibo.bt.Behavior
* @memberof jibo.bt.behaviors
* @description Plays the animation specified by `animPath`, `animName` or `animQuery`.
* Succeeds when the animation is finished playing. Playing an
* animation consists of two phases: the transition phase and the play phase. The transition phase will
* transition Jibo from his current position to the start position of the specified animation. The play
* phase plays the animation with the current configuration.
* @param {Object} options See {@link jibo.bt.Behavior|Behavior} for all options.
* @param {String} options.animPath The path to the `.keys` file. This behavior assumes `${project}/animations` is the root for
* all the animations.
* @param {Function} options.config Called and passed a {@link AnimationBuilder} object for configuration purposes. Do not call
* {@link AnimationBuilder#play}. This is done automatically by the behavior.
*/