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

135 lines
3.3 KiB
JavaScript

/**
* @class BaseElement
* @memberof jibo.bt
* @private
* @description Parent class for Behavior and Decorator.
*
* Subclasses: {@link jibo.bt.behaviors.Behavior|Behavior}, {@link jibo.bt.behaviors.ParentBehavior|ParentBehavior}, {@link jibo.bt.behaviors.Decorator|Decorator}
*
* @param {Object} [options] Options for the behavior
*/
/**
* The list of options
* @name jibo.bt.Behavior#options
* @type {Object}
* @readOnly
*/
/**
* The list of options
* @name jibo.bt.Decorator#options
* @type {Object}
* @readOnly
*/
/**
* The current internal status of the element
* @name jibo.bt.BaseElement#_currentStatus
* @type {String}
* @private
*/
/**
* Instance of the blackboard
* @name jibo.bt.Behavior#blackboard
* @type {jibo.bt.Blackboard}
* @readOnly
*/
/**
* Instance of the blackboard
* @name jibo.bt.Decorator#blackboard
* @type {jibo.bt.Blackboard}
* @readOnly
*/
/**
* Instance of the behavior emitter
* @name jibo.bt.Behavior#emitter
* @type {jibo.bt.BehaviorEmitter}
* @readOnly
*/
/**
* Instance of the behavior emitter
* @name jibo.bt.Decorator#emitter
* @type {jibo.bt.BehaviorEmitter}
* @readOnly
*/
/**
* Name of the asset pack
* @name jibo.bt.Behavior#assetPack
* @type {String}
* @readOnly
*/
/**
* Name of the asset pack
* @name jibo.bt.Decorator#assetPack
* @type {String}
* @readOnly
*/
/**
* Name of the behavior
* @name jibo.bt.Behavior#name
* @type {String}
* @readOnly
*/
/**
* Name of the behavior
* @name jibo.bt.Decorator#name
* @type {String}
* @readOnly
*/
/**
* Get the current status
* @name jibo.bt.Behavior#currentStatus
* @type {String}
* @readOnly
*/
/**
* Get the current status
* @name jibo.bt.Decorator#currentStatus
* @type {String}
* @readOnly
*/
/**
* Stops the behavior or decorator, must override
* @method jibo.bt.Behavior#stop
* @return {Promise<void>} A promise that resolves after any asynchronous cleanup has been performed.
*/
/**
* Stops the behavior or decorator, must override
* @method jibo.bt.Decorator#stop
* @return {Promise<void>} A promise that resolves after any asynchronous cleanup has been performed.
*/
/**
* Destroys the behavior, removes all references.
* @method jibo.bt.Behavior#destroy
*/
/**
* Destroys the decorator, removes all references.
* @method jibo.bt.Decorator#destroy
*/
/**
* Stops and Destroys the behavior or decorator
* @method jibo.bt.Behavior#stopAndDestroy
* @return {Promise<void>} A promise that resolves after any asynchronous cleanup has been performed.
*/
/**
* Stops and Destroys the behavior or decorator
* @method jibo.bt.Decorator#stopAndDestroy
* @return {Promise<void>} A promise that resolves after any asynchronous cleanup has been performed.
*/