de.gurkenlabs.litiengine.environment.tilemap.ITileset Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of litiengine Show documentation

The FOSS 2D Java game engine.

The newest version!

package de.gurkenlabs.litiengine.environment.tilemap;

import java.awt.Dimension;
import java.util.List;

import de.gurkenlabs.litiengine.graphics.Spritesheet;
import de.gurkenlabs.litiengine.resources.Resource;

public interface ITileset extends ICustomPropertyProvider, Resource {

  /**
   * Gets the first grid id.
   *
   * @return the first grid id
   */
  int getFirstGridId();

  /**
   * Gets the image.
   *
   * @return the image
   */
  IMapImage getImage();

  Spritesheet getSpritesheet();

  int getMargin();

  int getSpacing();

  /**
   * Gets the tile dimension.
   *
   * @return the tile dimension
   */
  Dimension getTileDimension();

  int getColumns();

  ITileOffset getTileOffset();

  int getTileHeight();

  /**
   * Gets the tile width.
   *
   * @return the tile width
   */
  int getTileWidth();

  int getTileCount();

  ITilesetEntry getTile(int id);

  boolean containsTile(ITile tile);

  boolean containsTile(ITilesetEntry entry);

  boolean containsTile(int tileId);

  /**
   * Gets the terrain sets defined by this tile set.
   *
   * @return The terrain sets of this instance.
   */
  List getTerrainSets();
}