Package de.gurkenlabs.litiengine.environment.tilemap

Interface ITerrainSet

All Superinterfaces:

ICustomPropertyProvider

All Known Implementing Classes:

WangSet

public interface ITerrainSet
extends ICustomPropertyProvider

A set that contains ITerrain definitions and allocations to tiles of the related ITileset.

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets the name of this terrain set.
List<ITerrain>	getTerrains()	Gets the terrains defined by this terrain set.
ITerrain[]	getTerrains(int tileId)	Gets the terrains object associated with the specified tile ID.
TerrainType	getType()	Gets the type of terrain represented by this instance.

Methods inherited from interface de.gurkenlabs.litiengine.environment.tilemap.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

Method Details

getName

String getName()

Gets the name of this terrain set.

Returns:

THe name of the terrain set.

getType

TerrainType getType()

Gets the type of terrain represented by this instance.

This method returns the specific type of terrain as an element of the TerrainType enumeration. The TerrainType enum defines different types of terrain, including "corner," "edge," and "mixed." The return value indicates the classification of the terrain associated with the current instance.

Returns:

The TerrainType representing the type of terrain.

See Also:

• TerrainType
• TerrainType.CORNER
• TerrainType.EDGE
• TerrainType.MIXED

getTerrains

List<ITerrain> getTerrains()

Gets the terrains defined by this terrain set.

Returns:

The terrains defined by this instance.

getTerrains

ITerrain[] getTerrains(int tileId)

Gets the terrains object associated with the specified tile ID.

This method searches through the collection of Wang tiles to find a match for the specified tile ID. If a match is found, it extracts the Wang IDs associated with the tile and maps them to terrains defined by this ITerrainSet. The resulting array contains references to the corresponding terrain objects based on the Wang IDs. If a Wang ID is 0, the corresponding terrain in the array is set to null.

Parameters:

tileId - The tile ID for which terrains are to be retrieved.

Returns:

An array of ITerrain objects representing the terrains associated with the given tile ID.