Index (OpenComputers II API)

A B C D E F G H I J L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractRPCMethod - Class in li.cil.oc2.api.bus.device.rpc: Convenience base class for RPCMethod implementations.
AbstractRPCMethod(String, boolean, Class<?>, RPCParameter...) - Constructor for class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
AbstractRPCMethod(String, boolean, RPCParameter...) - Constructor for class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
AbstractRPCMethod(String, Class<?>, RPCParameter...) - Constructor for class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
AbstractRPCMethod(String, RPCParameter...) - Constructor for class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
addController(DeviceBusController) - Method in interface li.cil.oc2.api.bus.DeviceBusElement: Registers a controller with this bus element.
addListener(Consumer<Invalidatable<T>>) - Method in class li.cil.oc2.api.util.Invalidatable
API - Class in li.cil.oc2.api
API() - Constructor for class li.cil.oc2.api.API
ArchitectureType - Enum Class in li.cil.oc2.api.bus.device.vm: The architecture of a virtual machine, based on the processor installed in it.
argumentsDescription() - Element in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: Optional documentation of the bytes this method takes as arguments.
asPermanent() - Method in class li.cil.oc2.api.bus.device.vm.VMDeviceLoadResult: Marks failures as permanent, i.s.

B

b - Enum constant in enum class li.cil.oc2.api.util.Side
back - Enum constant in enum class li.cil.oc2.api.util.Side
BACK - Enum constant in enum class li.cil.oc2.api.util.Side
BLOCK - Static variable in class li.cil.oc2.api.fabric.Lookups.Device: Devices provided by a block, oc2:device.
BLOCK - Static variable in class li.cil.oc2.api.fabric.Lookups.DeviceBusElement: Device bus connection points, oc2:device_bus_element.
BLOCK - Static variable in class li.cil.oc2.api.fabric.Lookups.NetworkInterface: Network bus participants, oc2:network_interface.
BLOCK - Static variable in class li.cil.oc2.api.fabric.Lookups.RedstoneEmitter: Redstone signal sources, oc2:redstone_emitter.
BLOCK - Static variable in class li.cil.oc2.api.fabric.Lookups.TerminalUserProvider: Terminal user lists provided by a block, oc2:terminal_user_provider.
BLOCK - Static variable in class li.cil.oc2.api.neoforge.Capabilities.Device: Devices provided by a block, oc2:device.
BLOCK - Static variable in class li.cil.oc2.api.neoforge.Capabilities.DeviceBusElement: Device bus connection points, oc2:device_bus_element.
BLOCK - Static variable in class li.cil.oc2.api.neoforge.Capabilities.NetworkInterface: Network bus participants, oc2:network_interface.
BLOCK - Static variable in class li.cil.oc2.api.neoforge.Capabilities.RedstoneEmitter: Redstone signal sources, oc2:redstone_emitter.
BLOCK - Static variable in class li.cil.oc2.api.neoforge.Capabilities.TerminalUserProvider: Terminal user lists provided by a block, oc2:terminal_user_provider.
BLOCK_DEVICE_DATA - Static variable in class li.cil.oc2.api.util.Registries: The registry name of the registry holding block device bases.
BLOCK_DEVICE_PROVIDER - Static variable in class li.cil.oc2.api.util.Registries: The registry name of the registry holding block device providers.
BlockDeviceBusElement - Interface in li.cil.oc2.api.bus: Implementing this interface allows providing positional information to the DeviceBusController.
BlockDeviceData - Interface in li.cil.oc2.api.bus.device.data: Implementations of this interface that are registered with the registry for this type can be used as read-only base block devices for read-write block devices.
BlockDeviceProvider - Interface in li.cil.oc2.api.bus.device.provider: This is used to query for devices given a block face.
BlockDeviceQuery - Interface in li.cil.oc2.api.bus.device.provider: Device query for a block in the world.
BUS_CHANGE - Enum constant in enum class li.cil.oc2.api.bus.DeviceBusController.ScanReason
BUS_ERROR - Enum constant in enum class li.cil.oc2.api.bus.DeviceBusController.ScanReason
byIndex(int) - Static method in enum class li.cil.oc2.api.util.Side

C

Callback - Annotation Interface in li.cil.oc2.api.bus.device.object: Utility annotation to allow generating lists of RPCMethods using Callbacks.collectMethods(Object).
Callbacks - Class in li.cil.oc2.api.bus.device.object: Provides automated extraction of RPCMethods from instances of classes with methods annotated with the Callback annotation.
Callbacks() - Constructor for class li.cil.oc2.api.bus.device.object.Callbacks
Capabilities - Class in li.cil.oc2.api.neoforge: The NeoForge capabilities OpenComputers II provides.
Capabilities.Device - Class in li.cil.oc2.api.neoforge
Capabilities.DeviceBusElement - Class in li.cil.oc2.api.neoforge
Capabilities.NetworkInterface - Class in li.cil.oc2.api.neoforge
Capabilities.RedstoneEmitter - Class in li.cil.oc2.api.neoforge
Capabilities.Robot - Class in li.cil.oc2.api.neoforge
Capabilities.TerminalUserProvider - Class in li.cil.oc2.api.neoforge
CARD - Static variable in class li.cil.oc2.api.bus.device.DeviceTypes
claimInterrupt() - Method in interface li.cil.oc2.api.bus.device.vm.context.InterruptAllocator: Tries to claim the next free interrupt.
claimInterrupt(int) - Method in interface li.cil.oc2.api.bus.device.vm.context.InterruptAllocator: Tries to reserve an interrupt with the specified index.
claimMemory(int) - Method in interface li.cil.oc2.api.bus.device.vm.context.MemoryAllocator: Tries to reserve the specified amount of memory, in bytes.
claimMemoryRange(long, MemoryMappedDevice) - Method in interface li.cil.oc2.api.bus.device.vm.context.MemoryRangeAllocator: Tries to add a MemoryMappedDevice to the memory map at the specified address.
claimMemoryRange(MemoryMappedDevice) - Method in interface li.cil.oc2.api.bus.device.vm.context.MemoryRangeAllocator: Tries to add a MemoryMappedDevice to the memory map at an address determined by the virtual machine.
collectMethods(Object) - Static method in class li.cil.oc2.api.bus.device.io.IOCallbacks: Collects all methods annotated with IOCallback in the specified object and generated IOMethods for each one.
collectMethods(Object) - Static method in class li.cil.oc2.api.bus.device.object.Callbacks: Collects all methods annotated with Callback in the specified object and generated RPCMethods for each one.
CPU - Static variable in class li.cil.oc2.api.bus.device.DeviceTypes

