API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

classAsepriteSheet

@codexo/exojs-aseprite / aseprite / stable

Parsed representation of an Aseprite JSON sprite sheet export. `AsepriteSheet.parse(data, texture)` converts the raw JSON document into: - A Spritesheet whose frames correspond to the Aseprite frame array (keyed by zero-based index string: `"0"`, `"1"`, ...). - A `clips` map of AnimatedSpriteClipDefinition entries built from `meta.frameTags`, one per named tag. - The `slices` and `layers` metadata maps, carried through verbatim. Call createAnimatedSprite to obtain a ready-to-use AnimatedSprite with all clips pre-registered.

props

methods

events

Import

import { AsepriteSheet } from '@codexo/exojs-aseprite'

Parsed representation of an Aseprite JSON sprite sheet export.

`AsepriteSheet.parse(data, texture)` converts the raw JSON document into: - A Spritesheet whose frames correspond to the Aseprite frame array (keyed by zero-based index string: `"0"`, `"1"`, ...). - A `clips` map of AnimatedSpriteClipDefinition entries built from `meta.frameTags`, one per named tag. - The `slices` and `layers` metadata maps, carried through verbatim.

Call createAnimatedSprite to obtain a ready-to-use AnimatedSprite with all clips pre-registered.

Methods3

createAnimatedSprite(): AnimatedSpriteA Sprite that advances through a sequence of texture-frame Rectangles over time to produce frame-based animation. Multiple named clips can be registered via ad…

Create an AnimatedSprite with all frame-tag clips pre-defined. Each clip is registered via AnimatedSprite.addClip, which clones the frame Rectangles so the sprite owns its own copies. Call AnimatedSprite.play with a tag name to start playback.

destroy(): void

Destroy the underlying Spritesheet and release its frame resources.

parse(data: AsepriteDataUnion of both Aseprite JSON export formats. Use isAsepriteArrayData to discriminate between array and hash mode., texture: TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (…): AsepriteSheet

Parse a raw AsepriteData document and the already-loaded Texture into an AsepriteSheet. Supports both Aseprite array mode and hash mode. Frame indices from frameTags are resolved against the ordered frame array; out-of-range indices are silently skipped. A tag's direction determines the expanded frame sequence fed into the clip - forward and reverse play the [from, to] range in order or in reverse, while pingpong/pingpong_reverse append a backward pass (excluding both endpoints) so the bounce plays back correctly on the engine's forward-only AnimatedSprite playback. The tag's repeat field maps directly onto AnimatedSpriteClipDefinition.repeat: absent means the clip loops indefinitely (repeat: -1); a numeric string ("1", "2", ...) means it plays exactly that many full cycles before stopping. Each clip's frameDurations carries the real per-frame duration from the export (falling back to the tag's average when a frame's duration is non-positive), so uneven hold-frames survive into playback instead of being flattened to a uniform fps. frameOffsets carries each frame's spriteSourceSize {x,y} - its trimmed content's offset within the untrimmed canvas - whenever any frame in the tag is trimmed, so frames trimmed by different amounts stay anchored instead of jittering; it's omitted entirely for tags with no trimmed frames.

Properties4

clips: ReadonlyMap<string, AnimatedSpriteClipDefinitionDefinition for a single animation clip registered on an AnimatedSprite.>

Animation clips derived from the Aseprite frameTags metadata. Each clip's frames are live references into spritesheet.frames; they are cloned automatically when passed to AnimatedSprite.addClip.

layers: ReadonlyMap<string, AsepriteLayerA single layer entry in the Aseprite JSON metadata (`meta.layers`). Only `name` is guaranteed. `opacity` and `blendMode` describe an image layer's compositing…>

Layers from the Aseprite meta.layers metadata, keyed by layer name and in export order (bottom-most first). Aseprite packs the sheet already composited, so these are descriptive rather than renderable: they tell a consumer which layers went into a frame and how - opacity, blend mode, editor user data - and AsepriteLayer.group names the enclosing group layer, so the flat map still encodes the layer tree. Empty when the export carries no meta.layers block. Layer names are unique within an Aseprite document, so keying by name loses nothing.

slices: ReadonlyMap<string, AsepriteSliceA named slice defined in the Aseprite editor.>

Named slices from the Aseprite meta.slices metadata, keyed by slice name. Slices describe editor-defined regions - hitboxes, nine-patch borders, UI anchor points - that aren't part of the frame/animation data itself. Each AsepriteSlice carries one AsepriteSliceKey per frame at which its bounds change; consumers resolve the applicable key for a given frame index themselves.

spritesheet: SpritesheetSlices a single Texture into named frames and optional named animation sequences. Each frame is stored as both a Rectangle (the pixel region) and a pre-configu…

The underlying Spritesheet whose frames are keyed by index string.

Source

packages/exojs-aseprite/src/AsepriteSheet.ts