appeng.api.networking

Interface IGridCache

All Known Subinterfaces:

ICraftingGrid, IEnergyGrid, IPathingGrid, ISecurityGrid, ISpatialCache, IStorageGrid, ITickManager

public interface IGridCache

Allows you to create a network wise service, AE2 uses these for providing item, spatial, and tunnel services. Any Class that implements this, should have a public default constructor that takes a single argument of type IGrid.

Method Summary

Modifier and Type	Method and Description
void	addNode(IGridNode gridNode, IGridHost machine) informs you cache that a machine was added to the grid.
void	onJoin(IGridStorage sourceStorage) Called when two grids merge into one, AE will call a join as it Iteratively processes changes.
void	onSplit(IGridStorage destinationStorage) Called when a grid splits into two grids, AE will call a split as it Iteratively processes changes.
void	onUpdateTick() Called each tick for the network, allows you to have active network wide behaviors.
void	populateGridStorage(IGridStorage destinationStorage) Called when saving changes,
void	removeNode(IGridNode gridNode, IGridHost machine) inform your cache, that a machine was removed from the grid.

Method Detail

onUpdateTick

void onUpdateTick()

Called each tick for the network, allows you to have active network wide behaviors.

removeNode

void removeNode(@Nonnull
                IGridNode gridNode,
                @Nonnull
                IGridHost machine)

inform your cache, that a machine was removed from the grid. Important: Do not trust the grids state in this method, interact only with the node you are passed, if you need to manage other grid information, do it on the next updateTick.

Parameters:

gridNode - removed from that grid

machine - to be removed machine

addNode

void addNode(@Nonnull
             IGridNode gridNode,
             @Nonnull
             IGridHost machine)

informs you cache that a machine was added to the grid. Important: Do not trust the grids state in this method, interact only with the node you are passed, if you need to manage other grid information, do it on the next updateTick.

Parameters:

gridNode - added to grid node

machine - to be added machine

onSplit

void onSplit(@Nonnull
             IGridStorage destinationStorage)

Called when a grid splits into two grids, AE will call a split as it Iteratively processes changes. The destination should receive half, and the current cache should receive half.

Parameters:

destinationStorage - storage which receives half of old grid

onJoin

void onJoin(@Nonnull
            IGridStorage sourceStorage)

Called when two grids merge into one, AE will call a join as it Iteratively processes changes. Use this method to incorporate all the data from the source into your cache.

Parameters:

sourceStorage - old storage

populateGridStorage

void populateGridStorage(@Nonnull
                         IGridStorage destinationStorage)

Called when saving changes,

Parameters:

destinationStorage - storage