lauchmelder/BloodMagic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Javadoc warning cleanup

Browse source
This commit is contained in:
Nick 2016-01-01 10:52:42 -08:00
parent d4b5d3d3e2
commit 7ebd59382f
11 changed files with 103 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

33
src/main/java/WayofTime/bloodmagic/util/Utils.java
View file

@ -28,22 +28,35 @@ public class Utils
}
/**
* Used for inserting an ItemStack with a stacksize of 1 to a tile's
* inventory at slot 0. Returns {@code true} if the ItemStack is inserted,
* {@code false} otherwise
*
* EG: Block Altar
*
* @see #insertItemToTile(TileInventory, EntityPlayer, int)
*
* @param tile
* - The {@link TileInventory} to input the item to
* @param player
* - The player to take the item from.
*
* @return {@code true} if the ItemStack is inserted, {@code false} otherwise
*/
public static boolean insertItemToTile(TileInventory tile, EntityPlayer player)
{
return insertItemToTile(tile, player, 0);
}
/**
* Used for inserting an ItemStack with a stacksize of 1 to a tile's
* inventory at slot 0
*
* EG: Block Altar
*
* @param tile
* - The {@link TileInventory} to input the item to
* @param player
* - The player to take the item from.
* @param slot
* - The slot to attempt to insert to
*
* @return {@code true} if the ItemStack is inserted, {@code false} otherwise
*/
public static boolean insertItemToTile(TileInventory tile, EntityPlayer player, int slot)
{
if (tile.getStackInSlot(slot) == null && player.getHeldItem() != null)
@ -67,6 +80,14 @@ public class Utils
return false;
}
/**
* Gets a default block for each type of {@link EnumAltarComponent}
*
* @param component
* - The Component to provide a block for.
*
* @return The default Block for the EnumAltarComponent
*/
public static Block getBlockForComponent(EnumAltarComponent component)
{
switch (component)