Files
Zos/Skills/@be/node_modules/jibo-plugins/lib/docs/Plugin.js

36 lines
1.2 KiB
JavaScript

/**
* Callback for initializing a plugin.
* @callback module:jibo.Plugin~PluginCallback
* @param {String|Error} [err] Optional error if init failed.
* @param {Object} [api] Optional api to assign to the jibo runtime.
*/
/**
* List of jibo's internal plugins are below. These can be referenced
* by name when register a plugin with the "depends" option to ensure
* that plugin is create and initialized before the plugin can be used.
*
* - anim-utils - Setup the animation utilities
* - dof-arbiter - Setup the Emotion Manager
* - fonts - Install the system fonts
* - lifecycle - Install the lifecycle API
* - rendering - Setup the renderer
* - registry - Get the registry from SSM
* - service-records - Get the list of services from SSM
* - services - Setup the services
* - versions - Get the list of versions
* - loader - Setup the loader API
* - sound - Setup the sound API
*/
/**
* If provided, then this is chosen as the actual plugin instance used in the api
* @name module:jibo.Plugin#api
* @type {Object}
*/
/**
* Initialize the plugin when jibo is initialized. Optional to override intialization.
* @method module:jibo.Plugin#init
* @param {Callback} callback The asynchronous callback.
*/