appeng.api.networking

Interface IGridBlock

All Known Subinterfaces:

IGridMultiblock

public interface IGridBlock

An Implementation is required to create your node for IGridHost Implement for use with IGridHost

Method Summary

Modifier and Type	Method and Description
java.util.EnumSet<net.minecraft.util.EnumFacing>	getConnectableSides() Determine which sides of the block can be connected too, only used when isWorldAccessible returns true, not used for IPart implementations.
java.util.EnumSet<GridFlags>	getFlags() Various flags that AE uses to modify basic behavior for various parts of the network.
AEColor	getGridColor()
double	getIdlePowerUsage() how much power to drain per tick as part of idle network usage.
DimensionalCoord	getLocation() Must not return when isWorldAccessible() is true.
IGridHost	getMachine()
net.minecraft.item.ItemStack	getMachineRepresentation() Determines what item stack is used to render this node in the GUI.
void	gridChanged() called when the grid for the node has changed, the general grid state should not be trusted at this point.
boolean	isWorldAccessible() Generally speaking you will return true for this, the one exception is buses, or worm holes where the node represents something that isn't a real connection in the world, but rather one represented internally to the block.
void	onGridNotification(GridNotification notification) Notifies your IGridBlock that changes were made to your connections
void	setNetworkStatus(IGrid grid, int channelsInUse) Deprecated. to be removed in rv7

Method Detail

getIdlePowerUsage

@Nonnegative
double getIdlePowerUsage()

how much power to drain per tick as part of idle network usage. if the value of this changes, you must post a MENetworkPowerIdleChange

Returns:

ae/t to use.

getFlags

@Nonnull
java.util.EnumSet<GridFlags> getFlags()

Various flags that AE uses to modify basic behavior for various parts of the network.

Returns:

Set of flags for this IGridBlock

isWorldAccessible

boolean isWorldAccessible()

Generally speaking you will return true for this, the one exception is buses, or worm holes where the node represents something that isn't a real connection in the world, but rather one represented internally to the block.

Returns:

if the world can connect to this node, and the node can connect to the world.

getLocation

@Nonnull
DimensionalCoord getLocation()

Must not return when isWorldAccessible() is true. Otherwise the behavior is unspecified.

Returns:

current location of this node

getGridColor

@Nonnull
AEColor getGridColor()

Returns:

Transparent, or a valid color, NULL IS NOT A VALID RETURN

onGridNotification

void onGridNotification(@Nonnull
                        GridNotification notification)

Notifies your IGridBlock that changes were made to your connections

setNetworkStatus

@Deprecated
void setNetworkStatus(IGrid grid,
                                   int channelsInUse)

Deprecated. to be removed in rv7

Update Blocks network/connection/booting status. grid,

Parameters:

grid - grid

channelsInUse - used channels

getConnectableSides

@Nonnull
java.util.EnumSet<net.minecraft.util.EnumFacing> getConnectableSides()

Determine which sides of the block can be connected too, only used when isWorldAccessible returns true, not used for IPart implementations.

getMachine

@Nonnull
IGridHost getMachine()

Returns:

the IGridHost for the node, this will be an IGridPart or a TileEntity generally speaking.

gridChanged

void gridChanged()

called when the grid for the node has changed, the general grid state should not be trusted at this point.

getMachineRepresentation

@Nonnull
net.minecraft.item.ItemStack getMachineRepresentation()

Determines what item stack is used to render this node in the GUI.

Returns:

the render item stack to use to render this node, null is valid, and will not show this node.