de.gurkenlabs.litiengine.environment.tilemap.xml

Class Tile

java.lang.Object

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

de.gurkenlabs.litiengine.environment.tilemap.xml.Tile

All Implemented Interfaces:

ICustomPropertyProvider, ITile, java.io.Serializable

public class Tile
extends CustomPropertyProvider
implements ITile, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Tile	EMPTY
protected static long	FLIPPED_DIAGONALLY_FLAG
protected static long	FLIPPED_DIAGONALLY_FLAG_CSV
protected static long	FLIPPED_HORIZONTALLY_FLAG
protected static long	FLIPPED_HORIZONTALLY_FLAG_CSV
protected static long	FLIPPED_VERTICALLY_FLAG
protected static long	FLIPPED_VERTICALLY_FLAG_CSV
static int	NONE

Constructor Summary

Constructors

Constructor and Description
Tile()
Tile(int gid)
Tile(long gidBitmask, boolean csv)

Method Summary

Modifier and Type	Method and Description
ITileAnimation	getAnimation()
int	getGridId() Gets the grid id.
int	getId()
java.util.List<Property>	getProperties() Enumerates the custom properties for this object.
java.lang.String	getStringValue(java.lang.String name, java.lang.String defaultValue) Gets the string value of the custom property with the provided name.
ITerrain[]	getTerrain()
protected int[]	getTerrainIds()
java.awt.Point	getTileCoordinate() Gets the tile coordinate.
boolean	hasCustomProperty(java.lang.String name) Checks if a custom property with the given name is present.
boolean	isFlipped()
boolean	isFlippedDiagonally()
boolean	isFlippedHorizontally()
boolean	isFlippedVertically()
protected void	setCustomPropertySource(ITile source)
void	setProperties(java.util.List<Property> props) Sets all of the custom properties on this object to the provided values.
protected void	setTerrains(ITerrain[] terrains)
void	setTileCoordinate(java.awt.Point tileCoordinate) Sets the tile coordinate.
void	setValue(java.lang.String name, java.lang.String value) Sets the value for the custom property with the given name to the given string.
java.lang.String	toString()

Methods inherited from class de.gurkenlabs.litiengine.environment.tilemap.xml.CustomPropertyProvider

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getShortValue, getShortValue, getStringValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gurkenlabs.litiengine.environment.tilemap.ICustomPropertyProvider

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getShortValue, getShortValue, getStringValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Field Detail

NONE

public static final int NONE

See Also:

Constant Field Values

EMPTY

public static final Tile EMPTY

FLIPPED_HORIZONTALLY_FLAG

protected static final long FLIPPED_HORIZONTALLY_FLAG

See Also:

Constant Field Values

FLIPPED_VERTICALLY_FLAG

protected static final long FLIPPED_VERTICALLY_FLAG

See Also:

Constant Field Values

FLIPPED_DIAGONALLY_FLAG

protected static final long FLIPPED_DIAGONALLY_FLAG

See Also:

Constant Field Values

FLIPPED_HORIZONTALLY_FLAG_CSV

protected static final long FLIPPED_HORIZONTALLY_FLAG_CSV

See Also:

Constant Field Values

FLIPPED_VERTICALLY_FLAG_CSV

protected static final long FLIPPED_VERTICALLY_FLAG_CSV

See Also:

Constant Field Values

FLIPPED_DIAGONALLY_FLAG_CSV

protected static final long FLIPPED_DIAGONALLY_FLAG_CSV

See Also:

Constant Field Values

Constructor Detail

Tile

public Tile()

Tile

public Tile(int gid)

Tile

public Tile(long gidBitmask,
            boolean csv)

Method Detail

hasCustomProperty

public boolean hasCustomProperty(java.lang.String name)

Description copied from interface: ICustomPropertyProvider

Checks if a custom property with the given name is present.

Specified by:

hasCustomProperty in interface ICustomPropertyProvider

Overrides:

hasCustomProperty in class CustomPropertyProvider

Parameters:

name - the name of the custom property

Returns:

true if a custom property with the given name is present. False otherwise.

getProperties

public java.util.List<Property> getProperties()

Description copied from interface: ICustomPropertyProvider

Enumerates the custom properties for this object.

Specified by:

getProperties in interface ICustomPropertyProvider

Overrides:

getProperties in class CustomPropertyProvider

Returns:

a complete list of custom properties for this ICustomPropertyProvider

setProperties

public void setProperties(java.util.List<Property> props)

Description copied from interface: ICustomPropertyProvider

Sets all of the custom properties on this object to the provided values. Properties are added when they only exist in the provided properties, and deleted when they only exist in the current properties.

Specified by:

setProperties in interface ICustomPropertyProvider

Overrides:

setProperties in class CustomPropertyProvider

Parameters:

props - the new list of properties

getStringValue

public java.lang.String getStringValue(java.lang.String name,
                                       java.lang.String defaultValue)

Description copied from interface: ICustomPropertyProvider

Gets the string value of the custom property with the provided name. If the value is null, the provided default value is used as a fallback.

Specified by:

getStringValue in interface ICustomPropertyProvider

Overrides:

getStringValue in class CustomPropertyProvider

Parameters:

name - the name of the custom property

defaultValue - the fallback value in case the property value is null.

Returns:

the string value of the custom property, if present. Otherwise, the provided default value is returned.

setValue

public void setValue(java.lang.String name,
                     java.lang.String value)

Description copied from interface: ICustomPropertyProvider

Sets the value for the custom property with the given name to the given string.

Specified by:

setValue in interface ICustomPropertyProvider

Overrides:

setValue in class CustomPropertyProvider

Parameters:

name - the name of the custom property

value - the new value

isFlippedDiagonally

public boolean isFlippedDiagonally()

Specified by:

isFlippedDiagonally in interface ITile

isFlippedHorizontally

public boolean isFlippedHorizontally()

Specified by:

isFlippedHorizontally in interface ITile

isFlippedVertically

public boolean isFlippedVertically()

Specified by:

isFlippedVertically in interface ITile

isFlipped

public boolean isFlipped()

Specified by:

isFlipped in interface ITile

getGridId

public int getGridId()

Description copied from interface: ITile

Gets the grid id.

Specified by:

getGridId in interface ITile

Returns:

the grid id

getTileCoordinate

public java.awt.Point getTileCoordinate()

Description copied from interface: ITile

Gets the tile coordinate.

Specified by:

getTileCoordinate in interface ITile

Returns:

the tile coordinate

setTileCoordinate

public void setTileCoordinate(java.awt.Point tileCoordinate)

Sets the tile coordinate.

Parameters:

tileCoordinate - the new tile coordinate

getId

public int getId()

Specified by:

getId in interface ITile

getTerrain

public ITerrain[] getTerrain()

Specified by:

getTerrain in interface ITile

getAnimation

public ITileAnimation getAnimation()

Specified by:

getAnimation in interface ITile

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTerrainIds

protected int[] getTerrainIds()

setTerrains

protected void setTerrains(ITerrain[] terrains)

setCustomPropertySource

protected void setCustomPropertySource(ITile source)