74 lines
2.1 KiB
JavaScript
74 lines
2.1 KiB
JavaScript
|
/**
|
||
|
|
* The singleton animDB instance
|
||
|
|
* Should not be used in normal operation, but made visible for testing and debugging purposes
|
||
|
|
* @type {AnimDB}
|
||
|
|
* @private
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates an animDB from a list of root directories
|
||
|
|
* @method jibo.animdb#readAnimDB
|
||
|
|
* @param {object} jibo - The jibo runtime
|
||
|
|
* @param {string} [animDBPath] Path to an animDB json
|
||
|
|
* @param {string[]} [moreAnimDBPaths] Paths to more animDB json files
|
||
|
|
* @returns {Promise<jibo.animdb.AnimDB>}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks if AnimDB is already initialized
|
||
|
|
* @method jibo.animdb#isInitialized
|
||
|
|
* @returns {boolean}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Finds AnimDB database path globally or from directory
|
||
|
|
* @method jibo.animdb#resolveAnimDB
|
||
|
|
* @param {object} jibo - The jibo runtime
|
||
|
|
* @param {string} [dir] - Optional directory to search from; searches globally if not provided
|
||
|
|
* @returns {string} Path to AnimDB Database globally or from directory
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get animation by name. Returns first animation by that iname in the case of multiple collections
|
||
|
|
* @method jibo.animdb#getAnimByName
|
||
|
|
* @param {string} animName Name of animation to retrieve
|
||
|
|
* @returns {jibo.animdb.Animation}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get animation names. Returns a list of the animation names in the animDB.
|
||
|
|
* @method jibo.animdb#getAnimationNames
|
||
|
|
* @returns {string[]} List of animation names
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get animation categories. Returns a list of the animation categories in the animDB.
|
||
|
|
* @method jibo.animdb#getAnimationCategories
|
||
|
|
* @returns {string[]} List of animation categories
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Search animations for meta tags
|
||
|
|
* @method jibo.animdb#search
|
||
|
|
* @param {string} searchTerm Search term could be meta tag, name, or category
|
||
|
|
* @returns {jibo.animdb.SearchResults}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Queries for animations that fit the criteria
|
||
|
|
* @method jibo.animdb#query
|
||
|
|
* @param {jibo.animdb#AnimQuery} query The query parameters
|
||
|
|
* @return {jibo.animdb.AnimResults}
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Adds animation database instance
|
||
|
|
* @method jibo.animdb#push
|
||
|
|
* @param {jibo.animdb.AnimCollection} animCollection Animation collection to add
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pops the last anim database instance off the stack
|
||
|
|
* @method jibo.animdb#pop
|
||
|
|
* @return {jibo.animdb.AnimCollection}
|
||
|
|
*/
|