TiledLoader

Defined in: packages/three-flatland/src/loaders/TiledLoader.ts:166

Loader for Tiled JSON format (.tmj/.json).

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

• Standard JSON map format
• Embedded and external tilesets
• Tile layers with data arrays
• Infinite maps with chunks
• Object layers
• Tile animations
• Tile collision data

Example

// Three.js usage - static API
const mapData = await TiledLoader.load('/maps/level1.json')

// Override for this load
const mapData = await TiledLoader.load('/maps/hd-level.json', { texture: 'smooth' })

// R3F usage - works with useLoader
import { TiledLoader } from 'three-flatland/react';
const mapData = useLoader(TiledLoader, '/maps/level1.json');

// Override preset via extension
const mapData = useLoader(TiledLoader, '/maps/hd-level.json', (loader) => {
  loader.preset = 'smooth';
});

// Set loader-level default
TiledLoader.options = 'pixel-art'

Extends

• Loader <TileMapData>

Constructors

Constructor

new TiledLoader(manager?): TiledLoader

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

Parameters

manager?

LoadingManager 

Returns

TiledLoader

Inherited from

Loader<TileMapData>.constructor

Properties

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/TiledLoader.ts:200

Generate this tilemap’s tileset normal maps in the browser on every load instead of loading pre-baked sidecars. The in-memory bake runs on every load; sidecar probes and “no baked sibling” warns 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: TiledNormalsOption = false

Defined in: packages/three-flatland/src/loaders/TiledLoader.ts:191

Normal-map generation. See TiledLoaderOptions.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/TiledLoader.ts:186

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

Example

const mapData = useLoader(TiledLoader, '/maps/level.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/TiledLoader.ts:173

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<TileMapData>

Defined in: packages/three-flatland/src/loaders/TiledLoader.ts:206

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

Parameters

url

string

Returns

Promise<TileMapData>

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/TiledLoader.ts:644

Clear the cache.

Returns

void

---

load()

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

Defined in: packages/three-flatland/src/loaders/TiledLoader.ts:223

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

Parameters

url

string

options?

TiledLoaderOptions

Returns

Promise<TileMapData>

---

preload()

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

Defined in: packages/three-flatland/src/loaders/TiledLoader.ts:651

Preload multiple maps.

Parameters

urls

string[]

options?

TiledLoaderOptions

Returns

Promise<TileMapData[]>