Formatting!

This commit is contained in:
WayofTime 2016-04-05 16:16:17 -04:00
parent 029091852d
commit b56bbef29e
14 changed files with 57 additions and 54 deletions

View file

@ -1,8 +1,7 @@
package WayofTime.bloodmagic.api.altar;
/**
* List of different components used to construct
* different tiers of altars.
* List of different components used to construct different tiers of altars.
*/
public enum EnumAltarComponent
{

View file

@ -15,9 +15,9 @@ public class BoundToolEvent extends Event
}
/**
* This event is called when a {@link WayofTime.bloodmagic.item.ItemBoundTool}
* is being charged.
*
* This event is called when a
* {@link WayofTime.bloodmagic.item.ItemBoundTool} is being charged.
*
* If canceled, will result in the charging being canceled.
*/
@ -34,9 +34,9 @@ public class BoundToolEvent extends Event
}
/**
* This event is called when a {@link WayofTime.bloodmagic.item.ItemBoundTool}'s
* charge is released.
*
* This event is called when a
* {@link WayofTime.bloodmagic.item.ItemBoundTool}'s charge is released.
*
* If canceled, will result in the charge not being released.
*/

View file

@ -13,16 +13,17 @@ public class ItemBindEvent extends Event
public ItemStack itemStack;
/**
* This event is called whenever a player attempts to bind a {@link WayofTime.bloodmagic.api.iface.IBindable} item.
*
* This event is called whenever a player attempts to bind a
* {@link WayofTime.bloodmagic.api.iface.IBindable} item.
*
* @param player
* The player doing the binding
* @param key
* The UUID of the player doing the binding
* @param itemStack
* The {@link ItemStack} that the player is binding
*
* This event is {@link Cancelable}.<br>
*
* This event is {@link Cancelable}.<br>
*/
public ItemBindEvent(EntityPlayer player, String key, ItemStack itemStack)
{

View file

@ -15,9 +15,10 @@ public class SacrificeKnifeUsedEvent extends Event
public boolean shouldFillAltar;
/**
* This event is called whenever a player attempts to use a {@link WayofTime.bloodmagic.item.ItemSacrificialDagger}
* to self-sacrifice near an altar.
*
* This event is called whenever a player attempts to use a
* {@link WayofTime.bloodmagic.item.ItemSacrificialDagger} to self-sacrifice
* near an altar.
*
* @param player
* The player doing the sacrificing
* @param shouldDrainHealth
@ -28,8 +29,8 @@ public class SacrificeKnifeUsedEvent extends Event
* Amount of health lost
* @param lpAdded
* Amount of LP added to the altar
*
* This event is {@link Cancelable}.<br>
*
* This event is {@link Cancelable}.<br>
*/
public SacrificeKnifeUsedEvent(EntityPlayer player, boolean shouldDrainHealth, boolean shouldFillAltar, int hp, int lpAdded)
{

View file

@ -7,9 +7,9 @@ import net.minecraftforge.fml.common.eventhandler.Event;
/**
* Base event class for Soul Network related events.
*
* {@link #ownerUUID} contains the owner's UUID
* {@link #syphon} contains the amount of LP to be drained
*
* {@link #ownerUUID} contains the owner's UUID {@link #syphon} contains the
* amount of LP to be drained
*/
public class SoulNetworkEvent extends Event
{
@ -23,9 +23,10 @@ public class SoulNetworkEvent extends Event
}
/**
* This event is called when an {@link WayofTime.bloodmagic.api.impl.ItemBindable}
* is being drained inside of a {@link net.minecraft.tileentity.TileEntity}.
*
* This event is called when an
* {@link WayofTime.bloodmagic.api.impl.ItemBindable} is being drained
* inside of a {@link net.minecraft.tileentity.TileEntity}.
*
* If canceled, the drain will not be executed.
*/
@Cancelable
@ -41,9 +42,8 @@ public class SoulNetworkEvent extends Event
}
/**
* This event is called when a {@link EntityPlayer}
* drains the Soul Network
*
* This event is called when a {@link EntityPlayer} drains the Soul Network
*
* If canceled, the drain will not be executed.
*/
@Cancelable

View file

@ -1,8 +1,8 @@
package WayofTime.bloodmagic.api.iface;
/**
* Used for all {@link WayofTime.bloodmagic.api.impl.ItemSigil}
* <b>EXCEPT</b> Sigils of Holdings.
* Used for all {@link WayofTime.bloodmagic.api.impl.ItemSigil} <b>EXCEPT</b>
* Sigils of Holdings.
*/
public interface ISigil
{

View file

@ -50,8 +50,7 @@ public class AlchemyArrayRecipeRegistry
if (eff != null)
{
return; // Recipe already exists!
}
else
} else
{
arrayRecipe.catalystMap.put(ItemStackWrapper.getHolder(catalystStack), arrayEffect);
if (circleRenderer != null)
@ -64,8 +63,7 @@ public class AlchemyArrayRecipeRegistry
if (circleRenderer == null)
{
recipes.put(input, new AlchemyArrayRecipe(input, catalystStack, arrayEffect, defaultRenderer));
}
else
} else
{
recipes.put(input, new AlchemyArrayRecipe(input, catalystStack, arrayEffect, circleRenderer));
}
@ -168,8 +166,7 @@ public class AlchemyArrayRecipeRegistry
{
if (ItemStackWrapper.getHolder(arrayRecipe.getInput().get(0)).equals(ItemStackWrapper.getHolder(input.get(0))))
return arrayRecipe.getAlchemyArrayEffectForCatalyst(catalystStack); // TODO: Decide if a copy should be returned.
}
else
} else
{
if (input.equals(arrayRecipe.getInput()))
return arrayRecipe.getAlchemyArrayEffectForCatalyst(catalystStack);
@ -235,8 +232,8 @@ public class AlchemyArrayRecipeRegistry
}
/**
* Compares the inputed list of ItemStacks to see if it matches with the recipe's
* list.
* Compares the inputed list of ItemStacks to see if it matches with the
* recipe's list.
*
* @param comparedList
* - The list to compare with

View file

@ -18,11 +18,13 @@ public class AltarRecipeRegistry
private static BiMap<List<ItemStack>, AltarRecipe> recipes = HashBiMap.create();
/**
* Registers an {@link AltarRecipe} for the Blood Altar. This can be a {@code ItemStack}, {@code List<Itemstack>},
* or {@code String} OreDictionary entry.
*
* If the OreDictionary entry does not exist or is empty, it will not be registered.
*
* Registers an {@link AltarRecipe} for the Blood Altar. This can be a
* {@code ItemStack}, {@code List<Itemstack>}, or {@code String}
* OreDictionary entry.
*
* If the OreDictionary entry does not exist or is empty, it will not be
* registered.
*
* @param altarRecipe
* - The AltarRecipe to register
*/
@ -41,9 +43,9 @@ public class AltarRecipeRegistry
/**
* Gets the recipe that the provided input is registered to.
*
*
* @param input
* - The input ItemStack to get the recipe for
* - The input ItemStack to get the recipe for
* @return - The recipe that the provided input is registered to.
*/
public static AltarRecipe getRecipeForInput(List<ItemStack> input)
@ -76,7 +78,7 @@ public class AltarRecipeRegistry
* {@link WayofTime.bloodmagic.tile.TileAltar}. The output ItemStack is
* allowed to be null as some recipes do not contain an output. (Blood
* Orbs)
*
*
* @param input
* - The input ItemStack
* @param output

