SpriteSheetLoader

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:85

Loader for spritesheet JSON files.

Extends Three.js’s Loader class for compatibility with R3F’s useLoader. Supports:

• JSON Hash format (TexturePacker default)
• JSON Array format

Example

// Three.js usage - static API
const sheet = await SpriteSheetLoader.load('/sprites/player.json');

// R3F usage - works with useLoader
import { SpriteSheetLoader } from 'three-flatland/react';
const sheet = useLoader(SpriteSheetLoader, '/sprites/player.json');

// Override preset via extension
const sheet = useLoader(SpriteSheetLoader, '/sprites/ui.json', (loader) => {
  loader.preset = 'smooth';
});

// Set loader-level default
SpriteSheetLoader.options = 'smooth';

Extends

• Loader <SpriteSheet>

Constructors

Constructor

new SpriteSheetLoader(manager?): SpriteSheetLoader

Defined in: three.js/loaders/Loader:SpriteSheetLoader 

Parameters

manager?

LoadingManager 

Returns

SpriteSheetLoader

Inherited from

Loader<SpriteSheet>.constructor

Properties

alpha

alpha: boolean = false

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:115

Alpha hitmask generation. See SpriteSheetLoaderOptions.alpha.

---

crossOrigin

crossOrigin: string

Defined in: three.js/loaders/Loader:crossOrigin 

Default

'anonymous'

Inherited from

Loader.crossOrigin

---

forceRuntime

forceRuntime: boolean = false

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:124

Generate this sheet’s normal map in the browser on every load instead of loading a pre-baked sidecar. The in-memory bake runs on every load; the sidecar probe and “no baked sibling” warn are skipped. Not a dev-iteration knob. See BakedAssetLoaderOptions.forceRuntime.

---

manager

manager: LoadingManager 

Defined in: three.js/loaders/Loader:manager 

Inherited from

Loader.manager

---

normals

normals: SpriteSheetNormalsOption = false

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:110

Normal-map generation. See SpriteSheetLoaderOptions.normals.

---

path

path: string

Defined in: three.js/loaders/Loader:path 

Default

''

Inherited from

Loader.path

---

preset

preset: TexturePreset | TextureOptions | undefined = undefined

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:105

Instance-level preset override. Set via R3F’s useLoader extension callback.

Example

const sheet = useLoader(SpriteSheetLoader, '/sprites/ui.json', (loader) => {
  loader.preset = 'smooth';
});

---

requestHeader

requestHeader: object

Defined in: three.js/loaders/Loader:requestHeader 

Index Signature

[header: string]: string

Default

{}

Inherited from

Loader.requestHeader

---

resourcePath

resourcePath: string

Defined in: three.js/loaders/Loader:resourcePath 

Default

''

Inherited from

Loader.resourcePath

---

withCredentials

withCredentials: boolean

Defined in: three.js/loaders/Loader:withCredentials 

Default

false

Inherited from

Loader.withCredentials

---

DEFAULT_MATERIAL_NAME

static DEFAULT_MATERIAL_NAME: string

Defined in: three.js/loaders/Loader:DEFAULT_MATERIAL_NAME 

Inherited from

Loader.DEFAULT_MATERIAL_NAME

---

options

static options: TexturePreset | TextureOptions | undefined = undefined

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:92

Texture options for this loader class. When undefined, falls through to TextureConfig.options.

Methods

abort()

abort(): this

Defined in: three.js/loaders/Loader:abort 

Returns

this

Inherited from

Loader.abort

---

load()

load(url, onLoad, onProgress?, onError?): void

Defined in: three.js/loaders/Loader:load 

Parameters

url

string

onLoad

(data) => void

onProgress?

(event) => void

onError?

(err) => void

Returns

void

Inherited from

Loader.load

---

loadAsync()

loadAsync(url): Promise<SpriteSheet>

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:130

Load a spritesheet asynchronously (for R3F useLoader compatibility). Presets are automatically applied.

Parameters

url

string

Returns

Promise<SpriteSheet>

Overrides

Loader.loadAsync

---

setCrossOrigin()

setCrossOrigin(crossOrigin): this

Defined in: three.js/loaders/Loader:setCrossOrigin 

Parameters

crossOrigin

string

Returns

this

Inherited from

Loader.setCrossOrigin

---

setPath()

setPath(path): this

Defined in: three.js/loaders/Loader:setPath 

Parameters

path

string

Returns

this

Inherited from

Loader.setPath

---

setRequestHeader()

setRequestHeader(requestHeader): this

Defined in: three.js/loaders/Loader:setRequestHeader 

Parameters

requestHeader

Returns

this

Inherited from

Loader.setRequestHeader

---

setResourcePath()

setResourcePath(resourcePath): this

Defined in: three.js/loaders/Loader:setResourcePath 

Parameters

resourcePath

string

Returns

this

Inherited from

Loader.setResourcePath

---

setWithCredentials()

setWithCredentials(value): this

Defined in: three.js/loaders/Loader:setWithCredentials 

Parameters

value

boolean

Returns

this

Inherited from

Loader.setWithCredentials

---

clearCache()

static clearCache(): void

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:556

Clear the cache.

Returns

void

---

load()

static load(url, options?): Promise<SpriteSheet>

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:148

Load a spritesheet from a JSON file (static method for Three.js usage). Results are cached by URL and resolved options.

Parameters

url

string

options?

SpriteSheetLoaderOptions

Returns

Promise<SpriteSheet>

---

preload()

static preload(urls, options?): Promise<SpriteSheet[]>

Defined in: packages/three-flatland/src/loaders/SpriteSheetLoader.ts:563

Preload multiple spritesheets.

Parameters

urls

string[]

options?

SpriteSheetLoaderOptions

Returns

Promise<SpriteSheet[]>