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

15 lines
697 B
JavaScript

/**
* @callback jibo.bt.decorators.StartOnAnimEvent~StartOnEventOnReceived
* @argument {AnimationInstance} instance The animation instance the event was dispatched from.
* @argument {Object} payload A payload defined in the `.keys` file.
*/
/**
* @class StartOnAnimEvent
* @extends jibo.bt.Decorator
* @memberof jibo.bt.decorators
* @description
* `StartOnAnimEvent` will begin the execution of its behavior when an animation fires an event from its event layer.
* @param {String} options.eventName - Name of the event this behavior listens for.
* @param {jibo.bt.decorators.StartOnAnimEvent~StartOnEventOnReceived} options.onReceived - Callback for when `eventName` is dispatched.
*/