libGDX 1.14.2 · com.badlogic.gdx.maps.tiled.TiledMapLoader

A universal map loader that automatically delegates to the appropriate underlying map loader TmxMapLoader, AtlasTmxMapLoader, TmjMapLoader, or AtlasTmjMapLoader based solely on the map file's extension and content. A primary use case is for projects that need to load a mix of TMX and TMJ maps (with or without atlases) using a single loader instance inside an AssetManager. For TMX and TMJ files, this loader checks for the presence of an "atlas" property. If found, it uses an atlas-based loader; otherwise, it falls back to the standard loader.

Field Summary

Modifier and Type	Field and Description
private final AtlasTmjMapLoader	atlasTmjMapLoader
private final AtlasTmxMapLoader	atlasTmxMapLoader
private final JsonReader	jsonReader
private final TmjMapLoader	tmjMapLoader
private final TmxMapLoader	tmxMapLoader
private final XmlReader	xmlReader

Constructor Summary

Access	Constructor and Description
public	TiledMapLoader()
public	TiledMapLoader(FileHandleResolver resolver)

Method Summary

Modifier and Type	Method and Description
public Array<AssetDescriptor<T>>	getDependencies(String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter) Implements abstract com.badlogic.gdx.assets.loaders.AssetLoader.getDependencies. Returns the assets this asset requires to be loaded first.
public TiledMap	Returns: a loaded `TiledMap` load(String path to a .tmx or .tmj file fileName) Universal synchronous loader.
public TiledMap	Returns: a loaded `TiledMap` load(String path to a .tmx or .tmj file fileName, BaseTiledMapLoader.Parameters existing Parameters object parameter) Universal synchronous loader with custom parameters.
public void	loadAsync(AssetManager manager, String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter) Implements abstract com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadAsync. Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.
public TiledMap	loadSync(AssetManager manager, String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter) Implements abstract com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadSync. Loads the OpenGL part of the asset.
private boolean	usesAtlas(FileHandle file)

Inherited from com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader:: unloadAsync

Field Detail

atlasTmjMapLoader	back to summary
private final AtlasTmjMapLoader atlasTmjMapLoader

atlasTmxMapLoader	back to summary
private final AtlasTmxMapLoader atlasTmxMapLoader

jsonReader	back to summary
private final JsonReader jsonReader

tmjMapLoader	back to summary
private final TmjMapLoader tmjMapLoader

tmxMapLoader	back to summary
private final TmxMapLoader tmxMapLoader

xmlReader	back to summary
private final XmlReader xmlReader

Constructor Detail

TiledMapLoader	back to summary
public TiledMapLoader()

TiledMapLoader	back to summary
public TiledMapLoader(FileHandleResolver resolver)

Method Detail

getDependencies	back to summary
public Array<AssetDescriptor<T>> getDependencies(String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter) Implements abstract com.badlogic.gdx.assets.loaders.AssetLoader.getDependencies. Doc from com.badlogic.gdx.assets.loaders.AssetLoader.getDependencies. Returns the assets this asset requires to be loaded first. This method may be called on a thread other than the GL thread. Annotations @Override

getDependencies

back to summary

public Array<AssetDescriptor<T>> getDependencies(String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter)

Implements abstract com.badlogic.gdx.assets.loaders.AssetLoader.getDependencies.

Doc from com.badlogic.gdx.assets.loaders.AssetLoader.getDependencies.

Returns the assets this asset requires to be loaded first. This method may be called on a thread other than the GL thread.

Annotations

@Override

load back to summary

load	back to summary
public TiledMap load(String fileName) Universal synchronous loader. This method is a thin wrapper that picks the correct underlying loader (TMX vs TMJ, atlas vs non‑atlas) and then delegates straight through to its synchronous `load(...)` implementation. Parameters fileName:String path to a .tmx or .tmj file Returns:TiledMap a loaded `TiledMap` Exceptions GdxRuntimeException: on unsupported formats or parse errors

public TiledMap load(String fileName)

Universal synchronous loader. This method is a thin wrapper that picks the correct underlying loader (TMX vs TMJ, atlas vs non‑atlas) and then delegates straight through to its synchronous load(...) implementation.

Parameters

fileName:String: path to a .tmx or .tmj file

Returns:TiledMap

a loaded TiledMap

Exceptions

GdxRuntimeException:: on unsupported formats or parse errors

load back to summary

load	back to summary
public TiledMap load(String fileName, BaseTiledMapLoader.Parameters parameter) Universal synchronous loader with custom parameters. Resolves the file and Inspects the extension (tmx vs tmj). Check whether the ‘atlas’ property exists in the map and delegates to the appropriate loader’s `load(...)`. Parameters fileName:String path to a .tmx or .tmj file parameter:BaseTiledMapLoader.Parameters existing Parameters object Returns:TiledMap a loaded `TiledMap` Exceptions GdxRuntimeException: on unsupported formats or parse errors

public TiledMap load(String fileName, BaseTiledMapLoader.Parameters parameter)

Universal synchronous loader with custom parameters. Resolves the file and Inspects the extension (tmx vs tmj). Check whether the ‘atlas’ property exists in the map and delegates to the appropriate loader’s load(...).

Parameters

fileName:String: path to a .tmx or .tmj file
parameter:BaseTiledMapLoader.Parameters: existing Parameters object

Returns:TiledMap

a loaded TiledMap

Exceptions

GdxRuntimeException:: on unsupported formats or parse errors

loadAsync	back to summary
public void loadAsync(AssetManager manager, String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter) Implements abstract com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadAsync. Doc from com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadAsync. Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager. Annotations @Override

loadAsync

back to summary

public void loadAsync(AssetManager manager, String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter)

Implements abstract com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadAsync.

Doc from com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadAsync.

Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.

Annotations

@Override

loadSync	back to summary
public TiledMap loadSync(AssetManager manager, String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter) Implements abstract com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadSync. Doc from com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadSync. Loads the OpenGL part of the asset. Annotations @Override

loadSync

back to summary

public TiledMap loadSync(AssetManager manager, String fileName, FileHandle file, BaseTiledMapLoader.Parameters parameter)

Implements abstract com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadSync.

Doc from com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader.loadSync.

Loads the OpenGL part of the asset.

Annotations

@Override

usesAtlas	back to summary
private boolean usesAtlas(FileHandle file)

public Class TiledMapLoader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail