li.cil.oc.api.internal

Interface Keyboard

All Superinterfaces:

Environment, Persistable

All Known Subinterfaces:

Keyboard

public interface Keyboard
extends Environment, Persistable

This interface is implemented by the keyboard component, to allow more flexible use of it.

You can obtain an instance of the keyboard component via the item driver of the keyboard block, for example:

     final ItemStack stack = li.cil.oc.api.Items.get("keyboard").createItemStack(1);
     final Keyboard keyboard = (Keyboard) li.cil.oc.api.Driver.driverFor(stack).createEnvironment(stack, this);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Keyboard.UsabilityChecker Contract interface that has to implemented for usability check overrides.

Method Summary

Modifier and Type	Method and Description
void	setUsableOverride(Keyboard.UsabilityChecker callback) Sets a custom usability override.

Methods inherited from interface li.cil.oc.api.network.Environment

node, onConnect, onDisconnect, onMessage

Methods inherited from interface li.cil.oc.api.Persistable

load, save

Method Detail

setUsableOverride

void setUsableOverride(Keyboard.UsabilityChecker callback)

Sets a custom usability override.

Instead of the default check, which is based on the component's owner's position, the specified callback will be queried for usability checks instead.

Pass null here to unset a previously set override.

Parameters:

callback - the usability checker to use.