forestry.core.multiblock

Class MultiblockWorldRegistry

java.lang.Object

forestry.core.multiblock.MultiblockWorldRegistry

public class MultiblockWorldRegistry
extends java.lang.Object

This class manages all the multiblock controllers that exist in a given world, either client- or server-side. You must create different registries for server and client worlds.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addDeadController(IMultiblockControllerInternal deadController) Registers a controller as dead.
void	addDirtyController(IMultiblockControllerInternal dirtyController) Registers a controller as dirty - its list of attached blocks has changed, and it must be re-checked for assembly and, possibly, for orphans.
java.util.Set<IMultiblockControllerInternal>	getControllers() Use this only if you know what you're doing.
void	onChunkLoaded(int chunkX, int chunkZ) Called when a chunk has finished loading.
void	onPartAdded(IMultiblockComponent part) Called when a multiblock part is added to the world, either via chunk-load or user action.
void	onPartRemovedFromWorld(IMultiblockComponent part) Called when a part is removed from the world, via user action or via chunk unloads.
void	onWorldUnloaded() Called when the world which this World Registry represents is fully unloaded from the system.
void	processMultiblockChanges() Called prior to processing multiblock controllers.
void	tickStart() Called before Tile Entities are ticked in the world.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiblockWorldRegistry

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

Method Detail

tickStart

public void tickStart()

Called before Tile Entities are ticked in the world. Run game logic.

processMultiblockChanges

public void processMultiblockChanges()

Called prior to processing multiblock controllers. Do bookkeeping.

onPartAdded

public void onPartAdded(IMultiblockComponent part)

Called when a multiblock part is added to the world, either via chunk-load or user action. If its chunk is loaded, it will be processed during the next tick. If the chunk is not loaded, it will be added to a list of objects waiting for a chunkload.

Parameters:

part - The part which is being added to this world.

onPartRemovedFromWorld

public void onPartRemovedFromWorld(IMultiblockComponent part)

Called when a part is removed from the world, via user action or via chunk unloads. This part is removed from any lists in which it may be, and its machine is marked for recalculation.

Parameters:

part - The part which is being removed.

onWorldUnloaded

public void onWorldUnloaded()

Called when the world which this World Registry represents is fully unloaded from the system. Does some housekeeping just to be nice.

onChunkLoaded

public void onChunkLoaded(int chunkX,
                          int chunkZ)

Called when a chunk has finished loading. Adds all of the parts which are awaiting load to the list of parts which are orphans and therefore will be added to machines after the next world tick.

Parameters:

chunkX - Chunk X coordinate (world coordate >> 4) of the chunk that was loaded

chunkZ - Chunk Z coordinate (world coordate >> 4) of the chunk that was loaded

addDeadController

public void addDeadController(IMultiblockControllerInternal deadController)

Registers a controller as dead. It will be cleaned up at the end of the next world tick. Note that a controller must shed all of its blocks before being marked as dead, or the system will complain at you.

Parameters:

deadController - The controller which is dead.

addDirtyController

public void addDirtyController(IMultiblockControllerInternal dirtyController)

Registers a controller as dirty - its list of attached blocks has changed, and it must be re-checked for assembly and, possibly, for orphans.

Parameters:

dirtyController - The dirty controller.

getControllers

public java.util.Set<IMultiblockControllerInternal> getControllers()

Use this only if you know what you're doing. You should rarely need to iterate over all controllers in a world!

Returns:

An (unmodifiable) set of controllers which are active in this world.