Class SpineAtlasManager

SpineAtlasManager loads .atlas files via the official @esotericsoftware/spine-pixi-v7 Pixi atlas loader, sharing texture pages with the engine's ImageManager.

The loader is auto-registered by the spine-pixi-v7 IIFE bundle. We simply prepare the asset metadata (data.images) so that PIXI.Assets binds atlas pages to the already-loaded base textures instead of fetching them again.

Implements

ResourceManager

Index

Constructors

constructor

Methods

dispose getAtlasAlias getAtlasTexture getOrLoad getResourceKinds isLoaded loadResource processResource unloadResource

Constructors

constructor

new SpineAtlasManager(resourceLoader, imageManager): SpineAtlasManager
Parameters
- resourceLoader: ResourceLoader
  The resources loader of the game.
- imageManager: PixiImageManager
  The image manager of the game.
Returns SpineAtlasManager
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:31

Methods

dispose

dispose(): void
To be called when the game is disposed.

Returns void
Implementation of ResourceManager.dispose
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:156

getAtlasAlias

getAtlasAlias(resourceName): null | string
Returns the alias used to register the atlas in PIXI.Assets, or null if the resource is not loaded.
Parameters
- resourceName: string
Returns null | string
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:131

getAtlasTexture

getAtlasTexture(resourceName): null | TextureAtlas
Returns the loaded TextureAtlas for the given resource, if available.
Parameters
- resourceName: string
Returns null | TextureAtlas
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:142

getOrLoad

getOrLoad(resourceName): Promise<TextureAtlas>
Returns a cached promise resolving to the loaded atlas, loading it if needed.
Parameters
- resourceName: string
Returns Promise<TextureAtlas>
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:54

getResourceKinds

getResourceKinds(): ResourceKind[]
Return the kind of resources handled by this manager.

Returns ResourceKind[]
Implementation of ResourceManager.getResourceKinds
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:39

isLoaded

isLoaded(resourceName): boolean
Check if the given atlas resource was loaded.
Parameters
- resourceName: string
  The name of the atlas resource.
Returns boolean
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:123

loadResource

loadResource(resourceName): Promise<void>
Load the specified resource.

This method will be run during the game. It should only do light tasks like file downloading.
Parameters
- resourceName: string
Returns Promise<void>
Implementation of ResourceManager.loadResource
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:47

processResource

processResource(_resourceName): Promise<void>
Process the specified resource.

This method will only be run while loading screen is shown. It can do heavy tasks like parsing data.
Parameters
- _resourceName: string
Returns Promise<void>
Implementation of ResourceManager.processResource
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:43

unloadResource

unloadResource(resourceData): void
Clear any data in cache for a resource. Embedded resources are also cleared.

Usually called when scene resources are unloaded.
Parameters
- resourceData: ResourceData
  The resource to clear
Returns void
Implementation of ResourceManager.unloadResource
- Defined in Extensions/Spine/managers/pixi-spine-atlas-manager.ts:161

Class SpineAtlasManager

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SpineAtlasManager

Methods

dispose

Returns void

getAtlasAlias

Parameters

Returns null | string

getAtlasTexture

Parameters

Returns null | TextureAtlas

getOrLoad

Parameters

Returns Promise<TextureAtlas>

getResourceKinds

Returns ResourceKind[]

isLoaded

Parameters

Returns boolean

loadResource

Parameters

Returns Promise<void>

processResource

Parameters

Returns Promise<void>

unloadResource

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page