D

d - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
d - Enum constant in enum class li.cil.oc2.api.util.Side
description() - Element in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: Optional documentation of this method.
description() - Element in annotation interface li.cil.oc2.api.bus.device.io.IODeviceDescription: Optional documentation of the device's mid-level API as a whole, such as how values are encoded and other conventions shared by its methods.
description() - Element in annotation interface li.cil.oc2.api.bus.device.object.Callback: Option VM visible documentation of this method.
description() - Element in annotation interface li.cil.oc2.api.bus.device.object.Parameter: Optional VM visible documentation of this parameter.
description() - Element in annotation interface li.cil.oc2.api.bus.device.object.RPCDeviceDescription: Optional documentation of the device's high-level API as a whole, such as what the device is, how to obtain it from a guest, and conventions shared by its methods.
deserializeNBT(CompoundTag) - Method in interface li.cil.oc2.api.bus.device.Device: Called to deserialize this device from its container's persistent storage.
Device - Interface in li.cil.oc2.api.bus.device: Base interface for objects that can be registered as devices on a DeviceBus.
DEVICE_TYPE - Static variable in class li.cil.oc2.api.util.Registries: The registry name of the registry holding device types.
DeviceBus - Interface in li.cil.oc2.api.bus: A device bus provides the interface by which Devices can be made available to a DeviceBusController, which in turn is usually used by VMs to access these devices.
DeviceBusController - Interface in li.cil.oc2.api.bus: For each device bus there can be exactly one controller.
DeviceBusController.ScanReason - Enum Class in li.cil.oc2.api.bus: Reason for a bus scan.
DeviceBusElement - Interface in li.cil.oc2.api.bus: Represents a single connection point on a device bus.
DeviceType - Interface in li.cil.oc2.api.bus.device: Implementations describe individual slot types.
DeviceTypes - Class in li.cil.oc2.api.bus.device: Lists built-in device types for convenience.
dispose() - Method in interface li.cil.oc2.api.bus.device.Device: Called to dispose this device.
dispose() - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
down - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
down - Enum constant in enum class li.cil.oc2.api.util.Side
DOWN - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
DOWN - Enum constant in enum class li.cil.oc2.api.util.Side

E

e - Enum constant in enum class li.cil.oc2.api.util.Side
east - Enum constant in enum class li.cil.oc2.api.util.Side
EAST - Enum constant in enum class li.cil.oc2.api.util.Side
empty() - Static method in class li.cil.oc2.api.util.Invalidatable
EnergyStorage - Class in li.cil.oc2.api.fabric: The lookups we do energy interop through on Fabric.
ENTITY - Static variable in class li.cil.oc2.api.fabric.EnergyStorage: Entity access to energy storages, oc2:entity_energy_storage.
ENTITY - Static variable in class li.cil.oc2.api.fabric.FluidStorage: Entity access to fluid storages, oc2:entity_fluid_storage.
ENTITY - Static variable in class li.cil.oc2.api.fabric.ItemStorage: Entity access to item storages, oc2:entity_item_storage.
ENTITY - Static variable in class li.cil.oc2.api.fabric.Lookups.Robot: Device hosts that installed modules may interact with, oc2:robot.
ENTITY - Static variable in class li.cil.oc2.api.fabric.Lookups.TerminalUserProvider: Terminal user lists provided by an entity, oc2:terminal_user_provider.
ENTITY - Static variable in class li.cil.oc2.api.neoforge.Capabilities.Robot: Device hosts that installed modules may interact with, oc2:robot.
ENTITY - Static variable in class li.cil.oc2.api.neoforge.Capabilities.TerminalUserProvider: Terminal user lists provided by an entity, oc2:terminal_user_provider.
equals(Object) - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
equals(Object) - Method in record class li.cil.oc2.api.bus.device.rpc.RPCTypeAdapter: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class li.cil.oc2.api.bus.device.vm.event.VMInitializingEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class li.cil.oc2.api.util.Invalidatable
exportToItemStack(CompoundTag) - Method in interface li.cil.oc2.api.bus.device.ItemDevice: Export data that should be copied to the ItemStack this device was created for to a tag that will be stored in the item.

F

f - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
f - Enum constant in enum class li.cil.oc2.api.util.Side
FabricRegistrationInitializer - Interface in li.cil.oc2.api.platform: Fabric specific interface, used to define an entrypoint that is invoked once all registries created by the mod exist and entries may be registered with them.
fail() - Static method in class li.cil.oc2.api.bus.device.vm.VMDeviceLoadResult: Signals that the device failed loading.
findOverload(RPCInvocation) - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethod
findOverload(RPCInvocation) - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethodGroup: Attempts to find an overload in this method group that matches the provided, serialized parameters.
FirmwareLoader - Interface in li.cil.oc2.api.bus.device.vm: This interface serves as a marker for devices that load firmware.
FLASH_MEMORY - Static variable in class li.cil.oc2.api.bus.device.DeviceTypes
FLOPPY - Static variable in class li.cil.oc2.api.bus.device.DeviceTypes
FluidStorage - Class in li.cil.oc2.api.fabric: The lookups we do fluid storage interop through on Fabric.
front - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
front - Enum constant in enum class li.cil.oc2.api.util.Side
FRONT - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
FRONT - Enum constant in enum class li.cil.oc2.api.util.Side

G

get() - Method in class li.cil.oc2.api.util.Invalidatable
getArchitectureType() - Method in interface li.cil.oc2.api.bus.device.provider.BlockDeviceQuery: The architecture of the machine this query is for.
getArchitectureType() - Method in interface li.cil.oc2.api.bus.device.provider.ItemDeviceQuery: The architecture of the machine this query is for.
getArchitectureType() - Method in interface li.cil.oc2.api.bus.DeviceBusController: The architecture of the machine owning this bus, if any.
getBackgroundIcon() - Method in interface li.cil.oc2.api.bus.device.DeviceType: An icon rendered as background of empty slots, visually indicating the type of the slot.
getBlockDevice() - Method in interface li.cil.oc2.api.bus.device.data.BlockDeviceData: Gets the read-only base block device this implementation describes.
getCapacity() - Method in interface li.cil.oc2.api.bus.device.data.BlockDeviceData: The size of the block device this implementation describes.
getClock() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: The primary clock/time source of the virtual machine.
getCode() - Method in interface li.cil.oc2.api.bus.device.io.IOMethod: The code identifying this method to the guest.
getColor() - Method in interface li.cil.oc2.api.bus.device.data.BlockDeviceData: The color items preloaded with this data are tinted with.
getContainerBlockEntity() - Method in interface li.cil.oc2.api.bus.device.provider.ItemDeviceQuery: The BlockEntity that holds the item this query is for.
getContainerEntity() - Method in interface li.cil.oc2.api.bus.device.provider.ItemDeviceQuery: The Entity that holds the item this query is for.
getControllers() - Method in interface li.cil.oc2.api.bus.DeviceBusElement: Get the bus controllers of the buses this element is on, if any.
getDescription() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethod: An optional description of the method.
getDescription() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCParameter: An optional description of the parameter.
getDevice(BlockDeviceQuery) - Method in interface li.cil.oc2.api.bus.device.provider.BlockDeviceProvider: Get a device for the specified query.
getDevice(ItemDeviceQuery) - Method in interface li.cil.oc2.api.bus.device.provider.ItemDeviceProvider: Get a device for the specified query.
getDeviceIdentifier(Device) - Method in interface li.cil.oc2.api.bus.DeviceBusElement: Returns an identifier unique to the specified device.
getDeviceIdentifiers(Device) - Method in interface li.cil.oc2.api.bus.DeviceBusController: Obtain the unique identifiers for the specified device, if any, as provided by the DeviceBusElements that provided this device.
getDeviceRangeAllocator() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: Allows adding devices that are not memory to wherever this machine maps its devices.
getDevices() - Method in interface li.cil.oc2.api.bus.DeviceBus: The list of all devices currently registered with this device bus.
getDevices() - Method in interface li.cil.oc2.api.bus.DeviceBusController: The set of all devices currently known to this controller.
getDirection() - Method in enum class li.cil.oc2.api.util.Side
getDisplayName() - Method in interface li.cil.oc2.api.bus.device.data.BlockDeviceData: The display name of this block device base.
getEnergyConsumption() - Method in interface li.cil.oc2.api.bus.DeviceBusElement: Returns the energy consumption of this bus element.
getEnergyConsumption(ItemDeviceQuery) - Method in interface li.cil.oc2.api.bus.device.provider.ItemDeviceProvider: The amount of energy the device that would be returned by ItemDeviceProvider.getDevice(ItemDeviceQuery) will consume per tick while the VM using it is running.
getErrorMessage() - Method in exception class li.cil.oc2.api.bus.device.vm.event.VMInitializationException: The error message indicating why initialization failed.
getErrorMessage() - Method in class li.cil.oc2.api.bus.device.vm.VMDeviceLoadResult: An optional error message on why the load failed.
getEventBus() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: Allows registering to VM lifecycle events.
getGson() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCInvocation: The serialization context that may be used to deserialize parameters.
getInterruptAllocator() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: Allows claiming interrupts for use with the VM's InterruptController.
getInterruptController() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: The interrupt controller of the virtual machine.
getIOMethods() - Method in interface li.cil.oc2.api.bus.device.io.IODevice: The list of methods provided by this device.
getIOMethods() - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
getIOName() - Method in interface li.cil.oc2.api.bus.device.io.IODevice: The name this device is known by to the guest.
getIOName() - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
getItemStack() - Method in interface li.cil.oc2.api.bus.device.provider.ItemDeviceQuery: The item stack this query is performed for.
getLevel() - Method in interface li.cil.oc2.api.bus.BlockDeviceBusElement: The level the bus lives in.
getLevel() - Method in interface li.cil.oc2.api.bus.device.provider.BlockDeviceQuery: The level containing the block this query is performed for.
getLocalDevices() - Method in interface li.cil.oc2.api.bus.DeviceBusElement: Returns the list of devices connected specifically by this element.
getMemoryAllocator() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: Allows reserving fixed amounts of memory respecting sandbox constraints.
getMemoryMap() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: The memory of the virtual machine.
getMemoryRangeAllocator() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: Allows adding MemoryMappedDevices to the VM's MemoryMap.
getMethodGroups() - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
getMethodGroups() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCDevice: The list of methods groups provided by this interface.
getName() - Method in interface li.cil.oc2.api.bus.device.DeviceType: The display name of this device type, may be shown as tooltip for slots of this type.
getName() - Method in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
getName() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethodGroup: The name of the method group/of the grouped RPCMethods.
getName() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCParameter: An optional name of the parameter.
getName(Object) - Static method in class li.cil.oc2.api.bus.device.io.IOCallbacks: Returns the guest-visible name declared by the specified object's IODeviceDescription.
getNeighbors() - Method in interface li.cil.oc2.api.bus.DeviceBusElement: Returns a stream of adjacent bus elements.
getOverloads() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethod
getOverloads() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethodGroup: The list of overloads in this method group, if available.
getParameters() - Method in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
getParameters() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCInvocation: The raw parameter list of this invocation.
getParameters() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethod: The parameters this method accepts.
getPosition() - Method in interface li.cil.oc2.api.bus.BlockDeviceBusElement: The position of this bus element.
getQueryPosition() - Method in interface li.cil.oc2.api.bus.device.provider.BlockDeviceQuery: The position of the block this query is performed for.
getQuerySide() - Method in interface li.cil.oc2.api.bus.device.provider.BlockDeviceQuery: The world-space side of the block this query is performed on, if any.
getRedstoneOutput() - Method in interface li.cil.oc2.api.capabilities.RedstoneEmitter: Returns the redstone output level for the side this interface was returned for.
getReturnType() - Method in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
getReturnType() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethod: The type of the values returned by this method.
getReturnValueDescription() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethod: An optional description of the return value of this method.
getRuntime() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMContext: Provides access to the execution state of the virtual machine.
getSelectedSlot() - Method in interface li.cil.oc2.api.capabilities.Robot: The index of the currently selected slot in the inventory.
getTag() - Method in interface li.cil.oc2.api.bus.device.DeviceType: The tag representing this device type.
getTerminalUsers() - Method in interface li.cil.oc2.api.capabilities.TerminalUserProvider: The list of players currently interacting with a terminal.
getType() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCParameter: The type of this parameter.
getTypeNames() - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
getTypeNames() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCDevice: A list of type names identifying this interface.
getTypeNames(Object) - Static method in class li.cil.oc2.api.bus.device.object.Callbacks: Returns the type names declared by the specified object's RPCDeviceDescription.

H

HARD_DRIVE - Static variable in class li.cil.oc2.api.bus.device.DeviceTypes
hashCode() - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
hashCode() - Method in record class li.cil.oc2.api.bus.device.rpc.RPCTypeAdapter: Returns a hash code value for this object.
hashCode() - Method in record class li.cil.oc2.api.bus.device.vm.event.VMInitializingEvent: Returns a hash code value for this object.
hashCode() - Method in class li.cil.oc2.api.util.Invalidatable
hasMethods(Object) - Static method in class li.cil.oc2.api.bus.device.io.IOCallbacks: Returns whether any IOCallback annotated methods are present on the specified object without creating bound IOMethod instances.
hasMethods(Object) - Static method in class li.cil.oc2.api.bus.device.object.Callbacks: Returns whether any Callback annotated methods are present on the specified object without creating bound RPCMethod instances.

I

ifPresent(Consumer<T>) - Method in class li.cil.oc2.api.util.Invalidatable
importFromItemStack(CompoundTag) - Method in interface li.cil.oc2.api.bus.device.ItemDevice: Import data that is present on the ItemStack this device was created for.
InterruptAllocator - Interface in li.cil.oc2.api.bus.device.vm.context: Allows reserving interrupts on the primary interrupt controller of a virtual machine during a VMDevice.mount(VMContext) call.
Invalidatable<T> - Class in li.cil.oc2.api.util: Wrapper for objects which may become invalid, such as Devices.
Invalidatable(T) - Constructor for class li.cil.oc2.api.util.Invalidatable
Invalidatable.ListenerToken - Interface in li.cil.oc2.api.util
invalidate() - Method in class li.cil.oc2.api.util.Invalidatable
invalidateDevices() - Method in interface li.cil.oc2.api.bus.DeviceBusElement: Called when the machine this element belongs to changes architecture, meaning devices managed by this bus element have to be recreated because their providers may return a different device based on the new architecture.
invoke(InputStream, OutputStream) - Method in interface li.cil.oc2.api.bus.device.io.IOMethod: Called to run this method.
invoke(Object...) - Method in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
invoke(RPCInvocation) - Method in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
invoke(RPCInvocation) - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethod: Called to run this method.
IOCallback - Annotation Interface in li.cil.oc2.api.bus.device.io: Utility annotation to allow generating lists of IOMethods using IOCallbacks.collectMethods(Object).
IOCallbacks - Class in li.cil.oc2.api.bus.device.io: Provides automated extraction of IOMethods from instances of classes with methods annotated with the IOCallback annotation.
IODevice - Interface in li.cil.oc2.api.bus.device.io: Provides an interface for an IO device, describing the methods that can be called on it and the name it can be detected by.
IODeviceDescription - Annotation Interface in li.cil.oc2.api.bus.device.io: Declares the name a device is known by to a low-level guest, and documents the device.
IOInputStream - Class in li.cil.oc2.api.bus.device.io: The arguments a guest wrote for an IOCallback, with correctly decoding readers.
IOInputStream(InputStream) - Constructor for class li.cil.oc2.api.bus.device.io.IOInputStream
IOMethod - Interface in li.cil.oc2.api.bus.device.io: Represents a single method than can be exposed by an IODevice.
IOOutputStream - Class in li.cil.oc2.api.bus.device.io: The results an IOCallback hands back to the guest, with correctly encoding writers.
IOOutputStream(OutputStream) - Constructor for class li.cil.oc2.api.bus.device.io.IOOutputStream
isPermanent() - Method in class li.cil.oc2.api.bus.device.vm.VMDeviceLoadResult: Whether retrying the emitting will never succeed.
isPresent() - Method in class li.cil.oc2.api.util.Invalidatable
isRelative() - Method in enum class li.cil.oc2.api.util.Side
isSynchronized() - Method in interface li.cil.oc2.api.bus.device.io.IOMethod: When true, invocations of this method will be synchronized to the main thread.
isSynchronized() - Method in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
isSynchronized() - Method in interface li.cil.oc2.api.bus.device.rpc.RPCMethod: When true, invocations of this method will be synchronized to the main thread.
ITEM - Static variable in class li.cil.oc2.api.fabric.EnergyStorage: Team Reborn's item lookup, teamreborn:energy.
ITEM - Static variable in class li.cil.oc2.api.fabric.FluidStorage: The transfer API's item lookup, fabric:fluid_storage.
ITEM - Static variable in class li.cil.oc2.api.fabric.ItemStorage: The transfer API's item lookup, fabric:item_storage.
ITEM - Static variable in class li.cil.oc2.api.fabric.Lookups.Device: Devices provided by an item, oc2:device.
ITEM - Static variable in class li.cil.oc2.api.neoforge.Capabilities.Device: Devices provided by an item, oc2:device.
ITEM_DEVICE_PROVIDER - Static variable in class li.cil.oc2.api.util.Registries: The registry name of the registry holding item device providers.
ItemDevice - Interface in li.cil.oc2.api.bus.device: Specialized device type provided by ItemDeviceProviders.
ItemDeviceProvider - Interface in li.cil.oc2.api.bus.device.provider: This is used to query for devices given an item stack.
ItemDeviceQuery - Interface in li.cil.oc2.api.bus.device.provider: Device query for an item stack.
ItemStorage - Class in li.cil.oc2.api.fabric: The lookups we do item storage interop through on Fabric.

