Block reference

XLAPI Block

The XLAPI block splits local computer segments and can relay structured bridge traffic between compatible remote segments. It is the block that turns one local system into a cross-segment network.

Bridge endpoint Structured remote queries Partially implemented
Back to block overview
In game

Relay and group controls.

  • Right click toggles relay mode and prints the current bridge state.
  • Shift-right-click cycles the uplink group from 0 to 15.
  • Name tags can rename the endpoint like other named device blocks.
  • The block acts as a segment boundary in local discovery even when you use it only as a separator.
Python commands

Bridge-specific methods on an XLAPI endpoint.

  • uplink_group() and set_uplink_group(group): read or change the bridge group. Group changes are local-only.
  • relay_enabled() and set_relay_enabled(enabled): read or change relay state. Relay changes are local-only.
  • forwarded_messages(): total count of forwarded bridge messages.
  • remote_computers(): list remote computer snapshots reachable through this bridge.
  • peek_messages(limit=16) and poll_messages(limit=16): inspect or drain bridge mailbox messages.
  • send_message(message, channel="default", target=""): send a raw message to all or one remote computer.
  • send_command(command, payload="", target=""): send a structured bridge command and receive response metadata.
  • request_status(target=""), ping(payload="ping", target=""), request_devices(target=""), and request_runtime(target="", output_limit=8, plan_limit=6): convenience wrappers around the built-in bridge commands.
  • peek_responses(limit=16) and poll_responses(limit=16): inspect or drain structured bridge responses.
  • state(): returns bridge metadata including uplink group, relay state, forwarded message count, reachable remote computers, and inbox count.
Common endpoint methods

Also available on XLAPI devices.

  • rename(name), available(), summary(), and describe().
  • api_name(), name(), type(), position(), distance(), and network/bridge metadata helpers.