mouserun.game

Class Mouse

java.lang.Object

mouserun.game.Mouse

Direct Known Subclasses:

ProblematicMouse, TestMouse, TheExplorer

public abstract class Mouse
extends java.lang.Object

Abstract Class Mouse should be the base class of all Mouse implementations. Players implementing the Mouse must implement all abstract methods and place the mouse in the mouserun.mouse package. MouseLoader will locate all mouse implementation in the package.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOMB
static int	DOWN
static int	LEFT
static int	RIGHT
static int	UP

Constructor Summary

Constructors

Constructor and Description
Mouse(java.lang.String name) Creates a new instance of Mouse.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of the mouse that appears on the game interface.
abstract int	move(Grid currentGrid, Cheese cheese) The move method is called every time a mouse reaches a new grid.
abstract void	newCheese() This method is called every time a mouse (including own implementation) consumes a cheese and a new cheese is relocated.
abstract void	respawned() This method is called every time the Mouse touches a bomb that is not planted by it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UP

public static final int UP

See Also:

Constant Field Values

DOWN

public static final int DOWN

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

BOMB

public static final int BOMB

See Also:

Constant Field Values

Constructor Detail

Mouse

public Mouse(java.lang.String name)

Creates a new instance of Mouse.

Parameters:

name - The name of the Mouse to appear in the game interface.

Method Detail

getName

public java.lang.String getName()

Get the name of the mouse that appears on the game interface.

Returns:

The name of the mouse.

move

public abstract int move(Grid currentGrid,
       Cheese cheese)

The move method is called every time a mouse reaches a new grid. This method expects a decision to be made and returns the decision to be made on how to move the Mouse next. Use the Mouse.UP, Mouse.DOWN, Mouse.LEFT, Mouse.RIGHT, Mouse.BOMB as options for the decision. Players can do that is need to implement an intelligent mouse.

Parameters:

currentGrid - The current grid the Mouse is at.

cheese - The cheese to be seek.

Returns:

The decision to move the mouse. Use Mouse.UP, Mouse.DOWN, Mouse.LEFT, Mouse.RIGHT, Mouse.BOMB

newCheese

public abstract void newCheese()

This method is called every time a mouse (including own implementation) consumes a cheese and a new cheese is relocated. Usually utilized for clean ups.

respawned

public abstract void respawned()

This method is called every time the Mouse touches a bomb that is not planted by it. Usually utilized for calibration.