Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here. By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
@@ -24,7 +24,8 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
|
||||
/**
|
||||
* Get the player's inventory.
|
||||
*
|
||||
* @return The inventory of the player, this also contains the armor slots.
|
||||
* @return The inventory of the player, this also contains the armor
|
||||
* slots.
|
||||
*/
|
||||
public PlayerInventory getInventory();
|
||||
|
||||
@@ -36,8 +37,8 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
|
||||
public Inventory getEnderChest();
|
||||
|
||||
/**
|
||||
* If the player currently has an inventory window open, this method will set a
|
||||
* property of that window, such as the state of a progress bar.
|
||||
* If the player currently has an inventory window open, this method will
|
||||
* set a property of that window, such as the state of a progress bar.
|
||||
*
|
||||
* @param prop The property.
|
||||
* @param value The value to set the property to.
|
||||
@@ -46,16 +47,16 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
|
||||
public boolean setWindowProperty(InventoryView.Property prop, int value);
|
||||
|
||||
/**
|
||||
* Gets the inventory view the player is currently viewing. If they do not have
|
||||
* an inventory window open, it returns their internal crafting view.
|
||||
* Gets the inventory view the player is currently viewing. If they do not
|
||||
* have an inventory window open, it returns their internal crafting view.
|
||||
*
|
||||
* @return The inventory view.
|
||||
*/
|
||||
public InventoryView getOpenInventory();
|
||||
|
||||
/**
|
||||
* Opens an inventory window with the specified inventory on the top and the player's inventory
|
||||
* on the bottom.
|
||||
* Opens an inventory window with the specified inventory on the top and
|
||||
* the player's inventory on the bottom.
|
||||
*
|
||||
* @param inventory The inventory to open
|
||||
* @return The newly opened inventory view
|
||||
@@ -63,22 +64,28 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
|
||||
public InventoryView openInventory(Inventory inventory);
|
||||
|
||||
/**
|
||||
* Opens an empty workbench inventory window with the player's inventory on the bottom.
|
||||
* Opens an empty workbench inventory window with the player's inventory
|
||||
* on the bottom.
|
||||
*
|
||||
* @param location The location to attach it to. If null, the player's location is used.
|
||||
* @param force If false, and there is no workbench block at the location, no inventory will be
|
||||
* opened and null will be returned.
|
||||
* @return The newly opened inventory view, or null if it could not be opened.
|
||||
* @param location The location to attach it to. If null, the player's
|
||||
* location is used.
|
||||
* @param force If false, and there is no workbench block at the location,
|
||||
* no inventory will be opened and null will be returned.
|
||||
* @return The newly opened inventory view, or null if it could not be
|
||||
* opened.
|
||||
*/
|
||||
public InventoryView openWorkbench(Location location, boolean force);
|
||||
|
||||
/**
|
||||
* Opens an empty enchanting inventory window with the player's inventory on the bottom.
|
||||
* Opens an empty enchanting inventory window with the player's inventory
|
||||
* on the bottom.
|
||||
*
|
||||
* @param location The location to attach it to. If null, the player's location is used.
|
||||
* @param force If false, and there is no enchanting table at the location, no inventory will be
|
||||
* opened and null will be returned.
|
||||
* @return The newly opened inventory view, or null if it could not be opened.
|
||||
* @param location The location to attach it to. If null, the player's
|
||||
* location is used.
|
||||
* @param force If false, and there is no enchanting table at the
|
||||
* location, no inventory will be opened and null will be returned.
|
||||
* @return The newly opened inventory view, or null if it could not be
|
||||
* opened.
|
||||
*/
|
||||
public InventoryView openEnchanting(Location location, boolean force);
|
||||
|
||||
@@ -110,8 +117,8 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
|
||||
public void setItemInHand(ItemStack item);
|
||||
|
||||
/**
|
||||
* Returns the ItemStack currently on your cursor, can be empty.
|
||||
* Will always be empty if the player currently has no open window.
|
||||
* Returns the ItemStack currently on your cursor, can be empty. Will
|
||||
* always be empty if the player currently has no open window.
|
||||
*
|
||||
* @return The ItemStack of the item you are currently moving around.
|
||||
*/
|
||||
@@ -119,7 +126,8 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
|
||||
|
||||
/**
|
||||
* Sets the item to the given ItemStack, this will replace whatever the
|
||||
* user was moving. Will always be empty if the player currently has no open window.
|
||||
* user was moving. Will always be empty if the player currently has no
|
||||
* open window.
|
||||
*
|
||||
* @param item The ItemStack which will end up in the hand
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user