li.cil.oc.api.detail

Interface MachineAPI

public interface MachineAPI

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.Class<? extends Architecture> architecture) Register an architecture that can be used to create new machines.
java.lang.Iterable<java.lang.Class<? extends Architecture>>	architectures() A list of all registered architectures.
Machine	create(Owner owner, java.lang.Class<? extends Architecture> architecture) Creates a new machine using the specified architecture.

Method Detail

add

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.

Throws:

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

architectures

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

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.