com.nkasenides.athlos.model.ITerrainChunk Maven / Gradle / Ivy

Go to download

package com.nkasenides.athlos.model;

import java.util.Map;

/**
 * Abstracts the functionality of terrain chunks.
 */
public interface ITerrainChunk {

    /**
     * Retrieves the terrain chunk's ID (a hash value).
     * @return Returns a string-based hash value.
     */
    String getId();

    /**
     * Retrieves the terrain chunk's cells map.
     * @return Returns a Map of String to ? extends ITerrainCell
     */
    Map getCells();

    /**
     * Retrieves the chunk's world ID.
     * @return Returns a string-based ID.
     */
    String getWorldID();

}