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

17 lines
702 B
JavaScript

/**
* @callback jibo.bt.decorators.StartOnCondition~StartOnConditionConditional
* @returns {Boolean} `true` when you want component to start.
*/
/**
* @class StartOnCondition
* @extends jibo.bt.Decorator
* @memberof jibo.bt.decorators
* @description
* Prevents the behavior it's decorating from starting until its conditional evaluates to
* true.
* @param {Object} options See {@link jibo.bt.Decorator|Decorator} for all options.
* @param {Function} [options.init] Function called at the start of this behavior. Used to initialize any
* variables or data.
* @argument {jibo.bt.decorators.StartOnCondition~StartOnConditionConditional} options.conditional - The conditional to evaluate.
*/