cubex2.mods.customstuff2.scripting

Class ScriptableEntityPlayer

java.lang.Object

cubex2.mods.customstuff2.engine.ScriptObject

cubex2.mods.customstuff2.scripting.ScriptableEntity

cubex2.mods.customstuff2.scripting.ScriptableEntityLiving

cubex2.mods.customstuff2.scripting.ScriptableEntityPlayer

public class ScriptableEntityPlayer
extends ScriptableEntityLiving

Constructor Summary

Constructors

Constructor and Description
ScriptableEntityPlayer(net.minecraft.src.EntityPlayer player)

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int id, int count, int metadata) Adds items to the player's iventory if there's space for them.
void	addEnchantment(int slotId, int id, int level) Adds an enchantment to the itemstack in the given slot
int	addToSlot(int slotId, int count) Adds items to an inventory slot if it isn't empty
void	clearEnchantments(int slotId) Removes all enchantments from the itemstack in the given slot
void	clearInventory() Clears the player's inventory
void	clearSlot(int slotId) Clears an inventory slot
void	damageItem(int slotId, int count) Damages an item in the player's inventory
int	fillInventory(int id, int metadata) Fills the player's inventory.
int	fillSlot(int slotId) Fills an inventory slot if it isn't empty
int	getCurrentSlot() Gets the id of the slot the player is currently using
int	getHunger() Gets the player's hunger
int	getItemCount(int id, int metadata) Gets the count of a item in the player's inventory
int	getItemId(int slotId) Gets the item's id in the player's inventory
int	getItemMetadata(int slotId) Gets the item's metadata in the player's inventory
int	getItemStackSize(int slotId) Gets the item's stack size in the player's inventory
ScriptablePosition	getLookPos() Gets the position of the block, that the player is looking on
double	getSaturation() Gets the player's saturation
double	getStepHeight() Gets the step height
boolean	hasEnchantment(int slotId) Checks if the itemstack in the given slot has any enchantment
boolean	hasEnchantment(int slotId, int id) Checks if the itemstack has the given enchantment enchantment
boolean	hasEnchantment(int slotId, int id, int level) Checks if the itemstack has the given enchantment enchantment
void	openGui(java.lang.String guiName, int x, int y, int z) Opens a gui for the player.
void	openGui(java.lang.String guiName, ScriptablePosition position) Opens a gui for the player.
boolean	placeBlock(int x, int y, int z, int side, int id, int metadata, boolean flag) Places a block
boolean	placeBlock(ScriptablePosition position, int side, int id, int metadata, boolean flag) Places a block
int	remove(int id, int count, int metadata) Removes items from the player's inventory
void	removeEnchantment(int slotId, int id) Removes an enchantment from the itemstack in the given slot
int	removeFromSlot(int slotId, int count) Removes items from an inventory slot
void	repairItem(int slotId) Fully repairs an item in the player's inventory
void	repairItem(int slotId, int count) Repairs an item in the player's inventory
void	sendMessage(java.lang.String message) Adds a message to the player
void	setHunger(int hunger) Sets the player's hunger
void	setItemInUse() Sets the current item in use, so onusing is called.
void	setSaturation(double saturation) Sets the player's saturation
int	setSlot(int slotId, int id, int count, int metadata) Sets an inventory slot
void	setStepHeight(double f) Sets how high this entity can step up when running into a block to try to get over it

Methods inherited from class cubex2.mods.customstuff2.scripting.ScriptableEntityLiving

addPotionEffect, attack, colorSheep, getHealth, getLookingSide, getMaxHealth, growSheepWool, setHealth

Methods inherited from class cubex2.mods.customstuff2.scripting.ScriptableEntity

addVelocity, addVelocityToLookingDirection, dropItem, extinguish, getName, getPosX, getPosY, getPosZ, move, move, sePosition, setAir, setFire, setPosition, setPosX, setPosY, setPosZ, setVelocity, setVelocityToLookingDirection, shear

Methods inherited from class cubex2.mods.customstuff2.engine.ScriptObject

setContext, setEngine, setMod, setName, setScope

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptableEntityPlayer

public ScriptableEntityPlayer(net.minecraft.src.EntityPlayer player)

Method Detail

openGui

public void openGui(java.lang.String guiName,
           ScriptablePosition position)

Opens a gui for the player.

Parameters:

guiName - The name of the gui used for the name-attribute in the gui-file

position - The position of the block to open a gui for.

openGui

public void openGui(java.lang.String guiName,
           int x,
           int y,
           int z)

Opens a gui for the player.

Parameters:

guiName - The name of the gui used for the name-attribute in the gui-file

x - The x-coordinate of the block

y - The y-coordinate of the block

z - The z-coordinate of the block

setHunger

public void setHunger(int hunger)

Sets the player's hunger

Parameters:

hunger - The hunger to set

getHunger

public int getHunger()

Gets the player's hunger

Returns:

The player's hunger

setSaturation

public void setSaturation(double saturation)

Sets the player's saturation

Parameters:

saturation - The saturation to set

getSaturation

public double getSaturation()

Gets the player's saturation

Returns:

The player's saturation

setStepHeight

public void setStepHeight(double f)

Sets how high this entity can step up when running into a block to try to get over it

Parameters:

f - The step height

getStepHeight

public double getStepHeight()

Gets the step height

Returns:

The player's step height

sendMessage

public void sendMessage(java.lang.String message)

