me.desht.pneumaticcraft.common.tileentity

Class TileEntityBase

java.lang.Object

net.minecraftforge.common.capabilities.CapabilityProvider<net.minecraft.tileentity.TileEntity>

net.minecraft.tileentity.TileEntity

me.desht.pneumaticcraft.common.tileentity.TileEntityBase

All Implemented Interfaces:

IUpgradeAcceptor, IDescSynced, IGUIButtonSensitive, ILuaMethodProvider, IUpgradeHolder, net.minecraft.util.INameable, net.minecraftforge.common.capabilities.ICapabilityProvider, net.minecraftforge.common.capabilities.ICapabilitySerializable<net.minecraft.nbt.CompoundNBT>, net.minecraftforge.common.extensions.IForgeTileEntity, net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.CompoundNBT>

Direct Known Subclasses:

TileEntityAphorismTile, TileEntityDisplayTable, TileEntityElevatorFrame, TileEntityPressureChamberWall, TileEntityReinforcedChest, TileEntityTickableBase

public abstract class TileEntityBase
extends net.minecraft.tileentity.TileEntity
implements net.minecraft.util.INameable, IGUIButtonSensitive, IDescSynced, IUpgradeAcceptor, IUpgradeHolder, ILuaMethodProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TileEntityBase.UpgradeHandler

Field Summary

Fields inherited from class net.minecraft.tileentity.TileEntity

level, remove, worldPosition

Fields inherited from interface net.minecraftforge.common.extensions.IForgeTileEntity

INFINITE_EXTENT_AABB

Constructor Summary

Constructors

Constructor and Description
TileEntityBase(net.minecraft.tileentity.TileEntityType type)
TileEntityBase(net.minecraft.tileentity.TileEntityType type, int upgradeSize)

Method Summary

