li.cil.oc.api.machine

Interface Owner

All Superinterfaces:

Context

public interface Owner
extends Context

This interface has to be implemented by 'owners' of machine instances.

It provides some context for the machine, in particular which world it is running in, to allow querying the time of day, for example.

Method Summary

Methods

Modifier and Type	Method and Description
int	installedMemory() The amount of memory (RAM) made available to the machine, in bytes.
void	markAsChanged() This is called by the machine when its state changed (which can be multiple times per actual game tick), to notify the owner that it should save its state on the next world save.
int	maxComponents() The number of components the machine can address without crashing.
void	onMachineConnect(Node node) This is called on the owner when the machine's Environment.onConnect(Node) method gets called.
void	onMachineDisconnect(Node node) Like onMachineConnect(Node), except that this is called whenever the machine's Environment.onDisconnect(Node) method is called.
net.minecraft.world.World	world() The world the machine is running in, e.g.
int	x() The X coordinate of this machine owner in the world, in block coordinates.
int	y() The Y coordinate of this machine owner in the world, in block coordinates.
int	z() The Z coordinate of this machine owner in the world, in block coordinates.

Methods inherited from interface li.cil.oc.api.network.Context

address, canInteract, isPaused, isRunning, node, pause, signal, start, stop

Method Detail

x

int x()

The X coordinate of this machine owner in the world, in block coordinates.

y

int y()

The Y coordinate of this machine owner in the world, in block coordinates.

z

int z()

The Z coordinate of this machine owner in the world, in block coordinates.

world

net.minecraft.world.World world()

The world the machine is running in, e.g. if the owner is a tile entity this is the world the tile entity lives in.

Returns:

the world the machine runs in.

installedMemory

int installedMemory()

The amount of memory (RAM) made available to the machine, in bytes.

This is usually determined by the components installed in the owner, for example the memory sticks in a computer case.

Returns:

the amount of memory that can be used by the machine, in bytes.

maxComponents

int maxComponents()

The number of components the machine can address without crashing.

This is usually determined by the components installed in the owner, for example the CPUs in a server.

Note that the component count does not include file systems.

Returns:

the number of supported components.

markAsChanged

void markAsChanged()

This is called by the machine when its state changed (which can be multiple times per actual game tick), to notify the owner that it should save its state on the next world save.

This method is called from executor threads, so it must be thread-safe.

onMachineConnect

void onMachineConnect(Node node)

This is called on the owner when the machine's Environment.onConnect(Node) method gets called. This can be useful for reacting to network events when the owner does not have its own node (for example, computer cases expose their machine's node as their own node). This callback allows it to connect its components (graphics cards and the like) when it is connected to a node network (when added to the world, for example).

Parameters:

node - the node that was connected to the network.

onMachineDisconnect

void onMachineDisconnect(Node node)

Like onMachineConnect(Node), except that this is called whenever the machine's Environment.onDisconnect(Node) method is called.

Parameters:

node - the node that was disconnected from the network.