Cocos Creator API

1.5.x

Cocos Creator is the game engine for the future.

Skeleton

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.)

Properties

paused Boolean readOnly

The skeletal animation is paused?

skeletonData 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.

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. 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.

timeScale Number

The time scale of this skeleton.

debugSlots Boolean

Indicates whether open debug slots.

debugBones Boolean

Indicates whether open debug bones.

_sgNode _ccsg.Node private

Reference to the instance of _ccsg.Node If it is possible to return null from your overloaded _createSgNode, then you should always check for null before using this property and reimplement __preload.

__eventTargets Array private

Inherited from Component:

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

node Node

Inherited from Component:

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

examples:

cc.log(comp.node);

uuid String readOnly

Inherited from Component:

The uuid for editor.

examples:

cc.log(comp.uuid);

_enabled Boolean private

Inherited from Component:

enabled Boolean

Inherited from Component:

indicates whether this component is enabled or not.

examples:

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

enabledInHierarchy Boolean readOnly

Inherited from Component:

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

examples:

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled Number readOnly

Inherited from Component:

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

examples:

cc.log(this._isOnLoadCalled > 0);

_name String private

_objFlags Number private

name String

The name of the object.

examples:

obj.name = "New Obj";

isValid Boolean readOnly

Indicates whether the object is not yet destroyed.

examples:

cc.log(obj.isValid);

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Methods

updateWorldTransform ( )

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

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.

setBonesToSetupPose ( )

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

setSlotsToSetupPose ( )

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

findBone
(
  • boneName
)
sp.spine.Bone

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

name type description
boneName String

returns:

type: sp.spine.Bone

findSlot
(
  • slotName
)
sp.spine.Slot

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

name type description
slotName String

returns:

type: sp.spine.Slot

setSkin
(
  • skinName
)
sp.spine.Skin

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.

name type description
skinName String

returns:

type: sp.spine.Skin

getAttachment
(
  • slotName
  • attachmentName
)
sp.spine.Attachment

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.

name type description
slotName String
attachmentName String

returns:

type: sp.spine.Attachment

setAttachment
(
  • slotName
  • attachmentName
)

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

name type description
slotName String
attachmentName String

setSkeletonData
(
  • skeletonData
  • ownsSkeletonData
)

Sets skeleton data to sp.Skeleton.

name type description
skeletonData sp.spine.SkeletonData
ownsSkeletonData sp.spine.SkeletonData

setAnimationStateData
(
  • stateData
)

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

name type description
stateData sp.spine.AnimationStateData

setMix
(
  • fromAnimation
  • toAnimation
  • duration
)

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

name type description
fromAnimation String
toAnimation String
duration Number

setAnimationListener
(
  • target
  • callback
)

Sets event listener.

name type description
target Object
callback Function

setAnimation
(
  • trackIndex
  • name
  • loop
)
sp.spine.TrackEntry

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

name type description
trackIndex Number
name String
loop Boolean

returns:

type: sp.spine.TrackEntry

addAnimation
(
  • trackIndex
  • name
  • loop
  • [delay =0]
)
sp.spine.TrackEntry

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

name type description
trackIndex Number
name String
loop Boolean
delay optional Number 0

returns:

type: sp.spine.TrackEntry

findAnimation
(
  • name
)
sp.spine.Animation

Find animation with specified name.

name type description
name String

returns:

type: sp.spine.Animation

getCurrent
(
  • trackIndex
)
sp.spine.TrackEntry

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

name type description
trackIndex Unknown

returns:

type: sp.spine.TrackEntry

clearTracks ( )

Clears all tracks of animation state.

clearTrack
(
  • trackIndex
)

Clears track of animation state by trackIndex.

name type description
trackIndex number

setStartListener
(
  • listener
)

Set the start event listener.

name type description
listener function

setInterruptListener
(
  • listener
)

Set the interrupt event listener.

name type description
listener function

setEndListener
(
  • listener
)

Set the end event listener.

name type description
listener function

setDisposeListener
(
  • listener
)

Set the dispose event listener.

name type description
listener function

setCompleteListener
(
  • listener
)

Set the complete event listener.

name type description
listener function

setEventListener
(
  • listener
)

Set the animation event listener.

name type description
listener function

setTrackStartListener
(
  • entry
  • listener
)

Set the start event listener for specified TrackEntry (only supported on Web).

name type description
entry sp.spine.TrackEntry
listener function

setTrackInterruptListener
(
  • entry
  • listener
)

Set the interrupt event listener for specified TrackEntry (only supported on Web).

name type description
entry sp.spine.TrackEntry
listener function

