OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-09 19:49:35 +01:00
Code Issues Projects Releases Packages Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse source 
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
Bukkit/Spigot 2013-03-20 00:42:05 -04:00
parent 9c2b722bd3
commit e5d1bf5f8d
4 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
paper-api/src/main/java/org/bukkit/block/Skull.java
View file

@ -17,7 +17,7 @@ public interface Skull extends BlockState {
/** /**
* Gets the owner of the skull * Gets the owner of the skull
* *
* @return the owner if the skull * @return the owner of the skull
*/ */
public String getOwner(); public String getOwner();

8
paper-api/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java
View file

@ -28,18 +28,18 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable {
} }
/** /**
* Gets the amount of damage caused by the Block * Gets the amount of damage caused by the event
* *
* @return The amount of damage caused by the Block * @return The amount of damage caused by the event
*/ */
public int getDamage() { public int getDamage() {
return damage; return damage;
} }
/** /**
* Sets the amount of damage caused by the Block * Sets the amount of damage caused by the event
* *
* @param damage The amount of damage caused by the Block * @param damage The amount of damage caused by the event
*/ */
public void setDamage(int damage) { public void setDamage(int damage) {
this.damage = damage; this.damage = damage;

25
paper-api/src/main/java/org/bukkit/inventory/Inventory.java
View file

@ -71,8 +71,15 @@ public interface Inventory extends Iterable<ItemStack> {
* <p /> * <p />
* The returned HashMap contains what it couldn't store, where the key is the * The returned HashMap contains what it couldn't store, where the key is the
* index of the parameter, and the value is the ItemStack at that index * index of the parameter, and the value is the ItemStack at that index
* of the variadic parameter. If all items are stored, it will return an * of the varargs parameter. If all items are stored, it will return an
* empty HashMap. * empty HashMap.
* <p />
* If you pass in ItemStacks which exceed the maximum stack size for the
* Material, first they will be added to partial stacks where
* Material.getMaxStackSize() is not exceeded, up to
* Material.getMaxStackSize(). When there are no partial stacks left
* stacks will be split on Inventory.getMaxStackSize() allowing you to
* exceed the maximum stack size for that material.
* *
* @param items The ItemStacks to add * @param items The ItemStacks to add
* @return A HashMap containing items that didn't fit. * @return A HashMap containing items that didn't fit.
@ -88,7 +95,7 @@ public interface Inventory extends Iterable<ItemStack> {
* <p /> * <p />
* The returned HashMap contains what it couldn't remove, where the key is the * The returned HashMap contains what it couldn't remove, where the key is the
* index of the parameter, and the value is the ItemStack at that index of the * index of the parameter, and the value is the ItemStack at that index of the
* variadic parameter. If all the given ItemStacks are removed, it will return * varargs parameter. If all the given ItemStacks are removed, it will return
* an empty HashMap. * an empty HashMap.
* *
* @param items The ItemStacks to remove * @param items The ItemStacks to remove
@ -169,12 +176,7 @@ public interface Inventory extends Iterable<ItemStack> {
public boolean contains(ItemStack item, int amount); public boolean contains(ItemStack item, int amount);
/** /**
* Returns a HashMap with all slots and ItemStacks in the inventory with * Checks if the inventory contains any ItemStacks matching the given ItemStack and at least the minimum amount specified
* given materialId.
* <p />
* The HashMap contains entries where, the key is the slot index, and the
* value is the ItemStack in that slot. If no matching ItemStack with the
* given materialId is found, an empty map is returned.
* *
* @param item The ItemStack to match against * @param item The ItemStack to match against
* @param amount The minimum amount * @param amount The minimum amount
@ -183,7 +185,12 @@ public interface Inventory extends Iterable<ItemStack> {
public boolean containsAtLeast(ItemStack item, int amount); public boolean containsAtLeast(ItemStack item, int amount);
/** /**
* Find all slots in the inventory containing any ItemStacks with the given materialId. * Returns a HashMap with all slots and ItemStacks in the inventory with
* given materialId.
* <p />
* The HashMap contains entries where, the key is the slot index, and the
* value is the ItemStack in that slot. If no matching ItemStack with the
* given materialId is found, an empty map is returned.
* *
* @param materialId The materialId to look for * @param materialId The materialId to look for
* @return A HashMap containing the slot index, ItemStack pairs * @return A HashMap containing the slot index, ItemStack pairs

2
paper-api/src/main/java/org/bukkit/material/MaterialData.java
View file

@ -75,7 +75,7 @@ public class MaterialData implements Cloneable {
/** /**
* Creates a new ItemStack based on this MaterialData * Creates a new ItemStack based on this MaterialData
* *
* @param amount The stack size of the new stak * @param amount The stack size of the new stack
* @return New ItemStack containing a copy of this MaterialData * @return New ItemStack containing a copy of this MaterialData
*/ */
public ItemStack toItemStack(int amount) { public ItemStack toItemStack(int amount) {