Create Mod CC Tweaked Integration

https://wiki.createmod.net/users/cc-tweaked-integration/
Admin
Documentation for integrating Create Mod with CC Tweaked, covering logistics systems, train control,...
Tokens:25,693
Snippets:289
Trust Score:5.4
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Item Detail Example

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-object

Retrieves detailed information about an item in a specific slot of the package. This includes basic item properties and can extend to display name, durability, and enchantments.

```lua
{
  name = "minecraft:apple",
  itemGroups = {},
  tags = {},
  count = 1,
  maxCount = 64,
  displayName = "Apple",
}
```

--------------------------------

### Get Order Data Example

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-object

Retrieves the order data associated with an encoded package. This data includes functions to manage crafts, index, and order details.

```lua
{
    getCrafts(), -- function: 52d1c058
    getIndex(), -- function: 1f03a979
    getItemDetail(), -- function: 4782ee89
    getLinkIndex(), -- function: 3dfc0241
    getOrderID(), -- function: 625c4b8e
    isFinal(), -- function: 4953530c
    isFinalLink(), -- function: 19750a09
    list(), -- function: 4446fd6c
}
```

--------------------------------

### List Inventory Items Example

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/repackager

Lists all items in the connected inventory, returning basic information for each slot. Use 'pairs' to iterate as the table is sparse.

```lua
{
  {
    name = "minecraft:apple",
    count = 1,
  },
  {
    name = "minecraft:stick",
    count = 1,
  },
  [ 10 ] = {
    nbt = "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    count = 1,
    name = "minecraft:enchanted_book",
  },
}
```

--------------------------------

### Example Item Detail Structure

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Illustrates the structure of the detailed information returned for an item in the Frogport's inventory when using `getItemDetail`.

```lua
{
  tags = {
    [ "create:packages" ] = true,
  },
  maxCount = 1,
  name = "create:cardboard_package_12x10",
  itemGroups = {},
  count = 1,
  nbt = "ceed8ad969b49055bc14042fc07b6892",
  displayName = "Cardboard Package",
  package = { -- Packages come with this field, which points to the Package Object
        getAddress(), --function: 38260b86
        getItemDetail(), -- function: 7de9d189
        getOrderData(), -- function: 6d149c07
        isValid(), -- function: 3a6300d3
        list(), -- function: 1c7bc70
        setAddresS(), -- function: 1c7bc70
  }
}
```

--------------------------------

### List Package Items Example

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-object

Lists all items within the package, returning a table where each entry represents an item in a slot. Each item includes its name, count, and an optional NBT hash for distinguishing identical items.

```lua
{
  {
    name = "minecraft:apple",
    count = 1,
  },
  {
    name = "minecraft:stick",
    count = 1,
  },
  {
    nbt = "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    count = 1,
    name = "minecraft:enchanted_book",
  },
}
```

--------------------------------

### Scheduler Library Schedule Example

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/libraries

Assigns a schedule to drive to Station 1, wait for 5 seconds or until powered/14:00, then drive to Station 2. Uses a minimalistic library.

```lua
local Scheduler = require("scheduler")

local schedule = Scheduler.new(true) -- cyclic / looping!
    :to("Station 1")
        :wait(5):powered()
        :OR():time(14, 0, "daily")
    :to("Station 2")
        :wait(1)

station.setSchedule(schedule)
```

--------------------------------

### Trainlib Schedule Example

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/libraries

Assigns a schedule to drive to Station 1, wait for players, then drive to Station 2 and wait for dismount. Uses a pseudo-OOP library.

```lua
local tl = require("trainlib")

local schedule = tl.schedule(true) -- cyclic / looping!
local conditions = tl.condition_set_or():addCondition(tl.conditions.player_count(1, false))
local conditions_destination = tl.condition_set_or():addCondition(tl.conditions.player_count(0, true))

schedule
    :addEntry(tl.entry(tl.instructions.destination("Station 1"), conditions))
    :addEntry(tl.entry(tl.instructions.destination("Station 2"), conditions_destination))

station.setSchedule(schedule)
```

--------------------------------

### Example List Inventory Structure

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Shows the structure of the table returned by `list()`, representing items in the Frogport's inventory. Note that empty slots are nil.

```lua
{
  {
    nbt = "ceed8ad969b49055bc14042fc07b6892",
    count = 1,
    name = "create:cardboard_package_12x10",
  },
  {
    nbt = "c04232dbe75de33196e9d261136f7a27",
    count = 1,
    name = "create:cardboard_package_10x8",
  },
}
```

--------------------------------

### Create Scheduler DSL Example

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/libraries

Defines a schedule using a domain-specific language for Create Train Schedules. The DSL code is then converted into a usable schedule object.

```scheduler
cyclic
to "Station 1" {
  wait 5m, powered
  time = 14:00 daily
}
to "Station 2" {
  wait 1m
}
```

```lua
local mksched = require "create-scheduler"
local schedule = mksched("cyclic to ...")
station.setSchedule(schedule)
```

