me.desht.pneumaticcraft.api.client.pneumatic_helmet

Interface IBlockTrackEntry

All Known Implementing Classes:

BlockTrackEntryEndPortalFrame, BlockTrackEntryEnergy, BlockTrackEntryFluid, BlockTrackEntryHackable, BlockTrackEntryInventory, BlockTrackEntryMisc, BlockTrackEntryMobSpawner, BlockTrackEntryThaumcraft

public interface IBlockTrackEntry

Implement this class and register it with IPneumaticHelmetRegistry.registerBlockTrackEntry(IBlockTrackEntry). Your implementation must provide a no-parameter constructor. For every entity that's applicable for this definition, an instance is created.

Method Summary

Modifier and Type	Method and Description
void	addInformation(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.tileentity.TileEntity te, net.minecraft.util.Direction face, java.util.List<net.minecraft.util.text.ITextComponent> infoList) This method is called each client tick to retrieve the block's additional information.
net.minecraft.util.ResourceLocation	getEntryID() Return a unique identifier for this block track entry.
java.util.List<net.minecraft.util.math.BlockPos>	getServerUpdatePositions(net.minecraft.tileentity.TileEntity te) This method controls whether the block should be updated by the server (at 5 second intervals).
static boolean	hasCapabilityOnAnyFace(net.minecraftforge.common.capabilities.ICapabilityProvider provider, net.minecraftforge.common.capabilities.Capability<?> cap) Convenience method: check if the given capability provider provides the given capability on any block face.
boolean	shouldTrackWithThisEntry(net.minecraft.world.IBlockReader world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.BlockState state, net.minecraft.tileentity.TileEntity te) This method should return true if the coordinate checked is one that should be tracked.
int	spamThreshold() The return of this method defines at how many tracked blocks of this type the HUD should stop displaying text at the tracked blocks of this type.

Method Detail

shouldTrackWithThisEntry

boolean shouldTrackWithThisEntry(net.minecraft.world.IBlockReader world,
                                 net.minecraft.util.math.BlockPos pos,
                                 net.minecraft.block.BlockState state,
                                 net.minecraft.tileentity.TileEntity te)

This method should return true if the coordinate checked is one that should be tracked. Most entries will just return true when the blockID is the one that they track.

Parameters:

world - The world that is examined.

pos - The position of the block examined.

state - The block of the current coordinate. This will save you a call to World.getBlockState().

te - The TileEntity at this x,y,z (may be null)

Returns:

true if the coordinate should be tracked by this BlockTrackEntry.

getServerUpdatePositions

java.util.List<net.minecraft.util.math.BlockPos> getServerUpdatePositions(@Nullable
                                                                          net.minecraft.tileentity.TileEntity te)

This method controls whether the block should be updated by the server (at 5 second intervals). This is specifically aimed at Tile Entities, as the server will send an NBT packet. Return an empty list if no updates are needed, otherwise a list of the block positions for which updates should be sent (in most cases, only the TE's own block pos, but potentially others for multiblocks like the vanilla double chest)

Parameters:

te - the tile entity at the currently checked location, may be null

Returns:

a list of the block positions for which update request packets should be sent

spamThreshold

int spamThreshold()

The return of this method defines at how many tracked blocks of this type the HUD should stop displaying text at the tracked blocks of this type.

Returns:

amount of blocks the HUD should stop displaying the block info.

addInformation

void addInformation(net.minecraft.world.World world,
                    net.minecraft.util.math.BlockPos pos,
                    net.minecraft.tileentity.TileEntity te,
                    net.minecraft.util.Direction face,
                    java.util.List<net.minecraft.util.text.ITextComponent> infoList)

This method is called each client tick to retrieve the block's additional information. The method behaves much the same as Item.appendHoverText(ItemStack, World, List, ITooltipFlag). This method is only called if shouldTrackWithThisEntry(IBlockReader, BlockPos, BlockState, TileEntity) returned true, and the player is curently focused on the block.

Parameters:

world - The world the block is in.

pos - The position the block is at.

te - The TileEntity at the x,y,z (may be null)

face - The blockface the player is looking at (null if player is not looking directly at the block)

infoList - The list of lines to display.

getEntryID

net.minecraft.util.ResourceLocation getEntryID()

Return a unique identifier for this block track entry. This is also used for translation key and keybind naming purposes; see IArmorUpgradeHandler.getStringKey(ResourceLocation)

Returns:

the ID of this entry

hasCapabilityOnAnyFace

static boolean hasCapabilityOnAnyFace(net.minecraftforge.common.capabilities.ICapabilityProvider provider,
                                      net.minecraftforge.common.capabilities.Capability<?> cap)

Convenience method: check if the given capability provider provides the given capability on any block face.

Parameters:

provider - the capability provider

cap - the capability

Returns:

true if the provider provides the capability on any face, including the null "face"