forestry.core.multiblock

Class MultiblockControllerBase

java.lang.Object

forestry.core.multiblock.MultiblockControllerBase

All Implemented Interfaces:

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

Direct Known Subclasses:

MultiblockControllerForestry

public abstract class MultiblockControllerBase
extends java.lang.Object
implements IMultiblockControllerInternal

This class contains the base logic for "multiblock controllers". Conceptually, they are meta-TileEntities. They govern the logic for an associated group of TileEntities.

Subordinate TileEntities implement the IMultiblockComponent class and, generally, should not have an update() loop.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MultiblockControllerBase.AssemblyState

Field Summary

Fields

Modifier and Type	Field and Description
protected MultiblockControllerBase.AssemblyState	assemblyState
protected java.util.HashSet<IMultiblockComponent>	connectedParts
protected net.minecraft.world.World	world

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiblockControllerBase(net.minecraft.world.World world)

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.
java.util.Set<IMultiblockComponent>	detachAllBlocks() Detach all parts.
void	detachBlock(IMultiblockComponent part, boolean chunkUnloading) Call to detach a block from this machine.
protected net.minecraft.util.math.BlockPos	getCenterCoord()
java.util.Collection<IMultiblockComponent>	getComponents()
java.lang.String	getLastValidationError()
net.minecraft.util.math.BlockPos	getLastValidationErrorPosition()
protected net.minecraft.util.math.BlockPos	getMaximumCoord()
protected net.minecraft.util.math.BlockPos	getMinimumCoord()
int	getNumConnectedBlocks()
java.lang.String	getPartsListString()
net.minecraft.util.math.BlockPos	getReferenceCoord()
protected int	getTickCount()
protected net.minecraft.util.math.BlockPos	getTopCenterCoord()
boolean	isAssembled()
protected void	isBlockGoodForExteriorLevel(int level, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos)
protected void	isBlockGoodForInterior(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) The interior is any block that does not touch blocks outside the machine.
protected boolean	isCoordInMultiblock(int x, int y, int z)
boolean	isEmpty()
protected abstract void	isMachineWhole() Checks if a machine is whole.
protected abstract void	onAssimilate(IMultiblockControllerInternal assimilated) Callback.
abstract void	onAssimilated(IMultiblockControllerInternal assimilator) Callback.
protected abstract void	onAttachedPartWithMultiblockData(IMultiblockComponent part, net.minecraft.nbt.NBTTagCompound data) Call when a block with cached save-delegate data is added to the multiblock.
protected abstract void	onBlockAdded(IMultiblockComponent newPart) Called when a new part is added to the machine.
protected abstract void	onBlockRemoved(IMultiblockComponent oldPart) Called when a part is removed from the machine.
protected void	onMachineAssembled() Called when a machine is assembled from a disassembled state.
protected void	onMachineDisassembled() Called when a machine is disassembled from an assembled state.
protected void	onMachinePaused() Called when a machine is paused from an assembled state This generally only happens due to chunk-loads and other "system" events.
protected void	onMachineRestored() Called when a machine is restored to the assembled state from a paused state.
void	reassemble() Call to force the controller to check the multiblock's validity.
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.
protected abstract void	updateClient(int tickCount) Client-side update loop.
void	updateMultiblockEntity() Driver for the update loop.
protected boolean	updateOnInterval(int tickInterval)
protected abstract boolean	updateServer(int tickCount) The server-side update loop! Use this similarly to a TileEntity's update loop.

Methods inherited from class java.lang.Object

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

Methods inherited from interface forestry.core.multiblock.IMultiblockControllerInternal

decodeDescriptionPacket, formatDescriptionPacket, getUnlocalizedType, getWorldObj

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

Field Detail

world

protected final net.minecraft.world.World world

assemblyState

protected MultiblockControllerBase.AssemblyState assemblyState

connectedParts

protected java.util.HashSet<IMultiblockComponent> connectedParts

Constructor Detail

MultiblockControllerBase

protected MultiblockControllerBase(net.minecraft.world.World world)

Method Detail

getComponents

public java.util.Collection<IMultiblockComponent> getComponents()

Specified by:

getComponents in interface IMultiblockController

Returns:

all the multiblock components attached to this controller

onAttachedPartWithMultiblockData

protected abstract void onAttachedPartWithMultiblockData(IMultiblockComponent part,
                                                         net.minecraft.nbt.NBTTagCompound data)

Call when a block with cached save-delegate data is added to the multiblock. The part will be notified that the data has been used after this call completes.

Parameters:

part - The NBT tag containing this controller's data.

attachBlock

public void attachBlock(IMultiblockComponent part)

Description copied from interface: IMultiblockControllerInternal

Attach a new part to this machine.

Specified by:

attachBlock in interface IMultiblockControllerInternal

Parameters:

part - The part to add.

onBlockAdded

protected abstract void onBlockAdded(IMultiblockComponent newPart)

Called when a new part is added to the machine. Good time to register things into lists.

Parameters:

newPart - The part being added.

onBlockRemoved

protected abstract void onBlockRemoved(IMultiblockComponent oldPart)

Called when a part is removed from the machine. Good time to clean up lists.

Parameters:

oldPart - The part being removed.

onMachineAssembled

protected void onMachineAssembled()

Called when a machine is assembled from a disassembled state.

onMachineRestored

protected void onMachineRestored()

Called when a machine is restored to the assembled state from a paused state.

onMachinePaused

protected void onMachinePaused()

Called when a machine is paused from an assembled state This generally only happens due to chunk-loads and other "system" events.

onMachineDisassembled

protected void onMachineDisassembled()

Called when a machine is disassembled from an assembled state. This happens due to user or in-game actions (e.g. explosions)

detachBlock

public void detachBlock(IMultiblockComponent part,
                        boolean chunkUnloading)

Description copied from interface: IMultiblockControllerInternal

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.

Specified by:

detachBlock in interface IMultiblockControllerInternal

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.

getLastValidationError

public java.lang.String getLastValidationError()

Specified by:

getLastValidationError in interface IMultiblockController

Returns:

A string representing the last error encountered when trying to assemble this multiblock, or null if there is no error.

getLastValidationErrorPosition

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

Specified by:

getLastValidationErrorPosition in interface IMultiblockController

reassemble

public void reassemble()

Description copied from interface: IMultiblockController

Call to force the controller to check the multiblock's validity. Use when important conditions around the multiblock change (i.e. Alveary slabs are removed and the alveary block detects it's neighbor changed) Changes to multiblock components are handled automatically and should not call this.

Specified by:

reassemble in interface IMultiblockController

isMachineWhole

protected abstract void isMachineWhole()
                                throws MultiblockValidationException

Checks if a machine is whole. If not, throws an exception with the reason why.

Throws:

MultiblockValidationException

checkIfMachineIsWhole

public void checkIfMachineIsWhole()

Description copied from interface: IMultiblockControllerInternal

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.

Specified by:

checkIfMachineIsWhole in interface IMultiblockControllerInternal

assimilate

public void assimilate(IMultiblockControllerInternal other)

Description copied from interface: IMultiblockControllerInternal

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

Specified by:

assimilate in interface IMultiblockControllerInternal

Parameters:

other - The controller to merge into this one.

_onAssimilated

public void _onAssimilated(IMultiblockControllerInternal otherController)

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

Specified by:

_onAssimilated in interface IMultiblockControllerInternal

Parameters:

otherController - The controller consuming this controller.

onAssimilate

protected abstract void onAssimilate(IMultiblockControllerInternal assimilated)

Callback. Called after this controller assimilates all the blocks from another controller. Use this to absorb that controller's game data.

Parameters:

assimilated - The controller whose uniqueness was added to our own.

onAssimilated

public abstract 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.

Specified by:

onAssimilated in interface IMultiblockControllerInternal

Parameters:

assimilator - The controller which has assimilated this controller.

updateMultiblockEntity

public final void updateMultiblockEntity()

Description copied from interface: IMultiblockControllerInternal

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

Specified by:

updateMultiblockEntity in interface IMultiblockControllerInternal

updateServer

protected abstract boolean updateServer(int tickCount)

The server-side update loop! Use this similarly to a TileEntity's update loop. You do not need to call your superclass' update() if you're directly derived from MultiblockControllerBase. This is a callback. Note that this will only be called when the machine is assembled.

Returns:

True if the multiblock should save data, i.e. its internal game state has changed. False otherwise.

getTickCount

protected int getTickCount()

updateClient

protected abstract void updateClient(int tickCount)

Client-side update loop. Generally, this shouldn't do anything, but if you want to do some interpolation or something, do it here.

updateOnInterval

protected final boolean updateOnInterval(int tickInterval)

isBlockGoodForExteriorLevel

protected void isBlockGoodForExteriorLevel(int level,
                                           net.minecraft.world.World world,
                                           net.minecraft.util.math.BlockPos pos)
                                    throws MultiblockValidationException

Parameters:

level - the level of the block on the multiblock, starting at 0 for the bottom.

world - World object for the world in which this controller is located.

pos - coordinate of the block being tested

Throws:

MultiblockValidationException - if the tested block is not allowed on the machine's side faces

isBlockGoodForInterior

protected void isBlockGoodForInterior(net.minecraft.world.World world,
                                      net.minecraft.util.math.BlockPos pos)
                               throws MultiblockValidationException

The interior is any block that does not touch blocks outside the machine.

Parameters:

world - World object for the world in which this controller is located.

pos - coordinate of the block being tested

Throws:

MultiblockValidationException - if the tested block is not allowed in the machine's interior

getReferenceCoord

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

Specified by:

getReferenceCoord in interface IMultiblockControllerInternal

Returns:

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

getNumConnectedBlocks

public int getNumConnectedBlocks()

Returns:

The number of blocks connected to this controller.

recalculateMinMaxCoords

public void recalculateMinMaxCoords()

Description copied from interface: IMultiblockControllerInternal

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

Specified by:

recalculateMinMaxCoords in interface IMultiblockControllerInternal

getMinimumCoord

protected net.minecraft.util.math.BlockPos getMinimumCoord()

Returns:

The minimum bounding-box coordinate containing this machine's blocks.

getMaximumCoord

protected net.minecraft.util.math.BlockPos getMaximumCoord()

Returns:

The maximum bounding-box coordinate containing this machine's blocks.

getCenterCoord

protected final net.minecraft.util.math.BlockPos getCenterCoord()

getTopCenterCoord

protected final net.minecraft.util.math.BlockPos getTopCenterCoord()

isCoordInMultiblock

protected final boolean isCoordInMultiblock(int x,
                                            int y,
                                            int z)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IMultiblockControllerInternal

Returns:

True if this controller has no associated blocks, false otherwise

shouldConsume

public boolean shouldConsume(IMultiblockControllerInternal otherController)

Description copied from interface: IMultiblockControllerInternal

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.

Specified by:

shouldConsume in interface IMultiblockControllerInternal

Parameters:

otherController - The other multiblock controller.

Returns:

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

getPartsListString

public java.lang.String getPartsListString()

Specified by:

getPartsListString in interface IMultiblockControllerInternal

auditParts

public void auditParts()

Description copied from interface: IMultiblockControllerInternal

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

Specified by:

auditParts in interface IMultiblockControllerInternal

checkForDisconnections

public java.util.Set<IMultiblockComponent> checkForDisconnections()

Description copied from interface: IMultiblockControllerInternal

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

Specified by:

checkForDisconnections in interface IMultiblockControllerInternal

Returns:

the parts that were disconnected and removed

detachAllBlocks

public java.util.Set<IMultiblockComponent> detachAllBlocks()

Description copied from interface: IMultiblockControllerInternal

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

Specified by:

detachAllBlocks in interface IMultiblockControllerInternal

Returns:

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

isAssembled

public boolean isAssembled()

Specified by:

isAssembled in interface IMultiblockController

Returns:

True if this multiblock machine is considered assembled and ready to go.