forestry.farming.multiblock

Class FarmController

java.lang.Object

forestry.core.multiblock.MultiblockControllerBase

forestry.core.multiblock.MultiblockControllerForestry

forestry.core.multiblock.RectangularMultiblockControllerBase

forestry.farming.multiblock.FarmController

All Implemented Interfaces:

IErrorLogicSource, ILocatable, INbtReadable, INbtWritable, IExtentCache, IFarmHousing, IFarmController, IMultiblockController, ISocketable, IMultiblockControllerInternal, IStreamableGui, IOwnedTile, IClimatised, ILiquidTankTile, IFarmControllerInternal, net.minecraft.inventory.IInventory, net.minecraft.inventory.ISidedInventory, net.minecraft.world.IWorldNameable

public class FarmController
extends RectangularMultiblockControllerBase
implements IFarmControllerInternal, ILiquidTankTile

Nested Class Summary

Nested classes/interfaces inherited from class forestry.core.multiblock.MultiblockControllerBase

MultiblockControllerBase.AssemblyState

Field Summary

Fields inherited from class forestry.core.multiblock.MultiblockControllerBase

assemblyState, connectedParts, world

Constructor Summary

Constructors

Constructor and Description
FarmController(net.minecraft.world.World world)

Method Summary

Modifier and Type	Method and Description
boolean	canPlantSoil(boolean manual)
void	cleanExtents(FarmDirection direction) Clears the cache for the given direction.
void	decodeDescriptionPacket(net.minecraft.nbt.NBTTagCompound data) Called when the save delegate's tile entity receiving a description packet
boolean	doWork()
void	formatDescriptionPacket(net.minecraft.nbt.NBTTagCompound data) Called when the save delegate's tile entity is being asked for its description packet
net.minecraft.util.math.Vec3i	getArea()
net.minecraft.util.math.BlockPos	getCoordinates()
net.minecraft.util.math.BlockPos	getCoords()
float	getExactHumidity()
float	getExactTemperature()
int	getExtents(FarmDirection direction, net.minecraft.util.math.BlockPos pos) Gets the current extent for the given direction and position.
net.minecraft.util.math.BlockPos	getFarmCorner(FarmDirection direction)
IFarmInventory	getFarmInventory()
IFarmLedgerDelegate	getFarmLedgerDelegate()
IFarmLogic	getFarmLogic(FarmDirection direction)
EnumHumidity	getHumidity()
IInventoryAdapter	getInternalInventory()
net.minecraft.util.math.Vec3i	getOffset()
net.minecraft.item.ItemStack	getSocket(int slot)
int	getSocketCount()
ICircuitSocketType	getSocketType()
int	getStoredFertilizerScaled(int scale)
TankManager	getTankManager()
EnumTemperature	getTemperature()
java.lang.String	getUnlocalizedType()
boolean	hasLiquid(net.minecraftforge.fluids.FluidStack liquid)
void	isGoodForExteriorLevel(IMultiblockComponent part, int level)
void	isGoodForInterior(IMultiblockComponent part)
protected void	isMachineWhole() Checks if a machine is whole.
boolean	isSquare()
boolean	isValidPlatform(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos)
void	onAssimilate(IMultiblockControllerInternal assimilated) Callback.
void	onAssimilated(IMultiblockControllerInternal assimilator) Callback.
void	onAttachedPartWithMultiblockData(IMultiblockComponent part, net.minecraft.nbt.NBTTagCompound data) Call when a block with cached save-delegate data is added to the multiblock.
protected void	onBlockAdded(IMultiblockComponent newPart) Called when a new part is added to the machine.
protected void	onBlockRemoved(IMultiblockComponent oldPart) Called when a part is removed from the machine.
protected void	onMachineDisassembled() Called when a machine is disassembled from an assembled state.
boolean	plantGermling(IFarmable germling, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Callback for IFarmLogics to plant a sapling, seed, germling, stem.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound data)
void	readGuiData(PacketBufferForestry data)
void	removeLiquid(net.minecraftforge.fluids.FluidStack liquid)
void	resetFarmLogic(FarmDirection direction)
void	setExtents(FarmDirection direction, net.minecraft.util.math.BlockPos pos, int extend) Sets the current extent for the given direction and position.
void	setFarmLogic(FarmDirection direction, IFarmLogic logic)
void	setSocket(int slot, net.minecraft.item.ItemStack stack)
java.lang.String	toString()
protected void	updateClient(int tickCount) Client-side update loop.
protected boolean	updateServer(int tickCount) The server-side update loop! Use this similarly to a TileEntity's update loop.
void	writeGuiData(PacketBufferForestry data)
net.minecraft.nbt.NBTTagCompound	writeToNBT(net.minecraft.nbt.NBTTagCompound data)

Methods inherited from class forestry.core.multiblock.RectangularMultiblockControllerBase

getSizeLimits

Methods inherited from class forestry.core.multiblock.MultiblockControllerForestry

canExtractItem, canInsertItem, clear, closeInventory, decrStackSize, getDisplayName, getErrorLogic, getField, getFieldCount, getInventoryStackLimit, getName, getOwnerHandler, getSizeInventory, getSlotsForFace, getStackInSlot, getWorldObj, hasCustomName, isItemValidForSlot, isUsableByPlayer, markDirty, onMachineAssembled, openInventory, removeStackFromSlot, setField, setInventorySlotContents

Methods inherited from class forestry.core.multiblock.MultiblockControllerBase

_onAssimilated, assimilate, attachBlock, auditParts, checkForDisconnections, checkIfMachineIsWhole, detachAllBlocks, detachBlock, getCenterCoord, getComponents, getLastValidationError, getLastValidationErrorPosition, getMaximumCoord, getMinimumCoord, getNumConnectedBlocks, getPartsListString, getReferenceCoord, getTickCount, getTopCenterCoord, isAssembled, isBlockGoodForExteriorLevel, isBlockGoodForInterior, isCoordInMultiblock, isEmpty, onMachinePaused, onMachineRestored, reassemble, recalculateMinMaxCoords, shouldConsume, updateMultiblockEntity, updateOnInterval

Methods inherited from class java.lang.Object

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

Methods inherited from interface forestry.api.farming.IFarmHousing

addPendingProduce, plantGermling

Methods inherited from interface forestry.api.core.IErrorLogicSource

getErrorLogic

Methods inherited from interface forestry.api.farming.IExtentCache

getValidExtent, getValidPosition, increaseExtent

Methods inherited from interface forestry.core.multiblock.IMultiblockControllerInternal

_onAssimilated, assimilate, attachBlock, auditParts, checkForDisconnections, checkIfMachineIsWhole, detachAllBlocks, detachBlock, getPartsListString, getReferenceCoord, getWorldObj, isEmpty, recalculateMinMaxCoords, shouldConsume, updateMultiblockEntity

Methods inherited from interface forestry.api.multiblock.IMultiblockController

getComponents, getLastValidationError, getLastValidationErrorPosition, isAssembled, reassemble

Methods inherited from interface forestry.core.owner.IOwnedTile

getOwnerHandler

Methods inherited from interface forestry.api.core.ILocatable

getWorldObj

Methods inherited from interface net.minecraft.inventory.IInventory

isEmpty

Constructor Detail

FarmController

public FarmController(net.minecraft.world.World world)

Method Detail

getFarmLedgerDelegate

public IFarmLedgerDelegate getFarmLedgerDelegate()

Specified by:

getFarmLedgerDelegate in interface IFarmControllerInternal

getInternalInventory

public IInventoryAdapter getInternalInventory()

Specified by:

getInternalInventory in interface IFarmControllerInternal

Overrides:

getInternalInventory in class MultiblockControllerForestry

getTankManager

public TankManager getTankManager()

Specified by:

getTankManager in interface ILiquidTankTile

Specified by:

getTankManager in interface IFarmControllerInternal

onAttachedPartWithMultiblockData

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

Description copied from class: MultiblockControllerBase

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.

Specified by:

onAttachedPartWithMultiblockData in class MultiblockControllerBase

Parameters:

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

onBlockAdded

protected void onBlockAdded(IMultiblockComponent newPart)

Description copied from class: MultiblockControllerBase

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

Specified by:

onBlockAdded in class MultiblockControllerBase

Parameters:

newPart - The part being added.

onBlockRemoved

protected void onBlockRemoved(IMultiblockComponent oldPart)

Description copied from class: MultiblockControllerBase

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

Specified by:

onBlockRemoved in class MultiblockControllerBase

Parameters:

oldPart - The part being removed.

isMachineWhole

protected void isMachineWhole()
                       throws MultiblockValidationException

Description copied from class: MultiblockControllerBase

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

Overrides:

isMachineWhole in class RectangularMultiblockControllerBase

Throws:

MultiblockValidationException

onMachineDisassembled

protected void onMachineDisassembled()

Description copied from class: MultiblockControllerBase

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

Overrides:

onMachineDisassembled in class MultiblockControllerBase

isGoodForExteriorLevel

public void isGoodForExteriorLevel(IMultiblockComponent part,
                                   int level)
                            throws MultiblockValidationException

Specified by:

isGoodForExteriorLevel in class RectangularMultiblockControllerBase

Throws:

MultiblockValidationException

isGoodForInterior

public void isGoodForInterior(IMultiblockComponent part)
                       throws MultiblockValidationException

Specified by:

isGoodForInterior in class RectangularMultiblockControllerBase

Throws:

MultiblockValidationException

onAssimilate

public void onAssimilate(IMultiblockControllerInternal assimilated)

Description copied from class: MultiblockControllerBase

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

Specified by:

onAssimilate in class MultiblockControllerBase

Parameters:

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

onAssimilated

public void onAssimilated(IMultiblockControllerInternal assimilator)

Description copied from class: MultiblockControllerBase

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

Specified by:

onAssimilated in class MultiblockControllerBase

Parameters:

assimilator - The controller which has assimilated this controller.

updateServer

protected boolean updateServer(int tickCount)

Description copied from class: MultiblockControllerBase

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.

Specified by:

updateServer in class MultiblockControllerBase

Returns:

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

updateClient

protected void updateClient(int tickCount)

Description copied from class: MultiblockControllerBase

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

Specified by:

updateClient in class MultiblockControllerBase

writeToNBT

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

Specified by:

writeToNBT in interface INbtWritable

Overrides:

writeToNBT in class MultiblockControllerForestry

readFromNBT

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

Specified by:

readFromNBT in interface INbtReadable

Overrides:

readFromNBT in class MultiblockControllerForestry

formatDescriptionPacket

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

Description copied from interface: IMultiblockControllerInternal

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

Specified by:

formatDescriptionPacket in interface IMultiblockControllerInternal

Parameters:

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

decodeDescriptionPacket

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

Description copied from interface: IMultiblockControllerInternal

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

Specified by:

decodeDescriptionPacket in interface IMultiblockControllerInternal

Parameters:

data - A compound tag containing multiblock data to import

getCoordinates

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

Specified by:

getCoordinates in interface ILocatable

writeGuiData

public void writeGuiData(PacketBufferForestry data)

Specified by:

writeGuiData in interface IStreamableGui

readGuiData

public void readGuiData(PacketBufferForestry data)
                 throws java.io.IOException

Specified by:

readGuiData in interface IStreamableGui

Throws:

java.io.IOException

getTemperature

public EnumTemperature getTemperature()

Specified by:

getTemperature in interface IClimatised

getHumidity

public EnumHumidity getHumidity()

Specified by:

getHumidity in interface IClimatised

getExactTemperature

public float getExactTemperature()

Specified by:

getExactTemperature in interface IClimatised

getExactHumidity

public float getExactHumidity()

Specified by:

getExactHumidity in interface IClimatised

getCoords

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

Specified by:

getCoords in interface IFarmHousing

getOffset

public net.minecraft.util.math.Vec3i getOffset()

Specified by:

getOffset in interface IFarmHousing

getArea

public net.minecraft.util.math.Vec3i getArea()

Specified by:

getArea in interface IFarmHousing

getFarmCorner

public net.minecraft.util.math.BlockPos getFarmCorner(FarmDirection direction)

Specified by:

getFarmCorner in interface IFarmHousing

getUnlocalizedType

public java.lang.String getUnlocalizedType()

Specified by:

getUnlocalizedType in interface IMultiblockControllerInternal

Returns:

an unlocalized string to specify the type of the multiblock

doWork

public boolean doWork()

Specified by:

doWork in interface IFarmHousing

Returns:

true if any work was done, false otherwise.

getStoredFertilizerScaled

public int getStoredFertilizerScaled(int scale)

Specified by:

getStoredFertilizerScaled in interface IFarmHousing

hasLiquid

public boolean hasLiquid(net.minecraftforge.fluids.FluidStack liquid)

Specified by:

hasLiquid in interface IFarmHousing

removeLiquid

public void removeLiquid(net.minecraftforge.fluids.FluidStack liquid)

Specified by:

removeLiquid in interface IFarmHousing

plantGermling

public boolean plantGermling(IFarmable germling,
                             net.minecraft.world.World world,
                             net.minecraft.util.math.BlockPos pos)

Description copied from interface: IFarmHousing

Callback for IFarmLogics to plant a sapling, seed, germling, stem. Will remove the appropriate germling from the farm's inventory. It's up to the logic to only call this on a valid location.

Specified by:

plantGermling in interface IFarmHousing

Returns:

true if planting was successful, false otherwise.

getFarmInventory

public IFarmInventory getFarmInventory()

Specified by:

getFarmInventory in interface IFarmHousing

setFarmLogic

public void setFarmLogic(FarmDirection direction,
                         IFarmLogic logic)

Specified by:

setFarmLogic in interface IFarmHousing

resetFarmLogic

public void resetFarmLogic(FarmDirection direction)

Specified by:

resetFarmLogic in interface IFarmHousing

getFarmLogic

public IFarmLogic getFarmLogic(FarmDirection direction)

Specified by:

getFarmLogic in interface IFarmHousing

getSocketCount

public int getSocketCount()

Specified by:

getSocketCount in interface ISocketable

getSocket

public net.minecraft.item.ItemStack getSocket(int slot)

Specified by:

getSocket in interface ISocketable

setSocket

public void setSocket(int slot,
                      net.minecraft.item.ItemStack stack)

Specified by:

setSocket in interface ISocketable

getSocketType

public ICircuitSocketType getSocketType()

Specified by:

getSocketType in interface ISocketable

canPlantSoil

public boolean canPlantSoil(boolean manual)

Specified by:

canPlantSoil in interface IFarmHousing

isValidPlatform

public boolean isValidPlatform(net.minecraft.world.World world,
                               net.minecraft.util.math.BlockPos pos)

Specified by:

isValidPlatform in interface IFarmHousing

isSquare

public boolean isSquare()

Specified by:

isSquare in interface IFarmHousing

getExtents

public int getExtents(FarmDirection direction,
                      net.minecraft.util.math.BlockPos pos)

Description copied from interface: IExtentCache

Gets the current extent for the given direction and position.

Specified by:

getExtents in interface IExtentCache

Parameters:

direction - The direction of the farm logic.

pos - The position the logic starts to operate on

Returns:

The current extent for the given direction and position.

setExtents

public void setExtents(FarmDirection direction,
                       net.minecraft.util.math.BlockPos pos,
                       int extend)

Description copied from interface: IExtentCache

Sets the current extent for the given direction and position.

Specified by:

setExtents in interface IExtentCache

Parameters:

direction - The direction of the farm logic.

pos - The position the logic starts to operate on

extend - The extent

cleanExtents

public void cleanExtents(FarmDirection direction)

Description copied from interface: IExtentCache

Clears the cache for the given direction.

For example used if the player remove the circuit from the farm.

Specified by:

cleanExtents in interface IExtentCache

Parameters:

direction - The direction that should be cleared

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object