Skip to main content

IO interfaces

The IO interface API defines the slots or indexed tanks that each machine face can expose. When buttonSlots is present, it also installs the six buttons used by the standard UtilityCraft IO tab.

Import​

import {
  IOInterface,
  ensureBlockIOInterface,
  hasRegisteredIOInterface,
  registerIOInterface,
  registerIOInterfaceForBlockTag,
} from "DoriosCore/index.js";

registerIOInterface​

registerIOInterface(blockTypeId: string, config?: IOInterfaceConfig): boolean

Registers the IO policy for one exact block identifier. Exact registrations take priority over tag-based definitions.

Parameters​

NameTypeRequiredDescription
blockTypeIdstringYesExact namespaced block identifier, such as myaddon:crusher.
configIOInterfaceConfigNoItem, liquid, and gas policies. An omitted or empty config registers nothing.

Returns​

true when at least one backend resource group was registered; otherwise false.

Example: item machine​

registerIOInterface("myaddon:crusher", {
  items: {
    buttonSlots: [9, 14],
    anyInputSlots: [3],
    anyOutputSlots: [4],
    modes: [
      { id: "disabled" },
      { id: "input_1", inputSlots: [3] },
      { id: "output_1", outputSlots: [4] },
    ],
  },
});

IOInterfaceConfig​

PropertyTypeRequiredDescription
invertFacesbooleanNoResolves each visual face to the opposite physical direction. Defaults to false.
itemsItemIOGroupConfigNoInventory-slot policy and optional item buttons.
liquidsLiquidIOGroupConfigNoIndexed-liquid policy and optional liquid buttons.
gasesGasIOGroupConfigNoIndexed-gas policy and optional gas buttons. Gas configuration is stored separately from liquids.

ItemIOGroupConfig​

PropertyTypeRequiredDescription
buttonSlotsnumber[] | [number, number]NoExactly six UI slots, or a two-number inclusive range that expands to six slots.
anyInputSlotsnumber[]YesInput fallback when the source face is unknown.
anyOutputSlotsnumber[]YesOutput fallback when the destination face is unknown.
modesItemIOModeConfig[]YesOrdered modes cycled independently for each face.

LiquidIOGroupConfig and GasIOGroupConfig​

PropertyTypeRequiredDescription
buttonSlotsnumber[] | [number, number]NoExactly six UI slots, or an inclusive six-slot range.
anyInputIndicesnumber[]YesTank-index fallback when the source face is unknown.
anyOutputIndicesnumber[]YesTank-index fallback when the destination face is unknown.
modesFluidIOModeConfig[] or GasIOModeConfig[]YesOrdered modes whose entries use inputIndices and outputIndices.

Button-slot rules​

  • Each declared resource group must use six unique slots when buttonSlots is present.
  • [9, 14] means the inclusive range 9 through 14.
  • A longer array is treated as an explicit list and must contain exactly six entries.
  • Item IO buttons cannot overlap operational item slots.
  • Item, liquid, and gas button groups cannot share UI slots with each other.
  • Slot values must be integers from 0 through 255.

Invalid button layouts throw RangeError during registration so configuration problems fail at startup rather than during machine ticks.

Modes​

A mode ID is the visible name tag consumed by UtilityCraft's UI assets. Its slot or index arrays define the actual policy while that mode is selected.

{
  id: "input_1",
  inputSlots: [3]
}
{
  id: "output_1",
  outputIndices: [0]
}

Use mode IDs supported by the shared resource pack. Typical modes include disabled, input_1, input_2, output_1, and output_2, depending on the UI being represented.

Example: items, liquids, and gases​

registerIOInterface("myaddon:chemical_processor", {
  items: {
    buttonSlots: [10, 15],
    anyInputSlots: [3, 4],
    anyOutputSlots: [5],
    modes: [
      { id: "disabled" },
      { id: "input_1", inputSlots: [3] },
      { id: "input_2", inputSlots: [4] },
      { id: "output_1", outputSlots: [5] },
    ],
  },
  liquids: {
    buttonSlots: [16, 21],
    anyInputIndices: [0],
    anyOutputIndices: [1],
    modes: [
      { id: "disabled" },
      { id: "input_1", inputIndices: [0] },
      { id: "output_1", outputIndices: [1] },
    ],
  },
  gases: {
    buttonSlots: [22, 27],
    anyInputIndices: [0],
    anyOutputIndices: [1],
    modes: [
      { id: "disabled" },
      { id: "input_1", inputIndices: [0] },
      { id: "output_1", outputIndices: [1] },
    ],
  },
});

registerIOInterfaceForBlockTag​

registerIOInterfaceForBlockTag(blockTag: string, config?: IOInterfaceConfig): boolean

Stores a reusable IO template for blocks carrying one exact runtime tag. Supply the runtime tag name without the JSON tag: prefix.

The first encountered block type with that tag is materialized into an ordinary exact registration. If a block matches more than one registered IO tag, resolution fails closed and logs a warning.

registerIOInterfaceForBlockTag("myaddon:crusher_family", crusherIO);

ensureBlockIOInterface​

ensureBlockIOInterface(block?: Block): boolean

Returns true when the block already has an exact registration or a single matching tag template can be materialized. Invalid blocks, no matches, and ambiguous matches return false.

hasRegisteredIOInterface​

hasRegisteredIOInterface(blockTypeId: string): boolean

Returns whether an exact block type currently owns a complete IO registration.

IOInterface facade​

IOInterface exposes the four functions above as properties for namespace-style callers:

import { IOInterface } from "DoriosCore/index.js";

IOInterface.registerIOInterface("myaddon:crusher", config);

The direct function imports and facade methods have identical behavior.