--------------------------------

### getSize()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/display-link

Gets the dimensions (height and width) of the connected display target.

```APIDOC
## getSize()

### Description
Gets the display size of the connected target.

### Returns
#### Success Response
* **height** (number) - The height of the display.
* **width** (number) - The width of the display.
```

--------------------------------

### getAddress

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/repackager

Gets the current address set for the Re-Packager.

```APIDOC
## getAddress()

### Description
Gets the Re-Packager's address.

### Method
`getAddress()`

### Returns
* `string` With the address currently in use.
```

--------------------------------

### Get PostBox Configuration

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Retrieves the current configuration of the PostBox. The configuration determines whether it sends and receives packages or only sends.

```lua
postbox.getConfiguration()
```

--------------------------------

### Get Crafting Recipes

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/order-data-object

Retrieves a list of crafting recipes associated with the order. Each recipe specifies the count and the 3x3 grid layout.

```lua
{
  {
    count = 5, -- Number of times this recipe needs to be crafted
    recipe = { -- Corresponds to crafting grid
      "minecraft:iron_nugget", "minecraft:iron_nugget", "minecraft:iron_nugget",
      "minecraft:iron_nugget", "create:cogwheel",       "minecraft:iron_nugget",
      "minecraft:iron_nugget", "minecraft:iron_nugget", "minecraft:iron_nugget"
    }
  },
  {
    count = 10,
    recipe = {
      nil, "minecraft:redstone_torch", nil, 
      nil, "minecraft:iron_ingot",     nil, 
      nil, "minecraft:glass_pane",     nil
    }
  }
}
```

--------------------------------

### Lua Train Schedule Example

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/train-schedule

Defines a cyclic train schedule with a destination instruction and multiple condition groups (delay/powered OR time_of_day).

```lua
schedule = {
  cyclic = true, -- Does the schedule repeat itself after the end has been reached?
  entries = { -- List of entries, each entry contains a single instruction and multiple conditions.
    {
      instruction = {
        id = "create:destination", -- The different instructions are described below.
        data = { -- Data that is stored about the instruction. Different for each instruction type.
          text = "Station 1",
        },
      },
      conditions = {    -- List of lists of conditions. The outer list is the "OR" list
        {               -- and the inner lists are "AND" lists.
          {
            id = "create:delay", -- The different conditions are described below.
            data = { -- Data that is stored about the condition. Different for each condition type.
              value = 5,
              time_unit = 1,
            },
          },
          {
            id = "create:powered",
            data = {},
          },
        },
        {
          {
            id = "create:time_of_day",
            data = {
              rotation = 0,
              hour = 14,
              minute = 0,
            },
          },
        },
      },
    },
  },
}
```

--------------------------------

### getAddress()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Gets the current address configured for the PostBox.

```APIDOC
## getAddress()

### Description
Gets the PostBox's address.

### Method
GET

### Endpoint
/postbox/address

### Returns
* `string` With the address currently in use.
```

--------------------------------

### getStress()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/stressometer

Gets the current stress level of the connected network.

```APIDOC
## getStress()

### Description
Gets the connected network's current stress level.

### Method
`getStress()`

### Returns
* `number` The current stress level in SU.
```

--------------------------------

### getAddress()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-object

Gets the package's address. If the package is editable, it also updates the snapshot's address if it has changed.

```APIDOC
## getAddress()

### Description
Gets the package's address. If the package `isEditable()`, then it'll also update the snapshot's address, in case it has changed.

### Returns
* `string` With the address currently in use.
```

--------------------------------

### Get PostBox Address

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Retrieves the current address set for the PostBox. This is used to filter incoming packages.

```lua
postbox.getAddress()
```

--------------------------------

### Get Frogport Configuration

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Retrieves the current operational mode of the Frogport. The configuration determines whether the Frogport sends and receives, or only sends packages.

```lua
frogport.getConfiguration()
```

--------------------------------

### Get Item Detail from PostBox Slot

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Fetches detailed information about an item in a specific slot of the PostBox. This includes display name, durability, and other item-specific data.

```lua
postbox.getItemDetail(slot)
```

--------------------------------

### Get Item Detail from Frogport Slot

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Fetches detailed information about an item within a specific slot of the Frogport's inventory. This includes item name, count, NBT data, and potentially package-specific details.

```lua
frogport.getItemDetail(slot)
```

--------------------------------

### getItemDetail(slot)

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-object

Gets detailed information about an item in the package at a specific slot. This includes basic item information and additional details like display name and durability.

```APIDOC
## getItemDetail(slot)

### Description
Get detailed information about an item in the package.

The returned information contains the same information as each item in `list()`, as well as additional details like the display name (`displayName`), and item durability (`damage`, `maxDamage`, `durability`).
Some items include more information (such as enchantments) - it is recommended to print it out using `textutils.serialize()` or in the Lua REPL, to explore what is available.

### Parameters
* _slot_ : `number` - The slot to get information about.

### Throws
* If the slot is not between 1 and 9.

### Returns
* `table` Information about the item in this slot, or `nil` if it is empty, like:
```lua
{
  name = "minecraft:apple",
  itemGroups = {},
  tags = {},
  count = 1,
  maxCount = 64,
  displayName = "Apple",
}
```
```

