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

Go to download

package com.nkasenides.athlos.model;

/**
 * Abstracts the functionality of entities.
 */
public interface IEntity {

    /**
     * Retrieves the ID of an entity.
     * @return Returns a string-based ID.
     */
    String getId();

    /**
     * Retrieves the world ID of an entity.
     * @return Returns a string-based ID.
     */
    String getWorldID();

    /**
     * Retrieves the player ID of an entity.
     * @return Returns a string-based ID.
     */
    String getPlayerID();

    /**
     * Retrieves the area of interest of an entity.
     * @return Returns a float.
     */
    float getAreaOfInterest();

}