Adds a message to the player

Parameters:

message - The message to send

setItemInUse

public void setItemInUse()

Sets the current item in use, so onusing is called.

clearInventory

public void clearInventory()

Clears the player's inventory

fillInventory

public int fillInventory(int id,
                int metadata)

Fills the player's inventory. Existing items won't be replaced.

Parameters:

id - The item's id

metadata - The item's damage value

Returns:

The amount added to the inventory

add

public int add(int id,
      int count,
      int metadata)

Adds items to the player's iventory if there's space for them.

Parameters:

id - The item's id

count - The item's stack size

metadata - The item's damage value

Returns:

The amount added to the inventory

remove

public int remove(int id,
         int count,
         int metadata)

Removes items from the player's inventory

Parameters:

id - The item's id

count - The item's stack size

metadata - The item's damage value

Returns:

The amount removed from the inventory

clearSlot

public void clearSlot(int slotId)

Clears an inventory slot

Parameters:

slotId - The slot's id

fillSlot

public int fillSlot(int slotId)

Fills an inventory slot if it isn't empty

Parameters:

slotId - The slot's id

Returns:

The amount added to the slot

setSlot

public int setSlot(int slotId,
          int id,
          int count,
          int metadata)

Sets an inventory slot

Parameters:

slotId - The slot's id

id - The item's id

count - The item's stack size

metadata - The item's damage value

Returns:

The amount added or removed if there is already the same item in this slot or count if the slot is empty or an other item is in it

addToSlot

public int addToSlot(int slotId,
            int count)

Adds items to an inventory slot if it isn't empty

Parameters:

slotId - The slot's id

count - The count to add

Returns:

The amount added to the slot

removeFromSlot

public int removeFromSlot(int slotId,
                 int count)

Removes items from an inventory slot

Parameters:

slotId - The slot's id

count - The count of items to remove

Returns:

The amount removed from the slot

damageItem

public void damageItem(int slotId,
              int count)

Damages an item in the player's inventory

Parameters:

slotId - The slot's id

count - The damage to add to the item

repairItem

public void repairItem(int slotId)

Fully repairs an item in the player's inventory

Parameters:

slotId - The slot's id

repairItem

public void repairItem(int slotId,
              int count)

Repairs an item in the player's inventory

Parameters:

slotId - The slot's id

count - The damage to remove from the item

getItemId

public int getItemId(int slotId)

Gets the item's id in the player's inventory

Parameters:

slotId - The slot's id

Returns:

The item's id or -1 if it is empty

getItemStackSize

public int getItemStackSize(int slotId)

Gets the item's stack size in the player's inventory

Parameters:

slotId - The slot's id

Returns:

The item's stack size or -1 if it is empty

getItemMetadata

public int getItemMetadata(int slotId)

Gets the item's metadata in the player's inventory

Parameters:

slotId - The slot's id

Returns:

The item's metadata or -1 if it is empty

hasEnchantment

public boolean hasEnchantment(int slotId)

Checks if the itemstack in the given slot has any enchantment

Parameters:

slotId - The slot's id

Returns:

ture if the itemstack has any enchantment

hasEnchantment

public boolean hasEnchantment(int slotId,
                     int id)

Checks if the itemstack has the given enchantment enchantment

Parameters:

slotId - The slot's id

id - The id of the enchantment

Returns:

true if the itemstack in the given slot has the given enchantment

hasEnchantment

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

Checks if the itemstack has the given enchantment enchantment

Parameters:

slotId - The slot's id

id - The id of the enchantment

level - The level of the enchantment

Returns:

true if the itemstack in the given slot has the given enchantment and the given level

clearEnchantments

public void clearEnchantments(int slotId)

Removes all enchantments from the itemstack in the given slot

Parameters:

slotId - The slot's id

addEnchantment

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

Adds an enchantment to the itemstack in the given slot

Parameters:

slotId - The slot's id

id - The id of the enchantment

level - The level of the enchantment

removeEnchantment

public void removeEnchantment(int slotId,
                     int id)

Removes an enchantment from the itemstack in the given slot

Parameters:

slotId - The slot's id

id - The id of the enchantment

getItemCount

public int getItemCount(int id,
               int metadata)

Gets the count of a item in the player's inventory

Parameters:

id - The item's id

metadata - The item's damage value

Returns:

The count of the item

getCurrentSlot

public int getCurrentSlot()

Gets the id of the slot the player is currently using

Returns:

The current slot's id

placeBlock

public boolean placeBlock(ScriptablePosition position,
                 int side,
                 int id,
                 int metadata,
                 boolean flag)

Places a block

Parameters:

position - The position

side - On what side at position the block should be added

id - The block's id

metadata - The block's metadata

flag - If true the function will uses blocks from the inventory and won't place any block if the required block isn't in the player's inventory

Returns:

True if the block has been placed, false otherwise

placeBlock

public boolean placeBlock(int x,
                 int y,
                 int z,
                 int side,
                 int id,
                 int metadata,
                 boolean flag)

Places a block

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

side - On what side at position the block should be added

id - The block's id

metadata - The block's metadata

flag - If true the function will uses blocks from the inventory and won't place any block if the required block isn't in the player's inventory

Returns:

True if the block has been placed, false otherwise

getLookPos

public ScriptablePosition getLookPos()

Gets the position of the block, that the player is looking on

Returns:

The position or null if the player isn't looking on a block