Creature

java.lang.Object
- Creature

All Implemented Interfaces:

Entity, Runnable
```
public abstract class Creature
extends Object
implements Entity, Runnable
```
Extend this class to create your own Creature.
Override the run() method to implement the Creature's AI. Within that method the following actions are available (each of which takes some time steps to execute):
Example:
```
public class Rover extends Creature {
    public void run() {
           while (true) {

                if (! moveForward()) {
                    attack();
                    turnLeft();
                }

            }
    }
 }
```
Morgan McGuire
morgan@cs.williams.edu

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`APPLE_CLASS_ID` The class ID for an Apple.
`static int`	`EMPTY_CLASS_ID` The class ID for an empty space on the map.
`static int`	`FLYTRAP_CLASS_ID` The class ID for a Flytrap.
`static int`	`HAZARD_CLASS_ID`
`static Type`	`THORN` Deprecated. Old name for HAZARD
`static int`	`THORN_CLASS_ID` Deprecated. Old name for HAZARD_CLASS_ID
`static int`	`TREASURE_CLASS_ID` The class ID for a Treasure.
`static int`	`UNINITIALIZED_CLASS_ID` An illegal, uninitialized value distinct from an empty square.
`static int`	`UNKNOWN_CREATURE_CLASS_ID` A class ID reserved for use by Creature subclasses.
`static int`	`WALL_CLASS_ID`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Creature()
Subclass constructors must not invoke any of the parent class methods from their constructor.

