TileEntity (Forge API 1.8.9-11.15.1.2318)

java.lang.Object
- net.minecraft.tileentity.TileEntity

All Implemented Interfaces:

ICapabilityProvider, ICapabilitySerializable<NBTTagCompound>, INBTSerializable<NBTTagCompound>

Direct Known Subclasses:

BlockJukebox.TileEntityJukebox, TileEntityBanner, TileEntityCommandBlock, TileEntityComparator, TileEntityDaylightDetector, TileEntityEnchantmentTable, TileEntityEnderChest, TileEntityEndPortal, TileEntityFlowerPot, TileEntityLockable, TileEntityMobSpawner, TileEntityNote, TileEntityPiston, TileEntitySign, TileEntitySkull, TileFluidHandler
```
public abstract class TileEntity
extends java.lang.Object
implements ICapabilitySerializable<NBTTagCompound>
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Block`	`blockType` the Block type that this TileEntity is contained within
`static AxisAlignedBB`	`INFINITE_EXTENT_AABB` Sometimes default render bounding box: infinite in scope.
`protected BlockPos`	`pos`
`protected boolean`	`tileEntityInvalid`
`protected World`	`worldObj` the instance of the world the tile entity is in.

Constructor Summary

Constructors
Constructor and Description

TileEntity()

Constructors
Constructor and Description
`TileEntity()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addInfoToCrashReport(CrashReportCategory reportCategory)`
`static void`	`addMapping(java.lang.Class<? extends TileEntity> cl, java.lang.String id)` Adds a new two-way mapping between the class and its string name in both hashmaps.
`boolean`	`canRenderBreaking()` Checks if this tile entity knows how to render its 'breaking' overlay effect.
`static TileEntity`	`createAndLoadEntity(NBTTagCompound nbt)` Creates a new entity and loads its data from the specified NBT.
`void`	`deserializeNBT(NBTTagCompound nbt)`
`boolean`	`func_183000_F()`
`int`	`getBlockMetadata()`
`Block`	`getBlockType()` Gets the block type at the location of this entity (client-only).
`<T> T`	`getCapability(Capability<T> capability, EnumFacing facing)` Retrieves the handler for the capability requested on the specific side.
`Packet`	`getDescriptionPacket()` Allows for a specialized description packet to be created.
`double`	`getDistanceSq(double x, double y, double z)` Returns the square of the distance between this entity and the passed in coordinates.
`double`	`getMaxRenderDistanceSquared()`
`BlockPos`	`getPos()`
`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.
`NBTTagCompound`	`getTileData()` Gets a `NBTTagCompound` that can be used to store custom data for this tile entity.
`World`	`getWorld()` Returns the worldObj for this tileEntity.
`boolean`	`hasCapability(Capability<?> capability, EnumFacing facing)` Determines if this object has support for the capability in question on the specific side.
`boolean`	`hasFastRenderer()` If the TileEntitySpecialRenderer associated with this TileEntity can be batched in with another renderers, and won't access the GL state.
`boolean`	`hasWorldObj()` Returns true if the worldObj isn't null.
`void`	`invalidate()` invalidates a tile entity
`boolean`	`isInvalid()`
`void`	`markDirty()` For tile entities, ensures the chunk containing the tile entity is saved to disk later - the game won't think it hasn't changed and skip it.
`void`	`onChunkUnload()` Called when the chunk this TileEntity is on is Unloaded.
`void`	`onDataPacket(NetworkManager net, S35PacketUpdateTileEntity pkt)` Called when you receive a TileEntityData packet for the location this TileEntity is currently in.
`void`	`onLoad()` Called from the Chunk when this is first added to the world.
`void`	`readFromNBT(NBTTagCompound compound)`
`boolean`	`receiveClientEvent(int id, int type)`
`boolean`	`restrictNBTCopy()` Determines if the player can overwrite the NBT data of this tile entity while they place it using a ItemStack.
`NBTTagCompound`	`serializeNBT()`
`void`	`setPos(BlockPos posIn)`
`void`	`setWorldObj(World worldIn)` Sets the worldObj for this tileEntity.
`boolean`	`shouldRefresh(World world, BlockPos pos, IBlockState oldState, IBlockState newSate)` Called from Chunk.setBlockIDWithMetadata and Chunk.fillChunk, determines if this tile entity should be re-created when the ID, or Metadata changes.
`boolean`	`shouldRenderInPass(int pass)`
`void`	`updateContainingBlockInfo()`
`void`	`validate()` validates a tile entity
`void`	`writeToNBT(NBTTagCompound compound)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - worldObj
```
protected World worldObj
```
    the instance of the world the tile entity is in.
  - pos
