Minor code and documentation cleanup. (#4664)

This commit is contained in:
mezz authored and GitHub committed 2018-01-12 23:54:29 -08:00
1 parent 0c0cb2b11a
commit d0bdb23300
52 files changed
+227 -249

No files matched your search

@@ -43,12 +43,12 @@ public interface IShearable
* Checks if the object is currently shearable
* Example: Sheep return false when they have no wool
*
* @param item The itemstack that is being used, Possible to be null
* @param world The current world
* @param item The ItemStack that is being used, may be empty.
* @param world The current world.
* @param pos Block's position in world.
* @return If this is shearable, and onSheared should be called.
*/
public boolean isShearable(@Nonnull ItemStack item, IBlockAccess world, BlockPos pos);
boolean isShearable(@Nonnull ItemStack item, IBlockAccess world, BlockPos pos);
/**
* Performs the shear function on this object.
@@ -62,11 +62,12 @@ public interface IShearable
* For entities, they should trust there internal location information
* over the values passed into this function.
*
* @param item The itemstack that is being used, Possible to be null
* @param world The current world
* @param item The ItemStack that is being used, may be empty.
* @param world The current world.
* @param pos If this is a block, the block's position in world.
* @param fortune The fortune level of the shears being used
* @return A ArrayList containing all items from this shearing. Possible to be null.
* @param fortune The fortune level of the shears being used.
* @return A List containing all items from this shearing. May be empty.
*/
public List<ItemStack> onSheared(@Nonnull ItemStack item, IBlockAccess world, BlockPos pos, int fortune);
@Nonnull
List<ItemStack> onSheared(@Nonnull ItemStack item, IBlockAccess world, BlockPos pos, int fortune);
}