cubex2.cs2core.scripting

Class ScriptableItemStack

java.lang.Object

cubex2.cs2core.scripting.ScriptableItemStack

public class ScriptableItemStack

extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScriptableItemStack(net.minecraft.item.ItemStack stack)

Method Summary

Methods

Modifier and Type	Method and Description
void	addEnchantment(int id, int level) Adds an enchantment to the itemstack
boolean	canEfficientlyBreak(int blockId, int metadata) Checks if the itemstack can efficiently break the given block.
boolean	canHarvest(int blockId, int metadata) Checks if the itemstack can harvest the given block.
void	clearEnchantments() Removes all enchantments from the itemstack
void	damageItem(int amount) Damages the item by the given amount
int	getDamage() Gets the stack's damage value
float	getFloatData(java.lang.String name) Gets the stack's float data
int	getId() Gets the stack's itemID
int	getIntData(java.lang.String name) Gets the stack's int data
int	getMaxStackSize() Gets the stack's maximum stack size
int	getStackSize() Gets the stack's stack size
java.lang.String	getStringData(java.lang.String name) Gets the stack's string data
boolean	hasEnchantment() Checks if the itemstack has any enchantment
boolean	hasEnchantment(int id) Checks if the itemstack has the given enchantment
boolean	hasEnchantment(int id, int level) Checks if the itemstack has the given enchantment.
void	removeEnchantment(int id) Removes an enchantment from the itemstack
void	setDamage(int damage) Sets the stack's damage value
void	setFloatData(java.lang.String name, float data) Sets the stack's float data
void	setId(int id) Sets the stack's itemID
void	setIntData(java.lang.String name, int data) Sets the stack's int data
void	setStackSize(int stackSize) Sets the stack's stack size
void	setStringData(java.lang.String name, java.lang.String data) Sets the stack's string data
void	setValues(int id, int stacksize, int meta) Sets the stack's itemID, damage value and stack size

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptableItemStack

public ScriptableItemStack(net.minecraft.item.ItemStack stack)

Method Detail

setValues

public void setValues(int id,

             int stacksize,

             int meta)

Sets the stack's itemID, damage value and stack size

Parameters:

id - The new itemID

stacksize - The new stack size

meta - The new damage value

setId

public void setId(int id)

Sets the stack's itemID

Parameters:

id - The new itemID

getId

public int getId()

Gets the stack's itemID

Returns:

The stack's itemID

setDamage

public void setDamage(int damage)

Sets the stack's damage value

Parameters:

damage - The new damage value

getDamage

public int getDamage()

Gets the stack's damage value

Returns:

The stack's damage value

setStackSize

public void setStackSize(int stackSize)

Sets the stack's stack size

Parameters:

stackSize - The new stack size

getStackSize

public int getStackSize()

Gets the stack's stack size

Returns:

The stack's stack size

getMaxStackSize

public int getMaxStackSize()

Gets the stack's maximum stack size

Returns:

The stack's maximum stack size

damageItem

public void damageItem(int amount)

Damages the item by the given amount

Parameters:

amount - The damage to add to the item

hasEnchantment

public boolean hasEnchantment()

Checks if the itemstack has any enchantment

Returns:

true if the itemstack has any enchantment

hasEnchantment

public boolean hasEnchantment(int id)

Checks if the itemstack has the given enchantment

Parameters:

id - The id of the enchantment

Returns:

true if the itemstack has the givem enchantment

hasEnchantment

public boolean hasEnchantment(int id,

                     int level)

Checks if the itemstack has the given enchantment.

Parameters:

id - The id of the enchantment

level - The level of the enchantment

Returns:

true if the itemstack has the given enchantment with the given level

clearEnchantments

public void clearEnchantments()

Removes all enchantments from the itemstack

addEnchantment

public void addEnchantment(int id,

                  int level)

Adds an enchantment to the itemstack

Parameters:

id - The id of the enchantment

level - The level of the enchantment

removeEnchantment

public void removeEnchantment(int id)

Removes an enchantment from the itemstack

Parameters:

id - The id of the enchantment

getIntData

public int getIntData(java.lang.String name)

Gets the stack's int data

Parameters:

name - The data's name

Returns:

The data or -1 if the data doesn't exist

getFloatData

public float getFloatData(java.lang.String name)

Gets the stack's float data

Parameters:

name - The data's name

Returns:

The data or -1.0 if the data doesn't exist

getStringData

public java.lang.String getStringData(java.lang.String name)

Gets the stack's string data

Parameters:

name - The data's name

Returns:

The data or null if the data doesn't exist

setIntData

public void setIntData(java.lang.String name,

              int data)

Sets the stack's int data

Parameters:

name - The data's name

data - The data

setFloatData

public void setFloatData(java.lang.String name,

                float data)

Sets the stack's float data

Parameters:

name - The data's name

data - The data

setStringData

public void setStringData(java.lang.String name,

                 java.lang.String data)

Sets the stack's string data

Parameters:

name - The data's name

data - The data

canEfficientlyBreak

public boolean canEfficientlyBreak(int blockId,

                          int metadata)

Checks if the itemstack can efficiently break the given block. It actually checks if it can harvest the block and if its efficiency against the block is higher than 1.0.

Parameters:

blockId - The block's id

metadata - The block's metadata

Returns:

true if the block can efficiently be breaked.

canHarvest

public boolean canHarvest(int blockId,

                 int metadata)

Checks if the itemstack can harvest the given block.

Parameters:

blockId - The block's id

metadata - The block's metadata

Returns:

true if the block can efficiently be breaked.