--------------------------------

### Get Item Detail from Payment Inventory

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Retrieves detailed information about an item in the payment inventory for a specific slot. Useful for inspecting item properties like display name and durability.

```lua
{
  name = "minecraft:apple",
  itemGroups = {},
  tags = {},
  count = 1,
  maxCount = 64,
  displayName = "Apple"
}
```

--------------------------------

### Get Creative Motor Speed

Source: https://wiki.createmod.net/users/cc-tweaked-integration/creative-motor

Gets the creative motor's current generated speed in RPM.

```lua
getGeneratedSpeed()
```

--------------------------------

### makePackage()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/packager

Activates the packager to create a new package, similar to powering it with redstone. Returns a boolean indicating success.

```APIDOC
## makePackage()

### Description
Activates the packager like if it was powered by redstone. It operates by the same rule as a button press, but unlike a redstone signal, returns a value on if it actually succeeded at making a package.

### Returns
* `boolean` whether a new package was made successfuly.
```

--------------------------------

### list()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-object

Lists all items in the package, returning a table with basic information for each item slot.

```APIDOC
## list()

### Description
List all items inside the package. This returns a table, with an entry for each slot.
Each item in the inventory is represented by a table containing some basic information. More information can be fetched with `getItemDetail()`. The table contains the item `name`, the `count` and a (potentially `nil`) hash of the item's `nbt`. This NBT data doesn't contain anything useful, but allows you to distinguish identical items.
The returned table is never sparse, so you can iterate over it with `ipairs()` just fine.

### Returns
* `table` with basic item information like:
```lua
{
  {
    name = "minecraft:apple",
    count = 1,
  },
  {
    name = "minecraft:stick",
    count = 1,
  },
  {
    nbt = "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    count = 1,
    name = "minecraft:enchanted_book",
  },
}
```
```

--------------------------------

### getStressCapacity()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/stressometer

Gets the total stress capacity of the connected network.

```APIDOC
## getStressCapacity()

### Description
Gets the connected network's total stress capacity.

### Method
`getStressCapacity()`

### Returns
* `number` The total stress capacity in SU.
```

--------------------------------

### getOrderData()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-object

Gets the orderData object associated with the package if it is an encoded package.

```APIDOC
## getOrderData()

### Description
Gets the `orderData` object of the package if it's an encoded package.

### Returns
* `orderData` of the package, or `nil` if none is present, like:
```lua
{
    getCrafts(), -- function: 52d1c058
    getIndex(), -- function: 1f03a979
    getItemDetail(), -- function: 4782ee89
    getLinkIndex(), -- function: 3dfc0241
    getOrderID(), -- function: 625c4b8e
    isFinal(), -- function: 4953530c
    isFinalLink(), -- function: 19750a09
    list(), -- function: 4446fd6c
}
```
```

--------------------------------

### request()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/redstone-requester

Initiates a package request to the network using the Redstone Requester's current address, configuration, and request data.

```APIDOC
## request()

### Description
Sends a package request to the network using the Redstone Requester's configured address, request data, and configuration.

### Method
POST (conceptual)

### Endpoint
N/A (Method Call)

### Parameters
None

### Response
None explicitly documented.
```

--------------------------------

### getPassingTrainName

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/train-observer

Gets the name of a train within the train observer's range.

```APIDOC
## getPassingTrainName()

### Description
Gets the name of a train within the train observer's range.

### Method
None (Function Call)

### Parameters
None

### Response
#### Success Response
- **return value** (string) - The name of the detected train, or `nil` if no train is found.
```

--------------------------------

### getAddress

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Gets the Frogport's current address. This is useful for determining where packages are being sent.

```APIDOC
## getAddress()

### Description
Gets the Frogport's address.

### Method
N/A (Function Call)

### Parameters
None

### Returns
* `string` With the address currently in use.
```

--------------------------------

### list()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Lists all items in the payment inventory. Returns a sparse table with basic item information.

```APIDOC
## list()

### Description
List all items in the payment inventory.

### Returns
* `table` with basic item information.

### Response Example
```json
{
  "1": {
    "name": "minecraft:apple",
    "count": 1
  },
  "2": {
    "name": "minecraft:stick",
    "count": 1
  },
  "10": {
    "nbt": "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    "count": 1,
    "name": "minecraft:enchanted_book"
  }
}
```
```

--------------------------------

### getGeneratedSpeed()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/creative-motor

Gets the creative motor's current generated rotation speed in RPM.

```APIDOC
## getGeneratedSpeed()

### Description
Gets the creative motor's current generated rotation speed.

### Method
N/A (SDK Method)

### Parameters
None

### Request Example
```javascript
getGeneratedSpeed()
```

### Response
#### Success Response (200)
- **speed** (number) - The current generated rotation speed in RPM.

#### Response Example
```json
{
  "speed": 100
}
```
```

--------------------------------

### stock([detailed])

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Lists all items in the network. Optionally includes detailed information for each item.

```APIDOC
## stock([detailed])

### Description
Lists all items in the network.

### Parameters
#### Query Parameters
* **detailed** (boolean) - Optional - If true, includes detailed information about each item.

### Returns
* `table` A list of items in the network.

### Response Example (detailed=true)
```json
{
  "name": "minecraft:apple",
  "itemGroups": [],
  "tags": [],
  "count": 1,
  "maxCount": 64,
  "displayName": "Apple"
}
```
```

--------------------------------

### getAddress

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/table-cloth

Gets the current address set for the Table Cloth. This is used to direct processed purchases.

```APIDOC
## getAddress()

### Description
Gets the Table Cloth's address.

### Method
`getAddress()`

### Returns
* `string` With the address currently in use.
```

--------------------------------

### Get Signal Type

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/train-signal

Retrieves the current signal type, which can be 'ENTRY_SIGNAL' or 'CROSS_SIGNAL'. This is typically changed with a wrench.

```lua
signal.getSignalType()
```

--------------------------------

### list()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/order-data-object

Lists basic information about all items in the complete order, even if they are not in the package. This function is only valid for packages with a link index of 1.

```APIDOC
## list()

### Description
Lists basic information about all items in the complete order, even if they are not in the package. The returned table is empty after re-packaging for individual crafts. This function is only valid for packages with a link index of 1. If the package is not the first in a linked order, this will return `nil`.

### Returns
* `table` with basic item information, or `nil` if its `linkIndex` isn't equal to `1`.

Each item in the inventory is represented by a table containing basic information. The table contains the item `name`, the `count` and a (potentially `nil`) hash of the item's `nbt`.

### Example Response
```lua
{
  {
    name = "minecraft:apple",
    count = 1,
  },
  {
    nbt = "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    count = 1,
    name = "minecraft:enchanted_book",
  },
}
```
```

--------------------------------

### list()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/packager

Lists all items present in the connected inventory. Returns a sparse table where keys represent slots and values are tables with item details.

```APIDOC
## list()

### Description
List all items in the connected inventory. This returns a table, with an entry for each slot.

Each item in the inventory is represented by a table containing some basic information. More information can be fetched with `getItemDetail`. The table contains the item `name`, the `count` and a (potentially `nil`) hash of the item's `nbt`. This NBT data doesn't contain anything useful, but allows you to distinguish identical items.

The returned table is sparse, so empty slots will be `nil` - it is recommended to loop over using `pairs` rather than `ipairs`.

### Returns
* `table` with basic item information like:
```lua
{
  {
    name = "minecraft:apple",
    count = 1,
  },
  {
    name = "minecraft:stick",
    count = 1,
  },
  [ 10 ] = {
    nbt = "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    count = 1,
    name = "minecraft:enchanted_book",
  },
}
```
```

--------------------------------

### makePackage

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/repackager

Activates the re-packager to create a package, similar to a redstone signal.

```APIDOC
## makePackage()

### Description
Activates the re-packager like if it was powered by redstone. It operates by the same rule as a button press, but unlike a redstone signal, returns a value on if it actually succeeded at making a package.

### Method
`makePackage()`

### Returns
* `boolean` whether a new package was made successfuly.
```

--------------------------------

### getTargetSpeed()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/rotational-speed-controller

Gets the rotation speed controller's current target speed. The speed is returned in RPM.

```APIDOC
## getTargetSpeed()

### Description
Gets the rotation speed controller's current target speed. The speed is returned in RPM.

### Method
INVOKE

### Returns
#### Returns
- **number** The current target rotation speed in RPM.
```

--------------------------------

### Basic Item Request

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Requests up to 10 items named 'apple' from the network.

```lua
.requestfiltered("address", {name = "apple", _requestCount = 10})
```

--------------------------------

### Get Frogport Address

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Retrieves the current address configured for the Frogport. This is useful for verifying where packages are being sent or received.

```lua
frogport.getAddress()
```

--------------------------------

### List Order Items

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/order-data-object

Lists basic information about all items in an order. This method is only valid for packages with a `linkIndex` of 1. The returned table contains item `name`, `count`, and an optional `nbt` hash.

```lua
{
  {
    name = "minecraft:apple",
    count = 1,
  },
  {
    nbt = "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    count = 1,
    name = "minecraft:enchanted_book",
  },
}
```

--------------------------------

### getStockItemDetail(index)

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Gets detailed information about an item in the stock's given index. Includes display name and durability.

```APIDOC
## getStockItemDetail(index)

### Description
Get detailed information about an item in the network stock.

### Parameters
#### Path Parameters
* **index** (number) - Required - The index to get information from.

### Returns
* `table` Information about the item in this slot, or `nil` if it is empty.

### Response Example
```json
{
  "name": "minecraft:apple",
  "itemGroups": [],
  "tags": [],
  "count": 1,
  "maxCount": 64,
  "displayName": "Apple"
}
```
```

