CC: Tweaked

https://tweaked.cc/reference/
Admin
CC: Tweaked is a Lua-based programming environment for ComputerCraft that provides APIs for...
Tokens:5,917
Snippets:46
Trust Score:7.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Get Basic Block Information (Lua)

Source: https://tweaked.cc/reference/block_details

Demonstrates how to retrieve basic information about a block using `turtle.inspect`. This includes the block's namespaced ID and its state, which describes its properties like moisture level or whether a piston is extended.

```lua
local ok, block = turtle.inspect()
if ok then
    print('Block Name: ' .. block.name)
    print('Block State:')
    for key, value in pairs(block.state) do
        print(string.format('  %s = %s', key, tostring(value)))
    end
else
    print('No block in front of the turtle.')
end
```

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

### Check Block Tags (Lua)

Source: https://tweaked.cc/reference/block_details

Shows how to check if a block possesses specific tags using the `tags` field returned by `turtle.inspect`. This example checks if the block in front of the turtle is classified as a log.

```lua
local function is_log()
    local ok, block = turtle.inspect()
    return ok and block.tags and block.tags["minecraft:logs"]
end

if is_log() then
    print('The block in front is a log.')
else
    print('The block in front is not a log.')
end
```

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

### Turn On Command

Source: https://tweaked.cc/reference/computercraft_command

Turns on one or more specified computers, or all loaded computers if no arguments are provided.

```APIDOC
## /computercraft turn-on [computers...]

### Description
Turns on one or more computers. If no computers are specified, all loaded computers are turned on.

### Method
POST (or PUT, as it modifies state)

### Endpoint
`/computercraft turn-on [computers...]`

### Parameters
#### Path Parameters
- `computers...` (string) - Optional - One or more computer IDs or selectors to turn on.

### Request Example
```json
{
  "computers": ["#0", "#2"]
}
```
Or
```json
{
  "computers": ["@c[family=command]"]
}
```
Or empty for all computers.
```

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

### Dump Command

Source: https://tweaked.cc/reference/computercraft_command

Prints information about loaded computers, including ID, position, and status. Can provide detailed info for a specific computer.

```APIDOC
## /computercraft dump

### Description
Prints a table of currently loaded computers with their id, position, and running status. Can also dump detailed information about a specific computer.

### Method
GET (implicitly, as it retrieves data)

### Endpoint
`/computercraft dump [computer]`

### Parameters
#### Path Parameters
- `computer` (string) - Optional - The ID or selector for a specific computer to dump detailed information about.

### Response
#### Success Response (200)
- `id` (number) - The unique identifier for the computer.
- `position` (string) - The world coordinates of the computer.
- `running` (boolean) - Indicates if the computer is currently running.
- (Detailed info for specific computer includes more fields)

#### Response Example
```json
{
  "computers": [
    {
      "id": 12,
      "position": "(100, 64, 200)",
      "running": true
    },
    {
      "id": 15,
      "position": "(110, 64, 210)",
      "running": false
    }
  ]
}
```
```

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

### View Command

Source: https://tweaked.cc/reference/computercraft_command

Opens a terminal for the specified computer, allowing remote viewing without direct interaction.

```APIDOC
## /computercraft view [computer]

### Description
Opens a terminal for the specified computer, enabling remote viewing without interacting with the physical block. Primarily intended for use from the `dump` command interface.

### Method
POST (or GET, as it retrieves a view)

### Endpoint
`/computercraft view [computer]`

### Parameters
#### Path Parameters
- `computer` (string) - Optional - The ID or selector for the computer to open a terminal for. If not specified, behavior might be undefined or default to a nearby computer.

### Request Example
```json
{
  "computer": "@c[label=main]"
}
```
```

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

### CC: Tweaked Command Overview

Source: https://tweaked.cc/reference/computercraft_command

The `/computercraft` command allows server owners to manage running computers on a server. Permissions vary, with most sub-commands requiring operator status, except for 'queue' which is available to all players.

```APIDOC
## /computercraft Command

### Description
Manages running computers on a server. Sub-commands have specific permission requirements.

### Permissions
- `computercraft.command.NAME`: Permission node for individual sub-commands.
- All players: `queue` sub-command.
- Operator (op) or equivalent: Most other sub-commands on multiplayer servers.
- Single-player worlds (cheats enabled): `dump`, `turn-on`/`shutdown`, `track`.
- Single-player worlds (cheats disabled): `tp` and `view` require cheats.

### Computer Selectors
Used to target specific computers for commands. Similar to entity selectors.

#### Supported Predicates:
- `id=<id>`: Select by computer ID.
- `instance=<id>`: Select by instance ID.
- `family=<normal|advanced|command>`: Select by computer type.
- `label=<label>`: Select by computer label.
- `distance=<distance>`: Select by distance from the player (uses float range syntax).

Shorthand: `#<id>` is equivalent to `@c[id=<id>]`.
```

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

### Track Command

Source: https://tweaked.cc/reference/computercraft_command

Enables profiling of computers to track performance metrics like code execution time and resource usage.

```APIDOC
## /computercraft track [action]

