net.minecraftforge.common.extensions

Interface IForgeTileEntity

All Superinterfaces:

ICapabilityProvider, ICapabilitySerializable<CompoundNBT>, INBTSerializable<CompoundNBT>

All Known Implementing Classes:

AbstractFurnaceTileEntity, BannerTileEntity, BarrelTileEntity, BeaconTileEntity, BedTileEntity, BeehiveTileEntity, BellTileEntity, BlastFurnaceTileEntity, BrewingStandTileEntity, CampfireTileEntity, ChestTileEntity, CommandBlockTileEntity, ComparatorTileEntity, ConduitTileEntity, DaylightDetectorTileEntity, DispenserTileEntity, DropperTileEntity, EnchantingTableTileEntity, EnderChestTileEntity, EndGatewayTileEntity, EndPortalTileEntity, FurnaceTileEntity, HopperTileEntity, JigsawTileEntity, JukeboxTileEntity, LecternTileEntity, LockableLootTileEntity, LockableTileEntity, MobSpawnerTileEntity, PistonTileEntity, ShulkerBoxTileEntity, SignTileEntity, SkullTileEntity, SmokerTileEntity, StructureBlockTileEntity, TileEntity, TileFluidHandler, TrappedChestTileEntity

public interface IForgeTileEntity
extends ICapabilitySerializable<CompoundNBT>

Field Summary

Fields

Modifier and Type	Field and Description
static AxisAlignedBB	INFINITE_EXTENT_AABB Sometimes default render bounding box: infinite in scope.

Method Summary

Modifier and Type	Method and Description
default boolean	canRenderBreaking() Checks if this tile entity knows how to render its 'breaking' overlay effect.
default void	deserializeNBT(CompoundNBT nbt)
default IModelData	getModelData() Allows you to return additional model data.
default AxisAlignedBB	getRenderBoundingBox() Return an AxisAlignedBB that controls the visible scope of a TileEntitySpecialRenderer associated with this TileEntity Defaults to the collision bounding box Block#getCollisionBoundingBoxFromPool(World, int, int, int) associated with the block at this location.
CompoundNBT	getTileData() Gets a NBTTagCompound that can be used to store custom data for this tile entity.
default TileEntity	getTileEntity()
default void	handleUpdateTag(CompoundNBT tag) Called when the chunk's TE update tag, gotten from #getUpdateTag(), is received on the client.
default boolean	hasFastRenderer() If the TileEntitySpecialRenderer associated with this TileEntity can be batched in with another renderers, and won't access the GL state.
default void	onChunkUnloaded()
default void	onDataPacket(NetworkManager net, SUpdateTileEntityPacket pkt) Called when you receive a TileEntityData packet for the location this TileEntity is currently in.
default void	onLoad() Called when this is first added to the world (by World.addTileEntity(TileEntity)).
default void	requestModelDataUpdate() Requests a refresh for the model data of your TE Call this every time your getModelData() changes
default CompoundNBT	serializeNBT()

Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability, getCapability

Field Detail

INFINITE_EXTENT_AABB

static final AxisAlignedBB INFINITE_EXTENT_AABB

Sometimes default render bounding box: infinite in scope. Used to control rendering on TileEntitySpecialRenderer.

Method Detail

getTileEntity

default TileEntity getTileEntity()

deserializeNBT

default void deserializeNBT(CompoundNBT nbt)

Specified by:

deserializeNBT in interface INBTSerializable<CompoundNBT>

serializeNBT

default CompoundNBT serializeNBT()

Specified by:

serializeNBT in interface INBTSerializable<CompoundNBT>

onDataPacket

default void onDataPacket(NetworkManager net,
                          SUpdateTileEntityPacket pkt)

Called when you receive a TileEntityData packet for the location this TileEntity is currently in. On the client, the NetworkManager will always be the remote server. On the server, it will be whomever is responsible for sending the packet.

Parameters:

net - The NetworkManager the packet originated from

pkt - The data packet

handleUpdateTag

default void handleUpdateTag(CompoundNBT tag)

Called when the chunk's TE update tag, gotten from #getUpdateTag(), is received on the client.

Used to handle this tag in a special way. By default this simply calls #readFromNBT(NBTTagCompound).

Parameters:

tag - The NBTTagCompound sent from #getUpdateTag()

getTileData

CompoundNBT getTileData()

Gets a NBTTagCompound that can be used to store custom data for this tile entity. It will be written, and read from disc, so it persists over world saves.

Returns:

A compound tag for custom data

onChunkUnloaded

default void onChunkUnloaded()

onLoad

default void onLoad()

Called when this is first added to the world (by World.addTileEntity(TileEntity)). Override instead of adding if (firstTick) stuff in update.

getRenderBoundingBox

default AxisAlignedBB getRenderBoundingBox()

Return an AxisAlignedBB that controls the visible scope of a TileEntitySpecialRenderer associated with this TileEntity Defaults to the collision bounding box Block#getCollisionBoundingBoxFromPool(World, int, int, int) associated with the block at this location.

Returns:

an appropriately size AxisAlignedBB for the TileEntity

canRenderBreaking

default boolean canRenderBreaking()

Checks if this tile entity knows how to render its 'breaking' overlay effect. If this returns true, The TileEntitySpecialRenderer will be called again with break progress set.

Returns:

True to re-render tile with breaking effect.

hasFastRenderer

default boolean hasFastRenderer()

If the TileEntitySpecialRenderer associated with this TileEntity can be batched in with another renderers, and won't access the GL state. If TileEntity returns true, then TESR should have the same functionality as (and probably extend) the FastTESR class.

requestModelDataUpdate

default void requestModelDataUpdate()

Requests a refresh for the model data of your TE Call this every time your getModelData() changes

getModelData

@Nonnull
default IModelData getModelData()

Allows you to return additional model data. This data can be used to provide additional functionality in your IBakedModel You need to schedule a refresh of you model data via requestModelDataUpdate() if the result of this function changes. Note that this method may be called on a chunk render thread instead of the main client thread

Returns:

Your model data