--------------------------------

### Get Signal State

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/train-signal

Retrieves the current signal state as perceived by trains. This can be 'RED', 'GREEN', or 'YELLOW' for CROSS_SIGNAL types.

```lua
signal.getState()
```

--------------------------------

### setWares

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/table-cloth

Configures the items that the Table Cloth will request for purchase. This method effectively turns the Table Cloth into a shop. If no items are provided, it reverts to normal behavior.

```APIDOC
## setWares(item, ...)

### Description
Sets the Table Cloth's wares that get requested on purchase. Each argument represents an item to be requested and is a table of the item `name`, like `create:wrench` or `apple` and the `count`, between `1` and `256`. nil argument or a table with an unspecified `name` equates to an empty slot. Unspecified `count` equates to `1`. If no items are provided, the tablecloth stops being a shop, and goes back to normal behaviour.

### Method
`setWares(item, ...)`

### Parameters
#### Path Parameters
* **item** (table) - Required - Table of `name = string` and `count = number`. You can have up to 9 `item` args.

### Request Example
lua
```lua
tableCloth = peripheral.find("Create_TableCloth")
if tableCloth then -- makes sure the tablecloth exists, in case it was wrapped while it wasn't a store/inventory
tableCloth.setWares(
    { name = "minecraft:diamond"}, -- defaults to 1
    { name = "redstone", count = 30 }
)
tableCloth.setPriceTagItem("gold_ingot")
tableCloth.setPriceTagCount(2)
end
```
```

--------------------------------

### Set PostBox Configuration

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Configures the PostBox to either send and receive packages (`"send_recieve"`) or only send packages (`"send"`).

```lua
postbox.setConfiguration(configuration)
```

--------------------------------

### update()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/display-link

Pushes all buffered changes to the connected display target, making them visible. This is necessary after operations like `write`, `writeBytes`, `clearLine`, or `clear`.

```APIDOC
## update()

### Description
Pushes any changes to the connected display target. Any changes made are only made to an internal buffer. For them to show up on the display they must be pushed to the display using this function. This allows for this peripheral to be better multithreaded and for users to be able to change multiple lines at once by using multiple `write(text)` calls and then one `update()` call.

### See Also
* `write(text)` To write text to the display target.
* `writeBytes(bytes)` To write bytes to the display target.
* `clearLine()` To clear the current line.
* `clear()` To clear the whole display.
```

--------------------------------

### Requesting All Items

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Requests all items available on the network by using an empty filter. This is useful for fetching all available stock.

```lua
stockTicker.request("givenAddress", {})
```

--------------------------------

### getConfiguration()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/redstone-requester

Retrieves the current configuration setting of the Redstone Requester, which can be 'allow_partial' or 'strict'.

```APIDOC
## getConfiguration()

### Description
Gets the Redstone Requester's configuration.

### Method
GET (conceptual)

### Endpoint
N/A (Method Call)

### Parameters
None

### Response
#### Success Response
- **configuration** (string) - Either "allow_partial" or "strict".
```

--------------------------------

### list()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Lists all items currently present in the PostBox's inventory.

```APIDOC
## list()

### Description
List all items in the PostBox's inventory.

### Method
GET

### Endpoint
/postbox/inventory

### Returns
* `table` with basic item information.
```

--------------------------------

### getState()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/train-signal

Gets the train signal's currently displayed signal color, as perceived by trains. This can be 'RED', 'GREEN', or 'YELLOW' for CROSS_SIGNAL types.

```APIDOC
## getState()

### Description
Gets the train signal's currently displayed signal, as how the trains see it.

### Returns
* `string` The color of the signal currently displayed - either "RED", "GREEN" or "YELLOW" (Only on CROSS_SIGNAL types).
```

--------------------------------

### list

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/repackager

Lists all items present in the connected inventory.

```APIDOC
## list()

### Description
List all items in the connected inventory. This returns a table, with an entry for each slot. Each item in the inventory is represented by a table containing some basic information. More information can be fetched with `getItemDetail`. The table contains the item `name`, the `count` and a (potentially `nil`) hash of the item's `nbt`. This NBT data doesn't contain anything useful, but allows you to distinguish identical items. The returned table is sparse, so empty slots will be `nil` - it is recommended to loop over using `pairs` rather than `ipairs`.

### Method
`list()`

### Returns
* `table` with basic item information like:
```lua
{
  {
    name = "minecraft:apple",
    count = 1,
  },
  {
    name = "minecraft:stick",
    count = 1,
  },
  [ 10 ] = {
    nbt = "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    count = 1,
    name = "minecraft:enchanted_book",
  },
}
```
```

--------------------------------

### getConfiguration()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Retrieves the current operational configuration of the PostBox.

```APIDOC
## getConfiguration()

### Description
Gets the PostBox's configuration.

### Method
GET

### Endpoint
/postbox/configuration

### Returns
* `string` With either `"send_recieve"` or `"send"` as the configuration.
```

--------------------------------

### stock

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Lists all items in the stock. Returns a table with an entry for each item. Item information can be basic or detailed.

```APIDOC
## stock

### Description
Lists all items in the stock. This returns a table, with an entry for each item. Each item in the inventory is represented by a table containing some basic information (or detailed information if `detailed = true`).

### Method
GET

### Endpoint
/stock

### Parameters
#### Query Parameters
- **detailed** (boolean) - Optional - Whether the item information should be detailed. Defaults to false.

### Response
#### Success Response (200)
- **table** - A table containing item information. The structure varies based on the 'detailed' parameter.

#### Response Example (Basic)
```json
{
  "items": [
    {
      "name": "minecraft:apple",
      "count": 1
    },
    {
      "nbt": "ce5c752cf2df5cf4ffb17d7b7bfacad7",
      "count": 1,
      "name": "minecraft:enchanted_book"
    }
  ]
}
```

#### Response Example (Detailed)
```json
{
  "items": [
    {
      "name": "minecraft:stick",
      "itemGroups": [],
      "tags": {
        "forge:rods/wooden": true,
        "forge:rods": true
      },
      "count": 1,
      "maxCount": 64,
      "displayName": "Stick"
    },
    {
      "enchantments": [
        {
          "level": 1,
          "name": "minecraft:unbreaking",
          "displayName": "Unbreaking I"
        }
      ],
      "tags": {
        "minecraft:bookshelf_books": true
      },
      "name": "minecraft:enchanted_book",
      "itemGroups": [],
      "maxCount": 1,
      "count": 1,
      "nbt": "ce5c752cf2df5cf4ffb17d7b7bfacad7",
      "displayName": "Enchanted Book"
    }
  ]
}
```
```

--------------------------------

### Set Table Cloth Wares and Price Tag

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/table-cloth

This snippet demonstrates how to set the items a Table Cloth will sell and configure its price tag. Ensure the Table Cloth peripheral is found before attempting to set its properties.

```lua
tableCloth = peripheral.find("Create_TableCloth")
if tableCloth then -- makes sure the tablecloth exists, in case it was wrapped while it wasn't a store/inventory
tableCloth.setWares(
    { name = "minecraft:diamond"}, -- defaults to 1
    { name = "redstone", count = 30 }
)
tableCloth.setPriceTagItem("gold_ingot")
tableCloth.setPriceTagCount(2)
end
```

--------------------------------

### getCrafts()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/order-data-object

Retrieves a list of crafting recipes associated with the order. Each recipe specifies the count and the grid layout.

```APIDOC
## getCrafts()

### Description
Gets the crafting recipes associated with the order.

### Returns
* `table` of crafting recipes, like:
```lua
{
  {
    count = 5, -- Number of times this recipe needs to be crafted
    recipe = { -- Corresponds to crafting grid
      "minecraft:iron_nugget", "minecraft:iron_nugget", "minecraft:iron_nugget",
      "minecraft:iron_nugget", "create:cogwheel",       "minecraft:iron_nugget",
      "minecraft:iron_nugget", "minecraft:iron_nugget", "minecraft:iron_nugget"
    }
  },
  {
    count = 10,
    recipe = {
      nil, "minecraft:redstone_torch", nil, 
      nil, "minecraft:iron_ingot",     nil, 
      nil, "minecraft:glass_pane",     nil
    }
  }
}
```
```

--------------------------------

### List Items in PostBox Inventory

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Lists all items currently in the PostBox's inventory. Returns a sparse table where keys are slots and values are item details.

```lua
postbox.list()
```

--------------------------------

### Requesting Items with Filters

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Requests items based on specified filters. Items from multiple filters can be packaged together if they meet certain criteria.

```lua
stockTicker.request("givenAddress", {
      ["forge:rods"] = true,
      ["forge:tools"] = true,
      _mode = "contained",
    },
    {
      nbt = {},
    }
)
```

--------------------------------

### list()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/order-data-object

Lists all items required for the complete Encoded Order. This provides a comprehensive view of the order's contents.

```APIDOC
## list()

### Description
Lists all items required for the complete Encoded Order.

### Returns
* `table` A list of items required for the complete order.
```

--------------------------------

### getWares

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/table-cloth

Retrieves the list of items that are being sold or requested for purchase via the Table Cloth.

```APIDOC
## getWares()

### Description
Gets the items being sold.

### Method
`getWares()`

### Returns
* `table` Table of itemDetails.
```

--------------------------------

### assemble()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/train-station

Assembles a new train at the station. The station must be in assembly mode before calling this function. This function also causes the station to exit assembly mode after the train is done assembling.

```APIDOC
## assemble()

### Description
Assembles a new train at the station. The station must be in assembly mode before calling this function.
This function also causes the station to exit assembly mode after the train is done assembling.

### Method
`assemble()`

### Throws
* If the station is not in assembly mode.
* If the station is not connected to a track.
* If the train failed to assemble.
* If the station failed to exit assembly mode.

### See also
* `setAssemblyMode(assemblyMode)` To set the assembly mode of the station.
```

