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

Clean up some javadoc spam

Browse source 
Still need to figure out why delombok is priting an error for every non-BM import. It was apparently fixed in `gradle-lombok` 1.5 but it seems to have returned.
This commit is contained in:
Nick 2016-03-02 12:56:57 -08:00
parent fe18be56fd
commit 126d17b55d
11 changed files with 175 additions and 177 deletions
Download patch file Download diff file Expand all files Collapse all files

35
src/main/java/WayofTime/bloodmagic/api/soul/IDiscreteDemonWill.java
View file

@ -4,26 +4,47 @@ import net.minecraft.item.ItemStack;
public interface IDiscreteDemonWill
{
public double getWill(ItemStack soulStack);
/**
* Obtains the amount of Will an ItemStack contains.
*
* @param soulStack
* - The stack to retrieve the Will from
*
* @return - The amount of Will an ItemStack contains
*/
double getWill(ItemStack soulStack);
/**
* Drains the demonic will from the willStack. If all of the will is
* drained, the willStack will be removed. Will only drain in discrete
* amounts, determined by getDiscretization.
*
*
* @param willStack
* - The ItemStack of the will
* @param drainAmount
* - The amount of Will to drain
*
* @return The amount of will drained.
*/
public double drainWill(ItemStack willStack, double drainAmount);
double drainWill(ItemStack willStack, double drainAmount);
/**
* Gets the discrete number for this demonic will.
*
*
* @param willStack
* @return
* - The ItemStack of the will
*
* @return - The discrete number for the given stack.
*/
public double getDiscretization(ItemStack willStack);
double getDiscretization(ItemStack willStack);
public EnumDemonWillType getType(ItemStack willStack);
/**
* Obtains the type of will this is.
*
* @param willStack
* - The ItemStack of the will
*
* @return - The type of will this is.
*/
EnumDemonWillType getType(ItemStack willStack);
}