Constructors
Modifier	Constructor and Description
`protected`	`Creature()` Subclass constructors must not invoke any of the parent class methods from their constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected boolean`	`attack()` Attack the creature right in front of you.
`protected void`	`delay()` Execute the delay action.
`protected void`	`delay(int n)` Execute the delay action n times in a row
`protected int`	`distance(Point p2)` Returns the Manhattan distance from current position to p2.
`static int`	`distance(Point p1, Point p2)` Returns the Manhattan distance between p1 and p2
`protected void`	`emitPheromone(String s)` Emit a pheromone onto this creature's current location.
`boolean`	`equals(Object ob)` Uses the pointer comparision from Object.
`abstract String`	`getAuthorName()` Allows GUI browsers to display your name as author of this creature.
`int`	`getClassId()` Each creature species is assigned a unique class ID for each trial, except Treasure, Apple, and Flytrap, which always have the same values.
`String`	`getClassName()` Name of this species of creature.
`abstract String`	`getDescription()` Allows GUI browsers to display information and credits about your creature.
`Direction`	`getDirection()` Direction this creature is facing.
`long`	`getGameTime()` Returns the time in virtual nanoseconds since the simulation started.
`int`	`getId()` Each creature has a unique number that it can use to distinguish itself from others.
`char`	`getLabel()` Used by Simulator for labeling the icons in 2D render mode.
`Dimension`	`getMapDimensions()` Returns the size of the map.
`protected Point`	`getMovePosition()` Same as `getMovePosition(int)` with the argument `n = 1`
`protected Point`	`getMovePosition(int n)` The coordinates of the next position this Creature will enter if it moves n times, regardless of whether that position is currently empty.
`long`	`getMyTimeSinceSpawn()` The time in virtual nanoseconds that this Creature has spent in actions and computing since it spawned.
`protected String`	`getPheromone()` Returns the pheromone at this creature's current location.
`Point`	`getPosition()` Returns the position of this Creature.
`long`	`getTime()` Deprecated. Use getGameTime instead
`long`	`getTurnTime()` Returns the time in virtual nanoseconds since this creature's current turn started.
`Type`	`getType()`
`int`	`hashCode()` Uses the pointer hashCode from Object.
`protected boolean`	`inFog()` Returns true if this creature's current location is in fog.
`protected boolean`	`inMud()` Returns true if this creature's current location is in mud.
`protected boolean`	`isEnchanted()` Returns true if this creature is enchanted.
`protected boolean`	`isEnemy(Observation obs)` Returns true if this observation describes a Creature that is not of this species, including Flytrap, Apple, and Treasure.
`protected Observation`	`look()` Deprecated. returns the first element of observe(). Provided for backwards compatibility.
`protected boolean`	`moveBackward()` Call to move your creature backward 1 square without changing its facing direction.
`protected boolean`	`moveBackward(int n)` Execute the moveBackward action n times in a row.
`protected boolean`	`moveForward()` Call to move your creature forward 1 square.
`protected boolean`	`moveForward(int n)` Execute the moveForward action n times in a row.
`protected int`	`myClassId()` Synonym for `getClassId()` to make Creature subclasses more readable.
`protected int`	`myId()` Synonym for `getId()` to make Creature subclasses more readable.
`protected Observation[]`	`observe()` Observe all locations that are visible to this creature.
`Observation`	`observeSelf()` Create an observation describing this creature.
`void`	`onDeath()` Called by the simulator on a creature that has is about to die, to give it an opportunity to communicate with other members of its species before it is removed from the game.
`abstract void`	`run()` Override this method to make your creature think and move.
`protected int`	`shrineClassId()` If this creature is on a shrine, returns the classID of the creatures that own the shrine.
`static String`	`toString(Point point)` Prints a point to a string concisely.
`protected void`	`turnLeft()` Rotate counter-clockwise 90 degrees.
`protected void`	`turnRight()` Rotate clockwise 90 degrees.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - THORN
```
public static final Type THORN
```
    Deprecated. Old name for HAZARD
  - UNINITIALIZED_CLASS_ID
```
public static final int UNINITIALIZED_CLASS_ID
```
    An illegal, uninitialized value distinct from an empty square. Guaranteed to be zero.
    
    See Also:
    Observation.classId, getClassId(), Constant Field Values
  - EMPTY_CLASS_ID
```
public static final int EMPTY_CLASS_ID
```
    The class ID for an empty space on the map. This will never be created by an Observation, but can be used by Creatures to record empty spaces that they have inferred.
    
    See Also:
    Observation.classId, getClassId(), Constant Field Values
  - WALL_CLASS_ID
```
public static final int WALL_CLASS_ID
```
    See Also:
    Observation.classId, getClassId(), Constant Field Values
  - HAZARD_CLASS_ID
```
public static final int HAZARD_CLASS_ID
```
    See Also:
    Observation.classId, getClassId(), Constant Field Values
  - THORN_CLASS_ID
```
public static final int THORN_CLASS_ID
```
    Deprecated. Old name for HAZARD_CLASS_ID
    
    See Also:
    Constant Field Values
  - TREASURE_CLASS_ID
```
public static final int TREASURE_CLASS_ID
```
    The class ID for a Treasure.
    
    See Also:
    Observation.classId, getClassId(), Constant Field Values
  - APPLE_CLASS_ID
```
public static final int APPLE_CLASS_ID
```
    The class ID for an Apple.
    
    See Also:
    Observation.classId, getClassId(), Constant Field Values
  - FLYTRAP_CLASS_ID
```
public static final int FLYTRAP_CLASS_ID
```
    The class ID for a Flytrap.
    
    See Also:
    Observation.classId, getClassId(), Constant Field Values
  - UNKNOWN_CREATURE_CLASS_ID
```
public static final int UNKNOWN_CREATURE_CLASS_ID
```
    A class ID reserved for use by Creature subclasses. This is guaranteed to not match the class ID of any creature actually in the match.
    
    See Also:
    Observation.classId, getClassId(), Constant Field Values
- Constructor Detail
  - Creature
```
protected Creature()
```
    Subclass constructors must not invoke any of the parent class methods from their constructor. Instead, perform initialization at the beginning of the run() method.
- Method Detail
  - getClassId
```
public final int getClassId()
```
    Each creature species is assigned a unique class ID for each trial, except Treasure, Apple, and Flytrap, which always have the same values. You can recognize your own creatures by
```
        Observation obs;
        ...
        if (obs.classId == getClassId()) { ... }
        
