[DOCS] Document pc.AnimationComponent#skeleton and pc.AnimationComponent#animations (playcanvas#1967)

aidinabedi · web-flow · commit e6603697a7ae · 2020-04-08T12:51:19.000+01:00
* add pc.AnimationComponent#getSkeleton

* change function getSkeleton to property skeleton

* remove setter since it already exists (but undocumented).

* add jsdoc documentation for existing animations property

* add missing character

* fix linting issue

* document skeleton as read-only

* add comment about skeleton being null when model is gltf/glb
diff --git a/src/framework/components/animation/component.js b/src/framework/components/animation/component.js
@@ -13,7 +13,9 @@ Object.assign(pc, function () {
      * @property {boolean} activate If true the first animation asset will begin playing when the scene is loaded.
      * @property {pc.Asset[]|number[]} assets The array of animation assets - can also be an array of asset ids.
      * @property {number} currentTime Get or Set the current time position (in seconds) of the animation.
-     * @property {number} duration Get the duration in seconds of the current animation.
+     * @property {number} duration Get the duration in seconds of the current animation. [read only]
+     * @property {pc.Skeleton|null} skeleton Get the skeleton for the current model; unless model is from glTF/glb, then skeleton is null. [read only]
+     * @property {object<string, pc.Animation>} animations Get or Set dictionary of animations by name.
      */
     var AnimationComponent = function (system, entity) {
         pc.Component.call(this, system, entity);
