Skip to content

Modules

This page lists module IDs currently documented for public API state queries.

Module IDs are case-insensitive in requests, but integrations should use the exact casing shown here.

Module IDDescription
PrinterSchematic Printer state, Printer runtime details, Printer settings, and server disable support.
MinimapMinimap module state.
EasyPlaceEasy Place module state and server disable support.

Only query modules listed on this page. Orbit may add more queryable modules later as the public API expands.

Module Extra Fields

Printer

Printer module objects include an extra object with read-only runtime details:

FieldTypeMeaning
printingEnabledbooleantrue when the Printer module is enabled and the internal Schematica printer loop is enabled.
isPrintingbooleantrue when printingEnabled is true and Printer successfully placed a block in the last second.

Use printingEnabled to know whether Printer is currently allowed to run. Use isPrinting as a live activity signal; it can be false while Printer is enabled if there is no loaded schematic, no block was placed recently, or Printer is waiting for delay, inventory, or placement conditions.

Server-Controllable Modules

Servers can disable and re-enable only the modules listed here.

Module IDBehavior
PrinterDisables Schematic Printer for the current server session.
EasyPlaceDisables Easy Place for the current server session.

Server-Controllable Settings

Servers can restrict only the settings listed here.

Module IDSetting IDSetting nameBehavior
Printerprint360360 PrinterPrevents 360-degree Printer placement while restricted.
MinimapplayerRadarPlayer RadarPrevents player radar entries from being shown while restricted.

Orbit Client API Documentation