View source

class SkeletonData

package spine

@:directlyUsed

Stores the setup pose and all of the stateless data for a skeleton.

See Data objects in the Spine Runtimes Guide.

Constructor

new()

Variables

@:value(new Array<Animation>())animations:Array<Animation> = new Array<Animation>()

The skeleton's animations.

audioPath:Null<String>

The path to the audio directory as defined in Spine. Available only when nonessential data was exported.

@:value(new Array<BoneData>())bones:Array<BoneData> = new Array<BoneData>()

The skeleton's bones, sorted parent first. The root bone is always the first bone.

defaultSkin:Null<Skin>

The skeleton's default skin. By default this skin contains all attachments that were not in a skin in Spine.

See Skeleton.getAttachmentByName.

@:value(new Array<EventData>())events:Array<EventData> = new Array<EventData>()

The skeleton's events.

@:value(0.0)fps:Float = 0.0

The dopesheet FPS in Spine. Available only when nonessential data was exported.

hash:Null<String>

The skeleton data hash. This value will change if any of the skeleton data has changed.

height:Float

The height of the skeleton's axis aligned bounding box in the setup pose.

@:value(new Array<IkConstraintData>())ikConstraints:Array<IkConstraintData> = new Array<IkConstraintData>()

The skeleton's IK constraints.

imagesPath:Null<String>

The path to the images directory as defined in Spine. Available only when nonessential data was exported.

name:Null<String>

The skeleton's name, which by default is the name of the skeleton data file, if possible.

@:value(new Array<PathConstraintData>())pathConstraints:Array<PathConstraintData> = new Array<PathConstraintData>()

The skeleton's path constraints.

@:value(new Array<Skin>())skins:Array<Skin> = new Array<Skin>()

@:value(new Array<SlotData>())slots:Array<SlotData> = new Array<SlotData>()

The skeleton's slots.

@:value(new Array<TransformConstraintData>())transformConstraints:Array<TransformConstraintData> = new Array<TransformConstraintData>()

The skeleton's transform constraints.

version:String

The Spine version used to export the skeleton data, or null.

width:Float

The width of the skeleton's axis aligned bounding box in the setup pose.

x:Float

The X coordinate of the skeleton's axis aligned bounding box in the setup pose.

y:Float

The Y coordinate of the skeleton's axis aligned bounding box in the setup pose.

Methods

findAnimation(animationName:String):Null<Animation>

Finds an animation by comparing each animation's name. It is more efficient to cache the results of this method than to call it multiple times.

findBone(boneName:String):Null<BoneData>

Finds a bone by comparing each bone's name. It is more efficient to cache the results of this method than to call it multiple times.

findBoneIndex(boneName:String):Int

findEvent(eventDataName:String):Null<EventData>

Finds an event by comparing each events's name. It is more efficient to cache the results of this method than to call it multiple times.

findIkConstraint(constraintName:String):Null<IkConstraintData>

Finds an IK constraint by comparing each IK constraint's name. It is more efficient to cache the results of this method than to call it multiple times.

findPathConstraint(constraintName:String):Null<PathConstraintData>

Finds a path constraint by comparing each path constraint's name. It is more efficient to cache the results of this method than to call it multiple times.

findPathConstraintIndex(pathConstraintName:String):Int

findSkin(skinName:String):Null<Skin>

Finds a skin by comparing each skin's name. It is more efficient to cache the results of this method than to call it multiple times.

findSlot(slotName:String):Null<SlotData>

Finds a slot by comparing each slot's name. It is more efficient to cache the results of this method than to call it multiple times.

findSlotIndex(slotName:String):Int

findTransformConstraint(constraintName:String):Null<TransformConstraintData>

Finds a transform constraint by comparing each transform constraint's name. It is more efficient to cache the results of this method than to call it multiple times.