ScriptableEntityPlayer

java.lang.Object
- cubex2.cs2.scripting.ScriptableEntity
- - cubex2.cs2.scripting.ScriptableEntityLiving
  - - cubex2.cs2.scripting.ScriptableEntityPlayer

public class ScriptableEntityPlayer
extends ScriptableEntityLiving

Constructor Summary

Constructors
Constructor and Description

ScriptableEntityPlayer(net.minecraft.entity.player.EntityPlayer player)

Constructors
Constructor and Description
`ScriptableEntityPlayer(net.minecraft.entity.player.EntityPlayer player)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`add(java.lang.String itemName, 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
`void`	`addExperience(int amount)` Adds experience to the player
`void`	`addExperienceLevel(int amount)` Adds level to the player
`int`	`addToSlot(int slotId, int count)` Adds items to an inventory slot if it isn't empty
`boolean`	`canEfficientlyBreak(int slotId, java.lang.String blockName, int metadata)` Checks if the itemstack int the given slot can efficiently break the given block.
`boolean`	`canHarvest(int slotId, java.lang.String blockName, int metadata)` Checks if the itemstack in the given slot can harvest the given block.
`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(java.lang.String itemName, 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
`float`	`getExp()`
`int`	`getExperienceLevel()` Gets the player's level
`float`	`getHorizontalAngle()` Gets the player's horizontal look angle
`int`	`getHunger()` Gets the player's hunger
`int`	`getItemCount(java.lang.String itemName, int metadata)` Gets the count of a item in the player's inventory
`int`	`getItemMaxStackSize(int slotId)` Gets the maximum stack size of an item in the player's inventory
`int`	`getItemMetadata(int slotId)` Gets the item's metadata in the player's inventory
`java.lang.String`	`getItemName(int slotId)` Gets the item's id in the player's inventory
`int`	`getItemStackSize(int slotId)` Gets the item's stack size in the player's inventory
`int`	`getLookX()` Gets the x-coordinate of the block that the player is looking on.
`int`	`getLookY()` Gets the y-coordinate of the block that the player is looking on.
`int`	`getLookZ()` Gets the z-coordinate of the block that the player is looking on.
`float`	`getMaxHealth()` Gets the player's max health
`double`	`getSaturation()` Gets the player's saturation
`float`	`getStackFloatData(int slotId, java.lang.String name)` Gets a stack's float data.
`int`	`getStackIntData(int slotId, java.lang.String name)` Gets a stack's int data.
`java.lang.String`	`getStackStringData(int slotId, java.lang.String name)` Gets a stack's string data
`double`	`getStepHeight()` Gets the step height
`java.lang.String`	`getUsername()` Gets the player's username
`float`	`getVerticalAngle()` Gets the player's vertical look angle
`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
`boolean`	`isInCreative()` Get if the player is in creative mode
`boolean`	`isSneaking()` Check if the player is sneaking
`boolean`	`isSprinting()` Checks if the player is sprinting
`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, java.lang.String blockName, int metadata, boolean flag)` Places a block
`boolean`	`placeBlock(ScriptablePosition position, int side, java.lang.String blockName, int metadata, boolean flag)` Places a block
`int`	`remove(java.lang.String itemName, 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
`void`	`removeExperienceLevel(int amount)` Removes level from the player
`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`	`sendChat(java.lang.String chat)` Makes the player send a chat message as if the message was sent with the chat console.
`void`	`sendMessage(java.lang.String message)` Displays a message for the player.
`void`	`setExperienceLevel(int level)` Sets the player's level
`void`	`setHunger(int hunger)` Sets the player's hunger
`void`	`setItemInUse()` Sets the current item in use, so onUsing is called.
`void`	`setMaxHealth(int value)` Sets the player's max health
`void`	`setSaturation(double saturation)` Sets the player's saturation
`int`	`setSlot(int slotId, java.lang.String itemName, int count, int metadata)` Sets an inventory slot
`void`	`setStackFloatData(int slotId, java.lang.String name, float data)` Sets the stack's float data
`void`	`setStackIntData(int slotId, java.lang.String name, int data)` Sets the stack's int data
`void`	`setStackStringData(int slotId, java.lang.String name, java.lang.String data)` Sets the stack's string data
`void`	`setStepHeight(double f)` Sets how high this entity can step up when running into a block to try to get over it
`void`	`swingItem()` Swings the item the player is holding.

Methods inherited from class cubex2.cs2.scripting.ScriptableEntityLiving
addPotionEffect, attack, colorSheep, getHealth, getLookingSide, growSheepWool, setHealth

Methods inherited from class cubex2.cs2.scripting.ScriptableEntity
addVelocity, addVelocityToLookingDirection, asItem, asLiving, asPlayer, dropItem, extinguish, getFallDistance, getName, getNbt, getPosX, getPosY, getPosZ, getVelocityX, getVelocityY, getVelocityZ, isItem, isLiving, isPlayer, move, move, setAir, setFallDistance, setFire, setMod, setPosition, setPosition, setPosX, setPosY, setPosZ, setVelocity, setVelocityToLookingDirection, setVelocityX, setVelocityY, setVelocityZ, shear

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScriptableEntityPlayer
```
public ScriptableEntityPlayer(net.minecraft.entity.player.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)
```
    Displays a message for the player.
    
    Parameters:
    
    message - The message to display
  - sendChat
```
public void sendChat(java.lang.String chat)
```
    Makes the player send a chat message as if the message was sent with the chat console. Commands will work this way.
    
    Parameters:
    
    chat - The chat message
  - 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(java.lang.String itemName,
                         int metadata)
```
    Fills the player's inventory. Existing items won't be replaced.
    
    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)
