Javadoc warning cleanup
This commit is contained in:
parent
d4b5d3d3e2
commit
7ebd59382f
11 changed files with 103 additions and 23 deletions
|
@ -64,6 +64,11 @@ public class BindableHelper
|
|||
|
||||
/**
|
||||
* @see BindableHelper#checkAndSetItemOwner(ItemStack, String)
|
||||
*
|
||||
* @param stack
|
||||
* - ItemStack to check
|
||||
* @param uuid
|
||||
* - UUID of the Player
|
||||
*/
|
||||
public static boolean checkAndSetItemOwner(ItemStack stack, UUID uuid)
|
||||
{
|
||||
|
|
|
@ -46,6 +46,9 @@ public class NetworkHelper
|
|||
|
||||
/**
|
||||
* @see NetworkHelper#getSoulNetwork(String)
|
||||
*
|
||||
* @param uuid
|
||||
* - The Player's Mojang UUID
|
||||
*/
|
||||
public static SoulNetwork getSoulNetwork(UUID uuid)
|
||||
{
|
||||
|
@ -54,6 +57,9 @@ public class NetworkHelper
|
|||
|
||||
/**
|
||||
* @see NetworkHelper#getSoulNetwork(String)
|
||||
*
|
||||
* @param player
|
||||
* - The Player
|
||||
*/
|
||||
public static SoulNetwork getSoulNetwork(EntityPlayer player)
|
||||
{
|
||||
|
@ -127,6 +133,16 @@ public class NetworkHelper
|
|||
return !(MinecraftForge.EVENT_BUS.post(event) || event.getResult() == Event.Result.DENY) && network.syphon(event.syphon) >= toSyphon;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the ItemStack has a user to be syphoned from.
|
||||
*
|
||||
* @param stack
|
||||
* - ItemStack to check
|
||||
* @param toSyphon
|
||||
* - Amount of LP to syphon
|
||||
*
|
||||
* @return - If syphoning is possible
|
||||
*/
|
||||
public static boolean canSyphonFromContainer(ItemStack stack, int toSyphon)
|
||||
{
|
||||
stack = NBTHelper.checkNBT(stack);
|
||||
|
|
|
@ -45,7 +45,12 @@ public class RitualHelper
|
|||
/**
|
||||
* Checks the RitualRegistry to see if the configuration of the ritual
|
||||
* stones in the world is valid for the given EnumFacing.
|
||||
*
|
||||
*
|
||||
* @param world
|
||||
* - The world
|
||||
* @param pos
|
||||
* - Location of the MasterRitualStone
|
||||
*
|
||||
* @return The ID of the valid ritual
|
||||
*/
|
||||
public static String getValidRitual(World world, BlockPos pos)
|
||||
|
@ -126,10 +131,7 @@ public class RitualHelper
|
|||
* Adds your Ritual to the {@link RitualRegistry#enabledRituals} Map. This
|
||||
* is used to determine whether your effect is enabled or not.
|
||||
*
|
||||
* The config option will be created as {@code B:ClassName=true} with a
|
||||
* comment of {@code Enables the ClassName ritual}.
|
||||
*
|
||||
* Use {@link #}
|
||||
* The config option will be created as {@code B:ClassName=true}.
|
||||
*
|
||||
* Should be safe to modify at any point.
|
||||
*
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue