API reference

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

C

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. Call createAnimatedSprite to obtain a ready-to-use AnimatedSprite with all clips pre-registered.

3
props
3
methods
0
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.

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

Methods 3
createAnimatedSprite(): AnimatedSprite
destroy(): void
parse(data: AsepriteData, texture: Texture): AsepriteSheet
Properties 3
clips: ReadonlyMap<string, AnimatedSpriteClipDefinition>
slices: ReadonlyMap<string, AsepriteSlice>
spritesheet: Spritesheet
Source
packages/exojs-aseprite/src/AsepriteSheet.ts