cubex2.cs2.scripting

Class ScriptableInventory

java.lang.Object

cubex2.cs2.scripting.ScriptableInventory

public class ScriptableInventory
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScriptableInventory(net.minecraft.inventory.IInventory inventory)

Method Summary

Methods

Modifier and Type	Method and Description
int	add(java.lang.String itemName, int count, int metadata) Add items the the inventory.
void	addEnchantment(int slotId, int id, int level) Add a certain enchantment to the item in a slot.
int	addToSlot(int slotId, int count) Add the given amount to a slot with the given id.
void	clear() Clear the inventory.
void	clearEnchantments(int slotId) Clear the enchantments of the item in a slot.
void	clearSlot(int slotId) Clear the slot with the given id.
void	damageItem(int slotId, int count) Damage the item in the slot with the given id.
int	fill(java.lang.String itemName, int metadata) Fill up the inventory with the given item.
int	fillSlot(int slotId) Fill up the slot with the given id.
int	getDamage(int slotId) Get the damage value of the item in the slot with the given id.
float	getFloatData(int slotId, java.lang.String name) Get a stack's float data.
int	getIntData(int slotId, java.lang.String name) Get a stack's integer data.
int	getItemCount(java.lang.String itemName, int metadata) Get the amount of an item in the inventory.
java.lang.String	getItemName(int slotId) Get the name of the item in the slot with the given id.
int	getMaxStackSize(int slotId) Get the maximum stack size of the item in the slot with the given id.
int	getStackSize(int slotId) Get the stack size of the item in the slot with the given id.
java.lang.String	getStringData(int slotId, java.lang.String name) Get a stack's string data.
boolean	hasEnchantment(int slotId, int id) Check if the item in a slot has a certain enchantment.
boolean	hasEnchantment(int slotId, int id, int level) Check if the item in a slot has a certain enchantment.
boolean	isItemEqual(int slot1, int slot2) Check if the items in two slots are equal
void	moveStack(int from, int to) Move as many items as possible from one slot to another.
int	remove(java.lang.String itemName, int count, int metadata) Remove items from the inventory.
void	removeEnnchantment(int slotId, int id) Remove a certain enchantment from the item in a slot.
int	removeFromSlot(int slotId, int count) Remove the given amount from a slot with the given id.
void	repairItem(int slotId) Repair the item in the slot with the given id.
void	repairItem(int slotId, int count) Repair the item in the slot with the given id by a certain amount.
void	setFloatData(int slotId, java.lang.String name, float data) Set a stack's float data.
void	setIntData(int slotId, java.lang.String name, int data) Set a stack's integer data.
int	setSlot(int slotId, java.lang.String itemName, int count, int metadata) Set the contents of the slot with the given id.
void	setStringData(int slotId, java.lang.String name, java.lang.String data) Set a stack's string data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptableInventory

public ScriptableInventory(net.minecraft.inventory.IInventory inventory)

Method Detail

clear

public void clear()

Clear the inventory.

fill

public int fill(java.lang.String itemName,
       int metadata)

Fill up the inventory with the given item.

Parameters:

itemName - The item's name

metadata - The item's damage value

Returns:

The amount added to the inventory

add

public int add(java.lang.String itemName,
      int count,
      int metadata)

Add items the the inventory.

Parameters:

itemName - The item's name

count - The amount to add to the inventory.

metadata - The item's damage value

Returns:

The amount added to the inventory

remove

public int remove(java.lang.String itemName,
         int count,
         int metadata)

Remove items from the inventory.

Parameters:

itemName - The item's name

count - The amount to remove from the inventory

metadata - The item's damage value

Returns:

The amount removed from the inventory

clearSlot

public void clearSlot(int slotId)

Clear the slot with the given id.

Parameters:

slotId - The slot's id

fillSlot

public int fillSlot(int slotId)

Fill up the slot with the given id. If the slot is empty, this does nothing.

Parameters:

slotId - The slot's id

Returns:

The amount added to the slot

setSlot

public int setSlot(int slotId,
          java.lang.String itemName,
          int count,
          int metadata)

Set the contents of the slot with the given id.

Parameters:

slotId - The slot's id

itemName - The item's name

count - The amount of the item

metadata - The item's damage value

Returns:

The given count if the slot's content doesn't match with the item or the amount added or removed if the slot's content matches with the item

addToSlot

public int addToSlot(int slotId,
            int count)

Add the given amount to a slot with the given id. If the slot is empty, this does nothing.

Parameters:

slotId - The slot's id

count - The amount to add to the slot

Returns:

The amount added to the slot

removeFromSlot

public int removeFromSlot(int slotId,
                 int count)

Remove the given amount from a slot with the given id. If the slot is empty, this does nothing.

