appeng.api.networking

Interface IGridNode

public interface IGridNode

Gives you a view into your Nodes connections and information. updateState, getGrid, destroy are required to implement a proper IGridHost. Don't Implement; Acquire from IAppEngApi.createGridNode

Method Summary

Modifier and Type	Method and Description
void	beginVisit(IGridVisitor visitor) lets you walk the grid stating at the current node using a IGridVisitor, generally not needed, please use only if required.
void	destroy() By destroying your node, you destroy any connections, and its existence in the grid, use in invalidate, or onChunkUnload
java.util.EnumSet<AEPartLocation>	getConnectedSides()
IReadOnlyCollection<IGridConnection>	getConnections() lets you iterate a nodes connections
IGrid	getGrid() get the grid for the node, this can change at a moments notice.
IGridBlock	getGridBlock()
IGridHost	getMachine() get the machine represented by the node.
int	getPlayerID()
net.minecraft.world.World	getWorld()
boolean	hasFlag(GridFlags flag) see if this node has a certain flag
boolean	isActive() Reflects the networks status, returns true only if the network is powered, and the network is not booting, this also takes into account channels.
void	loadFromNBT(java.lang.String name, net.minecraft.nbt.NBTTagCompound nodeData) this should be called for each node you create, if you have a nodeData compound to load from, you can store all your nods on a single compound using name.
boolean	meetsChannelRequirements()
void	saveToNBT(java.lang.String name, net.minecraft.nbt.NBTTagCompound nodeData) this should be called for each node you maintain, you can save all your nodes to the same tag with different names, if you fail to complete the load / save procedure, network state may be lost between game load/saves.
void	setPlayerID(int playerID) tell the node who was responsible for placing it, failure to do this may result in in-compatibility with the security system.
void	updateState() inform the node that your IGridBlock has changed its internal state, and force the node to update.

Method Detail

beginVisit

void beginVisit(@Nonnull
                IGridVisitor visitor)

lets you walk the grid stating at the current node using a IGridVisitor, generally not needed, please use only if required.

Parameters:

visitor - visitor

updateState

void updateState()

inform the node that your IGridBlock has changed its internal state, and force the node to update. ALWAYS make sure that your tile entity is in the world, and has its node properly saved to be returned from the host before updating state, If your entity is not in the world, or if you IGridHost returns a different node for the same side you will likely crash the game.

getMachine

@Nonnull
IGridHost getMachine()

get the machine represented by the node.

Returns:

grid host

getGrid

@Nonnull
IGrid getGrid()

get the grid for the node, this can change at a moments notice.

Returns:

grid

destroy

void destroy()

By destroying your node, you destroy any connections, and its existence in the grid, use in invalidate, or onChunkUnload

getWorld

@Nonnull
net.minecraft.world.World getWorld()

Returns:

the world the node is located in

getConnectedSides

@Nonnull
java.util.EnumSet<AEPartLocation> getConnectedSides()

Returns:

a set of the connected sides, INTERNAL represents an invisible connection

getConnections

@Nonnull
IReadOnlyCollection<IGridConnection> getConnections()

lets you iterate a nodes connections

Returns:

grid connections

getGridBlock

@Nonnull
IGridBlock getGridBlock()

Returns:

the IGridBlock for this node

isActive

boolean isActive()

Reflects the networks status, returns true only if the network is powered, and the network is not booting, this also takes into account channels.

Returns:

true if is Network node active, and participating.

loadFromNBT

void loadFromNBT(@Nonnull
                 java.lang.String name,
                 @Nonnull
                 net.minecraft.nbt.NBTTagCompound nodeData)

this should be called for each node you create, if you have a nodeData compound to load from, you can store all your nods on a single compound using name. Important: You must call this before updateState.

Parameters:

name - nbt name

nodeData - to be loaded data

saveToNBT

void saveToNBT(@Nonnull
               java.lang.String name,
               @Nonnull
               net.minecraft.nbt.NBTTagCompound nodeData)

this should be called for each node you maintain, you can save all your nodes to the same tag with different names, if you fail to complete the load / save procedure, network state may be lost between game load/saves.

Parameters:

name - nbt name

nodeData - to be saved data

meetsChannelRequirements

boolean meetsChannelRequirements()

Returns:

if the node's channel requirements are currently met, use this for display purposes, use isActive for status.

hasFlag

boolean hasFlag(@Nonnull
                GridFlags flag)

see if this node has a certain flag

Parameters:

flag - flags

Returns:

true if has flag

getPlayerID

int getPlayerID()

Returns:

the ownerID this represents the person who placed the node.

setPlayerID

void setPlayerID(int playerID)

tell the node who was responsible for placing it, failure to do this may result in in-compatibility with the security system. Called instead of loadFromNBT when initially placed, once set never required again, the value is saved with the Node NBT.

Parameters:

playerID - new player id