J

join() - Method in interface li.cil.oc2.api.bus.device.vm.context.VMRuntime: Waits for the virtual machine's worker thread to finish its current execution.

L

l - Enum constant in enum class li.cil.oc2.api.util.Side
left - Enum constant in enum class li.cil.oc2.api.util.Side
LEFT - Enum constant in enum class li.cil.oc2.api.util.Side
li.cil.oc2.api - package li.cil.oc2.api
li.cil.oc2.api.bus - package li.cil.oc2.api.bus: The device bus is the glue that connects devices and VMs.
li.cil.oc2.api.bus.device - package li.cil.oc2.api.bus.device
li.cil.oc2.api.bus.device.data - package li.cil.oc2.api.bus.device.data
li.cil.oc2.api.bus.device.io - package li.cil.oc2.api.bus.device.io
li.cil.oc2.api.bus.device.object - package li.cil.oc2.api.bus.device.object
li.cil.oc2.api.bus.device.provider - package li.cil.oc2.api.bus.device.provider
li.cil.oc2.api.bus.device.rpc - package li.cil.oc2.api.bus.device.rpc
li.cil.oc2.api.bus.device.vm - package li.cil.oc2.api.bus.device.vm
li.cil.oc2.api.bus.device.vm.context - package li.cil.oc2.api.bus.device.vm.context
li.cil.oc2.api.bus.device.vm.event - package li.cil.oc2.api.bus.device.vm.event
li.cil.oc2.api.capabilities - package li.cil.oc2.api.capabilities
li.cil.oc2.api.fabric - package li.cil.oc2.api.fabric
li.cil.oc2.api.neoforge - package li.cil.oc2.api.neoforge
li.cil.oc2.api.platform - package li.cil.oc2.api.platform
li.cil.oc2.api.util - package li.cil.oc2.api.util
LifecycleAwareDevice - Interface in li.cil.oc2.api.bus.device.object: This interface is used to receive life-cycle callbacks on targets of an ObjectDevice.
Lookups - Class in li.cil.oc2.api.fabric: The Fabric lookups OpenComputers II provides.
Lookups.Device - Class in li.cil.oc2.api.fabric
Lookups.DeviceBusElement - Class in li.cil.oc2.api.fabric
Lookups.NetworkInterface - Class in li.cil.oc2.api.fabric
Lookups.RedstoneEmitter - Class in li.cil.oc2.api.fabric
Lookups.Robot - Class in li.cil.oc2.api.fabric
Lookups.TerminalUserProvider - Class in li.cil.oc2.api.fabric

M

mapWithDependency(Function<T, U>) - Method in class li.cil.oc2.api.util.Invalidatable
MAX_CODE - Static variable in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: The largest value IOCallback.value() may take.
MAX_DATA_SIZE - Static variable in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: The maximum size of the argument and result buffers, in bytes.
MAX_NAME_LENGTH - Static variable in annotation interface li.cil.oc2.api.bus.device.io.IODeviceDescription: The upper bound on a name's length, matching the names the emulator itself uses.
memory() - Method in record class li.cil.oc2.api.bus.device.vm.event.VMInitializingEvent: Returns the value of the memory record component.
MEMORY - Static variable in class li.cil.oc2.api.bus.device.DeviceTypes
MemoryAllocator - Interface in li.cil.oc2.api.bus.device.vm.context: A memory allocator used to ensure sandbox limits when loading devices.
MemoryRangeAllocator - Interface in li.cil.oc2.api.bus.device.vm.context: Allows adding MemoryMappedDevices to the memory map of a virtual machine during a VMDevice.mount(VMContext) call.
MOD_ID - Static variable in class li.cil.oc2.api.API
mount(RPCBusContext) - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
mount(RPCBusContext) - Method in interface li.cil.oc2.api.bus.device.rpc.RPCDevice: Called to start this device.
mount(VMContext) - Method in interface li.cil.oc2.api.bus.device.vm.VMDevice: Called to start this device.

N

n - Enum constant in enum class li.cil.oc2.api.util.Side
name - Variable in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
name() - Element in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: The name of this method, for documentation only.
name() - Element in annotation interface li.cil.oc2.api.bus.device.io.IODeviceDescription: The guest-visible name, at most IODeviceDescription.MAX_NAME_LENGTH printable ASCII characters.
name() - Element in annotation interface li.cil.oc2.api.bus.device.object.Callback: Explicitly defines the name of this method.
NETWORK_TUNNEL - Static variable in class li.cil.oc2.api.bus.device.DeviceTypes
NetworkInterface - Interface in li.cil.oc2.api.capabilities: This interface provides interaction with the network bus.
north - Enum constant in enum class li.cil.oc2.api.util.Side
NORTH - Enum constant in enum class li.cil.oc2.api.util.Side

O

ObjectDevice - Class in li.cil.oc2.api.bus.device.object: A reflection based implementation of RPCDevice using the Callback annotation to discover RPCMethods in a target object via Callbacks.collectMethods(Object), and equally of IODevice using the IOCallback annotation to discover IOMethods in a target object via IOCallbacks.collectMethods(Object).
ObjectDevice(Object) - Constructor for class li.cil.oc2.api.bus.device.object.ObjectDevice: Creates a new object device with methods in the specified object and no explicit type name.
ObjectDevice(Object, String) - Constructor for class li.cil.oc2.api.bus.device.object.ObjectDevice: Creates a new object device with methods in the specified object and the specified type name.
ObjectDevice(Object, String...) - Constructor for class li.cil.oc2.api.bus.device.object.ObjectDevice: Creates a new object device with methods in the specified object and the specified list of type names.
ObjectDevice(Object, List<String>) - Constructor for class li.cil.oc2.api.bus.device.object.ObjectDevice: Creates a new object device with methods in the specified object and the specified list of type names.
of(T) - Static method in class li.cil.oc2.api.util.Invalidatable
onDeviceDisposed() - Method in interface li.cil.oc2.api.bus.device.object.LifecycleAwareDevice: This method corresponds to Device.dispose().
onDeviceMounted(RPCBusContext) - Method in interface li.cil.oc2.api.bus.device.object.LifecycleAwareDevice: This method corresponds to RPCDevice.mount(RPCBusContext).
onDeviceUnmounted(RPCBusContext) - Method in interface li.cil.oc2.api.bus.device.object.LifecycleAwareDevice: This method corresponds to RPCDevice.unmount(RPCBusContext).
optional() - Element in annotation interface li.cil.oc2.api.bus.device.object.Parameter: Documents that an overload without this parameter exists, so the VM may omit it.

P

Parameter - Annotation Interface in li.cil.oc2.api.bus.device.object: This annotation may be used to propagate the name of parameters and to provide VM visible documentation of this parameter for methods annotated with the Callback annotation.
parameters - Variable in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
programStartAddress() - Method in record class li.cil.oc2.api.bus.device.vm.event.VMInitializingEvent: Returns the value of the programStartAddress record component.

R

