Class Blueprint

java.lang.Object

de.gurkenlabs.litiengine.environment.tilemap.xml.CustomPropertyProvider

de.gurkenlabs.litiengine.environment.tilemap.xml.MapObject

de.gurkenlabs.litiengine.environment.tilemap.xml.Blueprint

All Implemented Interfaces:

ICustomPropertyProvider, IMapObject, Resource, Comparable<Resource>

public class Blueprint
extends MapObject

The Blueprint class extends the MapObject class. It represents a blueprint that can contain multiple map objects and provides functionality to build these objects at specified locations.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLUEPRINT_FILE_EXTENSION	Blueprint in this format support multiple map objects as children (extended template XML).
static final String	TEMPLATE_FILE_EXTENSION	Templates in this format typically come from the Tiled editor and only support a single MapObject.

Constructor Summary

Constructors

Constructor	Description
Blueprint()	Initializes a new instance of the Blueprint map object.
Blueprint(String name, boolean keepIds, MapObject... mapObjects)	Initializes a new instance of the Blueprint map object.
Blueprint(String name, MapObject... mapObjects)	Initializes a new instance of the Blueprint map object.

Method Summary

Modifier and Type	Method	Description
List<IMapObject>	build(float x, float y)	Builds a list of map objects at the specified coordinates.
List<IMapObject>	build(Point2D location)	Builds a list of map objects at the specified location.
Iterable<MapObject>	getItems()	Gets the list of map objects contained in this blueprint.
boolean	keepIds()	Gets a value that indicates whether the IDs if this blueprint's map-objects should be kept.

Methods inherited from class MapObject

getBoundingBox, getBounds, getBounds, getEllipse, getGridId, getHeight, getId, getLayer, getLocation, getName, getPolygon, getPolyline, getText, getTile, getType, getWidth, getX, getY, isEllipse, isPoint, isPolygon, isPolyline, setGridId, setHeight, setId, setLayer, setLocation, setLocation, setName, setPolygon, setPolyline, setType, setWidth, setX, setY, toString

Methods inherited from class CustomPropertyProvider

getBoolValue, getBoolValue, getByteValue, getByteValue, getCharValue, getCharValue, getColorValue, getColorValue, getCommaSeparatedStringValues, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFileValue, getFileValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getMapObjectId, getProperties, getProperty, getShortValue, getShortValue, getStringValue, getStringValue, hasCustomProperty, removeProperty, setProperties, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Methods inherited from class Object

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

Methods inherited from interface ICustomPropertyProvider

getBoolValue, getBoolValue, getByteValue, getByteValue, getCharValue, getCharValue, getColorValue, getColorValue, getCommaSeparatedStringValues, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFileValue, getFileValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getMapObjectId, getProperties, getProperty, getShortValue, getShortValue, getStringValue, getStringValue, hasCustomProperty, removeProperty, setProperties, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Methods inherited from interface Resource

compareTo

Field Details

TEMPLATE_FILE_EXTENSION

public static final String TEMPLATE_FILE_EXTENSION

Templates in this format typically come from the Tiled editor and only support a single MapObject.

See Also:

• Constant Field Values

BLUEPRINT_FILE_EXTENSION

public static final String BLUEPRINT_FILE_EXTENSION

Blueprint in this format support multiple map objects as children (extended template XML).

See Also:

• Constant Field Values

Constructor Details

Blueprint

public Blueprint()

Initializes a new instance of the Blueprint map object.

Blueprint

public Blueprint(String name,
 MapObject... mapObjects)

Initializes a new instance of the Blueprint map object.

Parameters:

name - The name of the blueprint.

mapObjects - The map objects to build the blueprint from.

Blueprint

public Blueprint(String name,
 boolean keepIds,
 MapObject... mapObjects)

Initializes a new instance of the Blueprint map object.

Parameters:

name - The name of the blueprint.

keepIds - A flag indicating whether the IDs of the specified map objects should be kept.

mapObjects - The map objects to build the blueprint from.

Method Details

getItems

public Iterable<MapObject> getItems()

Gets the list of map objects contained in this blueprint.

Returns:

An iterable collection of map objects.

keepIds

public boolean keepIds()

Gets a value that indicates whether the IDs if this blueprint's map-objects should be kept. This is currently used when objects are cut and pasted afterwards.

Returns:

True if the ids for all IMapObjects of this Blueprint should be re-applied after building new instances.

build

public List<IMapObject> build(Point2D location)

Builds a list of map objects at the specified location.

Parameters:

location - The location where the map objects should be built.

Returns:

A list of built map objects.

build

public List<IMapObject> build(float x,
 float y)

Builds a list of map objects at the specified coordinates.

Parameters:

x - The x-coordinate where the map objects should be built.

y - The y-coordinate where the map objects should be built.

Returns:

A list of built map objects.

classmapsapijava