setTrackEndListener
(
  • entry
  • listener
)

Set the end event listener for specified TrackEntry (only supported on Web).

name type description
entry sp.spine.TrackEntry
listener function

setTrackDisposeListener
(
  • entry
  • listener
)

Set the dispose event listener for specified TrackEntry (only supported on Web).

name type description
entry sp.spine.TrackEntry
listener function

setTrackCompleteListener
(
  • entry
  • listener
)

Set the complete event listener for specified TrackEntry (only supported on Web).

name type description
entry sp.spine.TrackEntry
listener function

setTrackEventListener
(
  • entry
  • listener
)

Set the event listener for specified TrackEntry (only supported on Web).

name type description
entry sp.spine.TrackEntry
listener function

_createSgNode ( ) _ccsg.Node private

Create and returns your new scene graph node (SGNode) to add to scene graph. You should call the setContentSize of the SGNode if its size should be the same with the node's.

returns:

type: _ccsg.Node

_initSgNode ( ) private

_removeSgNode ( ) private

update
(
  • dt
)
protected

Inherited from Component:

Update is called every frame, if the Component is enabled.

name type description
dt Number

the delta time in seconds it took to complete the last frame

lateUpdate ( ) protected

Inherited from Component:

LateUpdate is called every frame, if the Component is enabled.

__preload ( ) private

Inherited from Component:

__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 ( ) protected

Inherited from Component:

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.

start ( ) protected

Inherited from Component:

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.

onEnable ( ) protected

Inherited from Component:

Called when this component becomes enabled and its node is active.

onDisable ( ) protected

Inherited from Component:

Called when this component becomes disabled or its node becomes inactive.

onDestroy ( ) protected

Inherited from Component:

Called when this component will be destroyed.

onFocusInEditor ( ) protected

Inherited from Component:

onLostFocusInEditor ( ) protected

Inherited from Component:

resetInEditor ( ) protected

Inherited from Component:

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.

addComponent
(
  • typeOrClassName
)
Component

Inherited from Component:

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

name type description
typeOrClassName Function | String

the constructor or the class name of the component to add

returns:

type: Component

the newly added component

examples:

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

getComponent
(
  • typeOrClassName
)
Component

Inherited from Component:

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.

name type description
typeOrClassName Function | String

returns:

type: Component

examples:

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

getComponents
(
  • typeOrClassName
)
Component[]

Inherited from Component:

Returns all components of supplied Type in the node.

name type description
typeOrClassName Function | String

returns:

type: Component[]

examples:

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

getComponentInChildren
(
  • typeOrClassName
)
Component

Inherited from Component:

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

name type description
typeOrClassName Function | String

returns:

type: Component

examples:

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

getComponentsInChildren
(
  • typeOrClassName
)
Component[]

Inherited from Component:

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

name type description
typeOrClassName Function | String

returns:

type: Component[]

examples:

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

_getLocalBounds
(
  • out_rect
)

Inherited from Component:

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.

name type description
out_rect Rect

the Rect to receive the bounding box

onRestore ( )

Inherited from Component:

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.

schedule
(
  • callback
  • [interval =0]
  • [repeat =cc.macro.REPEAT_FOREVER]
  • [delay =0]
)

Inherited from Component:

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

name type description
callback function

The callback function
interval optional Number 0

Tick interval in seconds. 0 means tick every frame. If interval = 0, it's recommended to use scheduleUpdate() instead.
repeat optional Number cc.macro.REPEAT_FOREVER

The selector will be executed (repeat + 1) times, you can use kCCRepeatForever for tick infinitely.
delay optional Number 0

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
(
  • callback
  • [delay =0]
)

Inherited from Component:

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

name type description
callback function

A function wrapped as a selector
delay optional Number 0

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
(
  • callback_fn
)

Inherited from Component:

Unschedules a custom callback function.

name type description
callback_fn function

A function wrapped as a selector

examples:

this.unschedule(_callback);

unscheduleAllCallbacks ( )

Inherited from Component:

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

examples:

this.unscheduleAllCallbacks();

destroy ( ) Boolean

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

returns:

type: Boolean

whether it is the first time the destroy being called

examples:

obj.destroy();

_destruct ( ) private

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 ( ) private

Called before the object being destroyed.

_serialize
(
  • exporting
)
object private

The customized serialization for this object. (Editor Only)

name type description
exporting Boolean

returns:

type: object

the serialized json data object

_deserialize
(
  • data
  • ctx
)
private

Init this object from the custom serialized data.

name type description
data Object

the serialized json data
ctx _Deserializer

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index