CC: Tweaked Generic Peripherals

https://tweaked.cc/generic_peripheral
Admin
CC: Tweaked is a Minecraft mod that adds programmable computers and turtles, enabling automation of...
Tokens:3,490
Snippets:34
Trust Score:7.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Get Item Details by Slot

Source: https://tweaked.cc/generic_peripheral/inventory

Fetches detailed information about the item in a specific inventory slot. This includes display name, internal name, count, and potentially damage or other NBT data. Returns nil if the slot is empty. Throws an error if the slot is out of range.

```lua
local chest = peripheral.find("minecraft:chest")
local item = chest.getItemDetail(1)
if not item then print("No item") return end

print(string.format("%s (%s)", item.displayName, item.name))
print(string.format("Count: %d/%d", item.count, item.maxCount))

if item.damage then
  print(string.format("Damage: %d/%d", item.damage, item.maxDamage))
end
```

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

### Get Inventory Size

Source: https://tweaked.cc/generic_peripheral/inventory

Retrieves the total number of slots available in an inventory. This is useful for iterating through all possible slots.

```lua
local inventory = peripheral.find("minecraft:chest")
local size = inventory.size()
print("Inventory size: " .. size)
```

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

### Get Item Limit per Slot

Source: https://tweaked.cc/generic_peripheral/inventory

Determines the maximum number of items that can be stored in a specific inventory slot. This is typically 64 but can be much higher for specialized inventories like barrels or caches. Throws an error if the slot is out of range.

```lua
local chest = peripheral.find("minecraft:chest")
local total_capacity = 0
for i = 1, chest.size() do
  total_capacity = total_capacity + chest.getItemLimit(i)
end
print("Total capacity: " .. total_capacity)
```

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

### List All Items in Inventory

Source: https://tweaked.cc/generic_peripheral/inventory

Lists all items currently present in an inventory, returning a sparse table where keys are slot numbers and values are item details. Empty slots will be nil. This method is recommended for iterating over items using `pairs`.

```lua
local chest = peripheral.find("minecraft:chest")
for slot, item in pairs(chest.list()) do
  print(string.format("%d x %s in slot %d", item.count, item.name, slot))
end
```

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

### Push Items Between Inventories

Source: https://tweaked.cc/generic_peripheral/inventory

Transfers items from a slot in the current inventory to a specified slot in another connected inventory on the same wired network. The transfer is limited by the item's stack size by default. Both inventories must be connected via wired modems.

```lua
local chest_a = peripheral.wrap("minecraft:chest_0")
local chest_b = peripheral.wrap("minecraft:chest_1")

local transferred_count = chest_a.pushItems(peripheral.getName(chest_b), 1)
print(string.format("Transferred %d items", transferred_count))
```

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

### Pull Items Between Peripherals (Lua)

Source: https://tweaked.cc/generic_peripheral/inventory

Transfers items from a specified slot in a source peripheral to a destination peripheral. Supports an optional limit for the number of items to move and allows specifying the destination slot. Defaults to inserting into any available slot if not specified. Returns the number of transferred items.

```lua
local chest_a = peripheral.wrap("minecraft:chest_0")
local chest_b = peripheral.wrap("minecraft:chest_1")

chest_a.pullItems(peripheral.getName(chest_b), 1)
```

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

### Pull Items Into Inventory

Source: https://tweaked.cc/generic_peripheral/inventory

Transfers items from a specified slot in a connected inventory into the current inventory. This operation requires both inventories to be connected via wired modems. Items can be pulled into any available slot or a specific target slot.

```lua
local chest_a = peripheral.wrap("minecraft:chest_0")
local chest_b = peripheral.wrap("minecraft:chest_1")

-- Pull up to 32 items from slot 1 of chest_a into the first available slot of chest_b
local transferred_count = chest_b.pullItems(peripheral.getName(chest_a), 1, 32)
print(string.format("Pulled %d items", transferred_count))
```

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

### Push Fluid API

Source: https://tweaked.cc/generic_peripheral/fluid_storage

Moves a specified amount of fluid from the current fluid container to another connected fluid container on the same wired network. This operation requires both containers to be connected via wired modems and cables.

```APIDOC
## POST /pushFluid

### Description
Move a fluid from one fluid container to another connected one. This allows you to push fluid from the current fluid container to another container _on the same wired network_. Both containers must be attached to wired modems which are connected via a cable.

### Method
POST

### Endpoint
/pushFluid

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **toName** (string) - Required - The name of the peripheral/container to push to. This is the string given to `peripheral.wrap`, and displayed by the wired modem.
- **limit** (number) - Optional - The maximum amount of fluid to move.
- **fluidName** (string) - Optional - The fluid to move. If not given, an arbitrary fluid will be chosen.

### Request Example
```json
{
  "toName": "tank_output",
  "limit": 50,
  "fluidName": "water"
}
```

### Response
#### Success Response (200)
- **amount** (number) - The amount of fluid moved.

#### Response Example
```json
{
  "amount": 50
}
```

### Throws
- If the peripheral to transfer to doesn't exist or isn't a fluid container.
```

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

### Tanks API

Source: https://tweaked.cc/generic_peripheral/fluid_storage

Retrieves information about all fluid tanks within the fluid storage. Tanks can either contain fluid or be empty. For tanks with fluid, basic information like fluid name and amount is returned. Empty tanks are represented by nil values.

```APIDOC
## GET /tanks

### Description
Get all "tanks" in this fluid storage. Each tank either contains some amount of fluid or is empty. Tanks with fluids inside will return some basic information about the fluid, including its name and amount. The returned table is sparse, and so empty tanks will be `nil` - it is recommended to loop over using `pairs` rather than `ipairs`.

### Method
GET

### Endpoint
/tanks

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **tanks** (table | nil...) - Basic information about all fluids in this fluid storage.

#### Response Example
```json
{
  "tanks": {
    1: { "fluidName": "water", "amount": 100 },
    3: { "fluidName": "lava", "amount": 50 },
    5: nil
  }
}
```
```

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

### Pull Fluid API

Source: https://tweaked.cc/generic_peripheral/fluid_storage

Moves a specified amount of fluid from a connected fluid container on the same wired network into the current fluid container. This operation requires both containers to be connected via wired modems and cables.

```APIDOC
## POST /pullFluid

### Description
Move a fluid from a connected fluid container into this one. This allows you to pull fluid from another container _on the same wired network_ into the current fluid container. Both containers must be attached to wired modems which are connected via a cable.

### Method
POST

### Endpoint
/pullFluid

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **fromName** (string) - Required - The name of the peripheral/container to pull from. This is the string given to `peripheral.wrap`, and displayed by the wired modem.
- **limit** (number) - Optional - The maximum amount of fluid to move.
- **fluidName** (string) - Optional - The fluid to move. If not given, an arbitrary fluid will be chosen.

### Request Example
```json
{
  "fromName": "tank_input",
  "limit": 25,
  "fluidName": "milk"
}
```

### Response
#### Success Response (200)
- **amount** (number) - The amount of fluid moved.

#### Response Example
```json
{
  "amount": 25
}
```

### Throws
- If the peripheral to transfer from doesn't exist or isn't a fluid container.
```
Tokens:
Raw