li.cil.oc.api.prefab

Class ManagedEnvironment

java.lang.Object

li.cil.oc.api.prefab.ManagedEnvironment

All Implemented Interfaces:

Environment, ManagedEnvironment, Persistable

public abstract class ManagedEnvironment
extends java.lang.Object
implements ManagedEnvironment

Simple base implementation of the ManagedEnvironment interface, so unused methods don't clutter the implementing class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NODE_TAG

Constructor Summary

Constructors

Constructor and Description
ManagedEnvironment()

Method Summary

Modifier and Type	Method and Description
boolean	canUpdate() Like the method of the same name on tile entities, this is used to decide whether to put a component in the list of components that need updating, i.e.
void	load(net.minecraft.nbt.NBTTagCompound nbt) Restores a previous state of the object from the specified NBT tag.
Node	node() The node this environment wraps.
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	save(net.minecraft.nbt.NBTTagCompound nbt) Saves the current state of the object into the specified NBT tag.
protected void	setNode(Node value)
void	update() This is called by the host of this managed environment once per tick.

Methods inherited from class java.lang.Object

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

Field Detail

NODE_TAG

public static final java.lang.String NODE_TAG

See Also:

Constant Field Values

Constructor Detail

ManagedEnvironment

public ManagedEnvironment()

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.

setNode

protected void setNode(Node value)

canUpdate

public boolean canUpdate()

Description copied from interface: ManagedEnvironment

Like the method of the same name on tile entities, this is used to decide whether to put a component in the list of components that need updating, i.e. for which ManagedEnvironment.update() should be called each tick.

Return false here, if you do not need updates, to improve performance.

Specified by:

canUpdate in interface ManagedEnvironment

update

public void update()

Description copied from interface: ManagedEnvironment

This is called by the host of this managed environment once per tick.

Specified by:

update in interface ManagedEnvironment

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.

load

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

Description copied from interface: Persistable

Restores a previous state of the object from the specified NBT tag.

Specified by:

load in interface Persistable

Parameters:

nbt - the tag to read the state from.

save

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

Description copied from interface: Persistable

Saves the current state of the object into the specified NBT tag.

This should write the state in such a way that it can be restored when Persistable.load(net.minecraft.nbt.NBTTagCompound) is called with that tag.

Specified by:

save in interface Persistable

Parameters:

nbt - the tag to save the state to.