me.desht.pneumaticcraft.client.render.pneumatic_armor.block_tracker

Class BlockTrackEntryMisc

java.lang.Object

me.desht.pneumaticcraft.client.render.pneumatic_armor.block_tracker.BlockTrackEntryMisc

All Implemented Interfaces:

IBlockTrackEntry

public class BlockTrackEntryMisc
extends java.lang.Object
implements IBlockTrackEntry

Constructor Summary

Constructors

Constructor and Description
BlockTrackEntryMisc()

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).
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.desht.pneumaticcraft.api.client.pneumatic_helmet.IBlockTrackEntry

hasCapabilityOnAnyFace

Constructor Detail

BlockTrackEntryMisc

public BlockTrackEntryMisc()

Method Detail

shouldTrackWithThisEntry

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

Description copied from interface: IBlockTrackEntry

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.

Specified by:

shouldTrackWithThisEntry in interface IBlockTrackEntry

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

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

Description copied from interface: IBlockTrackEntry

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)

Specified by:

getServerUpdatePositions in interface IBlockTrackEntry

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

public int spamThreshold()

Description copied from interface: IBlockTrackEntry

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.

Specified by:

spamThreshold in interface IBlockTrackEntry

Returns:

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

addInformation

public 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)

Description copied from interface: IBlockTrackEntry

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 IBlockTrackEntry.shouldTrackWithThisEntry(IBlockReader, BlockPos, BlockState, TileEntity) returned true, and the player is curently focused on the block.

Specified by:

addInformation in interface IBlockTrackEntry

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

public net.minecraft.util.ResourceLocation getEntryID()

Description copied from interface: IBlockTrackEntry

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

Specified by:

getEntryID in interface IBlockTrackEntry

Returns:

the ID of this entry