r - Enum constant in enum class li.cil.oc2.api.util.Side
readEthernetFrame() - Method in interface li.cil.oc2.api.capabilities.NetworkInterface: Tries to read an ethernet frame from this network interface.
readString() - Method in class li.cil.oc2.api.bus.device.io.IOInputStream: Reads an ASCII string.
readU16() - Method in class li.cil.oc2.api.bus.device.io.IOInputStream: Reads two bytes.
readU32() - Method in class li.cil.oc2.api.bus.device.io.IOInputStream: Reads four bytes.
readU8() - Method in class li.cil.oc2.api.bus.device.io.IOInputStream: Reads one byte.
RedstoneEmitter - Interface in li.cil.oc2.api.capabilities: This interface may be provided as a capability by item components to signal to the containing BlockEntity that they wish to emit a redstone signal.
register(Object) - Method in interface li.cil.oc2.api.bus.device.vm.context.VMLifecycleEventBus: Registers the specified object as a subscriber for events.
registerObjects() - Method in interface li.cil.oc2.api.platform.FabricRegistrationInitializer: Registers objects with registries created by the mod.
Registries - Class in li.cil.oc2.api.util: ResourceKeys for registries created by the mod.
Registries() - Constructor for class li.cil.oc2.api.util.Registries
removeController(DeviceBusController) - Method in interface li.cil.oc2.api.bus.DeviceBusElement: Unregisters a controller from this bus element.
removeListener() - Method in interface li.cil.oc2.api.util.Invalidatable.ListenerToken
RESERVED_CODE - Static variable in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: The method code the register layout reserves; writing it always faults.
resultsDescription() - Element in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: Optional documentation of the bytes this method writes as results.
returnType - Variable in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
returnValueDescription() - Element in annotation interface li.cil.oc2.api.bus.device.object.Callback: Optional VM visible documentation of the values returned by this method.
right - Enum constant in enum class li.cil.oc2.api.util.Side
RIGHT - Enum constant in enum class li.cil.oc2.api.util.Side
RISCV - Enum constant in enum class li.cil.oc2.api.bus.device.vm.ArchitectureType
Robot - Interface in li.cil.oc2.api.capabilities: This interface may be implemented by entities hosting devices to allow modules installed in them to interact with them.
ROBOT_MODULE - Static variable in class li.cil.oc2.api.bus.device.DeviceTypes
RobotOperationSide - Enum Class in li.cil.oc2.api.util: A more restrictive version of Side, intended for robot operation APIs.
RPC_TYPE_ADAPTER - Static variable in class li.cil.oc2.api.util.Registries: The registry name of the registry holding RPC method parameter type adapters.
RPCBusContext - Interface in li.cil.oc2.api.bus.device.rpc: A device's handle on the computer it was mounted in.
RPCDevice - Interface in li.cil.oc2.api.bus.device.rpc: Provides an interface for an RPC device, describing the methods that can be called on it and the type names it can be detected by/is compatible with.
RPCDeviceDescription - Annotation Interface in li.cil.oc2.api.bus.device.object: Names and documents the high-level API of a class carrying Callback methods.
RPCInvocation - Interface in li.cil.oc2.api.bus.device.rpc: Describes an invocation context for an RPCMethod.
RPCMethod - Interface in li.cil.oc2.api.bus.device.rpc: Represents a single method that can be exposed by a RPCDevice.
RPCMethodGroup - Interface in li.cil.oc2.api.bus.device.rpc: A group of overloaded RPCMethods, i.e.
RPCParameter - Interface in li.cil.oc2.api.bus.device.rpc: Describes a single parameter of a RPCMethod.
RPCTypeAdapter - Record Class in li.cil.oc2.api.bus.device.rpc: A Gson type adapter for a type used as a parameter or return value of an RPCMethod.
RPCTypeAdapter(Class<?>, Object) - Constructor for record class li.cil.oc2.api.bus.device.rpc.RPCTypeAdapter: Creates an instance of a RPCTypeAdapter record class.

S

s - Enum constant in enum class li.cil.oc2.api.util.Side
scanDevices() - Method in interface li.cil.oc2.api.bus.DeviceBusController: Forces a device map rebuild.
scheduleBusScan() - Method in interface li.cil.oc2.api.bus.DeviceBusController: Schedules a scan due to a bus configuration change.
scheduleBusScan(DeviceBusController.ScanReason) - Method in interface li.cil.oc2.api.bus.DeviceBusController: Schedules a scan.
scheduleScan() - Method in interface li.cil.oc2.api.bus.DeviceBus: Schedules a rescan of the device bus.
sendEvent(String, Object) - Method in interface li.cil.oc2.api.bus.device.rpc.RPCBusContext: Sends an event to the guest of this computer, attributed to this device.
serializeNBT() - Method in interface li.cil.oc2.api.bus.device.Device: Called to serialize this device into its container's persistent storage.
setSelectedSlot(int) - Method in interface li.cil.oc2.api.capabilities.Robot: Sets the index of the currently selected slot in the inventory.
Side - Enum Class in li.cil.oc2.api.util: This enum indicates a side of a block device.
SIDED - Static variable in class li.cil.oc2.api.fabric.EnergyStorage: Team Reborn's sided block lookup, teamreborn:sided_energy.
SIDED - Static variable in class li.cil.oc2.api.fabric.FluidStorage: The transfer API's sided block lookup, fabric:sided_fluid_storage.
SIDED - Static variable in class li.cil.oc2.api.fabric.ItemStorage: The transfer API's sided block lookup, fabric:sided_item_storage.
south - Enum constant in enum class li.cil.oc2.api.util.Side
SOUTH - Enum constant in enum class li.cil.oc2.api.util.Side
success() - Static method in class li.cil.oc2.api.bus.device.vm.VMDeviceLoadResult: Signals that the device was loaded successfully.
synchronize - Variable in class li.cil.oc2.api.bus.device.rpc.AbstractRPCMethod
synchronize() - Element in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: Allows automatically moving method invocation into the main thread.
synchronize() - Element in annotation interface li.cil.oc2.api.bus.device.object.Callback: Allows automatically moving method invocation into the main thread.

T

TerminalUserProvider - Interface in li.cil.oc2.api.capabilities: This interface provides access to a list of Players that are currently using a terminal or similar provided by the owner of this capability.
toGlobal(Entity, RobotOperationSide) - Static method in enum class li.cil.oc2.api.util.RobotOperationSide: Gets the world-space direction for the specified side relative to the specified entity.
toString() - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
toString() - Method in record class li.cil.oc2.api.bus.device.rpc.RPCTypeAdapter: Returns a string representation of this record class.
toString() - Method in record class li.cil.oc2.api.bus.device.vm.event.VMInitializingEvent: Returns a string representation of this record class.
toString() - Method in class li.cil.oc2.api.util.Invalidatable
toString() - Method in enum class li.cil.oc2.api.util.Side
tryDeserializeParameters(RPCParameter...) - Method in interface li.cil.oc2.api.bus.device.rpc.RPCInvocation: Utility method for deserializing parameters, given a list of parameter types.
type() - Method in record class li.cil.oc2.api.bus.device.rpc.RPCTypeAdapter: Returns the value of the type record component.
typeAdapter() - Method in record class li.cil.oc2.api.bus.device.rpc.RPCTypeAdapter: Returns the value of the typeAdapter record component.
typeNames() - Element in annotation interface li.cil.oc2.api.bus.device.object.RPCDeviceDescription: The type names a guest can find the device by.

