edu.ucsb.cs56.projects.games.roguelike

Class Item

java.lang.Object

edu.ucsb.cs56.projects.games.roguelike.Item

All Implemented Interfaces:

GamePiece

Direct Known Subclasses:

Beef, Elixir, HealthPotion, Poison

public class Item
extends Object
implements GamePiece

An Item class to represent Items in the Dungeon.

Version:

cs56 s13

Author:

Hans Marasigan and Richard Nguyen

Constructor Summary

Constructors

Constructor and Description
Item() creates a default item with effect value of 10 and has not been used.
Item(boolean CanUse) creates an item with the default effect value of 10 and the computer/player decides on whether it has been used and is an item game piece with icon I
Item(int NewEffect) creates an item with an effect value of the user's choice and has not been used and is an item game piece with icon I

Method Summary

Modifier and Type	Method and Description
int	getEffect() gets the item's effect value
char	getIcon() This is the getter to figure out what piece icon it is.
String	getTypeOfPiece() this tells what kind of piece it is
boolean	getUse() this gets whether or not the item has been used
void	setEffect(int NewEffect) sets the item's effect value
void	setIcon(char NewIcon) This is the setter for the Icon it will be
void	setTypeOfPiece(String newTypeOfPiece) this allows the computer/programmer to set what type of piece this will be
void	setUse(boolean use) this sets whether the item has been used or not
void	UseEffect(Player p) this method uses the effect value in someway.

Methods inherited from class java.lang.Object

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

Constructor Detail

Item

public Item()

creates a default item with effect value of 10 and has not been used. and it is an item game piece it has icon I

Item

public Item(int NewEffect)

creates an item with an effect value of the user's choice and has not been used and is an item game piece with icon I

Parameters:

NewEffect - this will be how much the item will effect the user.

Item

public Item(boolean CanUse)

creates an item with the default effect value of 10 and the computer/player decides on whether it has been used and is an item game piece with icon I

Parameters:

CanUse - tells whether the item has been used

Method Detail

getEffect

public int getEffect()

gets the item's effect value

Returns:

the effect of this item

setEffect

public void setEffect(int NewEffect)

sets the item's effect value

Parameters:

NewEffect - this is the value the computer/programmer can set

setUse

public void setUse(boolean use)

this sets whether the item has been used or not

Parameters:

use - this is a true or false statement that tells whether the item has been used.

getUse

public boolean getUse()

this gets whether or not the item has been used

Returns:

true if this item has been used, false if not

getTypeOfPiece

public String getTypeOfPiece()

this tells what kind of piece it is

Specified by:

getTypeOfPiece in interface GamePiece

Returns:

the type of this piece

setTypeOfPiece

public void setTypeOfPiece(String newTypeOfPiece)

this allows the computer/programmer to set what type of piece this will be

Specified by:

setTypeOfPiece in interface GamePiece

Parameters:

newTypeOfPiece - this will be the name of this piece

getIcon

public char getIcon()

This is the getter to figure out what piece icon it is.

Specified by:

getIcon in interface GamePiece

Returns:

the icon of this game piece

setIcon

public void setIcon(char NewIcon)

This is the setter for the Icon it will be

Specified by:

setIcon in interface GamePiece

Parameters:

NewIcon - is the icon of piece that will be in the game

UseEffect

public void UseEffect(Player p)

this method uses the effect value in someway. in this method it just adds points to the player.

Parameters:

p - the player to be affected by the item