Variable: spritesheetAsset

> const spritesheetAsset: object

Defined in: node_modules/pixi.js/lib/spritesheet/spritesheetAsset.d.ts:44

Asset extension for loading spritesheets

Type Declaration

cache

> cache: object

Handle the caching of the related Spritesheet Textures

cache.getCacheableAssets

> getCacheableAssets: (keys, asset) => Record<string, any>

Parameters

keys

string[]

asset

Spritesheet

Returns

Record<string, any>

cache.test

> test: (asset) => boolean

Parameters

asset

Spritesheet

Returns

boolean

extension

> extension: Asset

loader

> loader: object

Loader plugin that parses sprite sheets! once the JSON has been loaded this checks to see if the JSON is spritesheet data. If it is, we load the spritesheets image and parse the data into Spritesheet All textures in the sprite sheet are then added to the cache

loader.extension

> extension: object

loader.extension.name

> name: string

loader.extension.priority

> priority: LoaderParserPriority

loader.extension.type

> type: LoadParser

loader.id

> id: string

loader.name

> name: string

used for deprecation purposes

loader.parse()

> parse<T>(asset, options, loader?): Promise<Spritesheet<SpritesheetData>>

Type Parameters

T

T

Parameters

asset

SpriteSheetJson

options

ResolvedAsset<{ cachePrefix?: string; ignoreMultiPack?: boolean; imageFilename?: string; texture?: Texture; textureOptions?: TextureSourceOptions; }>

loader?

Loader

Returns

Promise<Spritesheet<SpritesheetData>>

loader.testParse()

> testParse(asset, options): Promise<boolean>

Parameters

asset

SpriteSheetJson

options

ResolvedAsset

Returns

Promise<boolean>

loader.unload()

> unload(spritesheet, _resolvedAsset, loader): Promise<void>

Parameters

spritesheet

Spritesheet

_resolvedAsset

ResolvedAsset<any>

loader

Loader

Returns

Promise<void>

resolver

> resolver: object

Resolve the resolution of the asset.

resolver.extension

> extension: object

resolver.extension.name

> name: string

resolver.extension.type

> type: ResolveParser

resolver.parse

> parse: (value) => object

Parameters

value

string

Returns

object

format

> format: string

resolution

> resolution: number

src

> src: string

resolver.test

> test: (value) => boolean

Parameters

value

string

Returns

boolean

Example

import { Assets } from 'pixi.js';

Assets.load({
    alias: 'spritesheet',
    src: 'path/to/spritesheet.json',
    data: {
        ignoreMultiPack: true,
        textureOptions: {
            scaleMode: "nearest"
        }
    }
})

Advanced