Creature

java.lang.Object
- greenfoot.Actor
- - com.github.curriculeon.greeps.Creature

Direct Known Subclasses:

Greep
```
public abstract class Creature
extends greenfoot.Actor
```
A Creature is the base class for all alien beings in this scenario. It provides the basic abilities of creatures in this world.

Constructor Summary

Constructors
Constructor and Description

Creature(Spaceship ship)
Create a creature at its ship.

Constructors
Constructor and Description
`Creature(Spaceship ship)` Create a creature at its ship.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`act()` Act - must be called as part of subclass act.
`protected abstract void`	`behave()` Defines what a `Creature` will do
`java.lang.Boolean`	`canMove()`
`protected void`	`dropTomato()` Drop the tomato we are carrying.
`abstract java.lang.String`	`getCurrentImage()`
`int`	`getMemory()` Retrieve a previously stored value.
`int`	`getNextXCoordinate()`
`int`	`getNextYCoordinate()`
`Spaceship`	`getShip()`
`TomatoPile`	`getSurroundingTomatoPile()`
`boolean`	`isAtShip()`
`boolean`	`isAtTomatoes()`
`boolean`	`isAtWater()`
`boolean`	`isAtWorldEdge()`
`boolean`	`isCarryingTomato()` Check whether we are carrying a tomato.
`boolean`	`isFlaggedForState(int state)` Retrieve the value of a flag.
`boolean`	`isSeeingPaint(java.lang.String color)` Check whether we can see paint of a given color where we are sitting.
`void`	`loadTomato()` Load a tomato onto another creature.
`void`	`move()` Move forward roughly in the current direction.
`void`	`move(int amount)` To avoid confusion/cheating, calling the built-in Greenfoot move(int amount) does the same as the Creature move() function.
`boolean`	`removeTomato()` Remove the tomato currently carried (and return true).
`void`	`setFlag(int flagNo, boolean val)` Store a user defined boolean value (a "flag").
`void`	`setImage(java.lang.String imageName)`
`void`	`setMemory(int val)` Store a user defined value.
`void`	`spit(java.lang.String color)` Spit a drop of paint onto the ground.
`void`	`turnAwayFrom(greenfoot.Actor actor)`
`void`	`turnAwayFrom(greenfoot.Actor actor, int likelihoodOfExecutingTurn)`
`void`	`turnOppositeDirection(int angle)`
`void`	`turnTowards(greenfoot.Actor actor)` Turn in the direction of the specified `actor`
`void`	`turnTowards(greenfoot.Actor actor, float likelihoodOfTurn)`
`void`	`turnTowardsHome()` turn towards the ship
`void`	`turnTowardsHome(float likelihoodOfTurn)` turn towards the ship with some likelihood

Methods inherited from class greenfoot.Actor
addedToWorld, getImage, getIntersectingObjects, getNeighbours, getObjectsAtOffset, getObjectsInRange, getOneIntersectingObject, getOneObjectAtOffset, getRotation, getWorld, getWorldOfType, getX, getY, intersects, isAtEdge, isTouching, removeTouching, setImage, setLocation, setRotation, turn, turnTowards

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

- Constructor Detail
  - Creature
```
public Creature(Spaceship ship)
```
    Create a creature at its ship.
- Method Detail
  - getCurrentImage
```
public abstract java.lang.String getCurrentImage()
```
    Returns:
    
    string-representation of the current image of this `Creature` instance
  - behave
```
protected abstract void behave()
```
    Defines what a `Creature` will do
  - setImage
```
public final void setImage(java.lang.String imageName)
```
    Overrides:
    
    setImage in class greenfoot.Actor
    
    Parameters:
    
    imageName - path of image to set this `Creature` instance to
  - act
```
public final void act()
```
    Act - must be called as part of subclass act. This ensures single movement in each act round.
    
    Overrides:
    
    act in class greenfoot.Actor
  - move
```
public final void move(int amount)
```
    To avoid confusion/cheating, calling the built-in Greenfoot move(int amount) does the same as the Creature move() function.
    
    Overrides:
    
    move in class greenfoot.Actor
  - turnTowards
```
public void turnTowards(greenfoot.Actor actor)
```
    Turn in the direction of the specified `actor`
    
    Parameters:
    
    actor - - Actor to turn towards
  - turnTowards
```
public void turnTowards(greenfoot.Actor actor,
                        float likelihoodOfTurn)
```
    Parameters:
    
    actor - the actor to turn towards
    
    likelihoodOfTurn - the likelihood of successfully turning toward the specified actor
  - turnTowardsHome
