Adventure at Umalu  22nd March, 2013
Rogue-like Dungeon Crawler, written in Java
 All Classes Functions Variables Pages
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
rogue.creature.util.Item Class Reference

Public Member Functions

 Item (String name, int goldValue, int itemType, int bonusDamage, int bonusHealth, int stability)
 
 Item (String name, int goldValue, int itemType, int bonusDamage, int bonusHealth, String description, int stability)
 
 Item (String name, int goldValue, int itemType, int bonusDamage, int bonusHealth, ArrayList< String > description, int stability)
 
 Item (String name, int goldValue, int type, int bonusDamage, int bonusHealth, boolean equipped, int stability)
 
 Item (String name, int goldValue, int type, int bonusDamage, int bonusHealth, boolean equipped, int maxStability, int curStability, ArrayList< String > description)
 
 Item (String name, int goldValue, int type, int bonusDamage, int bonusHealth, boolean equipped, int stability, ArrayList< String > description)
 
int getGoldValue ()
 
String getName ()
 
int getItemType ()
 
int getDamageBonus ()
 
int getHealthBonus ()
 
int getStability ()
 
void showItem (Terminal term, Inventory inventory)
 
void setEquipped (boolean equipped)
 
void decreaseStability ()
 
int getDurability ()
 
int getMaxDurability ()
 

Static Public Attributes

static final int ITEMTYPE_HEAD = 0
 
static final int ITEMTYPE_BODY = 1
 
static final int ITEMTYPE_SWORD = 2
 

Protected Attributes

int stability
 

Detailed Description

Represents a single Item for players Inventory

Constructor & Destructor Documentation

rogue.creature.util.Item.Item ( String  name,
int  goldValue,
int  itemType,
int  bonusDamage,
int  bonusHealth,
int  stability 
)

Creates a new Item Object with given name and Goldvalue

Parameters
nameName of Item
goldValueGoldvalue of Item
typeSword or Helmet Item
bonusDamageAdditional Damage by Item
bonusHealthAdditional Health by Item
rogue.creature.util.Item.Item ( String  name,
int  goldValue,
int  itemType,
int  bonusDamage,
int  bonusHealth,
String  description,
int  stability 
)

Creates a new Item Object with given Parameters. Works like Item(name, goldValue, itemType, bonusDamag, bonusHealth), but also sets a descriptive text.

Parameters
nameName of Item
goldValueGoldvalue of Item
typeWeapon or Armor
bonusDamageAdditional Damage by Item
bonusHealthAdditional Health by Item
descriptionDescriptive Text, given by Lore
rogue.creature.util.Item.Item ( String  name,
int  goldValue,
int  itemType,
int  bonusDamage,
int  bonusHealth,
ArrayList< String >  description,
int  stability 
)

Creates a new Item Object with given Parameters. Works like Item(name, goldValue, itemType, bonusDamag, bonusHealth), but also sets a descriptive text.

Parameters
nameName of Item
goldValueGoldvalue of Item
typeWeapon or Armor
bonusDamageAdditional Damage by Item
bonusHealthAdditional Health by Item
descriptionDescriptive Text, given by Lore. Allows to add multiple Lines of Text.
rogue.creature.util.Item.Item ( String  name,
int  goldValue,
int  type,
int  bonusDamage,
int  bonusHealth,
boolean  equipped,
int  stability 
)

Creates a new Item Object with given name and Goldvalue. Additionally sets equipped Value. This method should only get called for initial Items in inventory, all other Items should use Item(name, goldValue, type, bonusDamage, bonusHealth,[description])!

Parameters
nameName of Item
goldValueGoldvalue of Item
typeSword or Helmet Item
bonusDamageAdditional Damage by Item
bonusHealthAddiotional Health by Item
equippedEquipped Value

Member Function Documentation

void rogue.creature.util.Item.decreaseStability ( )

Decrease Durability by 1

int rogue.creature.util.Item.getDamageBonus ( )

Returns Damagebonus of this Item

Returns
Damagebonus of this Item
int rogue.creature.util.Item.getDurability ( )

Get current Durability Value

Returns
Current Durability Value
int rogue.creature.util.Item.getGoldValue ( )

Returns Goldvalue of this item.

Returns
Goldvalue of this Item
int rogue.creature.util.Item.getHealthBonus ( )

Returns Healthbonus of this Item

Returns
Healthbonus of this Item
int rogue.creature.util.Item.getMaxDurability ( )

Get Maximum Durability Value for this Item

Parameters
MaximumDurability of Item
String rogue.creature.util.Item.getName ( )

Returns Name of Item

Returns
Name of Item
void rogue.creature.util.Item.setEquipped ( boolean  equipped)

Sets Equipped Variable to new Value

void rogue.creature.util.Item.showItem ( Terminal  term,
Inventory  inventory 
)

Prints Information about given Item on Screen.

Parameters
termcurrently used terminal
inventorycurrently used inventory

Member Data Documentation

final int rogue.creature.util.Item.ITEMTYPE_BODY = 1
static

Describes Item as Chest Armor

Deprecated:
Unused, Armor Items should use Item.ITEMTYPE_HEAD instead
final int rogue.creature.util.Item.ITEMTYPE_HEAD = 0
static

Describes Item is as Helmet/Armor

final int rogue.creature.util.Item.ITEMTYPE_SWORD = 2
static

Describes Item as a Weapon (Sword)


The documentation for this class was generated from the following file: