Package li.cil.oc.api

This API provides interfaces and factory methods for the OpenComputers mod.

See: Description

Interface Summary

Interface	Description
Persistable	An object that can be persisted to an NBT tag and restored back from it.
Rotatable	This interface is implemented by the computer case and robot tile entities to allow item components to query the orientation of their host, i.e.

Class Summary

Class	Description
CreativeTab	Allows access to the creative tab used by OpenComputers.
Driver	This API allows registering new drivers with the mod.
FileSystem	This class provides factory methods for creating file systems that are compatible with the built-in file system driver.
Items	Access to item definitions for all blocks and items provided by OpenComputers.
Machine	This API is intended for people who would like to implement custom computer blocks or anything else hosting a computer.
Network	This class provides factories for networks and nodes.

Package li.cil.oc.api Description

This API provides interfaces and factory methods for the OpenComputers mod.

There are several parts to this API:

The Driver API

This API is used to provide glue code to the mod that allows it to interact with foreign objects. You need a driver if you wish to connect some object to the internal Network, for example because you wish to interact with other blocks / components of the mod. The most typical scenario for this will be adding a new object that user programs should be able to interact with: a Component.

Note that for tile entities you implement yourself, you will not have to provide a driver, as long as you implement the necessary interface: Environment and call Network.joinOrCreateNetwork(net.minecraft.tileentity.TileEntity) in the first updateEntity() call. For items that should be installed in a computer you will always have to provide a driver.

The FileSystem API

This API provides facilities that make it easier to create file systems that can be interacted with from user programs via the file system driver that comes with the mod.

The Network API

This API provides interfaces that allow interacting with the internal network and creating nodes, components and power connectors for said network. If you implement Environment in your tile entity or provide a ManagedEnvironment via a driver you'll want to create a node. This API provides factory methods for creating it.