Skeleton Class

Extends RenderComponent

Module: sp

The skeleton of Spine

(Skeleton has a reference to a SkeletonData and stores the state for skeleton instance, which consists of the current pose's bone SRT, slot colors, and which slot attachments are visible.
Multiple skeletons can use the same SkeletonData which includes all animations, skins, and attachments.)

Index

Properties
  • paused Boolean The skeletal animation is paused?
  • skeletonData SkeletonData The skeleton data contains the skeleton information (bind pose bones, slots, draw order,...
  • defaultSkin String The name of default skin.
  • defaultAnimation String The name of default animation.
  • animation String The name of current playing animation.
  • _defaultSkinIndex Number
  • loop Boolean TODO
  • premultipliedAlpha Boolean Indicates whether to enable premultiplied alpha.
  • timeScale Number The time scale of this skeleton.
  • debugSlots Boolean Indicates whether open debug slots.
  • debugBones Boolean Indicates whether open debug bones.
  • useTint Boolean Enabled two color tint.
  • enableBatch Boolean Enabled batch model, if skeleton is complex, do not enable batch, or will lower performance.
  • sharedMaterials [Material] The materials used by this render component.
  • __eventTargets Array Register all related EventTargets,...
  • node Node The node this component is attached to.
  • uuid String The uuid for editor.
  • _enabled Boolean
  • enabled Boolean indicates whether this component is enabled or not.
  • enabledInHierarchy Boolean indicates whether this component is enabled and its node is also active in the hierarchy.
  • _isOnLoadCalled Number Returns a value which used to indicate the onLoad get called or not.
  • _name String
  • _objFlags Number
  • name String The name of the object.
  • isValid Boolean Indicates whether the object is not yet destroyed.
Methods

Details

Properties

paused

The skeletal animation is paused?

meta description
Type Boolean
Defined in extensions/spine/Skeleton.js:108
skeletonData

The skeleton data contains the skeleton information (bind pose bones, slots, draw order, attachments, skins, etc) and animations but does not hold any state.
Multiple skeletons can share the same skeleton data.

meta description
Type SkeletonData
Defined in extensions/spine/Skeleton.js:121
defaultSkin

The name of default skin.

meta description
Type String
Defined in extensions/spine/Skeleton.js:147
defaultAnimation

The name of default animation.

meta description
Type String
Defined in extensions/spine/Skeleton.js:157
animation

The name of current playing animation.

meta description
Type String
Defined in extensions/spine/Skeleton.js:167
_defaultSkinIndex
meta description
Type Number
Defined in extensions/spine/Skeleton.js:194
loop

TODO

meta description
Type Boolean
Defined in extensions/spine/Skeleton.js:295
premultipliedAlpha

Indicates whether to enable premultiplied alpha. You should disable this option when image's transparent area appears to have opaque pixels, or enable this option when image's half transparent area appears to be darken.

meta description
Type Boolean
Defined in extensions/spine/Skeleton.js:306
timeScale

The time scale of this skeleton.

meta description
Type Number
Defined in extensions/spine/Skeleton.js:320
debugSlots

Indicates whether open debug slots.

meta description
Type Boolean
Defined in extensions/spine/Skeleton.js:331
debugBones

Indicates whether open debug bones.

meta description
Type Boolean
Defined in extensions/spine/Skeleton.js:346
useTint

Enabled two color tint.

meta description
Type Boolean
Defined in extensions/spine/Skeleton.js:361
enableBatch

Enabled batch model, if skeleton is complex, do not enable batch, or will lower performance.

meta description
Type Boolean
Defined in extensions/spine/Skeleton.js:375
sharedMaterials

The materials used by this render component.

meta description
Type [Material]
Defined in cocos2d/core/components/CCRenderComponent.js:61
__eventTargets

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

meta description
Type Array
Defined in cocos2d/core/components/CCComponent.js:61
node

The node this component is attached to. A component is always attached to a node.

meta description
Type Node
Defined in cocos2d/core/components/CCComponent.js:75
Examples
cc.log(comp.node);
uuid

The uuid for editor.

meta description
Type String
Defined in cocos2d/core/components/CCComponent.js:106
Examples
cc.log(comp.uuid);
_enabled
meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:147
enabled

indicates whether this component is enabled or not.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:154
Examples
comp.enabled = true;
cc.log(comp.enabled);
enabledInHierarchy

indicates whether this component is enabled and its node is also active in the hierarchy.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:186
Examples
cc.log(comp.enabledInHierarchy);
_isOnLoadCalled

Returns a value which used to indicate the onLoad get called or not.

meta description
Type Number
Defined in cocos2d/core/components/CCComponent.js:202
Examples
cc.log(this._isOnLoadCalled > 0);
_name
meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
Type Number
Defined in cocos2d/core/platform/CCObject.js:83
name

The name of the object.

meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:240
Examples
obj.name = "New Obj";
isValid

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use cc.isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

meta description
Type Boolean
Defined in cocos2d/core/platform/CCObject.js:258
Examples
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

Methods

setSkeletonData

Sets runtime skeleton data to sp.Skeleton.
This method is different from the skeletonData property. This method is passed in the raw data provided by the Spine runtime, and the skeletonData type is the asset type provided by Creator.

meta description
Defined in extensions/spine/Skeleton.js:452
Parameters
  • skeletonData sp.spine.SkeletonData
setSlotsRange

Sets slots visible range.

meta description
Defined in extensions/spine/Skeleton.js:490
Parameters
  • skeletonData sp.spine.SkeletonData
setAnimationStateData

Sets animation state data.
The parameter type is sp.spine.AnimationStateData.

meta description
Defined in extensions/spine/Skeleton.js:505
Parameters
  • stateData sp.spine.AnimationStateData
setAnimationCacheMode

It's best to set cache mode before set property 'dragonAsset', or will waste some cpu time. If set the mode in editor, then no need to worry about order problem.

meta description
Defined in extensions/spine/Skeleton.js:558
Parameters
  • cacheMode AnimationCacheMode
Examples
skeleton.setAnimationCacheMode(sp.Skeleton.AnimationCacheMode.SHARED_CACHE);
isAnimationCached

Whether in cached mode.

meta description
Defined in extensions/spine/Skeleton.js:579
updateWorldTransform

Computes the world SRT from the local SRT for each bone.

meta description
Defined in extensions/spine/Skeleton.js:697
Examples
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

Sets the bones and slots to the setup pose.

meta description
Defined in extensions/spine/Skeleton.js:717
setBonesToSetupPose

Sets the bones to the setup pose, using the values from the BoneData list in the SkeletonData.

meta description
Defined in extensions/spine/Skeleton.js:732
setSlotsToSetupPose

Sets the slots to the setup pose, using the values from the SlotData list in the SkeletonData.

meta description
Defined in extensions/spine/Skeleton.js:751
updateAnimationCache

Update an animation cache.

meta description
Defined in extensions/spine/Skeleton.js:770
Parameters
findBone

Finds a bone by name. This does a string comparison for every bone.
Returns a sp.spine.Bone object.

meta description
Returns sp.spine.Bone
Defined in extensions/spine/Skeleton.js:784
Parameters
findSlot

Finds a slot by name. This does a string comparison for every slot.
Returns a sp.spine.Slot object.

meta description
Returns sp.spine.Slot
Defined in extensions/spine/Skeleton.js:805
Parameters
setSkin

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.
Returns a sp.spine.Skin object.

meta description
Defined in extensions/spine/Skeleton.js:824
Parameters
getAttachment

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 a sp.spine.Attachment object.

meta description
Returns sp.spine.Attachment
Defined in extensions/spine/Skeleton.js:849
Parameters
setAttachment

Sets the attachment for the slot and attachment name. The skeleton looks first in its skin, then in the skeleton data’s default skin.

meta description
Defined in extensions/spine/Skeleton.js:870
Parameters
getTextureAtlas

Return the renderer of attachment.

meta description
Returns sp.spine.TextureAtlasRegion
Defined in extensions/spine/Skeleton.js:887
Parameters
  • regionAttachment sp.spine.RegionAttachment | spine.BoundingBoxAttachment
setMix

Mix applies all keyframe values, interpolated for the specified time and mixed with the current values.

meta description
Defined in extensions/spine/Skeleton.js:898
Parameters
setAnimation

Set the current animation. Any queued animations are cleared.
Returns a sp.spine.TrackEntry object.

meta description
Returns sp.spine.TrackEntry
Defined in extensions/spine/Skeleton.js:914
Parameters
addAnimation

Adds an animation to be played delay seconds after the current or last queued animation.
Returns a sp.spine.TrackEntry object.

meta description
Returns sp.spine.TrackEntry
Defined in extensions/spine/Skeleton.js:961
Parameters
findAnimation

Find animation with specified name.

meta description
Returns sp.spine.Animation
Defined in extensions/spine/Skeleton.js:993
Parameters
getCurrent

Returns track entry by trackIndex.
Returns a sp.spine.TrackEntry object.

meta description
Returns sp.spine.TrackEntry
Defined in extensions/spine/Skeleton.js:1007
Parameters
  • trackIndex Unknown
clearTracks

Clears all tracks of animation state.

meta description
Defined in extensions/spine/Skeleton.js:1027
clearTrack

Clears track of animation state by trackIndex.

meta description
Defined in extensions/spine/Skeleton.js:1042
Parameters
setStartListener

Set the start event listener.

meta description
Defined in extensions/spine/Skeleton.js:1061
Parameters
setInterruptListener

Set the interrupt event listener.

meta description
Defined in extensions/spine/Skeleton.js:1072
Parameters
setEndListener

Set the end event listener.

meta description
Defined in extensions/spine/Skeleton.js:1083
Parameters
setDisposeListener

Set the dispose event listener.

meta description
Defined in extensions/spine/Skeleton.js:1094
Parameters
setCompleteListener

Set the complete event listener.

meta description
Defined in extensions/spine/Skeleton.js:1105
Parameters
setEventListener

Set the animation event listener.

meta description
Defined in extensions/spine/Skeleton.js:1116
Parameters
setTrackStartListener

Set the start event listener for specified TrackEntry.

meta description
Defined in extensions/spine/Skeleton.js:1127
Parameters
  • entry sp.spine.TrackEntry
  • listener function
setTrackInterruptListener

Set the interrupt event listener for specified TrackEntry.

meta description
Defined in extensions/spine/Skeleton.js:1138
Parameters
  • entry sp.spine.TrackEntry
  • listener function
setTrackEndListener

Set the end event listener for specified TrackEntry.

meta description
Defined in extensions/spine/Skeleton.js:1149
Parameters
  • entry sp.spine.TrackEntry
  • listener function
setTrackDisposeListener

Set the dispose event listener for specified TrackEntry.

meta description
Defined in extensions/spine/Skeleton.js:1160
Parameters
  • entry sp.spine.TrackEntry
  • listener function
setTrackCompleteListener

Set the complete event listener for specified TrackEntry.

meta description
Defined in extensions/spine/Skeleton.js:1171
Parameters
  • entry sp.spine.TrackEntry
  • listener function
    • entry sp.spine.TrackEntry
    • loopCount Number
setTrackEventListener

Set the event listener for specified TrackEntry.

meta description
Defined in extensions/spine/Skeleton.js:1187
Parameters
  • entry sp.spine.TrackEntry
  • listener function
setTrackEventListener

Get the animation state object

meta description
Returns sp.spine.AnimationState
Defined in extensions/spine/Skeleton.js:1198
getMaterial

Get the material by index.

meta description
Defined in cocos2d/core/components/CCRenderComponent.js:167
Parameters
setMaterial

Set the material by index.

meta description
Defined in cocos2d/core/components/CCRenderComponent.js:189
Parameters
update

Update is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:223
Parameters
  • dt Number the delta time in seconds it took to complete the last frame
lateUpdate

LateUpdate is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:234
__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.

meta description
Defined in cocos2d/core/components/CCComponent.js:244
onLoad

When attaching to an active node or its node first activated. onLoad is always called before any start functions, this allows you to order initialization of scripts.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:255
start

Called before all scripts' update if the Component is enabled the first time. Usually used to initialize some logic which need to be called after all components' onload methods called.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:268
onEnable

Called when this component becomes enabled and its node is active.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:281
onDisable

Called when this component becomes disabled or its node becomes inactive.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:291
onDestroy

Called when this component will be destroyed.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:301
onFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:311
onLostFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:316
resetInEditor

Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.

meta description
Defined in cocos2d/core/components/CCComponent.js:321
addComponent

Adds a component class to the node. You can also add component to node by passing in the name of the script.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:331
Parameters
  • typeOrClassName Function | String the constructor or the class name of the component to add
Examples
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
getComponent

Returns the component of supplied type if the node has one attached, null if it doesn't.
You can also get component in the node by passing in the name of the script.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:349
Parameters
Examples
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
getComponents

Returns all components of supplied Type in the node.

meta description
Returns Component[]
Defined in cocos2d/core/components/CCComponent.js:373
Parameters
Examples
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
getComponentInChildren

Returns the component of supplied type in any of its children using depth first search.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:391
Parameters
Examples
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
getComponentsInChildren

Returns the components of supplied type in self or any of its children using depth first search.

meta description
Returns Component[]
Defined in cocos2d/core/components/CCComponent.js:409
Parameters
Examples
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
_getLocalBounds

If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

meta description
Defined in cocos2d/core/components/CCComponent.js:429
Parameters
  • out_rect Rect the Rect to receive the bounding box
onRestore

onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

If the component contains the "internal state", short for "temporary member variables which not included
in its CCClass properties", then you may need to implement this function.

The editor will call the getset accessors of your component to record/restore the component's state
for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
this function to manually synchronize your component's "internal states" with its public properties.
Once you implement this function, all the getset accessors of your component will not be called when
the user performs an undo/redo operation. Which means that only the properties with default value
will be recorded or restored by editor.

Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
to support the reset menu, you should manually synchronize your component's "internal states" with its
properties in this function. Once you implement this function, all the getset accessors of your component
will not be called during reset operation. Which means that only the properties with default value
will be reset by editor.

This function is only called in editor mode.

meta description
Defined in cocos2d/core/components/CCComponent.js:442
schedule

Schedules a custom selector.
If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

meta description
Defined in cocos2d/core/components/CCComponent.js:536
Parameters
  • 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.
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
scheduleOnce

Schedules a callback function that runs only once, with a delay of 0 or larger.

meta description
Defined in cocos2d/core/components/CCComponent.js:573
Parameters
  • callback function A function wrapped as a selector
  • delay Number The amount of time that the first tick will wait before execution.
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
unschedule

Unschedules a custom callback function.

meta description
Defined in cocos2d/core/components/CCComponent.js:590
Parameters
  • callback_fn function A function wrapped as a selector
Examples
this.unschedule(_callback);
unscheduleAllCallbacks

unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.

meta description
Defined in cocos2d/core/components/CCComponent.js:606
Examples
this.unscheduleAllCallbacks();
destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering. From the next frame, this object is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCObject.js:293
Examples
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; } } }

meta description
Defined in cocos2d/core/platform/CCObject.js:427
_onPreDestroy

Called before the object being destroyed.

meta description
Defined in cocos2d/core/platform/CCObject.js:460
_serialize

The customized serialization for this object. (Editor Only)

meta description
Returns object
Defined in cocos2d/core/platform/CCObject.js:485
Parameters
_deserialize

Init this object from the custom serialized data.

meta description
Defined in cocos2d/core/platform/CCObject.js:495
Parameters
  • data Object the serialized json data
  • ctx _Deserializer

results matching ""

    No results matching ""