Formatting!

This commit is contained in:
WayofTime 2016-06-23 21:43:27 -04:00
parent d240daf958
commit 8c4eff0d81
30 changed files with 301 additions and 225 deletions

View file

@ -151,14 +151,14 @@ public class BloodMagicAPI
}
/**
* Used to add a {@link BlockStack} to the Transposition blacklist that cannot
* be changed via Configuration files.
*
* Used to add a {@link BlockStack} to the Transposition blacklist that
* cannot be changed via Configuration files.
*
* IMC:
* {@code FMLInterModComs.sendMessage("BloodMagic", "transpositionBlacklist", ItemStack)}
* Example:
* {@code FMLInterModComs.sendMessage("BloodMagic", "transpositionBlacklist", new ItemStack(Blocks.bedrock))}
*
*
* @param blockStack
* - The BlockStack to blacklist.
*/
@ -170,7 +170,7 @@ public class BloodMagicAPI
/**
* @see #addToTranspositionBlacklist(BlockStack)
*
*
* @param block
* - The block to blacklist
* @param meta
@ -183,7 +183,7 @@ public class BloodMagicAPI
/**
* @see #addToTranspositionBlacklist(BlockStack)
*
*
* @param block
* - The block to blacklist
*/

View file

@ -46,8 +46,8 @@ public class TeleposeEvent extends Event
}
/**
* Fired when a Teleposer attempts to move an Entity between locations. Can be cancelled to
* stop transposition.
* Fired when a Teleposer attempts to move an Entity between locations. Can
* be cancelled to stop transposition.
*/
@Cancelable
public static class Ent extends TeleposeEvent
@ -76,9 +76,11 @@ public class TeleposeEvent extends Event
/**
* Called after the entity has been transposed.
*/
public static class Post extends Ent {
public static class Post extends Ent
{
public Post(Entity entity, World initialWorld, BlockPos initialBlockPos, World finalWorld, BlockPos finalBlockPos) {
public Post(Entity entity, World initialWorld, BlockPos initialBlockPos, World finalWorld, BlockPos finalBlockPos)
{
super(entity, initialWorld, initialBlockPos, finalWorld, finalBlockPos);
}
}

View file

@ -11,24 +11,27 @@ import java.util.List;
/**
* Marks blocks as one that is documented.
*
* This documentation can be read by an {@link WayofTime.bloodmagic.item.ItemSanguineBook} (or child)
*
* This documentation can be read by an
* {@link WayofTime.bloodmagic.item.ItemSanguineBook} (or child)
*/
public interface IDocumentedBlock
{
/**
* Provides the documentation to provide to the player. Usually a short'n'sweet description about basic usage.
*
* Provides the documentation to provide to the player. Usually a
* short'n'sweet description about basic usage.
*
* @param player
* - The EntityPlayer attempting to view the Documentation.
* - The EntityPlayer attempting to view the Documentation.
* @param world
* - The World interaction is happening in.
* - The World interaction is happening in.
* @param pos
* - The BlockPos being interacted at.
* - The BlockPos being interacted at.
* @param state
* - The IBlockState of the interacted Block.
*
* @return - A list of formatted ITextComponent to provide to the player. Provide an empty list if there is no available documentation.
* - The IBlockState of the interacted Block.
*
* @return - A list of formatted ITextComponent to provide to the player.
* Provide an empty list if there is no available documentation.
*/
@Nonnull
List<ITextComponent> getDocumentation(EntityPlayer player, World world, BlockPos pos, IBlockState state);

View file

@ -19,7 +19,8 @@ public enum EnumRuneType implements IStringSerializable
public final TextFormatting colorCode;
EnumRuneType(TextFormatting colorCode) {
EnumRuneType(TextFormatting colorCode)
{
this.colorCode = colorCode;
}