--------------------------------

### Set Frogport Configuration

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Sets the operational mode of the Frogport. Use 'send_recieve' to enable both sending and receiving, or 'send' to only send packages.

```lua
frogport.setConfiguration("send_recieve")
```

```lua
frogport.setConfiguration("send")
```

--------------------------------

### setSignal(firstSignal, secondSignal)

Source: https://wiki.createmod.net/users/cc-tweaked-integration/nixie-tube

Displays custom shapes and signals on up to two Nixie tubes. Allows control over color, size, and blinking behavior.

```APIDOC
## setSignal(firstSignal, secondSignal)

### Description
Sets a custom signal for the nixie tubes. This function controls up to two tubes at once.

### Parameters
#### Path Parameters
* **firstSignal** (table) - Required - Describes the color, size, and blink rate of the glow in the first tube.
* **secondSignal** (table) - Required - Describes the color, size, and blink rate of the glow in the second tube.

### Signal Table Structure
```lua
{
    r = 0, -- red color value between 0 and 255
    g = 0, -- green color value between 0 and 255
    b = 0, -- blue color value between 0 and 255
    glowWidth, -- width of the glow shape between 1 and 4
    glowHeight, -- height of the glow shape between 1 and 4
    blinkPeriod = 40, -- time between blinks in ticks
    blinkOffTime = 20, -- downtime between blinks in ticks
}
```
*Note: All fields in the signal table are optional, but have no default values. Unspecified values persist from previous settings.* 

### Request Example
```lua
local signal1 = {
    r = 255, g = 0, b = 0, -- Red color
    glowWidth = 3,
    glowHeight = 3,
    blinkPeriod = 40, -- Blink every 2 seconds (assuming 20 ticks per second)
    blinkOffTime = 20  -- Off for 1 second
}
local signal2 = {
    r = 0, g = 0, b = 255, -- Blue color
    glowWidth = 2,
    glowHeight = 2
}
nixieTube.setSignal(signal1, signal2)
```
```

--------------------------------

### isColor()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/display-link

Checks if the connected display target supports color.

```APIDOC
## isColor()

### Description
Whether the connected display target supports color.

### Returns
#### Success Response
* **supported** (boolean) - Whether the display supports color.
```

--------------------------------

### getConfiguration

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Retrieves the current configuration of the Frogport, indicating its send/receive behavior.

```APIDOC
## getConfiguration()

### Description
Gets the Frogport's configuration.

### Method
N/A (Function Call)

### Parameters
None

### Returns
* `string` With either `"send_recieve"` or `"send"` as the configuration.
```

--------------------------------

### getPackage

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/repackager

Retrieves the package object currently held by the re-packager.

```APIDOC
## getPackage()

### Description
Get an interactive `package` object for the package currently held by the re-packager. Package objects return `true` on their respective `isValid` function, and allow for the usage of `setAddress` while held inside a re-packager/re-packager.

### Method
`getPackage()`

### Returns
* `table` of a `package` object or `nil` if there is none.
```

--------------------------------

### isRunning()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/sequenced-gearshift

Checks if the sequenced gearshift is currently spinning.

```APIDOC
## isRunning()

### Description
Checks if the sequenced gearshift is currently spinning.

### Method
`isRunning()`

### Parameters
This method does not take any parameters.

### Response
#### Success Response (boolean)
* **Returns** (boolean) - Whether the sequenced gearshift is currently spinning.

### Response Example
```
true
```
```

--------------------------------

### isShop

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/table-cloth

Determines if the Table Cloth is currently configured as a shop.

```APIDOC
## isShop()

### Description
Checks if the Table Cloth is a shop or not.

### Method
`isShop()`

### Returns
* `boolean` , True if it's a shop.
```

--------------------------------

### setConfiguration(configuration)

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/redstone-requester

Sets the Redstone Requester's configuration to either 'strict' or 'allow_partial'.

```APIDOC
## setConfiguration(configuration)

### Description
Sets the Redstone Requester's configuration to either "strict" or "allow_partial".
*   "strict" will only let the request through if all the matching items are available.
*   "allow_partial" will run the request no matter the availability.

### Method
PUT (conceptual)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **configuration** (string) - Required - The desired configuration, either "strict" or "allow_partial".
```

--------------------------------

### list

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/package-frogport

Lists all items currently present in the Frogport's inventory, returning basic information for each item.

```APIDOC
## list()

### Description
List all items in the Frogport's inventory.

### Method
N/A (Function Call)

### Parameters
None

### Returns
* `table` with basic item information.
```

--------------------------------

### getIndex()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/order-data-object

Retrieves the index of the package. This indicates the package's position among others from the same packager.

```APIDOC
## getIndex()

### Description
Gets the index of the package.

### Returns
* `number` The package index.
```

--------------------------------

### isInAssemblyMode()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/train-station

Checks whether the station is currently in assembly mode.

