Class Player

java.lang.Object

Player

public class Player
extends java.lang.Object

Represents a player in the Spy Game.

Constructor Summary

Constructors

Constructor and Description
Player(java.lang.String name, int budget, int spycams, GraphNode startnode) Constructs an instance of Player to track location and other information for the player.

Method Summary

Modifier and Type	Method and Description
void	decreaseBudget(int dec) Subtract the dec amount from the budget.
boolean	dropSpycam() If there are no remaining spy cams to drop, display "Not enough spycams" and return false.
int	getBudget() Return the amount remaining in this player's budget.
GraphNode	getLocation() Returns the node where the player is currently located.
java.lang.String	getLocationName() Returns the name (label) of the node where the player is currently located.
java.lang.String	getName() Return the name of the player.
void	getSpycamBack(boolean pickupSpyCam) If pickupSpyCam is true, increment the number of spy cams remaining.
int	getSpycams() Returns the number of spy cams available to drop.
boolean	move(java.lang.String name) Change the location of the player to the specified node.
boolean	pickupSpycam(GraphNode node) Check the node to see if there is a spy cam.
void	printSpyCamLocations() Display the names of the locations where Spy Cams were dropped (and are still there).

Methods inherited from class java.lang.Object

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

Constructor Detail

Player

public Player(java.lang.String name,
              int budget,
              int spycams,
              GraphNode startnode)

Constructs an instance of Player to track location and other information for the player.

Parameters:

name - Player's name

budget - Player budget to spend on moves

spycams - the number of spy cams the player starts with

startnode - the node the player starts on

Method Detail

getName

public java.lang.String getName()

Return the name of the player.

Returns:

name of player

getBudget

public int getBudget()

Return the amount remaining in this player's budget.

Returns:

remaining budget

decreaseBudget

public void decreaseBudget(int dec)

Subtract the dec amount from the budget.

Parameters:

dec - The amount to decrease the budget by.

dropSpycam

public boolean dropSpycam()

If there are no remaining spy cams to drop, display "Not enough spycams" and return false. Otherwise:

 If there is not a spy cam at the player's current location:
    display "Dropped a Spy cam at D" where D is the node name
    drop a spy cam (here) D
    decrement the remaining spy cam count if there was not already a spycam
 

Returns:

true if a spycam is already there or is dropped

pickupSpycam

public boolean pickupSpycam(GraphNode node)

Check the node to see if there is a spy cam. If there is a spy cam at that node, remove the spy cam from that node. Also, remove the spy cam name from the Player's list of spy cam names. Otherwise, return false.

Parameters:

node - The node the player asked to remove a spy cam from.

Returns:

true if a spycam is retrieved

getSpycams

public int getSpycams()

Returns the number of spy cams available to drop.

Returns:

number of spycams remaining

move

public boolean move(java.lang.String name)

Change the location of the player to the specified node. Moves to nodes with a cost of one are not counted. (ie. it is "free" to "walk" to a node); If attempt to move to a node that is not a neighbor (nn) is made, displays the message: "nn is not a neighbor of your current location"; and returns false.

Parameters:

name - Name of the neighboring to move to

Returns:

true if the player successfully moves to this node if the cost is greater than 1, decrement budget by that amount

getLocationName

public java.lang.String getLocationName()

Returns the name (label) of the node where the player is currently located.

Returns:

node label for the current location of the player

getLocation

public GraphNode getLocation()

Returns the node where the player is currently located.

Returns:

player's current node

getSpycamBack

public void getSpycamBack(boolean pickupSpyCam)

If pickupSpyCam is true, increment the number of spy cams remaining.

Parameters:

pickupSpyCam - true if a spy cam was picked up. False means there was no spy cam

printSpyCamLocations

public void printSpyCamLocations()

Display the names of the locations where Spy Cams were dropped (and are still there). If there are spy cams at nodes named a, f, and g, the display would show:

 Spy cam at a
 Spy cam at f
 Spy cam at g