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.
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.
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.

addRomResource

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 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 or the 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.