forestry.core.multiblock

Interface IMultiblockControllerInternal

All Superinterfaces:

IClimatised, IErrorLogicSource, IMultiblockController, INbtReadable, INbtWritable, IOwnedTile, IStreamableGui

All Known Subinterfaces:

IAlvearyControllerInternal, IFarmControllerInternal

All Known Implementing Classes:

AlvearyController, FakeAlvearyController, FakeFarmController, FakeMultiblockController, FarmController, MultiblockControllerBase, MultiblockControllerForestry, RectangularMultiblockControllerBase

public interface IMultiblockControllerInternal
extends IMultiblockController, INbtWritable, INbtReadable, IOwnedTile, IErrorLogicSource, IClimatised, IStreamableGui

Method Summary

Modifier and Type	Method and Description
void	_onAssimilated(IMultiblockControllerInternal otherController) Called when this machine is consumed by another controller.
void	assimilate(IMultiblockControllerInternal other) Assimilate another controller into this controller.
void	attachBlock(IMultiblockComponent part) Attach a new part to this machine.
void	auditParts() Checks all of the parts in the controller.
java.util.Set<IMultiblockComponent>	checkForDisconnections() Called when this machine may need to check for blocks that are no longer physically connected to the reference coordinate.
void	checkIfMachineIsWhole() Check if the machine is whole or not.
void	decodeDescriptionPacket(net.minecraft.nbt.NBTTagCompound data) Called when the save delegate's tile entity receiving a description packet
java.util.Set<IMultiblockComponent>	detachAllBlocks() Detach all parts.
void	detachBlock(IMultiblockComponent part, boolean chunkUnloading) Call to detach a block from this machine.
void	formatDescriptionPacket(net.minecraft.nbt.NBTTagCompound data) Called when the save delegate's tile entity is being asked for its description packet
java.lang.String	getPartsListString()
net.minecraft.util.math.BlockPos	getReferenceCoord()
java.lang.String	getUnlocalizedType()
net.minecraft.world.World	getWorldObj()
boolean	isEmpty()
void	onAssimilated(IMultiblockControllerInternal assimilator) Callback.
void	recalculateMinMaxCoords() Force this multiblock to recalculate its minimum and maximum coordinates from the list of connected parts.
boolean	shouldConsume(IMultiblockControllerInternal otherController) Tests whether this multiblock should consume the other multiblock and become the new multiblock master when the two multiblocks are adjacent.
void	updateMultiblockEntity() Driver for the update loop.

Methods inherited from interface forestry.api.multiblock.IMultiblockController

getComponents, getLastValidationError, getLastValidationErrorPosition, isAssembled, reassemble

Methods inherited from interface forestry.api.core.INbtWritable

writeToNBT

Methods inherited from interface forestry.api.core.INbtReadable

readFromNBT

Methods inherited from interface forestry.core.owner.IOwnedTile

getOwnerHandler

Methods inherited from interface forestry.api.core.IErrorLogicSource

getErrorLogic

Methods inherited from interface forestry.core.tiles.IClimatised

getExactHumidity, getExactTemperature, getHumidity, getTemperature

Methods inherited from interface forestry.core.network.IStreamableGui

readGuiData, writeGuiData

Method Detail

attachBlock

void attachBlock(IMultiblockComponent part)

Attach a new part to this machine.

Parameters:

part - The part to add.

detachBlock

void detachBlock(IMultiblockComponent part,
                 boolean chunkUnloading)

Call to detach a block from this machine. Generally, this should be called when the tile entity is being released, e.g. on block destruction.

Parameters:

part - The part to detach from this machine.

chunkUnloading - Is this entity detaching due to the chunk unloading? If true, the multiblock will be paused instead of broken.

checkIfMachineIsWhole

void checkIfMachineIsWhole()

Check if the machine is whole or not. If the machine was not whole, but now is, assemble the machine. If the machine was whole, but no longer is, disassemble the machine.

assimilate

void assimilate(IMultiblockControllerInternal other)

Assimilate another controller into this controller. Acquire all of the other controller's blocks and attach them to this one.

Parameters:

other - The controller to merge into this one.

_onAssimilated

void _onAssimilated(IMultiblockControllerInternal otherController)

Called when this machine is consumed by another controller. Essentially, forcibly tear down this object.

Parameters:

otherController - The controller consuming this controller.

onAssimilated

void onAssimilated(IMultiblockControllerInternal assimilator)

Callback. Called after this controller is assimilated into another controller. All blocks have been stripped out of this object and handed over to the other controller. This is intended primarily for cleanup.

Parameters:

assimilator - The controller which has assimilated this controller.

updateMultiblockEntity

void updateMultiblockEntity()

Driver for the update loop. If the machine is assembled, runs the game logic update method.

getReferenceCoord

@Nullable
net.minecraft.util.math.BlockPos getReferenceCoord()

Returns:

The reference coordinate, the block with the lowest x, y, z coordinates, evaluated in that order.

recalculateMinMaxCoords

void recalculateMinMaxCoords()

Force this multiblock to recalculate its minimum and maximum coordinates from the list of connected parts.

formatDescriptionPacket

void formatDescriptionPacket(net.minecraft.nbt.NBTTagCompound data)

Called when the save delegate's tile entity is being asked for its description packet

Parameters:

data - A fresh compound tag to write your multiblock data into

decodeDescriptionPacket

void decodeDescriptionPacket(net.minecraft.nbt.NBTTagCompound data)

Called when the save delegate's tile entity receiving a description packet

Parameters:

data - A compound tag containing multiblock data to import

getWorldObj

net.minecraft.world.World getWorldObj()

isEmpty

boolean isEmpty()

Returns:

True if this controller has no associated blocks, false otherwise

shouldConsume

boolean shouldConsume(IMultiblockControllerInternal otherController)

Tests whether this multiblock should consume the other multiblock and become the new multiblock master when the two multiblocks are adjacent. Assumes both multiblocks are the same type.

Parameters:

otherController - The other multiblock controller.

Returns:

True if this multiblock should consume the other, false otherwise.

getPartsListString

java.lang.String getPartsListString()

getUnlocalizedType

java.lang.String getUnlocalizedType()

Returns:

an unlocalized string to specify the type of the multiblock

auditParts

void auditParts()

Checks all of the parts in the controller. If any are dead or do not exist in the world, they are removed.

checkForDisconnections

java.util.Set<IMultiblockComponent> checkForDisconnections()

Called when this machine may need to check for blocks that are no longer physically connected to the reference coordinate.

Returns:

the parts that were disconnected and removed

detachAllBlocks

java.util.Set<IMultiblockComponent> detachAllBlocks()

Detach all parts. Return a set of all parts which still have a valid tile entity. Chunk-safe.

Returns:

A set of all parts which still have a valid tile entity.