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

Formatting!

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

23
src/main/java/WayofTime/bloodmagic/api/iface/IDocumentedBlock.java
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);