java.lang.Object

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

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

All Implemented Interfaces:: ICustomPropertyProvider, ITile

public class Tile
extends CustomPropertyProvider
implements ITile

Field Summary

Fields
Modifier and Type	Field	Description
`static Tile`	`EMPTY`
`protected static int`	`FLIPPED_DIAGONALLY_FLAG`
`protected static int`	`FLIPPED_HORIZONTALLY_FLAG`
`protected static int`	`FLIPPED_VERTICALLY_FLAG`
`static int`	`NONE`

Constructor Summary

Constructors
Constructor	Description
`Tile()`	Instantiates a new `Tile` instance.
`Tile(int gidBitmask)`	Instantiates a new `Tile` instance.
`Tile(Tile original)`	Instantiates a new `Tile` instance with the same attributes as a given `Tile`.

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object anObject)`	Tests for equality between two tiles.
`int`	`getGridId()`	Gets the grid id.
`java.awt.image.BufferedImage`	`getImage()`
`java.util.Map<java.lang.String,ICustomProperty>`	`getProperties()`	Returns a `Map` view of the custom properties for this `ICustomPropertyProvider`.
`java.awt.Point`	`getTileCoordinate()`	Gets the tile coordinate.
`ITilesetEntry`	`getTilesetEntry()`
`boolean`	`hasCustomProperty(java.lang.String name)`	Checks if a custom property with the given name is present.
`int`	`hashCode()`	Computes a hash code for this tile.
`boolean`	`isFlipped()`
`boolean`	`isFlippedDiagonally()`
`boolean`	`isFlippedHorizontally()`
`boolean`	`isFlippedVertically()`
`void`	`setProperties(java.util.Map<java.lang.String,ICustomProperty> props)`	Sets all of the custom properties on this object to the provided values.
`java.lang.String`	`toString()`

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

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getCommaSeparatedStringValues, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFileValue, getFileValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getProperty, getShortValue, getShortValue, getStringValue, getStringValue, getTypeOfProperty, removeProperty, setTypeOfProperty, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getCommaSeparatedStringValues, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFileValue, getFileValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getProperty, getShortValue, getShortValue, getStringValue, getStringValue, getTypeOfProperty, removeProperty, setTypeOfProperty, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Field Details
- NONE
  public static final int NONE
  See Also:
  Constant Field Values
- EMPTY
  public static final Tile EMPTY
- FLIPPED_HORIZONTALLY_FLAG
  protected static final int FLIPPED_HORIZONTALLY_FLAG
  See Also:
  Constant Field Values
- FLIPPED_VERTICALLY_FLAG
  protected static final int FLIPPED_VERTICALLY_FLAG
  See Also:
  Constant Field Values
- FLIPPED_DIAGONALLY_FLAG
  protected static final int FLIPPED_DIAGONALLY_FLAG
  See Also:
  Constant Field Values
Constructor Details
- Tile
  public Tile()
  Instantiates a new Tile instance.
- Tile
  public Tile(Tile original)
  Instantiates a new Tile instance with the same attributes as a given Tile.
  Parameters:
  original - The original tile from which the values will be copied to this new instance.
- Tile
  public Tile(int gidBitmask)
  Instantiates a new Tile instance.
  Parameters:
  gidBitmask - The grid ID bitmask used to identify flags of this instance.
  See Also:
  FLIPPED_HORIZONTALLY_FLAG, FLIPPED_DIAGONALLY_FLAG, FLIPPED_VERTICALLY_FLAG
Method Details
- 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.Map<java.lang.String,ICustomProperty> getProperties()
  Description copied from interface: ICustomPropertyProvider
  Returns a Map view of the custom properties for this ICustomPropertyProvider.
  Specified by:
  getProperties in interface ICustomPropertyProvider
  Overrides:
  getProperties in class CustomPropertyProvider
  Returns:
  a Map view of the custom properties for this ICustomPropertyProvider
- setProperties
  public void setProperties(java.util.Map<java.lang.String,ICustomProperty> 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
- 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
- getImage
  public java.awt.image.BufferedImage getImage()
  Specified by:
  getImage 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
- getTilesetEntry
  public ITilesetEntry getTilesetEntry()
  Specified by:
  getTilesetEntry in interface ITile
- equals
  public boolean equals(java.lang.Object anObject)
  Description copied from interface: ITile
  Tests for equality between two tiles. Two tiles are equal if they have the same grid ID, flipped flags, and tileset entry.
  Specified by:
  equals in interface ITile
  Overrides:
  equals in class java.lang.Object
  Parameters:
  anObject - The tile to test equality for
  Returns:
  Whether the provided tile is equal to this tile, or false if anObject is not a tile
- hashCode
  public int hashCode()
  Description copied from interface: ITile
  Computes a hash code for this tile. A tile's hash code is equal to its stored grid ID, i.e. the gid bitmask, xor the tileset entry's hash code.
  Specified by:
  hashCode in interface ITile
  Overrides:
  hashCode in class java.lang.Object
  Returns:
  The hash code for this tile
- toString
  public java.lang.String toString()
  Overrides:
  toString in class java.lang.Object

Class Tile

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

Constructor Details

Method Details