```
protected BlockPos pos
```
  - tileEntityInvalid
```
protected boolean tileEntityInvalid
```
  - blockType
```
protected Block blockType
```
    the Block type that this TileEntity is contained within
  - INFINITE_EXTENT_AABB
```
public static final AxisAlignedBB INFINITE_EXTENT_AABB
```
    Sometimes default render bounding box: infinite in scope. Used to control rendering on TileEntitySpecialRenderer.
- Constructor Detail
  - TileEntity
```
public TileEntity()
```
- Method Detail
  - addMapping
```
public static void addMapping(java.lang.Class<? extends TileEntity> cl,
                              java.lang.String id)
```
    Adds a new two-way mapping between the class and its string name in both hashmaps.
  - getWorld
```
public World getWorld()
```
    Returns the worldObj for this tileEntity.
  - setWorldObj
```
public void setWorldObj(World worldIn)
```
    Sets the worldObj for this tileEntity.
  - hasWorldObj
```
public boolean hasWorldObj()
```
    Returns true if the worldObj isn't null.
  - readFromNBT
```
public void readFromNBT(NBTTagCompound compound)
```
  - writeToNBT
```
public void writeToNBT(NBTTagCompound compound)
```
  - createAndLoadEntity
```
public static TileEntity createAndLoadEntity(NBTTagCompound nbt)
```
    Creates a new entity and loads its data from the specified NBT.
  - getBlockMetadata
```
public int getBlockMetadata()
```
  - markDirty
```
public void markDirty()
```
    For tile entities, ensures the chunk containing the tile entity is saved to disk later - the game won't think it hasn't changed and skip it.
  - getDistanceSq
```
public double getDistanceSq(double x,
                            double y,
                            double z)
```
    Returns the square of the distance between this entity and the passed in coordinates.
  - getMaxRenderDistanceSquared
```
public double getMaxRenderDistanceSquared()
```
  - getPos
```
public BlockPos getPos()
```
  - getBlockType
```
public Block getBlockType()
```
    Gets the block type at the location of this entity (client-only).
  - getDescriptionPacket
```
public Packet getDescriptionPacket()
```
    Allows for a specialized description packet to be created. This is often used to sync tile entity data from the server to the client easily. For example this is used by signs to synchronise the text to be displayed.
  - isInvalid
```
public boolean isInvalid()
```
  - invalidate
```
public void invalidate()
```
    invalidates a tile entity
  - validate
```
public void validate()
```
    validates a tile entity
  - receiveClientEvent
```
public boolean receiveClientEvent(int id,
                                  int type)
```
  - updateContainingBlockInfo
```
public void updateContainingBlockInfo()
```
  - addInfoToCrashReport
```
public void addInfoToCrashReport(CrashReportCategory reportCategory)
```
  - setPos
```
public void setPos(BlockPos posIn)
```
  - func_183000_F
```
public boolean func_183000_F()
```
  - onDataPacket
```
public void onDataPacket(NetworkManager net,
                         S35PacketUpdateTileEntity 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
  - onChunkUnload
```
public void onChunkUnload()
```
    Called when the chunk this TileEntity is on is Unloaded.
  - shouldRefresh
```
public boolean shouldRefresh(World world,
                             BlockPos pos,
                             IBlockState oldState,
                             IBlockState newSate)
