Skeleton 类型

继承于 RenderComponent

模块: sp

Spine 骨骼动画

(Skeleton 具有对骨骼数据的引用并且存储了骨骼实例的状态， 它由当前的骨骼动作，slot 颜色，和可见的 slot attachments 组成。
多个 Skeleton 可以使用相同的骨骼数据，其中包括所有的动画，皮肤和 attachments。

索引

属性（properties）

• paused Boolean 该骨骼动画是否暂停。
• skeletonData sp.SkeletonData attachments，皮肤等等）和动画但不持有任何状态。
• defaultSkin String 默认的皮肤名称。
• defaultAnimation String 默认的动画名称。
• animation String 当前播放的动画名称。
• _defaultSkinIndex Number
• loop Boolean 是否循环播放当前骨骼动画。
• premultipliedAlpha Boolean 是否启用贴图预乘。
• timeScale Number 当前骨骼中所有动画的时间缩放率。
• debugSlots Boolean 是否显示 slot 的 debug 信息。
• debugBones Boolean 是否显示 bone 的 debug 信息。
• useTint Boolean 是否启用染色效果。
• enableBatch Boolean 开启合批，如果渲染大量相同纹理，且结构简单的骨骼动画，开启合批可以降低drawcall，否则请不要开启，cpu消耗会上升。
• sharedMaterials [Material] 渲染组件使用的材质。
• __eventTargets Array Register all related EventTargets,...
• node Node 该组件被附加到的节点。
• uuid String 组件的 uuid，用于编辑器。
• _enabled Boolean
• enabled Boolean 表示该组件自身是否启用。
• enabledInHierarchy Boolean 表示该组件是否被启用并且所在的节点也处于激活状态。
• _isOnLoadCalled Number 返回一个值用来判断 onLoad 是否被调用过，不等于 0 时调用过，等于 0 时未调用。
• _name String
• _objFlags Number
• name String 该对象的名称。
• isValid Boolean 表示该对象是否可用（被 destroy 后将不可用）。

方法

• setSkeletonData 设置底层运行时用到的 SkeletonData。
• setSlotsRange 设置骨骼插槽可视范围。
• setAnimationStateData 设置动画状态数据。
• setAnimationCacheMode 若想切换渲染模式，最好在设置'dragonAsset'之前，先设置好渲染模式，否则有运行时开销。
• isAnimationCached 当前是否处于缓存模式。
• updateWorldTransform 当获取 bone 的数值未更新时，即可使用该函数进行更新数值。
• setToSetupPose 还原到起始动作
• setBonesToSetupPose 使用 SkeletonData 中的 BoneData 列表中的值。
• setSlotsToSetupPose 设置 slot 到起始动作。
• updateAnimationCache 更新某个动画缓存。
• findBone 通过名称查找 bone。
• findSlot 通过名称查找 slot。
• setSkin 按名称查找皮肤，激活该皮肤。
• getAttachment 通过 slot 和 attachment 的名称获取 attachment。
• setAttachment 通过 slot 和 attachment 的名字来设置 attachment。
• getTextureAtlas Return the renderer of attachment.
• setMix 为所有关键帧设定混合及混合时间（从当前值开始差值）。
• setAnimation 设置当前动画。
• addAnimation 添加一个动画到动画队列尾部，还可以延迟指定的秒数。
• findAnimation 查找指定名称的动画
• getCurrent 通过 track 索引获取 TrackEntry。
• clearTracks 清除所有 track 的动画状态。
• clearTrack 清除出指定 track 的动画状态。
• setStartListener 用来设置开始播放动画的事件监听。
• setInterruptListener 用来设置动画被打断的事件监听。
• setEndListener 用来设置动画播放完后的事件监听。
• setDisposeListener 用来设置动画将被销毁的事件监听。
• setCompleteListener 用来设置动画播放一次循环结束后的事件监听。
• setEventListener 用来设置动画播放过程中帧事件的监听。
• setTrackStartListener 用来为指定的 TrackEntry 设置动画开始播放的事件监听。
• setTrackInterruptListener 用来为指定的 TrackEntry 设置动画被打断的事件监听。
• setTrackEndListener 用来为指定的 TrackEntry 设置动画播放结束的事件监听。
• setTrackDisposeListener 用来为指定的 TrackEntry 设置动画即将被销毁的事件监听。
• setTrackCompleteListener 用来为指定的 TrackEntry 设置动画一次循环播放结束的事件监听。
• setTrackEventListener 用来为指定的 TrackEntry 设置动画帧事件的监听。
• setTrackEventListener 获取
• getMaterial 根据指定索引获取材质
• setMaterial 根据指定索引设置材质
• update 如果该组件启用，则每帧调用 update。
• lateUpdate 如果该组件启用，则每帧调用 LateUpdate。
• __preload __preload is called before every onLoad....
• onLoad 当附加到一个激活的节点上或者其节点第一次激活时候调用。
• start 如果该组件第一次启用，则在所有组件的 update 之前调用。
• onEnable 当该组件被启用，并且它的节点也激活时。
• onDisable 当该组件被禁用或节点变为无效时调用。
• onDestroy 该方法为生命周期方法，父类未必会有实现。
• onFocusInEditor
• onLostFocusInEditor
• resetInEditor 用来初始化组件或节点的一些属性，当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。
• addComponent 向节点添加一个组件类，你还可以通过传入脚本的名称来添加组件。
• getComponent 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
• getComponents 返回节点上指定类型的所有组件。
• getComponentInChildren 递归查找所有子节点中第一个匹配指定类型的组件。
• getComponentsInChildren 递归查找自身或所有子节点中指定类型的组件
• _getLocalBounds 以便编辑器的场景视图可以正确地执行点选测试。
• onRestore onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。
• schedule 调度一个自定义的回调函数。
• scheduleOnce 调度一个只运行一次的回调函数，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
• unschedule 取消调度一个自定义的回调函数。
• unscheduleAllCallbacks 取消调度所有已调度的回调函数：定制的回调函数以及 'update' 回调函数。
• destroy 销毁该对象，并释放所有它对其它对象的引用。
• _destruct Clear all references in the instance....
• _onPreDestroy Called before the object being destroyed.
• _serialize The customized serialization for this object. (Editor Only)
• _deserialize Init this object from the custom serialized data.

Details

属性（properties）

paused

该骨骼动画是否暂停。

skeletonData

骨骼数据包含了骨骼信息（绑定骨骼动作，slots，渲染顺序， attachments，皮肤等等）和动画但不持有任何状态。
多个 Skeleton 可以共用相同的骨骼数据。

defaultSkin

默认的皮肤名称。

defaultAnimation

默认的动画名称。

animation

当前播放的动画名称。

_defaultSkinIndex

loop

是否循环播放当前骨骼动画。

premultipliedAlpha

是否启用贴图预乘。 当图片的透明区域出现色块时需要关闭该选项，当图片的半透明区域颜色变黑时需要启用该选项。

timeScale

当前骨骼中所有动画的时间缩放率。

debugSlots

是否显示 slot 的 debug 信息。

debugBones

是否显示 bone 的 debug 信息。

useTint

是否启用染色效果。

enableBatch

开启合批，如果渲染大量相同纹理，且结构简单的骨骼动画，开启合批可以降低drawcall，否则请不要开启，cpu消耗会上升。

sharedMaterials

渲染组件使用的材质。

__eventTargets

Register all related EventTargets, all event callbacks will be removed in _onPreDestroy

node

该组件被附加到的节点。组件总会附加到一个节点。

示例

cc.log(comp.node);

uuid

组件的 uuid，用于编辑器。

示例

cc.log(comp.uuid);

_enabled

enabled

表示该组件自身是否启用。

示例

comp.enabled = true;
cc.log(comp.enabled);

enabledInHierarchy

表示该组件是否被启用并且所在的节点也处于激活状态。

示例

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled

返回一个值用来判断 onLoad 是否被调用过，不等于 0 时调用过，等于 0 时未调用。

示例

cc.log(this._isOnLoadCalled > 0);

_name

_objFlags

name

该对象的名称。

示例

obj.name = "New Obj";

isValid

表示该对象是否可用（被 destroy 后将不可用）。
当一个对象的 destroy 调用以后，会在这一帧结束后才真正销毁。因此从下一帧开始 isValid 就会返回 false，而当前帧内 isValid 仍然会是 true。如果希望判断当前帧是否调用过 destroy，请使用 cc.isValid(obj, true)，不过这往往是特殊的业务需求引起的，通常情况下不需要这样。

示例

var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

方法

setSkeletonData

设置底层运行时用到的 SkeletonData。
这个接口有别于 skeletonData 属性，这个接口传入的是 Spine runtime 提供的原始数据，而 skeletonData 的类型是 Creator 提供的资源类型。

参数列表

• skeletonData sp.spine.SkeletonData

setSlotsRange

设置骨骼插槽可视范围。

参数列表

• startSlotIndex Number
• endSlotIndex Number

setAnimationStateData

设置动画状态数据。
参数是 sp.spine.AnimationStateData。

参数列表

• stateData sp.spine.AnimationStateData

setAnimationCacheMode

若想切换渲染模式，最好在设置'dragonAsset'之前，先设置好渲染模式，否则有运行时开销。 若在编辑中设置渲染模式，则无需担心设置次序的问题。

参数列表

• cacheMode AnimationCacheMode

示例

skeleton.setAnimationCacheMode(sp.Skeleton.AnimationCacheMode.SHARED_CACHE);

isAnimationCached

当前是否处于缓存模式。

updateWorldTransform

重新更新所有骨骼的世界 Transform， 当获取 bone 的数值未更新时，即可使用该函数进行更新数值。

示例

var bone = spine.findBone('head');
cc.log(bone.worldX); // return 0;
spine.updateWorldTransform();
bone = spine.findBone('head');
cc.log(bone.worldX); // return -23.12;

setToSetupPose

还原到起始动作

setBonesToSetupPose

设置 bone 到起始动作 使用 SkeletonData 中的 BoneData 列表中的值。

setSlotsToSetupPose

设置 slot 到起始动作。 使用 SkeletonData 中的 SlotData 列表中的值。

updateAnimationCache

更新某个动画缓存。

参数列表

• animName String

findBone

通过名称查找 bone。 这里对每个 bone 的名称进行了对比。
返回一个 sp.spine.Bone 对象。

参数列表

• boneName String

findSlot

通过名称查找 slot。这里对每个 slot 的名称进行了比较。
返回一个 sp.spine.Slot 对象。

参数列表

• slotName String

setSkin

按名称查找皮肤，激活该皮肤。这里对每个皮肤的名称进行了比较。
注意：设置皮肤不会改变 attachment 的可见性。
返回一个 sp.spine.Skin 对象。

参数列表

• skinName String

getAttachment

通过 slot 和 attachment 的名称获取 attachment。Skeleton 优先查找它的皮肤，然后才是 Skeleton Data 中默认的皮肤。
返回一个 sp.spine.Attachment 对象。

参数列表

• slotName String
• attachmentName String

setAttachment

通过 slot 和 attachment 的名字来设置 attachment。 Skeleton 优先查找它的皮肤，然后才是 Skeleton Data 中默认的皮肤。

参数列表

• slotName String
• attachmentName String

getTextureAtlas

Return the renderer of attachment.

参数列表

• regionAttachment sp.spine.RegionAttachment | spine.BoundingBoxAttachment

setMix

为所有关键帧设定混合及混合时间（从当前值开始差值）。

参数列表

• fromAnimation String
• toAnimation String
• duration Number

setAnimation

设置当前动画。队列中的任何的动画将被清除。
返回一个 sp.spine.TrackEntry 对象。

参数列表

• trackIndex Number
• name String
• loop Boolean

addAnimation

添加一个动画到动画队列尾部，还可以延迟指定的秒数。
返回一个 sp.spine.TrackEntry 对象。

参数列表

• trackIndex Number
• name String
• loop Boolean
• delay Number

findAnimation

查找指定名称的动画

参数列表

• name String

getCurrent

通过 track 索引获取 TrackEntry。
返回一个 sp.spine.TrackEntry 对象。

参数列表

• trackIndex Unknown

clearTracks

清除所有 track 的动画状态。

clearTrack

清除出指定 track 的动画状态。

参数列表

• trackIndex number

setStartListener

用来设置开始播放动画的事件监听。

参数列表

• listener function

setInterruptListener

用来设置动画被打断的事件监听。

参数列表

• listener function

setEndListener

用来设置动画播放完后的事件监听。

参数列表

• listener function

setDisposeListener

用来设置动画将被销毁的事件监听。

参数列表

• listener function

setCompleteListener

用来设置动画播放一次循环结束后的事件监听。

参数列表

• listener function

setEventListener

用来设置动画播放过程中帧事件的监听。

参数列表

• listener function

setTrackStartListener

用来为指定的 TrackEntry 设置动画开始播放的事件监听。

参数列表

• entry sp.spine.TrackEntry
• listener function

setTrackInterruptListener

用来为指定的 TrackEntry 设置动画被打断的事件监听。

参数列表

• entry sp.spine.TrackEntry
• listener function

setTrackEndListener

用来为指定的 TrackEntry 设置动画播放结束的事件监听。

参数列表

• entry sp.spine.TrackEntry
• listener function

setTrackDisposeListener

用来为指定的 TrackEntry 设置动画即将被销毁的事件监听。

参数列表

• entry sp.spine.TrackEntry
• listener function

setTrackCompleteListener

用来为指定的 TrackEntry 设置动画一次循环播放结束的事件监听。

参数列表

• entry sp.spine.TrackEntry
• listener function
  • entry sp.spine.TrackEntry
  • loopCount Number

setTrackEventListener

用来为指定的 TrackEntry 设置动画帧事件的监听。

参数列表

• entry sp.spine.TrackEntry
• listener function

setTrackEventListener

获取

getMaterial

根据指定索引获取材质

参数列表

• index Number

setMaterial

根据指定索引设置材质

参数列表

• index Number
• material Material

update

如果该组件启用，则每帧调用 update。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

参数列表

• dt Number the delta time in seconds it took to complete the last frame

lateUpdate

如果该组件启用，则每帧调用 LateUpdate。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

__preload

__preload is called before every onLoad. It is used to initialize the builtin components internally, to avoid checking whether onLoad is called before every public method calls. This method should be removed if script priority is supported.

onLoad

当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行，这能用于安排脚本的初始化顺序。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

start

如果该组件第一次启用，则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onEnable

当该组件被启用，并且它的节点也激活时。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onDisable

当该组件被禁用或节点变为无效时调用。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onDestroy

当该组件被销毁时调用
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onFocusInEditor

onLostFocusInEditor

resetInEditor

用来初始化组件或节点的一些属性，当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

addComponent

向节点添加一个组件类，你还可以通过传入脚本的名称来添加组件。

参数列表

• typeOrClassName Function | String the constructor or the class name of the component to add

示例

var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");

getComponent

获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
传入参数也可以是脚本的名称。

参数列表

• typeOrClassName Function | String

示例

// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");

getComponents

返回节点上指定类型的所有组件。

参数列表

• typeOrClassName Function | String

示例

var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");

getComponentInChildren

递归查找所有子节点中第一个匹配指定类型的组件。

参数列表

• typeOrClassName Function | String

示例

var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");

getComponentsInChildren

递归查找自身或所有子节点中指定类型的组件

参数列表

• typeOrClassName Function | String

示例

var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");

_getLocalBounds

如果组件的包围盒与节点不同，您可以实现该方法以提供自定义的轴向对齐的包围盒（AABB）， 以便编辑器的场景视图可以正确地执行点选测试。

参数列表

• out_rect Rect the Rect to receive the bounding box

onRestore

onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。

如果组件包含了“内部状态”（不在 CCClass 属性中定义的临时成员变量），那么你可能需要实现该方法。

编辑器执行撤销/重做操作时，将调用组件的 get set 来录制和还原组件的状态。 然而，在极端的情况下，它可能无法良好运作。
那么你就应该实现这个方法，手动根据组件的属性同步“内部状态”。 一旦你实现这个方法，当用户撤销或重做时，组件的所有 get set 都不会再被调用。 这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

同样的，编辑可能无法在极端情况下正确地重置您的组件。
于是如果你需要支持组件重置菜单，你需要在该方法中手工同步组件属性到“内部状态”。
一旦你实现这个方法，组件的所有 get set 都不会在重置操作时被调用。 这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。

schedule

调度一个自定义的回调函数。
如果回调函数已调度，那么将不会重复调度它，只会更新时间间隔参数。

参数列表

• callback function The callback function
• interval Number Tick interval in seconds. 0 means tick every frame.
• repeat Number The selector will be executed (repeat + 1) times, you can use cc.macro.REPEAT_FOREVER for tick infinitely.
• delay Number The amount of time that the first tick will wait before execution.

示例

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);

scheduleOnce

调度一个只运行一次的回调函数，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

参数列表

• callback function A function wrapped as a selector
• delay Number The amount of time that the first tick will wait before execution.

示例

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);

unschedule

取消调度一个自定义的回调函数。

参数列表

• callback_fn function A function wrapped as a selector

示例

this.unschedule(_callback);

unscheduleAllCallbacks

取消调度所有已调度的回调函数：定制的回调函数以及 'update' 回调函数。动作不受此方法影响。

示例

this.unscheduleAllCallbacks();

destroy

销毁该对象，并释放所有它对其它对象的引用。
实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始，该对象将不再可用。 您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。

示例

obj.destroy();

_destruct

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

_onPreDestroy

Called before the object being destroyed.

_serialize

The customized serialization for this object. (Editor Only)

参数列表

• exporting Boolean

_deserialize

Init this object from the custom serialized data.

参数列表

• data Object the serialized json data
• ctx _Deserializer