```
public void turnTowardsHome()
```
    turn towards the ship
  - turnTowardsHome
```
public void turnTowardsHome(float likelihoodOfTurn)
```
    turn towards the ship with some likelihood
    
    Parameters:
    
    likelihoodOfTurn - the likelihood of successfully turning toward the ship
  - turnOppositeDirection
```
public void turnOppositeDirection(int angle)
```
    Parameters:
    
    angle - the angle to turn away from
  - turnAwayFrom
```
public void turnAwayFrom(greenfoot.Actor actor)
```
    Parameters:
    
    actor - the actor to turn away from
  - turnAwayFrom
```
public void turnAwayFrom(greenfoot.Actor actor,
                         int likelihoodOfExecutingTurn)
```
    Parameters:
    
    actor - the actor to turn away from
    
    likelihoodOfExecutingTurn - the likelihood of executing the turn
  - isAtShip
```
public final boolean isAtShip()
```
    Returns:
    
    true if we are at our space ship.
  - isAtTomatoes
```
public final boolean isAtTomatoes()
```
    Returns:
    
    true if we have found food at our current location.
  - getSurroundingTomatoPile
```
public TomatoPile getSurroundingTomatoPile()
```
    Returns:
    
    the instance of the tomato pile that this `Creature` instance is currently intersecting; return null if no tomato pile can be found
  - isAtWater
```
public final boolean isAtWater()
```
    Returns:
    
    true if we have just seen water in front of us.
  - isAtWorldEdge
```
public boolean isAtWorldEdge()
```
    Returns:
    
    true if we are within 3 cells of the world's edge
  - isSeeingPaint
```
public boolean isSeeingPaint(java.lang.String color)
```
    Check whether we can see paint of a given color where we are sitting.
  - isFlaggedForState
```
public boolean isFlaggedForState(int state)
```
    Retrieve the value of a flag. 'flagNo' can be 1 or 2.
  - isCarryingTomato
```
public final boolean isCarryingTomato()
```
    Check whether we are carrying a tomato.
  - removeTomato
```
public final boolean removeTomato()
```
    Remove the tomato currently carried (and return true). Return false if we were not carrying one.
  - dropTomato
```
protected final void dropTomato()
```
    Drop the tomato we are carrying. If we are at the ship, it is counted. If not, it's just gone...
  - loadTomato
```
public final void loadTomato()
```
    Load a tomato onto *another* creature. This works only if there is another creature and a tomato pile present, otherwise this method does nothing.
  - spit
```
public void spit(java.lang.String color)
```
    Spit a drop of paint onto the ground. We can spit in three colors: "red", "orange", and "purple". (All other strings will be mapped to one of these.)
  - setMemory
```
public void setMemory(int val)
```
    Store a user defined value. Attention: even though the parameter type is int, only byte size values (0 <= val <= 255) are accepted.
  - getMemory
```
public int getMemory()
```
    Retrieve a previously stored value.
  - setFlag
```
public void setFlag(int flagNo,
                    boolean val)
```
    Store a user defined boolean value (a "flag"). Two flags are available, i.e. 'flagNo' may be 1 or 2.
  - getShip
```
public Spaceship getShip()
```
    Returns:
    
    the Spaceship to return tomato piles to
  - move
```
public void move()
```
    Move forward roughly in the current direction. Sometimes we get a little off course.
  - canMove
```
public java.lang.Boolean canMove()
```
    Returns:
    
    true if the next coordinate is not equal to the current coordinate
  - getNextXCoordinate
```
public int getNextXCoordinate()
```
    Returns:
    
    return the `Y` coordinates of the next location to move into
  - getNextYCoordinate
```
public int getNextYCoordinate()
```
    Returns:
    
    return the `X` coordinates of the next location to move into

Class Creature

Constructor Summary

Method Summary

Methods inherited from class greenfoot.Actor

Methods inherited from class java.lang.Object

Constructor Detail

Creature

Method Detail

getCurrentImage

behave

setImage

act

move

turnTowards

turnTowards

turnTowardsHome

turnTowardsHome

turnOppositeDirection

turnAwayFrom

turnAwayFrom

isAtShip

isAtTomatoes

getSurroundingTomatoPile

isAtWater

isAtWorldEdge

isSeeingPaint

isFlaggedForState

isCarryingTomato

removeTomato

dropTomato

loadTomato

spit

setMemory

getMemory

setFlag

getShip

move

canMove

getNextXCoordinate

getNextYCoordinate