Merge pull request #1098 from jareguo/temp

API 中加入 spine 官方文档链接
This commit is contained in:
Wang Nan
2016-09-07 10:36:54 +08:00
committed by GitHub
4 changed files with 66 additions and 31 deletions
+12 -5
View File
@@ -208,7 +208,8 @@ sp._SGSkeleton = _ccsg.Node.extend({
},
/**
* Finds a bone by name. This does a string comparison for every bone.
* Finds a bone by name. This does a string comparison for every bone.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Bone object.
* @param {String} boneName
* @returns {spine.Bone}
*/
@@ -217,7 +218,9 @@ sp._SGSkeleton = _ccsg.Node.extend({
},
/**
* Finds a slot by name. This does a string comparison for every slot.
* Finds a slot by name. This does a string comparison for every slot.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Slot object.
*
* @param {String} slotName
* @returns {spine.Slot}
*/
@@ -226,7 +229,9 @@ sp._SGSkeleton = _ccsg.Node.extend({
},
/**
* Finds a skin by name and makes it the active skin. This does a string comparison for every skin. Note that setting the skin does not change which attachments are visible.
* Finds a skin by name and makes it the active skin. This does a string comparison for every skin. Note that setting the skin does not change which attachments are visible.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Skin object.
*
* @param {string} skinName
* @returns {spine.Skin}
*/
@@ -235,10 +240,12 @@ sp._SGSkeleton = _ccsg.Node.extend({
},
/**
* Returns the attachment for the slot and attachment name. The skeleton looks first in its skin, then in the skeleton data’s default skin.
* Returns the attachment for the slot and attachment name. The skeleton looks first in its skin, then in the skeleton data’s default skin.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Attachment object.
*
* @param {String} slotName
* @param {String} attachmentName
* @returns {spine.RegionAttachment|spine.BoundingBoxAttachment}
* @returns {spine.Attachment}
*/
getAttachment: function (slotName, attachmentName) {
return this._skeleton.getAttachmentBySlotName(slotName, attachmentName);
+40 -24
View File
@@ -504,10 +504,13 @@ sp.Skeleton = cc.Class({
/**
* !#en
* Finds a bone by name.
* This does a string comparison for every bone.
* This does a string comparison for every bone.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Bone object.
* !#zh
* 通过名称查找 bone。
* 这里对每个 bone 的名称进行了对比。
* 这里对每个 bone 的名称进行了对比。<br>
* 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Bone 对象。
*
* @method findBone
* @param {String} boneName
* @return {spine.Bone}
@@ -521,11 +524,12 @@ sp.Skeleton = cc.Class({
/**
* !#en
* Finds a slot by name.
* This does a string comparison for every slot.
* Finds a slot by name. This does a string comparison for every slot.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Slot object.
* !#zh
* 通过名称查找 slot。
* 这里对每个 slot 的名称进行了比较。
* 通过名称查找 slot。这里对每个 slot 的名称进行了比较。<br>
* 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Slot 对象。
*
* @method findSlot
* @param {String} slotName
* @return {spine.Slot}
@@ -540,12 +544,14 @@ sp.Skeleton = cc.Class({
/**
* !#en
* Finds a skin by name and makes it the active skin.
* This does a string comparison for every skin.
* Note that setting the skin does not change which attachments are visible.
* This does a string comparison for every skin.<br>
* Note that setting the skin does not change which attachments are visible.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Skin object.
* !#zh
* 按名称查找皮肤,激活该皮肤。
* 这里对每个皮肤的名称进行了比较。
* 注意:设置皮肤不会改变 attachment 的可见性。。
* 按名称查找皮肤,激活该皮肤。这里对每个皮肤的名称进行了比较。<br>
* 注意:设置皮肤不会改变 attachment 的可见性。<br>
* 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Skin 对象。
*
* @method setSkin
* @param {String} skinName
* @return {spine.Skin}
@@ -560,14 +566,16 @@ sp.Skeleton = cc.Class({
/**
* !#en
* Returns the attachment for the slot and attachment name.
* The skeleton looks first in its skin, then in the skeleton data’s default skin.
* The skeleton looks first in its skin, then in the skeleton data’s default skin.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Attachment object.
* !#zh
* 通过 slot 和 attachment 的名称获取 attachment。
* Skeleton 优先查找它的皮肤,然后才是 Skeleton Data 中默认的皮肤。
* 通过 slot 和 attachment 的名称获取 attachment。Skeleton 优先查找它的皮肤,然后才是 Skeleton Data 中默认的皮肤。<br>
* 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.Attachment 对象。
*
* @method getAttachment
* @param {String} slotName
* @param {String} attachmentName
* @return {spine.RegionAttachment|sp.spine.BoundingBoxAttachment}
* @return {spine.Attachment}
*/
getAttachment: function (slotName, attachmentName) {
if (this._sgNode) {
@@ -609,7 +617,7 @@ sp.Skeleton = cc.Class({
///**
// * Return the renderer of attachment.
// * @method getTextureAtlas
// * @param {spine.RegionAttachment|sp.spine.BoundingBoxAttachment} regionAttachment
// * @param {spine.RegionAttachment|spine.BoundingBoxAttachment} regionAttachment
// * @return {_ccsg.Node}
// */
//getTextureAtlas: function (regionAttachment) {
@@ -621,8 +629,10 @@ sp.Skeleton = cc.Class({
// ANIMATION
/**
* !#en Sets animation state data.
* !#zh 设置动画状态数据。
* !#en Sets animation state data.<br>
* The parameter type is {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.AnimationStateData.
* !#zh 设置动画状态数据。<br>
* 参数是 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.AnimationStateData。
* @method setAnimationStateData
* @param {spine.AnimationStateData} stateData
*/
@@ -662,8 +672,10 @@ sp.Skeleton = cc.Class({
},
/**
* !#en Set the current animation. Any queued animations are cleared.
* !#zh 设置当前动画。队列中的任何的动画将被清除。
* !#en Set the current animation. Any queued animations are cleared.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry object.
* !#zh 设置当前动画。队列中的任何的动画将被清除。<br>
* 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry 对象。
* @method setAnimation
* @param {Number} trackIndex
* @param {String} name
@@ -689,8 +701,10 @@ sp.Skeleton = cc.Class({
},
/**
* !#en Adds an animation to be played delay seconds after the current or last queued animation.
* !#zh 添加一个动画到动画队列尾部,还可以延迟指定的秒数。
* !#en Adds an animation to be played delay seconds after the current or last queued animation.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry object.
* !#zh 添加一个动画到动画队列尾部,还可以延迟指定的秒数。<br>
* 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry 对象。
* @method addAnimation
* @param {Number} trackIndex
* @param {String} name
@@ -706,8 +720,10 @@ sp.Skeleton = cc.Class({
},
/**
* !#en Returns track entry by trackIndex.
* !#zh 通过 track 索引获取 TrackEntry。
* !#en Returns track entry by trackIndex.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry object.
* !#zh 通过 track 索引获取 TrackEntry。<br>
* 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.TrackEntry 对象。
* @method getCurrent
* @param trackIndex
* @return {spine.TrackEntry}
+4 -2
View File
@@ -187,8 +187,10 @@ var SkeletonData = cc.Class({
},
/**
* !#en Get the included SkeletonData used in spine runtime.
* !#zh 获取 Spine Runtime 使用的 SkeletonData。
* !#en Get the included SkeletonData used in spine runtime.<br>
* Returns a {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.SkeletonData object.
* !#zh 获取 Spine Runtime 使用的 SkeletonData。<br>
* 返回一个 {{#crossLinkModule "spine"}}spine{{/crossLinkModule}}.SkeletonData 对象。
* @method getRuntimeData
* @param {Boolean} [quiet=false]
* @return {spine.SkeletonData}
+10
View File
@@ -124,3 +124,13 @@ if (!CC_EDITOR || !Editor.isMainProcess) {
else {
require('./SkeletonData');
}
/**
* !#en
* `spine` is the namespace for official Spine Runtime, which officially implemented and maintained by Spine.<br>
* Please refer to the official documentation for its detailed usage: [http://en.esotericsoftware.com/spine-using-runtimes](http://en.esotericsoftware.com/spine-using-runtimes)
* !#zh
* spine 模块是 Spine 官方运行库的 API 入口,由 Spine 官方统一实现和维护,具体用法请参考:[http://zh.esotericsoftware.com/spine-using-runtimes](http://zh.esotericsoftware.com/spine-using-runtimes)
* @module spine
* @main spine
*/