li.cil.oc.api.prefab

Class TileEntityEnvironment

java.lang.Object

net.minecraft.tileentity.TileEntity

li.cil.oc.api.prefab.TileEntityEnvironment

All Implemented Interfaces:

Environment, net.minecraft.server.gui.IUpdatePlayerListBox

public abstract class TileEntityEnvironment
extends net.minecraft.tileentity.TileEntity
implements Environment, net.minecraft.server.gui.IUpdatePlayerListBox

TileEntities can implement the Environment interface to allow them to interact with the component network, by providing a Node and connecting it to said network.

Nodes in such a network can communicate with each other, or just use the network as an index structure to find other nodes connected to them.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addedToNetwork
protected Node	node This must be set in subclasses to the node that is used to represent this tile entity.

Fields inherited from class net.minecraft.tileentity.TileEntity

blockType, classToNameMap, INFINITE_EXTENT_AABB, pos, tileEntityInvalid, worldObj

Constructor Summary

Constructors

Constructor and Description
TileEntityEnvironment()

Method Summary

Modifier and Type	Method and Description
void	invalidate()
Node	node() The node this environment wraps.
void	onChunkUnload()
void	onConnect(Node node) This is called when a node is added to a network.
void	onDisconnect(Node node) This is called when a node is removed from the network.
void	onMessage(Message message) This is the generic message handler.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)
void	update()
void	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

Methods inherited from class net.minecraft.tileentity.TileEntity

addInfoToCrashReport, addMapping, canRenderBreaking, createAndLoadEntity, getBlockMetadata, getBlockType, getDescriptionPacket, getDistanceSq, getMaxRenderDistanceSquared, getPos, getRenderBoundingBox, getTileData, getWorld, hasWorldObj, isInvalid, markDirty, onDataPacket, receiveClientEvent, restrictNBTCopy, setPos, setWorldObj, shouldRefresh, shouldRenderInPass, updateContainingBlockInfo, validate

Methods inherited from class java.lang.Object

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

Field Detail

node

protected Node node

This must be set in subclasses to the node that is used to represent this tile entity.

You must only create new nodes using the factory method in the network API, Network.newNode(Environment, Visibility).

For example:

 // The first parameters to newNode is the host() of the node, which will
 // usually be this tile entity. The second one is it's reachability,
 // which determines how other nodes in the same network can query this
 // node. See Network.nodes(li.cil.oc.api.network.Node).
 node = Network.newNode(this, Visibility.Network)
       // This call allows the node to consume energy from the
       // component network it is in and act as a consumer, or to
       // inject energy into that network and act as a producer.
       // If you do not need energy remove this call.
       .withConnector()
       // This call marks the tile entity as a component. This means you
       // can mark methods in it using the Callback
       // annotation, making them callable from user code. The first
       // parameter is the name by which the component will be known in
       // the computer, in this case it could be accessed as
       // component.example. The second parameter is the
       // component's visibility. This is like the node's reachability,
       // but only applies to computers. For example, network cards can
       // only be seen by the computer they're installed in, but
       // can be reached by all other network cards in the same
       // network. If you do not need callbacks remove this call.
       .withComponent("example", Visibility.Neighbors)
       // Finalizes the construction of the node and returns it.
       .create();
 

addedToNetwork

protected boolean addedToNetwork

Constructor Detail

TileEntityEnvironment

public TileEntityEnvironment()

Method Detail

node

public Node node()

Description copied from interface: Environment

The node this environment wraps.

The node is the environments gateway to the component network, and thus its preferred way to interact with other components in the same network.

Specified by:

node in interface Environment

Returns:

the node this environment wraps.

onConnect

public void onConnect(Node node)

Description copied from interface: Environment

This is called when a node is added to a network.

This is also called for the node itself, if it was added to the network.

At this point the node's network is never null and you can use it to query it for other nodes. Use this to perform initialization logic, such as building lists of nodes of a certain type in the network.

For example, if node A is added to a network with nodes B and C, these calls are made:

• A.onConnect(A)
• A.onConnect(B)
• A.onConnect(C)
• B.onConnect(A)
• C.onConnect(A)

Specified by:

onConnect in interface Environment

onDisconnect

public void onDisconnect(Node node)

Description copied from interface: Environment

This is called when a node is removed from the network.

This is also called for the node itself, when it has been removed from its network. Note that this is called on the node that is being removed only once with the node itself as the parameter.

At this point the node's network is no longer available (null). Use this to perform clean-up logic such as removing references to the removed node.

For example, if node A is removed from a network with nodes A, B and C, these calls are made:

• A.onDisconnect(A)
• B.onDisconnect(A)
• C.onDisconnect(A)

Specified by:

onDisconnect in interface Environment

onMessage

public void onMessage(Message message)

Description copied from interface: Environment

This is the generic message handler.

It is called whenever this environments Node receives a message that was sent via one of the send methods in the Network or the Node itself.

Specified by:

onMessage in interface Environment

Parameters:

message - the message to handle.

update

public void update()

Specified by:

update in interface net.minecraft.server.gui.IUpdatePlayerListBox

onChunkUnload

public void onChunkUnload()

Overrides:

onChunkUnload in class net.minecraft.tileentity.TileEntity

invalidate

public void invalidate()

Overrides:

invalidate in class net.minecraft.tileentity.TileEntity

readFromNBT

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

Overrides:

readFromNBT in class net.minecraft.tileentity.TileEntity

writeToNBT

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

Overrides:

writeToNBT in class net.minecraft.tileentity.TileEntity