```
    Specified by:
    
    getClassId in interface Entity
    
    See Also:
    UNINITIALIZED_CLASS_ID, EMPTY_CLASS_ID, TREASURE_CLASS_ID, APPLE_CLASS_ID, FLYTRAP_CLASS_ID, UNKNOWN_CREATURE_CLASS_ID
  - myClassId
```
protected final int myClassId()
```
    Synonym for getClassId() to make Creature subclasses more readable.
  - myId
```
protected final int myId()
```
    Synonym for getId() to make Creature subclasses more readable.
  - getType
```
public final Type getType()
```
    Specified by:
    
    getType in interface Entity
  - getTime
```
public final long getTime()
```
    Deprecated. Use getGameTime instead
  - getGameTime
```
public final long getGameTime()
```
    Returns the time in virtual nanoseconds since the simulation started. This is the sum of the time spent by all creatures. It matches the values stored in Observations. This is only updated between turns.
    
    See Also:
    getTurnTime(), getMyTimeSinceSpawn(), Observation.time, System.nanoTime()
  - getMyTimeSinceSpawn
```
public final long getMyTimeSinceSpawn()
```
    The time in virtual nanoseconds that this Creature has spent in actions and computing since it spawned. Will always be less than getTime, and usually much less if there are other creatures on the map.
    
    See Also:
    getTime(), getTurnTime()
  - getTurnTime
```
public final long getTurnTime()
```
    Returns the time in virtual nanoseconds since this creature's current turn started.
    
    See Also:
    getTime(), getMyTimeSinceSpawn()
  - getClassName
```
public final String getClassName()
```
    Name of this species of creature.
  - getAuthorName
```
public abstract String getAuthorName()
```
    Allows GUI browsers to display your name as author of this creature.
  - getDescription
```
public abstract String getDescription()
```
    Allows GUI browsers to display information and credits about your creature. Override to return a one-sentence description of your creature's behavior.
  - onDeath
```
public void onDeath()
```
    Called by the simulator on a creature that has is about to die, to give it an opportunity to communicate with other members of its species before it is removed from the game. The creature is still in the map and may observe itself or ask for its position or direction before it is removed. Taking any action will throw an exception and cause the method to terminate.
    
    This is far more reliable than a finalizer, which Java is not required to call and has no explicit time at which it runs. This is run on a separate thread than the creature's usual thread, so if the creature was holding a lock this method may block. The normal time limit is enforced for the onDeath method.
  - getMapDimensions
```
public Dimension getMapDimensions()
```
    Returns the size of the map. Fast.
  - getId
```
public final int getId()
```
    Each creature has a unique number that it can use to distinguish itself from others. The id is not valid until run() is called on the creature; do not reference it from the constructor.
  - observeSelf
```
public Observation observeSelf()
```
    Create an observation describing this creature. This is not an action and does not take substantial time.
  - getPheromone
```
protected String getPheromone()
```
    Returns the pheromone at this creature's current location. This is not an action and does not take substantial time. Pheromones are an experimental feature in the current version of Darwin.
  - inFog
```
protected boolean inFog()
```
    Returns true if this creature's current location is in fog. This is not an action and does not take substantial time. Fog is an experimental feature in the current version of Darwin and will not appear on any tournament map in 2012.
  - inMud
```
protected boolean inMud()
```
    Returns true if this creature's current location is in mud. Invoking this method is not an action and does not take substantial time.
  - isEnchanted
```
protected boolean isEnchanted()
```
    Returns true if this creature is enchanted. Invoking this method is not an action and does not take substantial time. A creature that spawns enchanted remains enchanted.
  - shrineClassId
```
protected int shrineClassId()
```
    If this creature is on a shrine, returns the classID of the creatures that own the shrine. Otherwise, returns UNINITIALIZED_CLASS_ID
  - getMovePosition
```
protected Point getMovePosition(int n)
```
    The coordinates of the next position this Creature will enter if it moves n times, regardless of whether that position is currently empty. (fast)
  - getMovePosition
```
protected Point getMovePosition()
```
    Same as getMovePosition(int) with the argument n = 1
  - isEnemy
```
protected boolean isEnemy(Observation obs)
```
    Returns true if this observation describes a Creature that is not of this species, including Flytrap, Apple, and Treasure.
    
    See Also:
    Observation.className
  - distance
```
protected int distance(Point p2)
```
    Returns the Manhattan distance from current position to p2.
  - distance
```
public static int distance(Point p1,
           Point p2)
```
    Returns the Manhattan distance between p1 and p2
  - hashCode
```
public final int hashCode()
```
    Uses the pointer hashCode from Object.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object ob)
```
    Uses the pointer comparision from Object.
    
    Overrides:
    
    equals in class Object
  - getLabel
```
public final char getLabel()
```
    Used by Simulator for labeling the icons in 2D render mode.
    
    Specified by:
    
    getLabel in interface Entity
  - run
```
public abstract void run()
```
    Override this method to make your creature think and move. Executes as soon as the creature is injected into the world. Your creature will stop moving when the run method ends (but stay alive), so most implementations will be an intentional infinite loop.
    
    Specified by:
    
    run in interface Runnable
  - getPosition
