mouserun.game

Class MouseController

java.lang.Object

mouserun.game.MouseController

public class MouseController
extends java.lang.Object

Class MouseController is the wrapper class for each Mouse implementation. This class layers the connection between the GameController and the Mouse itself to prevent access to crucial information and manipulation.

Constructor Summary

Constructors

Constructor and Description
MouseController(Mouse mouse) Creates a new instance of MouseController

Method Summary

Methods

Modifier and Type	Method and Description
Mouse	getMouse() Get the Mouse wrapped in this MouseController.
int	getNumberOfBombs() Gets the number of Bombs the Mouse still has.
int	getNumberOfCheese() Get the number of cheese the current Mouse has consumed thus far.
int	getSpeed() Get the number of pixels to move per mouse move turn.
Grid	getTargetGrid() Gets the next grid the mouse is to head to.
void	increaseNumberOfCheese() Increases the number of cheese consumed by the Mouse.
Bomb	makeBomb() Creates a new bomb for the Mouse to be planted on the current targetGrid.
int	onGrid(Grid currentGrid, Cheese cheese) This method is called each time the mouse reaches a grid.
void	setNumberOfBombs(int numberOfBombs) Sets the number of Bombs that Mouse will have.
void	setTargetGrid(Grid targetGrid) Sets the next grid the mouse is heading to.

Methods inherited from class java.lang.Object

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

Constructor Detail

MouseController

public MouseController(Mouse mouse)

Creates a new instance of MouseController

Parameters:

mouse - The mouse to be wrapped in the controller.

Method Detail

onGrid

public int onGrid(Grid currentGrid,
         Cheese cheese)

This method is called each time the mouse reaches a grid. This bridge to the move method implemented in the mouse.

Parameters:

currentGrid - The current grid the Mouse is at.

cheese - The cheese to seek.

Returns:

The move decision

setTargetGrid

public void setTargetGrid(Grid targetGrid)

Sets the next grid the mouse is heading to.

Parameters:

targetGrid - The next grid the mouse is heading to.

getTargetGrid

public Grid getTargetGrid()

Gets the next grid the mouse is to head to.

Returns:

The next grid the mouse is to head to.

getMouse

public Mouse getMouse()

Get the Mouse wrapped in this MouseController.

Returns:

Returns the Mouse wrapped in this MouseController

getSpeed

public int getSpeed()

Get the number of pixels to move per mouse move turn.

Returns:

The number of pixels to move per mouse move turn.

getNumberOfCheese

public int getNumberOfCheese()

Get the number of cheese the current Mouse has consumed thus far.

Returns:

The number of cheese the current Mouse has consumed.

increaseNumberOfCheese

public void increaseNumberOfCheese()

Increases the number of cheese consumed by the Mouse.

getNumberOfBombs

public int getNumberOfBombs()

Gets the number of Bombs the Mouse still has.

Returns:

The number of Bombs available.

setNumberOfBombs

public void setNumberOfBombs(int numberOfBombs)

Sets the number of Bombs that Mouse will have.

Parameters:

numberOfBombs - The number of Bombs the Mouse will have.

makeBomb

public Bomb makeBomb()

Creates a new bomb for the Mouse to be planted on the current targetGrid. If no Bomb is available, null will be returned.

Returns:

The Bomb to be planted by the Mouse. If not available, null will be returned.