```
    Adds items to the player's iventory if there's space for them.
    
    Parameters:
    
    itemName - The item's name
    
    count - The item's stack size
    
    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)
```
    Removes items from the player's inventory
    
    Parameters:
    
    itemName - The item's name
    
    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,
                   java.lang.String itemName,
                   int count,
                   int metadata)
```
    Sets an inventory slot
    
    Parameters:
    
    slotId - The slot's id
    
    itemName - The item's name
    
    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
  - getItemName
```
public java.lang.String getItemName(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 the slot 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 the slot is empty
  - getItemMaxStackSize
```
public int getItemMaxStackSize(int slotId)
```
    Gets the maximum stack size of an item in the player's inventory
    
    Parameters:
    
    slotId - The slot's id
    
    Returns:
    
    The item's maximum stack size or -1 if the slot 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 the slot 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(java.lang.String itemName,
                        int metadata)
```
    Gets the count of a item in the player's inventory
    
    Parameters:
    
    itemName - The item's name
    
    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,
                          java.lang.String blockName,
                          int metadata,
                          boolean flag)
```
    Places a block
    
    Parameters:
    
    position - The position
    
    side - On what side at position the block should be added
    
    blockName - The block's name
    
    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,
                          java.lang.String blockName,
                          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
    
    blockName - The block's name
    
    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
  - getLookX
```
public int getLookX()
```
    Gets the x-coordinate of the block that the player is looking on.
    
    Returns:
    
    The x-coordinate or -1 if the player isn't looking on any block
  - getLookY
```
public int getLookY()
```
    Gets the y-coordinate of the block that the player is looking on.
    
    Returns:
    
    The y-coordinate or -1 if the player isn't looking on any block
  - getLookZ
```
public int getLookZ()
```
    Gets the z-coordinate of the block that the player is looking on.
    
    Returns:
    
    The z-coordinate or -1 if the player isn't looking on any block
  - addExperience
```
public void addExperience(int amount)
```
    Adds experience to the player
    
    Parameters:
    
    amount - The amount of xp
  - addExperienceLevel
```
public void addExperienceLevel(int amount)
```
    Adds level to the player
    
    Parameters:
    
    amount - The amount of levels
  - removeExperienceLevel
```
public void removeExperienceLevel(int amount)
```
    Removes level from the player
    
    Parameters:
    
    amount - The amount of levels
  - setExperienceLevel
```
public void setExperienceLevel(int level)
```
    Sets the player's level
    
    Parameters:
    
    level - The level
  - getExperienceLevel
```
public int getExperienceLevel()
```
    Gets the player's level
    
    Returns:
  - getHorizontalAngle
```
public float getHorizontalAngle()
```
    Gets the player's horizontal look angle
    
    Returns:
  - getVerticalAngle
```
public float getVerticalAngle()
```
    Gets the player's vertical look angle
    
    Returns:
  - getUsername
```
public java.lang.String getUsername()
```
    Gets the player's username
    
    Returns:
  - isSneaking
```
public boolean isSneaking()
```
    Check if the player is sneaking
    
    Returns:
  - isSprinting
```
public boolean isSprinting()
```
    Checks if the player is sprinting
    
    Returns:
  - getStackIntData