```
public final Point getPosition()
```
    Returns the position of this Creature. If you change this value, it will remain at the incorrect value until the Creature moves and it is overwritten by the simulator. This is fast.
  - getDirection
```
public final Direction getDirection()
```
    Direction this creature is facing. This is fast.
  - toString
```
public static String toString(Point point)
```
    Prints a point to a string concisely.
  - delay
```
protected void delay()
```
    Execute the delay action.
  - delay
```
protected void delay(int n)
```
    Execute the delay action n times in a row
  - moveForward
```
protected boolean moveForward(int n)
```
    Execute the moveForward action n times in a row.
    
    Returns:
    true if it moves all n spaces successfully.
  - moveBackward
```
protected boolean moveBackward(int n)
```
    Execute the moveBackward action n times in a row.
    
    Returns:
    true if it moves all n spaces successfully.
  - moveForward
```
protected boolean moveForward()
```
    Call to move your creature forward 1 square. If the creature is blocked, it will not move. Moving costs Simulator.MOVE_FORWARD_COST nanoseconds, even if it fails.
    
    Returns:
    true if the Creature successfully moved forward.
  - moveBackward
```
protected boolean moveBackward()
```
    Call to move your creature backward 1 square without changing its facing direction. If the creature is blocked, it will not move. Moving costs Simulator.MOVE_BACKWARD_COST time steps, even if it fails.
    
    Returns:
    true if the creature successfully moved backward.
  - emitPheromone
```
protected void emitPheromone(String s)
```
    Emit a pheromone onto this creature's current location. Costs Simulator.EMIT_PHEROMONE_COST nanoseconds. Pheromones can be sensed with getPheromone().
  - look
```
protected Observation look()
```
    Deprecated. returns the first element of observe(). Provided for backwards compatibility.
  - observe
```
protected Observation[] observe()
```
    Observe all locations that are visible to this creature. This includes the creature itself and all squares along its facing direction until blocked by a wall, thorn, or another creature. Future versions may include a wider field of view, so design your creatures to make no assumptions about the locations of observed squares.
    The returned array is ordered so that the first element is always the first non-Type.EMPTY element along the facing direction. Note that a square with a shrine on it has Type.EMPTY, so a shrine will never appear first in the array. The other elements are not in any guaranteed order.
    Costs Simulator.OBSERVE_COST nanoseconds. The result of the observe action is accurate at the beginning of the creature's next turn, but of course whatever is seen might have moved by the time the creature actually makes its response.
    The return value always contains at least one element.
  - turnLeft
```
protected void turnLeft()
```
    Rotate counter-clockwise 90 degrees. Costs Simulator.TURN_COST nanoseconds.
  - turnRight
```
protected void turnRight()
```
    Rotate clockwise 90 degrees. Costs Simulator.TURN_COST nanoseconds.
  - attack
```
protected boolean attack()
```
    Attack the creature right in front of you. If there is a creature of a different species present in that spot, that creature will be destroyed and a new creature of the same type as this one will be created in its place. The new creature will face in the opposite direction as this one (i.e., they will be face to face) with probability 60%. It will be facing perpendicular with probability 20% per direction. It will never be facing away from this one.
    Whether there is a creature present or not, this costs Simulator.ATTACK_COST nanoseconds.
    
    Returns:
    true if the attack succeeded.

Class Creature

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

THORN

UNINITIALIZED_CLASS_ID

EMPTY_CLASS_ID

WALL_CLASS_ID

HAZARD_CLASS_ID

THORN_CLASS_ID

TREASURE_CLASS_ID

APPLE_CLASS_ID

FLYTRAP_CLASS_ID

UNKNOWN_CREATURE_CLASS_ID

Constructor Detail

Creature

Method Detail

getClassId

myClassId

myId

getType

getTime

getGameTime

getMyTimeSinceSpawn

getTurnTime

getClassName

getAuthorName

getDescription

onDeath

getMapDimensions

getId

observeSelf

getPheromone

inFog

inMud

isEnchanted

shrineClassId

getMovePosition

getMovePosition

isEnemy

distance

distance

hashCode

equals

getLabel

run

getPosition

getDirection

toString

delay

delay

moveForward

moveBackward

moveForward

moveBackward

emitPheromone

look

observe

turnLeft

turnRight

attack