li.cil.oc.api

Class Machine

java.lang.Object

li.cil.oc.api.Machine

public final class Machine
extends java.lang.Object

This API is intended for people who would like to implement custom computer blocks or anything else hosting a computer.

It also allows registering new Architectures, which are implementations of specific languages (e.g. assembler). The built- in ones are available as static fields in this class.

Note that registration of architectures is optional and only intended as a convenience feature to provide mods with a way to iterate available architectures using architectures(). Also note that any architecture passed to create(li.cil.oc.api.machine.Owner, Class) that has not yet been registered will automatically be registered.

Note that these methods should not be called in the pre-init phase, since the instance may not have been initialized at that time. Only start calling these methods in the init phase or later.

Field Summary

Fields

Modifier and Type	Field and Description
static MachineAPI	instance
static java.lang.Class<? extends Architecture>	LuaArchitecture The built-in Lua architecture.

Method Summary

Methods

Modifier and Type	Method and Description
static void	add(java.lang.Class<? extends Architecture> architecture) Register an architecture that can be used to create new machines.
static void	addRomResource(java.lang.Class<? extends Architecture> architecture, java.util.concurrent.Callable<FileSystem> resource, java.lang.String name) Adds a file system to use for the composite file system that is made available as the ROM to each machine of the specified architecture.
static java.lang.Iterable<java.lang.Class<? extends Architecture>>	architectures() A list of all registered architectures.
static Machine	create(Owner owner) Creates a new machine using the default architecture (Lua).
static Machine	create(Owner owner, java.lang.Class<? extends Architecture> architecture) Creates a new machine using the specified architecture.

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static MachineAPI instance

LuaArchitecture

public static java.lang.Class<? extends Architecture> LuaArchitecture

The built-in Lua architecture. This will be set to the native Lua implementation when possible, to the LuaJ fallback, otherwise.

Method Detail

add

public static void add(java.lang.Class<? extends Architecture> architecture)

Register an architecture that can be used to create new machines.

Note that although registration is optional, it is strongly recommended to allow architectures() to be useful.

Parameters:

architecture - the architecture to register.

addRomResource

public static void addRomResource(java.lang.Class<? extends Architecture> architecture,
                  java.util.concurrent.Callable<FileSystem> resource,
                  java.lang.String name)

Adds a file system to use for the composite file system that is made available as the ROM to each machine of the specified architecture.

File systems are merged in a overshadowing manner, i.e. if files or directories with the same path exist in multiple file systems, only the one that was last registered will be used. In other words, added file systems override previously existed file systems on a file-by-file level (where files can override folders and vice versa).

Parameters:

architecture - the the architecture for which to add to the ROM.

resource - the file system factory to add to the ROM.

name - a unique name for the file system. This is required to allow for deterministic loading/saving of the file system (open file handles). This value must be unique for each file system in the resource set.

Throws:

java.lang.IllegalArgumentException - if the name is not unique.

architectures

public static java.lang.Iterable<java.lang.Class<? extends Architecture>> architectures()

A list of all registered architectures.

Note that registration is optional, although automatic when calling create(li.cil.oc.api.machine.Owner, Class) with a not yet registered architecture. What this means is that unless a mod providing a custom architecture also registers it, you may not see it in this list until it also created a new machine using that architecture.

create

public static Machine create(Owner owner,
             java.lang.Class<? extends Architecture> architecture)

Creates a new machine using the specified architecture.

You are responsible for calling update and save / load functions on the machine for it to work correctly.

Parameters:

owner - the owner object of the machine, providing context.

architecture - the architecture to use for running code on the machine.

Returns:

the newly created machine.

Throws:

java.lang.IllegalArgumentException - if the specified architecture is invalid.

create

public static Machine create(Owner owner)

Creates a new machine using the default architecture (Lua).

You are responsible for calling update and save / load functions on the machine for it to work correctly.

Parameters:

owner - the owner object of the machine, providing context.

Returns:

the newly created machine.