Behaviour.java

package rabbitescape.engine;

import java.util.Map;

import rabbitescape.engine.ChangeDescription.State;

public abstract class Behaviour
{
    public boolean triggered;

    /**
     * Subclasses examine the rabbit's situation using BehaviourTools and
     * return the state (see ChangeDescription) for the next time step.
     * This method may return null indicating that a different Behaviour
     * must take over.
     *
     * Note that the state determines the animation used.
     */
    public abstract State newState( BehaviourTools t, boolean triggered );

    /**
     * Move the rabbit in the world. Kill it, or record its safe exit.
     */
    public abstract boolean behave( World world, Rabbit rabbit, State state );

    /**
     * Examine the rabbit's situation and return true if this Behaviour must
     * take control.
     */
    public abstract boolean checkTriggered( Rabbit rabbit, World world );

    public abstract void cancel();

    public void saveState( Map<String, String> saveState )
    {
    }

    public void restoreFromState( Map<String, String> saveState )
    {
    }
}