Class Maps

java.lang.Object

de.gurkenlabs.litiengine.resources.ResourcesContainer<IMap>

de.gurkenlabs.litiengine.resources.Maps

public final class Maps
extends ResourcesContainer<IMap>

A container class for managing map resources. This class extends the ResourcesContainer class, specifically for IMap objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Maps.MapGenerator	This class provides the API to simplify the generation of map resources from code.

Method Summary

Modifier and Type	Method	Description
Maps.MapGenerator	generate(IMapOrientation orientation, String name, int width, int height, int tileWidth, int tileHeight, ITileset... tilesets)	Starts a process that allows the generation of maps from code.
protected String	getAlias(String resourceName, IMap resource)	Gets an alias for the specified resourceName.
static boolean	isSupported(String fileName)	Checks if the specified file name has a supported extension.
protected IMap	load(URL resourceName)	Loads an IMap resource from the specified URL.

Methods inherited from class ResourcesContainer

add, add, addClearedListener, addContainerListener, clear, contains, contains, contains, count, get, get, get, get, get, get, get, getAll, getAsync, getAsync, getResources, remove, remove, removeClearedListener, removeContainerListener, tryGet, tryGet

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

isSupported

public static boolean isSupported(String fileName)

Checks if the specified file name has a supported extension.

Parameters:

fileName - The name of the file to check.

Returns:

true if the file has a supported extension, false otherwise.

generate

public Maps.MapGenerator generate(IMapOrientation orientation,
 String name,
 int width,
 int height,
 int tileWidth,
 int tileHeight,
 ITileset... tilesets)

Starts a process that allows the generation of maps from code.

Notice that you must call this within a try-with block or ensure that Maps.MapGenerator.close() is called before using the generated map instance.

Example usage:

IMap map;
try (MapGenerator generator = Resources.maps().generate("name", 50, 50, 16, 16, Resources.tilesets().get("tileset.tsx"))) {
  ITileLayer tileLayer = generator.addTileLayer(RenderType.GROUND, (x, y) -> {
    if (x == y) {
      // draw a diagonal in another tile color
      return 2;
    }

    // fill the entire map with this tile
    return 1;
  });

  // set an explicit tile at a location
  tileLayer.setTile(10, 10, 3);

  // add a collision box to the map
  generator.add(new CollisionBox(0, 64, 100, 10));

  map = generator.getMap();
}

Parameters:

orientation - The orientation of the map to be generated.

name - The name of the map to be generated.

width - The width (in tiles).

height - The height (in tiles).

tileWidth - The width of a tile (in pixels).

tileHeight - The height of a tile (in pixels).

tilesets - Tilesets that will be used by the map.

Returns:

A MapGenerator instance used to add additional layers or objects to the map.

load

protected IMap load(URL resourceName)
             throws IOException,
URISyntaxException

Loads an IMap resource from the specified URL.

Specified by:

load in class ResourcesContainer<IMap>

Parameters:

resourceName - The URL of the resource to load.

Returns:

The loaded IMap resource.

Throws:

IOException - If an I/O error occurs.

URISyntaxException - If the URL is not formatted correctly.

getAlias

protected String getAlias(String resourceName,
 IMap resource)

Description copied from class: ResourcesContainer

Gets an alias for the specified resourceName. Note that the process of providing an alias is up to the ResourceContainer implementation.

Overrides:

getAlias in class ResourcesContainer<IMap>

Parameters:

resourceName - The original name of the resource.

resource - The resource.

Returns:

An alias for the specified resource.

classmapsapijava