Files
Zos/Skills/@be/node_modules/jibo-anim-db/lib/docs/AnimCollection.js

64 lines
1.7 KiB
JavaScript
Raw Normal View History

/**
* @class AnimCollection
* @memberof jibo.animdb
*/
/**
* Adds animation to collection
* @method jibo.animdb.AnimCollection#addAnimation
* @param {jibo.animdb.Animation} animation Animation to add
*/
/**
* Adds animation category to collection
* @method jibo.animdb.AnimCollection#addCategory
* @param {jibo.animdb.Category} category Category to add
*/
/**
* Returns category by name
* @method jibo.animdb.AnimCollection#getCategoryByName
* @param {string} name Name of category
* @returns {jibo.animdb.Category|undefined}
*/
/**
* Returns animation by name
* @method jibo.animdb.AnimCollection#getAnimByName
* @param {string} name Name of animation
* @returns {jibo.animdb.Animation|undefined}
*/
/**
* Returns the animation names in this collection.
* @method jibo.animdb.AnimCollection#getAnimationNames
* @returns {string[]} List of animation names.
*/
/**
* Returns the animation categories in this collection.
* @method jibo.animdb.AnimCollection#getAnimationCategories
* @returns {string[]} List of animation categories.
*/
/**
* Search animations for meta tags
* @method jibo.animdb.AnimCollection#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.AnimCollection#query
* @param {jibo.animdb#AnimQuery} query
* @return {jibo.animdb.AnimResults}
*/
/**
* @private
*/
/**
* @private
*/