```APIDOC
## isInAssemblyMode()

### Description
Checks whether the station is in assembly mode.

### Method
`isInAssemblyMode()`

### Returns
* `boolean` Whether the station is in assembly mode.

### Throws
* If the station is not connected to a track.
```

--------------------------------

### setRequest([item], ...)

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/redstone-requester

Sets the Redstone Requester's request for packages, similar to the GUI, with a maximum of 9 item arguments.

```APIDOC
## setRequest([item], ...)

### Description
Sets the packager's request, similar to the one available in the GUI, with a maximum of 9 arguments. Each argument represents a slot and is a table containing the item `name` (string) and `count` (number, 1-256). A nil argument or a table with an unspecified `name` is allowed but serves no purpose. An unspecified `count` defaults to 1.

### Method
PUT (conceptual)

### Endpoint
N/A (Method Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **item** (table | nil) - Optional - A table with `name` (string) and `count` (number). Up to 9 `item` arguments can be provided. A nil value or a table with an unspecified `name` is allowed but serves no purpose. Unspecified `count` defaults to 1.
```

--------------------------------

### Set Crafting Request

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/redstone-requester

Configures the Redstone Requester for autocrafting with up to 9 item slots. Use nil for empty slots. The first argument specifies the number of crafts.

```lua
redstoneRequester = peripheral.find("Create_RedstoneRequester")
redstoneRequester.setCraftingRequest(
    1, -- number of crafts we want
    "minecraft:diamond",
    "minecraft:diamond",
    "diamond",          -- skipping "minecraft:" works for vanilla items
    "minecraft:air",    -- sets an empty slot
    "minecraft:stick",
    nil,                -- also sets an empty slot
    nil,
    "minecraft:stick",
      -- not providing args at the end also sets empty slots
)
redstoneRequester.setAddress("crafter"])
redstoneRequester.request()
```

```lua
redstoneRequester.setCraftingRequest()
```

--------------------------------

### isColour()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/display-link

Checks if the connected display target supports colour (alternative spelling).

```APIDOC
## isColour()

### Description
Whether the connected display target supports colour.

### Returns
#### Success Response
* **supported** (boolean) - Whether the display supports colour.
```

--------------------------------

### setConfiguration(configuration)

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/postbox

Sets the PostBox's operational mode to either 'send_recieve' or 'send'.

```APIDOC
## setConfiguration(configuration)

### Description
Sets the PostBox's configuration to either `"send_recieve"` or `"send"`, represented by the bottoms on the bottom left of it's gui.

### Method
PUT

### Endpoint
/postbox/configuration

### Parameters
#### Request Body
* **configuration** (string) - Required - The desired configuration, either `"send_recieve"` or `"send"`.
```

--------------------------------

### Event: train_arrival

Source: https://wiki.createmod.net/users/cc-tweaked-integration/train/train-station

Triggers when a train arrives at the station.

```APIDOC
## Event: train_arrival

### Description
Triggers whenever a train arrives at the station.

### Returns
* `string` Name of station.
* `string` Name of train.
```

--------------------------------

### List Detailed Stock Items

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/stock-ticker

Retrieves a table of all items in the stock with detailed information, including item groups, tags, max count, and enchantments if applicable. Use this when comprehensive item data is required.

```lua
{
  {
    name = "minecraft:stick",
    itemGroups = {},
    tags = {
      [ "forge:rods/wooden" ] = true,
      [ "forge:rods" ] = true,
    },
    count = 1,
    maxCount = 64,
    displayName = "Stick",
  },
  {
    enchantments = {
      {
        level = 1,
        name = "minecraft:unbreaking",
        displayName = "Unbreaking I",
      },
    },
    tags = {
      [ "minecraft:bookshelf_books" ] = true,
    },
    name = "minecraft:enchanted_book",
    itemGroups = {},
    maxCount = 1,
    count = 1,
    nbt = "ce5c752cf2df5cf4ffb17d7b7bfacad7",
    displayName = "Enchanted Book",
  },
}
```

--------------------------------

### getPackage()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/packager

Retrieves the package object currently being held by the packager. This object can be used for further manipulation, such as setting its address.

```APIDOC
## getPackage()

### Description
Get an interactive `package` object for the package currently held by the packager.

Package objects return `true` on their respective `isValid` function, and allow for the usage of `setAddress` while held inside a packager/repackager.

### Returns
* `table` of a `package` object or `nil` if there is none.
```

--------------------------------

### clear()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/display-link

Clears the entire display. Changes are visible after calling `update()`.

```APIDOC
## clear()

### Description
Clears the whole display.

### See Also
* `update()` To push the changes to the display target.
```

--------------------------------

### isFinalLink()

Source: https://wiki.createmod.net/users/cc-tweaked-integration/logistics/order-data-object

Checks if this package is part of the last link in a chain of packagers fulfilling the same order.

```APIDOC
## isFinalLink()

### Description
Indicates if this package is part of the last link in the order.

### Returns
* `boolean` `true` if this is part of the final linked package in a chain, `false` otherwise.
```
Tokens:
Raw