```
    Called from Chunk.setBlockIDWithMetadata and Chunk.fillChunk, determines if this tile entity should be re-created when the ID, or Metadata changes. Use with caution as this will leave straggler TileEntities, or create conflicts with other TileEntities if not used properly.
    
    Parameters:
    
    world - Current world
    
    pos - Tile's world position
    
    oldState - The old ID of the block
    
    newState - The new ID of the block (May be the same)
    
    Returns:
    
    true forcing the invalidation of the existing TE, false not to invalidate the existing TE
  - shouldRenderInPass
```
public boolean shouldRenderInPass(int pass)
```
  - getRenderBoundingBox
```
public 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
```
public 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.
  - getTileData
```
public NBTTagCompound 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
  - restrictNBTCopy
```
public boolean restrictNBTCopy()
```
    Determines if the player can overwrite the NBT data of this tile entity while they place it using a ItemStack. Added as a fix for MC-75630 - Exploit with signs and command blocks
    
    Returns:
    
    True to prevent NBT copy, false to allow.
  - onLoad
```
public void onLoad()
```
    Called from the Chunk when this is first added to the world. Override instead of adding if (firstTick) stuff in update. Happens after validate and after it has been placed into the Chunk tileEntity map.
  - hasFastRenderer
```
public 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.
  - hasCapability
```
public boolean hasCapability(Capability<?> capability,
                             EnumFacing facing)
```
    Description copied from interface: ICapabilityProvider
    
    Determines if this object has support for the capability in question on the specific side. The return value of this MIGHT change during runtime if this object gains or looses support for a capability. Example: A Pipe getting a cover placed on one side causing it loose the Inventory attachment function for that side. This is a light weight version of getCapability, intended for metadata uses.
    
    Specified by:
    
    hasCapability in interface ICapabilityProvider
    
    Parameters:
    
    capability - The capability to check
    
    facing - The Side to check from: CAN BE NULL. Null is defined to represent 'internal' or 'self'
    
    Returns:
    
    True if this object supports the capability.
  - getCapability
```
public <T> T getCapability(Capability<T> capability,
                           EnumFacing facing)
```
    Description copied from interface: ICapabilityProvider
    
    Retrieves the handler for the capability requested on the specific side. The return value CAN be null if the object does not support the capability. The return value CAN be the same for multiple faces.
    
    Specified by:
    
    getCapability in interface ICapabilityProvider
    
    Parameters:
    
    capability - The capability to check
    
    facing - The Side to check from: CAN BE NULL. Null is defined to represent 'internal' or 'self'
    
    Returns:
    
    True if this object supports the capability.
  - deserializeNBT
```
public void deserializeNBT(NBTTagCompound nbt)
```
    Specified by:
    
    deserializeNBT in interface INBTSerializable<NBTTagCompound>
  - serializeNBT
```
public NBTTagCompound serializeNBT()
```
    Specified by:
    
    serializeNBT in interface INBTSerializable<NBTTagCompound>

Class TileEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

worldObj

pos

tileEntityInvalid

blockType

INFINITE_EXTENT_AABB

Constructor Detail

TileEntity

Method Detail

addMapping

getWorld

setWorldObj

hasWorldObj

readFromNBT

writeToNBT

createAndLoadEntity

getBlockMetadata

markDirty

getDistanceSq

getMaxRenderDistanceSquared

getPos

getBlockType

getDescriptionPacket

isInvalid

invalidate

validate

receiveClientEvent

updateContainingBlockInfo

addInfoToCrashReport

setPos

func_183000_F

onDataPacket

onChunkUnload

shouldRefresh

shouldRenderInPass

getRenderBoundingBox

canRenderBreaking

getTileData

restrictNBTCopy

onLoad

hasFastRenderer

hasCapability

getCapability

deserializeNBT

serializeNBT