LDtkLoader

Defined in: packages/three-flatland/src/loaders/LDtkLoader.ts:209

Loader for LDtk JSON format.

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

Single level or multi-level projects
Tile layers (Tiles, AutoLayer, IntGrid)
Entity layers
IntGrid collision data
Tile flip flags
Custom field data

Example

// Three.js usage - static API
const mapData = await LDtkLoader.load('/maps/world.ldtk', 'Level_0')

// Override for this load
const mapData = await LDtkLoader.load('/maps/world.ldtk', 'Level_0', { texture: 'smooth' })

// R3F usage - works with useLoader (loads first level)
import { LDtkLoader } from 'three-flatland/react';
const mapData = useLoader(LDtkLoader, '/maps/world.ldtk');

// Override preset via extension
const mapData = useLoader(LDtkLoader, '/maps/world.ldtk', (loader) => {
  loader.preset = 'smooth';
  loader.levelId = 'Level_1';  // Specify level to load
});

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

Extends

Loader <TileMapData>

Constructors

Constructor

new LDtkLoader(manager?): LDtkLoader

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

Parameters

manager?

LoadingManager

Returns

LDtkLoader

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/LDtkLoader.ts:249

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.

levelId

levelId: string | number | undefined = undefined

Defined in: packages/three-flatland/src/loaders/LDtkLoader.ts:235

Level ID to load (for R3F useLoader). If undefined, loads the first level.

Example

const mapData = useLoader(LDtkLoader, '/maps/world.ldtk', (loader) => {
  loader.levelId = 'Level_1';
});

manager

manager: LoadingManager

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

Inherited from

Loader.manager

normals

normals: LDtkNormalsOption = false

Defined in: packages/three-flatland/src/loaders/LDtkLoader.ts:240

Normal-map generation. See LDtkLoaderOptions.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/LDtkLoader.ts:222

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

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/LDtkLoader.ts:216

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/LDtkLoader.ts:255

Load an LDtk level asynchronously (for R3F useLoader compatibility). Presets and levelId are automatically applied from instance properties.

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/LDtkLoader.ts:718

Clear the cache.

Returns

void

getLevelIds()

static getLevelIds(url): Promise<string[]>

Defined in: packages/three-flatland/src/loaders/LDtkLoader.ts:710

Get all level identifiers from a project.

Parameters

url

string

Returns

Promise<string[]>

load()

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

Defined in: packages/three-flatland/src/loaders/LDtkLoader.ts:271

Load a single level from an LDtk project (static method for Three.js usage).

Parameters

url

string

levelId?

string | number

options?

LDtkLoaderOptions

Returns

Promise<TileMapData>

loadProject()

static loadProject(url): Promise<LDtkProject>

Defined in: packages/three-flatland/src/loaders/LDtkLoader.ts:299

Load the LDtk project file.

Parameters

url

string

Returns

Promise<LDtkProject>