View file

@ -25,7 +25,8 @@ public class PropertyString extends PropertyHelper<String>
}
@SideOnly(Side.CLIENT)
public Optional<String> parseValue(String value) {
public Optional<String> parseValue(String value)
{
return allowedValues.contains(value) ? Optional.of(value) : Optional.<String>absent();
}

View file

@ -16,7 +16,7 @@ public interface IMeshProvider
{
/**
* Gets the custom ItemMeshDefinition to use for the item.
*
*
* @return - the custom ItemMeshDefinition to use for the item.
*/
@SideOnly(Side.CLIENT)
@ -24,16 +24,16 @@ public interface IMeshProvider
/**
* Gets all possible variants for this item
*
*
* @return - All possible variants for this item
*/
List<String> getVariants();
/**
* If a custom ResourceLocation is required, return it here.
*
*
* Can be null if unneeded.
*
*
* @return - The custom ResourceLocation
*/
@Nullable

View file

@ -10,7 +10,8 @@ import net.minecraft.init.Blocks;
import net.minecraft.util.math.BlockPos;
import net.minecraft.world.World;
public class TranquilityHandlers {
public class TranquilityHandlers
{
public static class Plant implements ITranquilityHandler
{

View file

@ -94,7 +94,7 @@ public class ItemBoundSword extends ItemSword implements IBindable, IActivatable
NBTHelper.checkNBT(stack);
if (TextHelper.canTranslate("tooltip.BloodMagic.bound.sword.desc"))
tooltip.add(TextHelper.localizeEffect("tooltip.BloodMagic.bound.sword.desc"));
tooltip.add(TextHelper.localizeEffect("tooltip.BloodMagic.bound.sword.desc"));
tooltip.add(TextHelper.localize("tooltip.BloodMagic." + (getActivated(stack) ? "activated" : "deactivated")));

View file

@ -35,8 +35,8 @@ public class ChatUtil
}
/**
* Returns a standard {@link TextComponentString} for the given {@link String}
* .
* Returns a standard {@link TextComponentString} for the given
* {@link String} .
*
* @param s
* The string to wrap.

View file

@ -69,7 +69,8 @@ public class TextHelper
return cutLongString(string, 30);
}
public static boolean canTranslate(String key) {
public static boolean canTranslate(String key)
{
return I18n.canTranslate(key);
}
}