U

u - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
u - Enum constant in enum class li.cil.oc2.api.util.Side
unmount() - Method in interface li.cil.oc2.api.bus.device.vm.VMDevice: Called to pause this device.
unmount(RPCBusContext) - Method in class li.cil.oc2.api.bus.device.object.ObjectDevice
unmount(RPCBusContext) - Method in interface li.cil.oc2.api.bus.device.rpc.RPCDevice: Called to pause this device.
up - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
up - Enum constant in enum class li.cil.oc2.api.util.Side
UP - Enum constant in enum class li.cil.oc2.api.util.RobotOperationSide
UP - Enum constant in enum class li.cil.oc2.api.util.Side

V

value() - Element in annotation interface li.cil.oc2.api.bus.device.io.IOCallback: The method code identifying this method to the guest.
value() - Element in annotation interface li.cil.oc2.api.bus.device.object.Parameter: The name of the parameter as seen by the VM.
valueOf(String) - Static method in enum class li.cil.oc2.api.bus.device.vm.ArchitectureType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class li.cil.oc2.api.bus.DeviceBusController.ScanReason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class li.cil.oc2.api.util.RobotOperationSide: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class li.cil.oc2.api.util.Side: Returns the enum constant of this class with the specified name.
values() - Static method in enum class li.cil.oc2.api.bus.device.vm.ArchitectureType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class li.cil.oc2.api.bus.DeviceBusController.ScanReason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class li.cil.oc2.api.util.RobotOperationSide: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class li.cil.oc2.api.util.Side: Returns an array containing the constants of this enum class, in the order they are declared.
VMContext - Interface in li.cil.oc2.api.bus.device.vm.context: Provides access to a virtual machine to low level devices.
VMDevice - Interface in li.cil.oc2.api.bus.device.vm: Allows adding MemoryMappedDevices directly to the underlying virtual machine.
VMDeviceLoadResult - Class in li.cil.oc2.api.bus.device.vm: VMDevices may signal the result of their VMDevice.mount(VMContext) operations.
VMInitializationException - Exception Class in li.cil.oc2.api.bus.device.vm.event: May be fired by devices while handling VMInitializingEvent to indicate that initialization failed.
VMInitializationException() - Constructor for exception class li.cil.oc2.api.bus.device.vm.event.VMInitializationException
VMInitializationException(Component) - Constructor for exception class li.cil.oc2.api.bus.device.vm.event.VMInitializationException
VMInitializingEvent - Record Class in li.cil.oc2.api.bus.device.vm.event: Fired exactly once, when the VM first starts running.
VMInitializingEvent(MemoryMap, long) - Constructor for record class li.cil.oc2.api.bus.device.vm.event.VMInitializingEvent: Creates an instance of a VMInitializingEvent record class.
VMLifecycleEventBus - Interface in li.cil.oc2.api.bus.device.vm.context: Allows registering for VM lifecycle events.
VMPausingEvent - Class in li.cil.oc2.api.bus.device.vm.event: Fired when the VM is about to pause, typically before state is persisted.
VMPausingEvent() - Constructor for class li.cil.oc2.api.bus.device.vm.event.VMPausingEvent
VMResumedRunningEvent - Class in li.cil.oc2.api.bus.device.vm.event: Fired when the VM resumed running, either when first starting up, when resuming after being loaded, or after a VMPausingEvent.
VMResumedRunningEvent() - Constructor for class li.cil.oc2.api.bus.device.vm.event.VMResumedRunningEvent
VMRuntime - Interface in li.cil.oc2.api.bus.device.vm.context: Provides access to the execution state of a running virtual machine.

W

w - Enum constant in enum class li.cil.oc2.api.util.Side
wasSuccessful() - Method in class li.cil.oc2.api.bus.device.vm.VMDeviceLoadResult: Whether the load operation was successful or not.
west - Enum constant in enum class li.cil.oc2.api.util.Side
WEST - Enum constant in enum class li.cil.oc2.api.util.Side
withErrorMessage(Component) - Method in class li.cil.oc2.api.bus.device.vm.VMDeviceLoadResult: Adds an error message to this load result.
writeEthernetFrame(NetworkInterface, byte[], int) - Method in interface li.cil.oc2.api.capabilities.NetworkInterface: Tries to write an ethernet frame to this network interface.
writeString(String) - Method in class li.cil.oc2.api.bus.device.io.IOOutputStream: Writes the specified text as printable ASCII.
writeU16(int) - Method in class li.cil.oc2.api.bus.device.io.IOOutputStream: Writes the low two bytes of the specified value.
writeU32(long) - Method in class li.cil.oc2.api.bus.device.io.IOOutputStream: Writes the low four bytes of the specified value.
writeU8(int) - Method in class li.cil.oc2.api.bus.device.io.IOOutputStream: Writes the low byte of the specified value.

Z

Z80 - Enum constant in enum class li.cil.oc2.api.bus.device.vm.ArchitectureType

A B C D E F G H I J L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form