Modifier and Type	Method and Description
void	addLuaMethods(LuaMethodRegistry registry) Called lazily to populate the method registry with the methods.
void	clearCache()
int	countPlayersUsing() Get the number of players who have a GUI open for this tile entity.
java.util.Map<EnumUpgrade,java.lang.Integer>	getApplicableUpgrades() This method is called as soon as an instance of this interface is registered, be aware.
net.minecraft.tileentity.TileEntity	getCachedNeighbor(net.minecraft.util.Direction dir)
<T> net.minecraftforge.common.util.LazyOptional<T>	getCapability(net.minecraftforge.common.capabilities.Capability<T> cap, net.minecraft.util.Direction side)
void	getContentsToDrop(net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> drops) Collect all items which should be dropped when this TE is broken.
java.lang.String	getCurrentRecipeIdSynced() For machines which use recipes, get the synced recipe ID client-side for informational purposes
net.minecraft.util.text.ITextComponent	getCustomName()
java.util.List<SyncedField<?>>	getDescriptionFields()
net.minecraft.util.text.ITextComponent	getDisplayName()
net.minecraftforge.common.util.LazyOptional<IHeatExchangerLogic>	getHeatCap(net.minecraft.util.Direction side)
protected net.minecraftforge.common.util.LazyOptional<net.minecraftforge.items.IItemHandler>	getInventoryCap()
LuaMethodRegistry	getLuaMethodRegistry() Get this TE's method registry object.
net.minecraftforge.client.model.data.IModelData	getModelData()
net.minecraft.util.text.ITextComponent	getName()
java.lang.String	getPeripheralType() Get a unique identifier for this type of method provider.
net.minecraft.util.math.BlockPos	getPosition() We don't override getUpdatePacket() or onDataPacket() because TE sync'ing is all handled by our custom PacketDescription and the @DescSynced system
abstract net.minecraftforge.items.IItemHandler	getPrimaryInventory()
net.minecraft.util.Direction	getRotation()
float	getSpeedMultiplierFromUpgrades()
float	getSpeedUsageMultiplierFromUpgrades()
net.minecraft.nbt.CompoundNBT	getUpdateTag()
java.lang.String	getUpgradeAcceptorTranslationKey() Get a translation key for this upgrade acceptor.
UpgradeCache	getUpgradeCache()
TileEntityBase.UpgradeHandler	getUpgradeHandler()
int	getUpgrades(EnumUpgrade upgrade)
void	handleGUIButtonPress(java.lang.String tag, boolean shiftHeld, net.minecraft.entity.player.ServerPlayerEntity player)
void	handleUpdateTag(net.minecraft.block.BlockState state, net.minecraft.nbt.CompoundNBT tag)
boolean	isGuiUseableByPlayer(net.minecraft.entity.player.PlayerEntity player)
void	load(net.minecraft.block.BlockState state, net.minecraft.nbt.CompoundNBT tag)
void	onBlockRotated()
void	onDescUpdate()
protected void	onFirstServerTick()
void	onGuiUpdate() Called when a key is synced in the container.
void	onNeighborBlockUpdate(net.minecraft.util.math.BlockPos fromPos) Called when a neighboring block changes state (i.e.
void	onNeighborTileUpdate(net.minecraft.util.math.BlockPos tilePos) Called when a neighboring tile entity changes state (specifically when net.minecraft.world.World#updateComparatorOutputLevel(BlockPos, Block) is called.
void	onUpgradesChanged() Called when a machine's upgrades have changed in any way.
void	readFromPacket(net.minecraft.nbt.CompoundNBT tag) Encoded into the description packet.
void	requestModelDataUpdate()
net.minecraft.nbt.CompoundNBT	save(net.minecraft.nbt.CompoundNBT tag)
void	sendDescriptionPacket() Force a sync of this TE to the client right now.
void	serializeExtraItemData(net.minecraft.nbt.CompoundNBT blockEntityTag, boolean preserveState) Get any extra data to be serialized onto a dropped item stack.
void	setCustomName(net.minecraft.util.text.ITextComponent customName)
void	setPreserveStateOnBreak(boolean preserveStateOnBreak)
void	setRemoved()
boolean	shouldPreserveStateOnBreak() Should this tile entity preserve its state (currently: upgrades and stored air) when broken? By default this is true when sneak-wrenched, and false when broken by pick.
protected boolean	shouldRerenderChunkOnDescUpdate()
boolean	shouldSyncField(int idx)
protected void	updateNeighbours()
void	writeToPacket(net.minecraft.nbt.CompoundNBT tag) Encoded into the description packet.

Methods inherited from class net.minecraft.tileentity.TileEntity

clearRemoved, fillCrashReportCategory, getBlockPos, getBlockState, getLevel, getTileData, getType, getUpdatePacket, getViewDistance, hasLevel, isRemoved, loadStatic, logInvalidState, mirror, onChunkUnloaded, onlyOpCanSetNbt, rotate, setChanged, setLevelAndPosition, setPosition, triggerEvent

Methods inherited from class net.minecraftforge.common.capabilities.CapabilityProvider

areCapsCompatible, areCapsCompatible, deserializeCaps, gatherCapabilities, gatherCapabilities, getCapabilities, invalidateCaps, reviveCaps, serializeCaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.util.INameable

hasCustomName

Methods inherited from interface net.minecraftforge.common.extensions.IForgeTileEntity

deserializeNBT, deserializeNBT, getRenderBoundingBox, getTileEntity, onDataPacket, onLoad, serializeNBT

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

getCapability

Constructor Detail

TileEntityBase

public TileEntityBase(net.minecraft.tileentity.TileEntityType type)

TileEntityBase

public TileEntityBase(net.minecraft.tileentity.TileEntityType type,
                      int upgradeSize)

Method Detail

getUpgradeAcceptorTranslationKey

public java.lang.String getUpgradeAcceptorTranslationKey()

Description copied from interface: IUpgradeAcceptor

Get a translation key for this upgrade acceptor. This is used to display the acceptor in relevant upgrades' tooltip texts.

Specified by:

getUpgradeAcceptorTranslationKey in interface IUpgradeAcceptor

Returns:

a translation key

getName

public net.minecraft.util.text.ITextComponent getName()

Specified by:

getName in interface net.minecraft.util.INameable

getCustomName

@Nullable
public net.minecraft.util.text.ITextComponent getCustomName()

Specified by:

getCustomName in interface net.minecraft.util.INameable

setCustomName

public void setCustomName(net.minecraft.util.text.ITextComponent customName)

getDisplayName

public net.minecraft.util.text.ITextComponent getDisplayName()

Specified by:

getDisplayName in interface net.minecraft.util.INameable

getUpdateTag

public net.minecraft.nbt.CompoundNBT getUpdateTag()

Overrides:

getUpdateTag in class net.minecraft.tileentity.TileEntity

handleUpdateTag

public void handleUpdateTag(net.minecraft.block.BlockState state,
                            net.minecraft.nbt.CompoundNBT tag)

Specified by:

handleUpdateTag in interface net.minecraftforge.common.extensions.IForgeTileEntity

getPosition

public net.minecraft.util.math.BlockPos getPosition()

We don't override getUpdatePacket() or onDataPacket() because TE sync'ing is all handled by our custom PacketDescription and the @DescSynced system

Specified by:

getPosition in interface IDescSynced

shouldSyncField

public boolean shouldSyncField(int idx)

Specified by:

shouldSyncField in interface IDescSynced

getDescriptionFields

public java.util.List<SyncedField<?>> getDescriptionFields()

Specified by:

getDescriptionFields in interface IDescSynced

sendDescriptionPacket

public void sendDescriptionPacket()

Force a sync of this TE to the client right now.

setRemoved

public void setRemoved()

Overrides:

setRemoved in class net.minecraft.tileentity.TileEntity

onFirstServerTick

protected void onFirstServerTick()

updateNeighbours

protected void updateNeighbours()

onBlockRotated

public void onBlockRotated()

shouldRerenderChunkOnDescUpdate

protected boolean shouldRerenderChunkOnDescUpdate()

writeToPacket

public void writeToPacket(net.minecraft.nbt.CompoundNBT tag)

Encoded into the description packet. Also included in saved data written by TileEntityBase#write(CompoundNBT) Prefer to use @DescSynced where possible - use this either for complex fields not handled by @DescSynced, or for non-ticking tile entities.

Specified by:

writeToPacket in interface IDescSynced

Parameters:

tag - NBT tag

readFromPacket

public void readFromPacket(net.minecraft.nbt.CompoundNBT tag)

Encoded into the description packet. Also included in saved data read by TileEntityBase#read(BlockState, CompoundNBT). Prefer to use @DescSynced where possible - use this either for complex fields not handled by @DescSynced, or for non-ticking tile entities.

Specified by:

readFromPacket in interface IDescSynced

Parameters:

tag - NBT tag

save

public net.minecraft.nbt.CompoundNBT save(net.minecraft.nbt.CompoundNBT tag)

Overrides:

save in class net.minecraft.tileentity.TileEntity

load

public void load(net.minecraft.block.BlockState state,
                 net.minecraft.nbt.CompoundNBT tag)

Overrides:

load in class net.minecraft.tileentity.TileEntity

onDescUpdate

public void onDescUpdate()

Specified by:

onDescUpdate in interface IDescSynced

getModelData

@Nonnull
public net.minecraftforge.client.model.data.IModelData getModelData()

Specified by:

getModelData in interface net.minecraftforge.common.extensions.IForgeTileEntity

onGuiUpdate

public void onGuiUpdate()

Called when a key is synced in the container.

getRotation

public net.minecraft.util.Direction getRotation()

clearCache

public void clearCache()

Overrides:

clearCache in class net.minecraft.tileentity.TileEntity

getUpgrades

public int getUpgrades(EnumUpgrade upgrade)

getSpeedMultiplierFromUpgrades

public float getSpeedMultiplierFromUpgrades()

getSpeedUsageMultiplierFromUpgrades

public float getSpeedUsageMultiplierFromUpgrades()

handleGUIButtonPress

public void handleGUIButtonPress(java.lang.String tag,
                                 boolean shiftHeld,
                                 net.minecraft.entity.player.ServerPlayerEntity player)

Specified by:

handleGUIButtonPress in interface IGUIButtonSensitive

isGuiUseableByPlayer

public boolean isGuiUseableByPlayer(net.minecraft.entity.player.PlayerEntity player)

getCachedNeighbor

public net.minecraft.tileentity.TileEntity getCachedNeighbor(net.minecraft.util.Direction dir)

onNeighborTileUpdate

public void onNeighborTileUpdate(net.minecraft.util.math.BlockPos tilePos)

Called when a neighboring tile entity changes state (specifically when net.minecraft.world.World#updateComparatorOutputLevel(BlockPos, Block) is called.

Parameters:

tilePos - the blockpos of the neighboring tile entity

onNeighborBlockUpdate

public void onNeighborBlockUpdate(net.minecraft.util.math.BlockPos fromPos)

Called when a neighboring block changes state (i.e. blockstate update)

Parameters:

fromPos - the blockpos of the block that caused this update

getApplicableUpgrades

public java.util.Map<EnumUpgrade,java.lang.Integer> getApplicableUpgrades()

Description copied from interface: IUpgradeAcceptor

This method is called as soon as an instance of this interface is registered, be aware. It should return a map which maps the collection of accepted upgrades for this machine/item to the maximum number of each upgrade which can be inserted.

Specified by:

getApplicableUpgrades in interface IUpgradeAcceptor

Returns:

a map of the accepted upgrades and their maximum count

addLuaMethods

public void addLuaMethods(LuaMethodRegistry registry)

Description copied from interface: ILuaMethodProvider

Called lazily to populate the method registry with the methods.

Specified by:

addLuaMethods in interface ILuaMethodProvider

Parameters:

registry - the registry to populate

getLuaMethodRegistry

public LuaMethodRegistry getLuaMethodRegistry()

Description copied from interface: ILuaMethodProvider

Get this TE's method registry object. This should be created in the TE constructor, but not populated with methods yet.

Specified by:

getLuaMethodRegistry in interface ILuaMethodProvider

Returns:

the method registry

getPeripheralType

public java.lang.String getPeripheralType()

Description copied from interface: ILuaMethodProvider

Get a unique identifier for this type of method provider. The TE's type (a registry ID) is a good choice.

Specified by:

getPeripheralType in interface ILuaMethodProvider

Returns:

a unique string identifier

getPrimaryInventory

public abstract net.minecraftforge.items.IItemHandler getPrimaryInventory()

getUpgradeHandler

public TileEntityBase.UpgradeHandler getUpgradeHandler()

Specified by:

getUpgradeHandler in interface IUpgradeHolder

getCapability

@Nonnull
public <T> net.minecraftforge.common.util.LazyOptional<T> getCapability(@Nonnull
                                                                                 net.minecraftforge.common.capabilities.Capability<T> cap,
                                                                                 @Nullable
                                                                                 net.minecraft.util.Direction side)

Specified by:

getCapability in interface net.minecraftforge.common.capabilities.ICapabilityProvider

Overrides:

getCapability in class net.minecraftforge.common.capabilities.CapabilityProvider<net.minecraft.tileentity.TileEntity>

getInventoryCap

@Nonnull
protected net.minecraftforge.common.util.LazyOptional<net.minecraftforge.items.IItemHandler> getInventoryCap()

getHeatCap

@Nonnull
public net.minecraftforge.common.util.LazyOptional<IHeatExchangerLogic> getHeatCap(net.minecraft.util.Direction side)

getContentsToDrop

public void getContentsToDrop(net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> drops)

Collect all items which should be dropped when this TE is broken. Override and extend this in subclassing TE's which have extra inventories to be dropped.

Parameters:

drops - list in which to collect dropped items

shouldPreserveStateOnBreak

public boolean shouldPreserveStateOnBreak()

Should this tile entity preserve its state (currently: upgrades and stored air) when broken? By default this is true when sneak-wrenched, and false when broken by pick.

Returns:

true if state should be preserved, false otherwise

setPreserveStateOnBreak

public void setPreserveStateOnBreak(boolean preserveStateOnBreak)

getCurrentRecipeIdSynced

public java.lang.String getCurrentRecipeIdSynced()

For machines which use recipes, get the synced recipe ID client-side for informational purposes

Returns:

the recipe id (in string form), or the empty string if no current recipe or not applicable

onUpgradesChanged

public void onUpgradesChanged()

Called when a machine's upgrades have changed in any way. This is also called from readNBT() when saved upgrades are deserialized, so it is not guaranteed that the world field is non-null - beware. If you override this, remember to call the super method!

Specified by:

onUpgradesChanged in interface IUpgradeHolder

getUpgradeCache

public UpgradeCache getUpgradeCache()

serializeExtraItemData

public void serializeExtraItemData(net.minecraft.nbt.CompoundNBT blockEntityTag,
                                   boolean preserveState)

Get any extra data to be serialized onto a dropped item stack. The supplied tag is the "BlockEntityTag" subtag of the item's NBT data, so will be automatically deserialized into the TE (i.e. available to TileEntity#read(BlockState, CompoundNBT) method) when the itemblock is next placed.

Parameters:

blockEntityTag - the existing "BlockEntityTag" subtag to add data to

preserveState - true when dropped with a wrench, false when broken with a pickaxe etc.

countPlayersUsing

public int countPlayersUsing()

Get the number of players who have a GUI open for this tile entity. Only use this server-side.

Returns:

the player count

requestModelDataUpdate

public void requestModelDataUpdate()

Specified by:

requestModelDataUpdate in interface net.minecraftforge.common.extensions.IForgeTileEntity