Parameters:

slotId - The slot's id

count - The amount to remove from the slot

Returns:

The amount removed from the slot

damageItem

public void damageItem(int slotId,
              int count)

Damage the item in the slot with the given id. If the slot is empty or the item in the slot isn't damageable, this does nothing.

Parameters:

slotId - The slot's id

count - The amount of damage to add to the item

repairItem

public void repairItem(int slotId)

Repair the item in the slot with the given id. If the slot is empty or the item in the slot isn't damageable, this does nothing

Parameters:

slotId - The slot's id

repairItem

public void repairItem(int slotId,
              int count)

Repair the item in the slot with the given id by a certain amount. If the slot is empty or the item in the slot isn't damageable, this does nothing

Parameters:

slotId - The slot's id

count - The amount of damage to remove from the item

getItemName

public java.lang.String getItemName(int slotId)

Get the name of the item in the slot with the given id.

Parameters:

slotId - The slot's id

Returns:

The item's name or null if the slot doesn't exist or the slot is empty

getStackSize

public int getStackSize(int slotId)

Get the stack size of the item in the slot with the given id.

Parameters:

slotId - The slot's id

Returns:

The item's stack size or -1 if the slot doesn't exist or the slot is empty

getMaxStackSize

public int getMaxStackSize(int slotId)

Get the maximum stack size of the item in the slot with the given id.

Parameters:

slotId - The slot's id

Returns:

The item's maximum stack size or -1 if the slot doesn't exist or the slot is empty

getDamage

public int getDamage(int slotId)

Get the damage value of the item in the slot with the given id.

Parameters:

slotId - The slot's id

Returns:

The item's damage value or -1 if the slot doesn't exist or the slot is empty

getItemCount

public int getItemCount(java.lang.String itemName,
               int metadata)

Get the amount of an item in the inventory.

Parameters:

itemName - The item's name

metadata - The item's damage value

Returns:

The amount of the given item in the inventory

moveStack

public void moveStack(int from,
             int to)

Move as many items as possible from one slot to another.

Parameters:

from - The destination slot's id

to - The id of the slot to move the items to

isItemEqual

public boolean isItemEqual(int slot1,
                  int slot2)

Check if the items in two slots are equal

Parameters:

slot1 - The first slot's id

slot2 - The second slot's id

Returns:

True if the items are equal, false otherwise

hasEnchantment

public boolean hasEnchantment(int slotId,
                     int id)

Check if the item in a slot has a certain enchantment.

Parameters:

slotId - The slot's id

id - The enchantment's id

Returns:

True if the item has the enchantment, false otherwise

hasEnchantment

public boolean hasEnchantment(int slotId,
                     int id,
                     int level)

Check if the item in a slot has a certain enchantment.

Parameters:

slotId - The slot's id

id - The enchantment's id

level - The enchantment's level

Returns:

True if the item has the enchantment, false otherwise

clearEnchantments

public void clearEnchantments(int slotId)

Clear the enchantments of the item in a slot.

Parameters:

slotId - The slot's id

addEnchantment

public void addEnchantment(int slotId,
                  int id,
                  int level)

Add a certain enchantment to the item in a slot.

Parameters:

slotId - The slot's id

id - The enchantment's id

level - The enchantment's level

removeEnnchantment

public void removeEnnchantment(int slotId,
                      int id)

Remove a certain enchantment from the item in a slot.

Parameters:

slotId - The slot's id

id - The enchantment's id

getIntData

public int getIntData(int slotId,
             java.lang.String name)

Get a stack's integer data.

Parameters:

slotId - The slot's id

name - The data's name

Returns:

The data or -1 if the slot is empty or the data doesn't exist.

getFloatData

public float getFloatData(int slotId,
                 java.lang.String name)

Get a stack's float data.

Parameters:

slotId - The slot's id

name - The data's name

Returns:

The data or -1.0 if the slot is empty or the data doesn't exist.

getStringData

public java.lang.String getStringData(int slotId,
                             java.lang.String name)

Get a stack's string data.

Parameters:

slotId - The slot's id

name - The data's name

Returns:

The data or null if the slot is empty or the data doesn't exist.

setIntData

public void setIntData(int slotId,
              java.lang.String name,
              int data)

Set a stack's integer data.

Parameters:

slotId - The slot's id

name - The data's name

data - The data

setFloatData

public void setFloatData(int slotId,
                java.lang.String name,
                float data)

Set a stack's float data.

Parameters:

slotId - The slot's id

name - The data's name

data - The data

setStringData

public void setStringData(int slotId,
                 java.lang.String name,
                 java.lang.String data)

Set a stack's string data.

Parameters:

slotId - The slot's id

name - The data's name

data - The data