### Description
Enables and manages profiling of computers to identify performance issues. Allows starting, stopping, and dumping profiling data.

### Method
POST (for actions like start/stop)

### Endpoint
`/computercraft track [action] [fields...]`

### Parameters
#### Path Parameters
- `action` (string) - Required - The action to perform: `start`, `stop`, `dump`.
- `fields...` (string) - Optional - When using `dump`, specifies additional fields to display (e.g., `server_thread_time`, `http_bandwidth`).

### Request Example
```json
{
  "action": "start"
}
```
```json
{
  "action": "stop"
}
```
```json
{
  "action": "dump",
  "fields": ["server_thread_time", "http_bandwidth"]
}
```

### Response
#### Success Response (200)
- (Data related to profiling, depending on the action)

#### Response Example (for `track dump`)
```json
{
  "profiling_data": [
    {
      "computer_id": 12,
      "runs": 150,
      "total_time": 7.5,
      "average_time": 0.05,
      "server_thread_time": 1.2,
      "http_bandwidth": 1024
    }
  ]
}
```
```

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

### TP Command

Source: https://tweaked.cc/reference/computercraft_command

Teleports the player to the specified computer. Typically used via the 'dump' command interface.

```APIDOC
## /computercraft tp [computer]

### Description
Teleports the player to the specified computer. Primarily intended for use from the `dump` command interface.

### Method
POST (or PUT, as it changes player location)

### Endpoint
`/computercraft tp [computer]`

### Parameters
#### Path Parameters
- `computer` (string) - Optional - The ID or selector for the computer to teleport to. If not specified, behavior might be undefined or default to a nearby computer.

### Request Example
```json
{
  "computer": "#12"
}
```
```

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

### Shutdown Command

Source: https://tweaked.cc/reference/computercraft_command

Shuts down one or more specified computers, or all loaded computers if no arguments are provided.

```APIDOC
## /computercraft shutdown [computers...]

### Description
Shuts down one or more computers. If no computers are specified, all loaded computers are shut down. Useful for managing lag.

### Method
POST (or DELETE, as it modifies state)

### Endpoint
`/computercraft shutdown [computers...]`

### Parameters
#### Path Parameters
- `computers...` (string) - Optional - One or more computer IDs or selectors to shut down.

### Request Example
```json
{
  "computers": []
}
```
Or
```json
{
  "computers": ["@c[distance=..10]"]
}
```
```

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

### Retrieve Block Map Color (Lua)

Source: https://tweaked.cc/reference/block_details

Illustrates how to access the map color information for a block, if available. The `mapColour` or `mapColor` field provides an RGB hex value that can be formatted or unpacked.

```lua
local ok, block = turtle.inspect()
if ok and block.mapColour then
    local mapColorValue = block.mapColour
    print(string.format('Map Color (Hex): #%06X', mapColorValue))
    local r, g, b = colors.unpackRGB(mapColorValue)
    print(string.format('Map Color (RGB): R=%d, G=%d, B=%d', r, g, b))
elseif ok and block.mapColor then
    local mapColorValue = block.mapColor
    print(string.format('Map Color (Hex): #%06X', mapColorValue))
    local r, g, b = colors.unpackRGB(mapColorValue)
    print(string.Format('Map Color (RGB): R=%d, G=%d, B=%d', r, g, b))
else
    print('Map color is not available for this block.')
end
```

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

### Define Potion Effects for Minecraft Items

Source: https://tweaked.cc/reference/item_details

This snippet demonstrates how to define potion effects for Minecraft items. It includes properties like effect name, display name, duration, and potency. This is useful for creating custom potions or items with unique buffs.

```Lua-like
{
    name = "minecraft:potion",
    displayName = "Potion of Healing",
    potionEffects = {
        {
            name = "minecraft:instant_health",
            displayName = "Instant Health",
        },
    },
}
```

```Lua-like
{
    name = "minecraft:potion",
    displayName = "Potion of Regeneration",
    potionEffects = {
        {
            name = "minecraft:regeneration",
            displayName = "Regeneration II",
            duration = 22.5,
            potency = 2,
        },
    },
}
```

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

### Check if Item is a Log using turtle.getItemDetail

Source: https://tweaked.cc/reference/item_details

This Lua function checks if the item in a given inventory slot is a log. It utilizes the `turtle.getItemDetail` function with the `detailed` flag set to true to retrieve item tags and then checks for the presence of the 'minecraft:logs' tag. The function returns true if the item is a log, and false otherwise. This relies on the CC: Tweaked API.

```lua
local function is_log(slot)
    local ok, block = turtle.getItemDetail(slot, true)
    return ok and block.tags["minecraft:logs"]
end
```

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

### Specify Map Color for Minecraft Items

Source: https://tweaked.cc/reference/item_details

This snippet shows how to define the map color for an item's block form in Minecraft. The map color is represented as an RGB hex value and can be specified using either `mapColour` or `mapColor`. This property affects how the item appears on in-game maps.

```Lua-like
{
    name = "minecraft:stripped_acacia_log",
    count = 32,
    mapColour = 14188339,
    mapColor = 14188339,
}
```
Tokens:
Raw