forestry.core.multiblock

Class MultiblockLogic<T extends IMultiblockControllerInternal>

java.lang.Object

forestry.core.multiblock.MultiblockLogic<T>

All Implemented Interfaces:

INbtWritable, IMultiblockLogic

Direct Known Subclasses:

MultiblockLogicAlveary, MultiblockLogicFarm

public abstract class MultiblockLogic<T extends IMultiblockControllerInternal>
extends java.lang.Object
implements IMultiblockLogic

Field Summary

Fields

Modifier and Type	Field and Description
protected T	controller

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiblockLogic(java.lang.Class<T> controllerClass)

Method Summary

Modifier and Type	Method and Description
void	assertDetached(IMultiblockComponent part)
void	becomeMultiblockSaveDelegate()
abstract T	createNewController(net.minecraft.world.World world)
void	decodeDescriptionPacket(net.minecraft.nbt.NBTTagCompound packetData) Override this to easily read in data from a TileEntity's description packet.
protected void	detachSelf(net.minecraft.world.World world, IMultiblockComponent part, boolean chunkUnloading)
void	encodeDescriptionPacket(net.minecraft.nbt.NBTTagCompound packetData) Override this to easily modify the description packet's data without having to worry about sending the packet itself.
void	forfeitMultiblockSaveDelegate()
abstract T	getController()
java.lang.Class<T>	getControllerClass()
net.minecraft.nbt.NBTTagCompound	getMultiblockSaveData()
boolean	hasMultiblockSaveData()
void	invalidate(net.minecraft.world.World world, IMultiblockComponent part) Called when a block is removed by game actions, such as a player breaking the block or the block being changed into another block.
boolean	isConnected()
boolean	isMultiblockSaveDelegate()
boolean	isVisited()
void	onChunkUnload(net.minecraft.world.World world, IMultiblockComponent part) Called from Minecraft's tile entity loop, after all tile entities have been ticked, as the chunk in which this tile entity is contained is unloading.
void	onMultiblockDataAssimilated()
void	readFromNBT(net.minecraft.nbt.NBTTagCompound data) Read the logic's data from file.
void	setController(IMultiblockControllerInternal controller)
void	setUnvisited()
void	setVisited()
void	validate(net.minecraft.world.World world, IMultiblockComponent part) This is called when a block is being marked as valid by the chunk, but has not yet fully been placed into the world's TileEntity cache.
net.minecraft.nbt.NBTTagCompound	writeToNBT(net.minecraft.nbt.NBTTagCompound data) Write the logic's data to file.

Methods inherited from class java.lang.Object

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

Field Detail

controller

@Nullable
protected T extends IMultiblockControllerInternal controller

Constructor Detail

MultiblockLogic

protected MultiblockLogic(java.lang.Class<T> controllerClass)

Method Detail

setController

public void setController(@Nullable
                          IMultiblockControllerInternal controller)

getControllerClass

public java.lang.Class<T> getControllerClass()

getController

public abstract T getController()

Specified by:

getController in interface IMultiblockLogic

Returns:

the multiblock controller for this logic

createNewController

public abstract T createNewController(net.minecraft.world.World world)

validate

public void validate(net.minecraft.world.World world,
                     IMultiblockComponent part)

This is called when a block is being marked as valid by the chunk, but has not yet fully been placed into the world's TileEntity cache. this.world, xCoord, yCoord and zCoord have been initialized, but any attempts to read data about the world can cause infinite loops - if you call getTileEntity on this TileEntity's coordinate from within validate(), you will blow your call stack.

TL;DR: Here there be dragons.

Specified by:

validate in interface IMultiblockLogic

See Also:

TileEntity.validate()

invalidate

public final void invalidate(net.minecraft.world.World world,
                             IMultiblockComponent part)

Called when a block is removed by game actions, such as a player breaking the block or the block being changed into another block.

Specified by:

invalidate in interface IMultiblockLogic

See Also:

TileEntity.invalidate()

onChunkUnload

public final void onChunkUnload(net.minecraft.world.World world,
                                IMultiblockComponent part)

Called from Minecraft's tile entity loop, after all tile entities have been ticked, as the chunk in which this tile entity is contained is unloading. Happens before the Forge TickEnd event.

Specified by:

onChunkUnload in interface IMultiblockLogic

See Also:

TileEntity.onChunkUnload()

detachSelf

protected void detachSelf(net.minecraft.world.World world,
                          IMultiblockComponent part,
                          boolean chunkUnloading)

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound data)

Description copied from interface: IMultiblockLogic

Read the logic's data from file. Use this in Tile.readFromNBT()

Specified by:

readFromNBT in interface IMultiblockLogic

writeToNBT

public net.minecraft.nbt.NBTTagCompound writeToNBT(net.minecraft.nbt.NBTTagCompound data)

Description copied from interface: IMultiblockLogic

Write the logic's data to file. Use this in Tile.writeToNBT()

Specified by:

writeToNBT in interface INbtWritable

Specified by:

writeToNBT in interface IMultiblockLogic

assertDetached

public final void assertDetached(IMultiblockComponent part)

isConnected

public final boolean isConnected()

Specified by:

isConnected in interface IMultiblockLogic

Returns:

True if this block is connected to a multiblock controller. False otherwise.

becomeMultiblockSaveDelegate

public void becomeMultiblockSaveDelegate()

forfeitMultiblockSaveDelegate

public void forfeitMultiblockSaveDelegate()

isMultiblockSaveDelegate

public final boolean isMultiblockSaveDelegate()

setUnvisited

public final void setUnvisited()

setVisited

public final void setVisited()

isVisited

public final boolean isVisited()

hasMultiblockSaveData

public final boolean hasMultiblockSaveData()

getMultiblockSaveData

@Nullable
public final net.minecraft.nbt.NBTTagCompound getMultiblockSaveData()

onMultiblockDataAssimilated

public final void onMultiblockDataAssimilated()

encodeDescriptionPacket

public void encodeDescriptionPacket(net.minecraft.nbt.NBTTagCompound packetData)

Override this to easily modify the description packet's data without having to worry about sending the packet itself. Decode this data in decodeDescriptionPacket.

Specified by:

encodeDescriptionPacket in interface IMultiblockLogic

Parameters:

packetData - An NBT compound tag into which you should write your custom description data.

decodeDescriptionPacket

public void decodeDescriptionPacket(net.minecraft.nbt.NBTTagCompound packetData)

Override this to easily read in data from a TileEntity's description packet. Encoded in encodeDescriptionPacket.

Specified by:

decodeDescriptionPacket in interface IMultiblockLogic

Parameters:

packetData - The NBT data from the tile entity's description packet.