Dockroom - the Stockroom SDK

Stockroom is an inventory management system. It provides a rotnetz host.

You can, of course, interact with it directly, but dockroom provides a thin wrapper around this which handles much of the boilerplate.

Making a Dockroom client

To use dockroom, you need to construct a client. You can do so like this:

It takes the subnet mask of your server as a parameter.

The Core SDK

Dockroom:Balance () -> Bundle Dockroom:hasBundle(bundle: Bundle) -> Boolean Dockroom:reserve(bundle: Bundle) -> reservationId

Constructors

Dockroom:bindInventory(inventoryId: String) -> Inventory Dockroom:findPort() -> Port

Inventories

You can bind inventories. Inventories inherit all the core methods from the SDK, but not the constructors.

Ports

Ports are a special kind of inventory, intended to be accessed programmatically by turtles. Stockroom keeps track of a list of these available ports.

You can request a port from stockroom using the findPort method. Ports behave identically to Inventories, but they have one extra field on them: location contains the XYZ coordinate of the port inventory.