SpinePlugin

View source
ceramic.SpinePlugin (Class)

Plugin that integrates the Spine 2D skeletal animation runtime into Ceramic.

This plugin extends Ceramic's asset system to support loading and managing Spine animations, including skeleton data, texture atlases, and animation configurations. It provides convenient methods for loading Spine assets and accessing them throughout your application.

The plugin automatically:

  • Registers the 'spine' asset kind with the asset system
  • Sets up SpineData converters for serialization
  • Loads required shaders for two-color tinting support
  • Provides helper methods for accessing Spine assets

Loading Spine assets

// Add a spine asset to load
assets.add(Spines.HERO);

// Load and use
assets.load(function(success) {
    if (success) {
        var heroData = assets.spine(Spines.HERO);
        var spine = new Spine();
        spine.spineData = heroData;
        spine.animate("idle", true);
    }
});

Static Members

spine
addSpine(assets: Assets, name: String, ?variant: String, ?options: Null<AssetOptions>): Void

Adds a Spine asset to the asset loading queue.

This method creates a new SpineAsset instance and registers it with the asset system for loading. The asset will be loaded when assets.load() is called.

Name Type Default Description
assets Assets The Assets instance to add the spine asset to
name String The asset name/path (with or without 'spine:' prefix)
variant String (optional) Optional variant name for different versions of the same asset
options Null<AssetOptions> (optional) Optional loading options (density, filter, etc.) * haxe assets.addSpine("characters/hero"); assets.addSpine("spine:characters/hero"); // Same as above assets.addSpine("characters/hero", "hd"); // HD variant
spine
ensureSpine(assets: Assets, name: Either<String, Dynamic>, ?variant: String, ?options: Null<AssetOptions>, done: Function): Void

Ensures a Spine asset is loaded before executing a callback.

This method checks if the specified Spine asset is already loaded. If not, it loads the asset first. Once the asset is available, the callback is executed with the loaded SpineAsset.

Name Type Default Description
assets Assets The Assets instance to check/load from
name Either<String, Dynamic> Asset identifier - either a string name or an object with _id field
variant String (optional) Optional variant name
options Null<AssetOptions> (optional) Optional loading options
done Function Callback executed with the loaded SpineAsset (or null if loading failed) * haxe assets.ensureSpine(Spines.HERO, function(asset) { if (asset != null) { var spine = new Spine(); spine.spineData = asset.spineData; } });
spine
spine(assets: Assets, name: Either<String, Dynamic>, ?variant: String): SpineData

Retrieves the SpineData for a loaded Spine asset.

This is a convenience method that gets the SpineAsset and returns its spineData property. Returns null if the asset is not found or not yet loaded.

Name Type Default Description
assets Assets The Assets instance to retrieve from
name Either<String, Dynamic> Asset identifier - either a string name or an object with _id field
variant String (optional) Optional variant name
Returns Description
SpineData The SpineData instance, or null if not found/loaded * haxe var heroData = assets.spine(Spines.HERO); if (heroData != null) { var spine = new Spine(); spine.spineData = heroData; }
spine
spineAsset(assets: Assets, name: Either<String, Dynamic>, ?variant: String): SpineAsset

Retrieves a SpineAsset from the asset system.

This method looks up a Spine asset by name and variant, checking both the current Assets instance and its parent hierarchy if not found. The 'spine:' prefix is handled automatically.

Name Type Default Description
assets Assets The Assets instance to search in
name Either<String, Dynamic> Asset identifier - either a string name or an object with _id field
variant String (optional) Optional variant name
Returns Description
SpineAsset The SpineAsset if found, null otherwise * haxe var asset = assets.spineAsset("characters/hero"); if (asset != null && asset.status == READY) { // Asset is loaded and ready to use }
spine
toSkeletonName(name: Dynamic): String

Converts a dynamic asset reference to its skeleton name string.

This utility method extracts the '_id' field from asset constant objects generated by the build system (e.g., from the Spines class).

Name Type Description
name Dynamic An asset constant object with an _id field
Returns Description
String The string identifier for the skeleton * haxe var skeletonName = SpinePlugin.toSkeletonName(Spines.HERO); // Returns something like "characters/hero"

Private Members

spine
pluginInit(): Void

Initializes the Spine plugin during Ceramic's pre-initialization phase.

This method is called automatically by Ceramic's plugin system and:

  • Registers the 'spine' asset kind for .spine file support
  • Sets up the SpineData converter for serialization/deserialization
  • Loads the tintBlack shader required for two-color tinting in Spine

The plugin initialization happens before the main app initialization, ensuring Spine assets can be loaded during the app's startup phase.

Metadata

Name Parameters
:access ceramic.App