```
public int getStackIntData(int slotId,
                           java.lang.String name)
```
    Gets a stack's int data.
    
    Parameters:
    
    slotId - The slot's id
    
    name - The name of the data
    
    Returns:
    
    The data or -1 if the slot is empty or the data doesn't exist.
  - getStackFloatData
```
public float getStackFloatData(int slotId,
                               java.lang.String name)
```
    Gets a stack's float data.
    
    Parameters:
    
    slotId - The slot's id
    
    name - The name of the data
    
    Returns:
    
    The data or -1.0 if the slot is empty or the data doesn't exist.
  - getStackStringData
```
public java.lang.String getStackStringData(int slotId,
                                           java.lang.String name)
```
    Gets a stack's string data
    
    Parameters:
    
    slotId - The slot's id
    
    name - The name of the data
    
    Returns:
    
    The data or null if the slot is empty or the data doesn't exist.
  - setStackIntData
```
public void setStackIntData(int slotId,
                            java.lang.String name,
                            int data)
```
    Sets the stack's int data
    
    Parameters:
    
    slotId - The slot's id
    
    name - The name of the data
    
    data - The data
  - setStackFloatData
```
public void setStackFloatData(int slotId,
                              java.lang.String name,
                              float data)
```
    Sets the stack's float data
    
    Parameters:
    
    slotId - The slot's id
    
    name - The name of the data
    
    data - The data
  - setStackStringData
```
public void setStackStringData(int slotId,
                               java.lang.String name,
                               java.lang.String data)
```
    Sets the stack's string data
    
    Parameters:
    
    slotId - The slot's id
    
    name - The name of the data
    
    data - The data
  - setMaxHealth
```
public void setMaxHealth(int value)
```
    Sets the player's max health
    
    Parameters:
    
    value - The new max health
  - getMaxHealth
```
public float getMaxHealth()
```
    Gets the player's max health
    
    Overrides:
    
    getMaxHealth in class ScriptableEntityLiving
    
    Returns:
    
    The maximum health
  - canEfficientlyBreak
```
public boolean canEfficientlyBreak(int slotId,
                                   java.lang.String blockName,
                                   int metadata)
```
    Checks if the itemstack int the given slot 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:
    
    slotId - The slot's id
    
    blockName - The block's name
    
    metadata - The block's metadata
    
    Returns:
    
    true if the block can efficiently be breaked.
  - canHarvest
```
public boolean canHarvest(int slotId,
                          java.lang.String blockName,
                          int metadata)
```
    Checks if the itemstack in the given slot can harvest the given block.
    
    Parameters:
    
    slotId - The slot's id
    
    blockName - The block's name
    
    metadata - The block's metadata
    
    Returns:
    
    true if the block can efficiently be breaked.
  - swingItem
```
public void swingItem()
```
    Swings the item the player is holding.
  - isInCreative
```
public boolean isInCreative()
```
    Get if the player is in creative mode
    
    Returns:
    
    true if the player is in creative mode false otherwise
  - getExp
```
public float getExp()
```

Class ScriptableEntityPlayer

Constructor Summary

Method Summary

Methods inherited from class cubex2.cs2.scripting.ScriptableEntityLiving

Methods inherited from class cubex2.cs2.scripting.ScriptableEntity

Methods inherited from class java.lang.Object

Constructor Detail

ScriptableEntityPlayer

Method Detail

openGui

openGui

setHunger

getHunger

setSaturation

getSaturation

setStepHeight

getStepHeight

sendMessage

sendChat

setItemInUse

clearInventory

fillInventory

add

remove

clearSlot

fillSlot

setSlot

addToSlot

removeFromSlot

damageItem

repairItem

repairItem

getItemName

getItemStackSize

getItemMaxStackSize

getItemMetadata

hasEnchantment

hasEnchantment

hasEnchantment

clearEnchantments

addEnchantment

removeEnchantment

getItemCount

getCurrentSlot

placeBlock

placeBlock

getLookX

getLookY

getLookZ

addExperience

addExperienceLevel

removeExperienceLevel

setExperienceLevel

getExperienceLevel

getHorizontalAngle

getVerticalAngle

getUsername

isSneaking

isSprinting

getStackIntData

getStackFloatData

getStackStringData

setStackIntData

setStackFloatData

setStackStringData

setMaxHealth

getMaxHealth

canEfficientlyBreak

canHarvest

swingItem

isInCreative

getExp