CC: Tweaked

https://tweaked.cc
Admin
CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game....
Tokens:134,507
Snippets:1,593
Trust Score:7.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Setup Autocompletion and Settings for a Program

Source: https://tweaked.cc/guide/startup.html

This startup script defines a boolean setting for 'example' and sets up shell autocompletion for the 'example.lua' program, providing 'get' and 'toggle' choices.

```lua
settings.define("example", { type = "boolean", default = true })

local completion = require "cc.shell.completion"
shell.setCompletionFunction("example.lua", completion.build(
  { completion.choice, { "get", "toggle" } }
))
```

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

### Code Completion Example

Source: https://tweaked.cc/module/textutils.html

Demonstrates how to use the textutils.complete function to get suggestions for a partial string within the global environment.

```lua
textutils.complete( "pa", _ENV )
```

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

### Run a Program on Startup

Source: https://tweaked.cc/guide/startup.html

Place this code in `startup.lua` to automatically run the 'hello' program when the computer starts.

```lua
shell.run("hello")
```

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

### Print a Page with Title and Message

Source: https://tweaked.cc/peripheral/printer.html

This snippet demonstrates how to start a new page, set its title, write text at specific positions, and then finalize the page. It includes error handling for cases where a new page cannot be started or ended.

```lua
local printer = peripheral.find("printer")

-- Start a new page, or print an error.
if not printer.newPage() then
 error("Cannot start a new page. Do you have ink and paper?")
end

-- Write to the page
printer.setPageTitle("Hello")
printer.write("This is my first page")
printer.setCursorPos(1, 3)
printer.write("This is two lines below.")

-- And finally print the page!
if not printer.endPage() then
 error("Cannot end the page. Is there enough space?")
end
```

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

### Modem Usage Example

Source: https://tweaked.cc/peripheral/modem.html

Demonstrates how to open a channel, send a message, and receive a reply using the modem peripheral.

```APIDOC
## Usage
  * Wrap a modem and a message on channel 15, requesting a response on channel 43. Then wait for a message to arrive on channel 43 and print it.
Run ᐅ```
local modem = peripheral.find("modem") or error("No modem attached", 0)
modem.open(43) -- Open 43 so we can receive replies

-- Send our message
modem.transmit(15, 43, "Hello, world!")

-- And wait for a reply
local event, side, channel, replyChannel, message, distance
repeat
 event, side, channel, replyChannel, message, distance = os.pullEvent("modem_message")
until channel == 43

print("Received a reply: " .. tostring(message))
```
```

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

### Get Computer Uptime

Source: https://tweaked.cc/module/os.html

Returns the total uptime of the computer in seconds since it was last started or rebooted.

```lua
clock()
```

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

### programWithArgs(shell, text, previous, starting)

Source: https://tweaked.cc/library/cc.shell.completion.html

Completes arguments of a program.

```APIDOC
## programWithArgs(shell, text, previous, starting)
    
### Description
Complete arguments of a program.
### Parameters
  1. shell `table` The shell we're completing in.
  2. text `string` Current text to complete.
  3. previous { `string`... } The shell arguments before this one.
  4. starting `number` Which argument index this program and args start at.


### Returns
  1. { `string`... } A list of suffixes of matching programs or arguments.


### Changes
  * **New in version 1.97.0**
```

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

### Start Timer

Source: https://tweaked.cc/module/os.html

Starts a timer that triggers a 'timer' event after a specified duration. The time is rounded up to the nearest 0.05 seconds. Returns a timer ID for cancellation.

```lua
startTimer(time)
```

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

### Make HTTP GET Request and Print Headers

Source: https://tweaked.cc/module/http.html

Makes an HTTP GET request to a specified URL and prints the response headers using textutils.serialize. The connection is closed after retrieving headers.

```lua
local request = http.get("https://example.tweaked.cc")
print(textutils.serialize(request.getResponseHeaders()))
-- => {
--  [ "Content-Type" ] = "text/plain; charset=utf8",
--  [ "content-length" ] = 17,
--  ...
-- }
request.close()
```

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

### Define and Toggle a Setting

Source: https://tweaked.cc/guide/startup.html

This script defines a boolean setting 'example', allows retrieving its value, and toggles it. It also saves the setting change.

```lua
local cmd = ...
if cmd == "get" then
  print(settings.get("example"))
elseif cmd == "toggle" then
  settings.set("example", not settings.get("example"))
  settings.save()
  print("Toggled our setting")
else
  error("Unknown command", 0)
end
```

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

### commands.getBlockInfo

Source: https://tweaked.cc/module/commands.html

Get some basic information about a block.

```APIDOC
## commands.getBlockInfo

### Description
Get some basic information about a block.

### Parameters
#### Path Parameters
* **x** (number) - Required - The X coordinate of the block.
* **y** (number) - Required - The Y coordinate of the block.
* **z** (number) - Required - The Z coordinate of the block.
* **dimension** (string) - Optional - The dimension to check the block in. Defaults to the current dimension.

### Returns
#### Success Response
* **block** (object) - An object containing information about the block.
  * **name** (string) - The name of the block.
  * **state** (object) - The state of the block.
  * **nbt** (object | nil) - The NBT data of the block, if any.
```

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

### Print Mouse Up Event Details

Source: https://tweaked.cc/event/mouse_up.html

This example continuously listens for the 'mouse_up' event and prints the details of the released mouse button and its coordinates.

```lua
while true do
  local event, button, x, y = os.pullEvent("mouse_up")
  print(("The mouse button %s was released at %d, %d"):format(button, x, y))
end
```

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

### startTimer

Source: https://tweaked.cc/module/os.html

Starts a timer that will run for the specified number of seconds.

```APIDOC
## startTimer(time)

### Description
Starts a timer that will run for the specified number of seconds.

### Parameters
  1. time `number` - Required - The number of seconds until the timer fires.
```

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

### input([file])

Source: https://tweaked.cc/module/io.html

Gets or sets the current input file handle.

```APIDOC
## input([file])

### Description
Get or set the current input file.

### Parameters
- **file** (Handle | string, optional): The new input file, either as a file path or a pre-existing handle.

### Returns
- **Handle**: The current input file.

### Throws
- If the provided filename cannot be opened for reading.

### Changes
- New in version 1.55
```

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

### Item with Item Groups Example

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

Shows a stack of Stripped Acacia Logs and the creative item groups it belongs to, such as 'Building Blocks'.

```lua
{
    name = "minecraft:stripped_acacia_log",
    count = 32,
    itemGroups = {
        {
            id = "minecraft:building_blocks",
            displayName = "Building Blocks"
        }
    }
}
```

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

### version

Source: https://tweaked.cc/module/os.html

Get the current CraftOS version (for example, `CraftOS 1.9`).

```APIDOC
## version()

### Description
Get the current CraftOS version.

### Returns
  1. `string` - The current CraftOS version string.
```

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

### help

Source: https://tweaked.cc/library/cc.shell.completion.html

Wraps `help.completeTopic` as a `build` compatible function.

```APIDOC
## help
    
### Description
Wraps `help.completeTopic` as a `build` compatible function.
```

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

### getTitle(n)

Source: https://tweaked.cc/module/multishell.html

Get the title of the given tab. This starts as the name of the program, but may be changed using `multishell.setTitle`.

```APIDOC
## getTitle(n)

### Description
Get the title of the given tab. This starts as the name of the program, but may be changed using `multishell.setTitle`.

### Parameters
  1. n `number` The process index.

### Returns
  1. `string` | nil The current process title, or `nil` if the process doesn't exist.
```

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

### Item with Tags Example

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

Represents a stack of Stripped Acacia Logs with associated tags like 'minecraft:logs'.

```lua
{
    name = "minecraft:stripped_acacia_log",
    count = 32,
    tags = {
        ["minecraft:acacia_logs"] = true,
        ["minecraft:logs"] = true,
        ["minecraft:logs_that_burn"] = true,
    }
}
```

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

### settings.get

Source: https://tweaked.cc/module/settings.html

Get the value of a setting. Optionally provide a default value if the setting is not found or has not been changed.

```APIDOC
## settings.get

### Description
Get the value of a setting.

### Parameters
  1. name `string` - The name of the setting to get.
  2. default? - The value to use should there be pre-existing value for this setting. If not given, it will use the setting's default value if given, or `nil` otherwise.

### Returns
  1. The setting's, or the default if the setting has not been changed.

### Changes
  * **Changed in version 1.87.0:** Now respects default value if pre-defined and `default` is unset.
```

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

### Define and Get a Basic Setting

Source: https://tweaked.cc/module/settings.html

Demonstrates how to define a new setting with a default value and then retrieve its value. This is useful for establishing default configurations for your programs.

```lua
settings.define("my.setting", {
    description = "An example setting",
    default = 123,
    type = "number",
})
print("my.setting = " .. settings.get("my.setting")) -- 123
```

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

### Start and Wait for Timer to Finish

Source: https://tweaked.cc/event/timer.html

Starts a timer and waits for it to complete using os.pullEvent. Ensure the timer ID matches the one returned by os.startTimer.

```lua
local timer_id = os.startTimer(2)
local event, id
repeat
    event, id = os.pullEvent("timer")
until id == timer_id
print("Timer with ID " .. id .. " was fired")
```

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

### Get Computer Label

Source: https://tweaked.cc/module/os.html

Retrieves the user-defined label for the current computer. Returns nil if no label is set.

```lua
getComputerLabel()
```

```lua
computerLabel()
```

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

### launch(tProgramEnv, sProgramPath, ...)

Source: https://tweaked.cc/module/multishell.html

Start a new process with the given environment, program, and arguments. The returned process index is not constant over the program's run and can be safely used immediately after launching.

```APIDOC
## launch(tProgramEnv, sProgramPath, ...)

### Description
Start a new process, with the given environment, program and arguments.
The returned process index is not constant over the program's run. It can be safely used immediately after launching (for instance, to update the title or switch to that tab). However, after your program has yielded, it may no longer be correct.

### Parameters
  1. tProgramEnv `table` The environment to load the path under.
  2. sProgramPath `string` The path to the program to run.
  3. ... Additional arguments to pass to the program.

### Returns
  1. `number` The index of the created process.

### Usage
  * Run the "hello" program, and set its title to "Hello!"
Run ᐅ```
local id = multishell.launch({}, "/rom/programs/fun/hello.lua")
multishell.setTitle(id, "Hello!")
```

### See also
  * **`os.run`**
```

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

### Start and Wait for Alarm

Source: https://tweaked.cc/event/alarm.html

Starts a timer using os.setAlarm and then waits for the specific alarm to complete using os.pullEvent. This is useful for scheduling tasks or delays.

```lua
local alarm_id = os.setAlarm(os.time() + 0.05)
local event, id
repeat
    event, id = os.pullEvent("alarm")
until id == alarm_id
print("Alarm with ID " .. id .. " was fired")
```

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

### Item with Map Color Example

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

Shows a stack of Stripped Acacia Logs with its associated map color value.

```lua
{
    name = "minecraft:stripped_acacia_log",
    count = 32,
    mapColour = 14188339,
    mapColor = 14188339,
}
```

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

### Advanced Input with History and Completion

Source: https://tweaked.cc/module/_G.html

An example demonstrating advanced input handling with command history and custom completion logic. Requires the 'cc.completion' module.

```lua
local completion = require "cc.completion"
local history = { "potato", "orange", "apple" }
local choices = { "apple", "orange", "banana", "strawberry" }
write("> ")
local msg = read(nil, history, function(text) return completion.choice(text, choices) end, "app")
print(msg)
```

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

### Make HTTP GET Request

Source: https://tweaked.cc/module/http.html

Use this to make a simple HTTP GET request to a URL and read the entire response body. Ensure the response is closed after reading.

```lua
local request = http.get("https://example.tweaked.cc")
print(request.readAll())
-- => HTTP is working!
request.close()
```

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

### List Available Help Topics

Source: https://tweaked.cc/module/help.html

Retrieves a table containing all topics that can be looked up or displayed, sorted alphabetically.

```lua
help.topics()
```

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

### setting

Source: https://tweaked.cc/library/cc.shell.completion.html

Wraps `cc.completion.setting` as a `build` compatible function.

```APIDOC
## setting
    
### Description
Wraps `cc.completion.setting` as a `build` compatible function.
```

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

### Refuel turtle example

Source: https://tweaked.cc/module/turtle.html

Demonstrates how to refuel a turtle and check the new fuel level. Also shows how to check if the current item is a valid fuel source.

```lua
local level = turtle.getFuelLevel()
if level == "unlimited" then error("Turtle does not need fuel", 0) end

local ok, err = turtle.refuel()
if ok then
 local new_level = turtle.getFuelLevel()
 print(("Refuelled %d, current level is %d"):format(new_level - level, new_level))
else
 printError(err)
end
```

```lua
local is_fuel, reason = turtle.refuel(0)
if not is_fuel then printError(reason) end
```

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

### run

Source: https://tweaked.cc/module/os.html

Run the program at the given path with the specified environment and arguments.

```APIDOC
## run(env, path, ...)

### Description
Run the program at the given path with the specified environment and arguments.

### Parameters
  1. env `table` - Required - The environment to run the program in.
  2. path `string` - Required - The path of the program to run.
  3. ... `any` - Optional - Arguments to pass to the program.
```

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

### commands.getBlockInfos

Source: https://tweaked.cc/module/commands.html

Get information about a range of blocks.

```APIDOC
## commands.getBlockInfos

### Description
Get information about a range of blocks.

### Parameters
#### Path Parameters
* **minX** (number) - Required - The minimum X coordinate of the range.
* **minY** (number) - Required - The minimum Y coordinate of the range.
* **minZ** (number) - Required - The minimum Z coordinate of the range.
* **maxX** (number) - Required - The maximum X coordinate of the range.
* **maxY** (number) - Required - The maximum Y coordinate of the range.
* **maxZ** (number) - Required - The maximum Z coordinate of the range.
* **dimension** (string) - Optional - The dimension to check blocks in. Defaults to the current dimension.

### Returns
#### Success Response
* **blocks** (array) - An array of objects, where each object contains information about a block in the specified range.
  * **name** (string) - The name of the block.
  * **state** (object) - The state of the block.
  * **nbt** (object | nil) - The NBT data of the block, if any.
```

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

### size()

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

Get the number of slots in this inventory.

```APIDOC
## size()

### Description
Get the size of this inventory.

### Returns
* `number` The number of slots in this inventory.
```

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

### Create and Configure a Window

Source: https://tweaked.cc/module/window.html

Creates a new window with specified dimensions and sets its background and text colors. This is useful for defining distinct areas for content within the terminal.

```lua
local my_window = window.create(term.current(), 1, 1, 20, 5)
my_window.setBackgroundColour(colours.red)
my_window.setTextColour(colours.white)
my_window.clear()
my_window.write("Testing my window!")
```

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

### Build and Display a Custom Document

Source: https://tweaked.cc/library/cc.pretty.html

Construct a custom document using functions like `group`, `text`, and `space_line`, then display it using `pretty.print`.

```lua
local pretty = require "cc.pretty"
pretty.print(pretty.group(pretty.text("hello") .. pretty.space_line .. pretty.text("world")))
```

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

### cancelAlarm

Source: https://tweaked.cc/module/os.html

Cancels an alarm previously started with `setAlarm`.

```APIDOC
## cancelAlarm(token)

### Description
Cancels an alarm previously started with `setAlarm`.

### Parameters
  1. token `any` - Required - The token returned by `setAlarm`.
```

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

### Listen for Multiple Event Types

Source: https://tweaked.cc/module/os.html

This example shows how to listen for various event types, including 'mouse_click' and 'key' presses. It processes different events based on their names and extracts relevant data.

```lua
while true do
    local eventData = {os.pullEvent()}
    local event = eventData[1]

    if event == "mouse_click" then
        print("Button", eventData[2], "was clicked at", eventData[3], ",", eventData[4])
    elseif event == "key" then
        print("Key code", eventData[2], "was pressed")
    end
end
```

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

### cancelTimer

Source: https://tweaked.cc/module/os.html

Cancels a timer previously started with `startTimer`.

```APIDOC
## cancelTimer(token)

### Description
Cancels a timer previously started with `startTimer`.

### Parameters
  1. token `any` - Required - The token returned by `startTimer`.
```

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

### getItemCount

Source: https://tweaked.cc/module/turtle.html

Gets the number of items in the given slot.

```APIDOC
## getItemCount([slot])

### Description
Get the number of items in the given slot.

### Parameters
#### Path Parameters
- **slot** (number) - Optional - The slot we wish to check. Defaults to the selected slot.

### Returns
- **number** The number of items in this slot.

### Throws
- If the slot is out of range.
```

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

### Vector:length

Source: https://tweaked.cc/module/vector.html

Gets the length (magnitude) of this vector.

```APIDOC
## Vector:length

### Description
Get the length (also referred to as magnitude) of this vector.

### Returns
  * `number` - The length of this vector.
```

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

### setting(text [, add_space])

Source: https://tweaked.cc/library/cc.completion.html

Completes a setting. It returns a list of suffixes of matching settings.

```APIDOC
## setting(text [, add_space])

### Description
Complete a setting.

### Parameters
  1. text `string` - The input string to complete.
  2. add_space? `boolean` - Whether to add a space after the completed settings.

### Returns
  1. { `string`... } - A list of suffixes of matching settings.

### Usage
  * Run ᐅ```lua
local completion = require "cc.completion"
read(nil, nil, completion.setting)
```
```

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

### io.output

Source: https://tweaked.cc/module/io.html

Gets or sets the current output file.

```APIDOC
## io.output

### Description
Get or set the current output file.

### Parameters
  1. file? `Handle` | `string` The new output file, either as a file path or pre-existing handle.

### Returns
  1. `Handle` The current output file.

### Throws
  * If the provided filename cannot be opened for writing.

### Changes
  * **New in version 1.55**
```

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

### Complete Help Topic by Prefix

Source: https://tweaked.cc/module/help.html

Returns a list of topic endings that match a given prefix. Useful for autocompleting help topic input.

```lua
help.completeTopic("pre")
```

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

### commands.getEntities

Source: https://tweaked.cc/module/commands.html

Get all entities matching the given selector.

```APIDOC
## commands.getEntities

### Description
Get all entities matching the given selector.

### Parameters
#### Path Parameters
* **selector** (string) - Required - The entity selector (e.g., `@e`, `@a`, `@p`).

### Returns
#### Success Response
* **entities** (array) - An array of objects, where each object represents an entity matching the selector.
  * **name** (string) - The name of the entity type.
  * **uuid** (string) - The unique identifier of the entity.
  * **position** (object) - The position of the entity.
    * **x** (number)
    * **y** (number)
    * **z** (number)
  * **nbt** (object | nil) - The NBT data of the entity, if any.
```

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

### Block Information with Tags Example

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

Demonstrates block information including name, state, and tags. Tags are represented as a mapping where the key is the tag name and the value is true.

```lua
{
    name = "minecraft:farmland",
    state = { ... },
    tags = {
        ["minecraft:mineable/shovel"] = true,
    }
}
```

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

### peripheral

Source: https://tweaked.cc/library/cc.shell.completion.html

Wraps `cc.completion.peripheral` as a `build` compatible function.

```APIDOC
## peripheral
    
### Description
Wraps `cc.completion.peripheral` as a `build` compatible function.
```

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

### commands.getBlockPosition

Source: https://tweaked.cc/module/commands.html

Get the position of the current command computer.

```APIDOC
## commands.getBlockPosition

### Description
Get the position of the current command computer.

### Returns
#### Success Response
* **position** (object) - An object containing the x, y, and z coordinates of the command computer.
  * **x** (number)
  * **y** (number)
  * **z** (number)
```

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

### help.topics()

Source: https://tweaked.cc/module/help.html

Retrieves a list of all available topics that can be looked up or displayed. The list is returned in alphabetical order.

```APIDOC
## help.topics()

### Description
Returns a list of topics that can be looked up and/or displayed.

### Returns
1. `table` A list of topics in alphabetical order.

### Usage
* Run ᐅ```
help.topics()
```
```

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

### getCount()

Source: https://tweaked.cc/module/multishell.html

Get the number of processes within this multishell.

```APIDOC
## getCount()

### Description
Get the number of processes within this multishell.

### Returns
  1. `number` The number of processes.
```

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

### getCurrent()

Source: https://tweaked.cc/module/multishell.html

Get the index of the currently running process.

```APIDOC
## getCurrent()

### Description
Get the index of the currently running process.

### Returns
  1. `number` The currently running process.
```

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

### commands.list

Source: https://tweaked.cc/module/commands.html

List all available commands which the computer has permission to execute.

```APIDOC
## commands.list

### Description
List all available commands which the computer has permission to execute.

### Returns
#### Success Response
* **commands** (string[]) - A list of available command names.
```

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

### help.path()

Source: https://tweaked.cc/module/help.html

Retrieves the current colon-separated list of directories where help files are searched for. All returned directories are absolute.

```APIDOC
## help.path()

### Description
Returns a colon-separated list of directories where help files are searched for. All directories are absolute.

### Returns
1. `string` The current help search path, separated by colons.

### See also
* **`help.setPath`**
```

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

### commands.list

Source: https://tweaked.cc/module/commands.html

Lists all available commands that the computer has permission to execute.

```APIDOC
## list

### Description
List all available commands which the computer has permission to execute.

### Parameters
* **subCommand** (string) - The sub-command to complete.

### Returns
* { `string`... } A list of all available commands
```

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

### getBundledInput

Source: https://tweaked.cc/module/redstone.html

Get the bundled cable input for a specific side.

```APIDOC
## getBundledInput

### Description
Get the bundled cable input for a specific side.

### Parameters
1. side `string` The side to get.

### Returns
1. `table` A table where keys are colors and values are booleans indicating if the signal is on or off.
```

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

### getBundledOutput

Source: https://tweaked.cc/module/redstone.html

Get the bundled cable output for a specific side.

```APIDOC
## getBundledOutput

### Description
Get the bundled cable output for a specific side.

### Parameters
1. side `string` The side to get.

### Returns
1. `table` A table where keys are colors and values are booleans indicating if the signal is on or off.
```

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

### getInput

Source: https://tweaked.cc/module/redstone.html

Get the current redstone input of a specific side.

```APIDOC
## getInput

### Description
Get the current redstone input of a specific side.

### Parameters
1. side `string` The side to get.

### Returns
1. `boolean` Whether the redstone input is on or off.
```

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

### Using `run` with `parallel` (default behavior)

Source: https://tweaked.cc/reference/exceptions.html

This example shows the default behavior when using the `run` function with `parallel`. Exceptions are not thrown, preserving compatibility with older user code that might inspect errors.

```lua
local run = require "run"
run(function()
  parallel.waitForAny(function()
    error("ohno")
  end)
end)
```

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

### getOutput

Source: https://tweaked.cc/module/redstone.html

Get the current redstone output of a specific side.

```APIDOC
## getOutput

### Description
Get the current redstone output of a specific side.

### Parameters
1. side `string` The side to get.

### Returns
1. `boolean` Whether the redstone output is on or off.

### See also
* **`setOutput`**
```

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

### equipBack()

Source: https://tweaked.cc/module/pocket.html

Searches the player's inventory for an upgrade and replaces the existing one if found. The search starts from the player's currently selected slot.

```APIDOC
## equipBack()

### Description
Search the player's inventory for another upgrade, replacing the existing one with that item if found. This inventory search starts from the player's currently selected slot, allowing you to prioritise upgrades.

### Returns
1. `boolean` If an item was equipped.
2. `string` | nil The reason an item was not equipped.
```

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

### command

Source: https://tweaked.cc/library/cc.shell.completion.html

Wraps `cc.completion.command` as a `build` compatible function.

```APIDOC
## command
    
### Description
Wraps `cc.completion.command` as a `build` compatible function.
```

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

### commands.getDimension

Source: https://tweaked.cc/module/commands.html

Get the name of the dimension the current command computer is in.

```APIDOC
## commands.getDimension

### Description
Get the name of the dimension the current command computer is in, such as `minecraft:overworld`.

### Returns
#### Success Response
* **dimension** (string) - The name of the current dimension.
```

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

### fs.makeDir(path)

Source: https://tweaked.cc/module/fs.html

Creates a directory, and any missing parents, at the specified path.

```APIDOC
## fs.makeDir(path)

### Description
Creates a directory, and any missing parents, at the specified path.

### Parameters
#### Path Parameters
* **path** (string) - Required - The path to the directory to create.

### Throws
* If the directory couldn't be created.
```

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

### os.cancelAlarm

Source: https://tweaked.cc/module/os.html

Cancels an alarm previously started with setAlarm, preventing it from firing.

```APIDOC
## os.cancelAlarm

### Description
Cancels an alarm previously started with setAlarm. This will stop the alarm from firing.

### Parameters
1. token `number` - The ID of the alarm to cancel.

### See also
* **`setAlarm`** - To set an alarm.

### Changes
* **New in version 1.6**
```

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

### Create a Lua Library File

Source: https://tweaked.cc/guide/using_require.html

Defines two functions, 'reset' and 'write_center', and returns them in a table. This table is what 'require' will return when this file is imported.

```lua
local function reset()
  term.clear()
  term.setCursorPos(1, 1)
end

local function write_center(text)
  local x, y = term.getCursorPos()
  local width, height = term.getSize()
  term.setCursorPos(math.floor((width - #text) / 2) + 1, y)
  term.write(text)
end

return { reset = reset, write_center = write_center }
```

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

### os.cancelTimer

Source: https://tweaked.cc/module/os.html

Cancels a timer previously started with startTimer, preventing it from firing.

```APIDOC
## os.cancelTimer

### Description
Cancels a timer previously started with `startTimer`. This will stop the timer from firing.

### Parameters
1. token `number` - The ID of the timer to cancel.

### See also
* **`startTimer`** - To start a timer.

### Changes
* **New in version 1.6**
```

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

### playAudio

Source: https://tweaked.cc/module/disk.html

Starts playing the music record in the specified disk drive.

```APIDOC
## playAudio(name)

### Description
Starts playing the music record in the drive. If any record is already playing on any disk drive, it stops before the target drive starts playing. The record stops when it reaches the end of the track, when it is removed from the drive, when `disk.stopAudio` is called, or when another record is started.

### Parameters
  * name `string` - The name of the disk drive.

### Usage
```lua
disk.playAudio("bottom")
```
```

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

### Create a Window and Redirect Output

Source: https://tweaked.cc/module/window.html

Creates a new window and redirects the standard output to it. This is useful for isolating output or directing it to a specific area of the screen, especially for long text that needs to wrap.

```lua
local my_window = window.create(term.current(), 1, 1, 25, 5)
term.redirect(my_window)
print("Writing some long text which will wrap around and show the bounds of this window.")
```

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

### os.run

Source: https://tweaked.cc/module/os.html

Runs a program at a specified path with a given environment and arguments.

```APIDOC
## os.run(env, path, ...)

### Description
Run the program at the given path with the specified environment and arguments.
This function does not resolve program names like the shell does. This means that, for example, `os.run("edit")` will not work. As well as this, it does not provide access to the `shell` API in the environment. For this behaviour, use `shell.run` instead.
If the program cannot be found, or failed to run, it will print the error and return `false`. If you want to handle this more gracefully, use an alternative such as `loadfile`.

### Parameters
1. env `table` The environment to run the program with.
2. path `string` The exact path of the program to run.
3. ... The arguments to pass to the program.

### Returns
1. `boolean` Whether or not the program ran successfully.
```

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

### getItemSpace

Source: https://tweaked.cc/module/turtle.html

Gets the remaining number of items which may be stored in this stack.

```APIDOC
## getItemSpace([slot])

### Description
Get the remaining number of items which may be stored in this stack. For instance, if a slot contains 13 blocks of dirt, it has room for another 51.

### Parameters
#### Path Parameters
- **slot** (number) - Optional - The slot we wish to check. Defaults to the selected slot.

### Returns
- **number** The space left in this slot.

### Throws
- If the slot is out of range.
```

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

### Set Help Search Path

Source: https://tweaked.cc/module/help.html

Sets the colon-separated list of directories for help file searches. Use this to specify custom locations for help documentation.

```lua
help.setPath( "/disk/help/" )
```

```lua
help.setPath( help.path() .. ":/myfolder/help/" )
```

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

### getAnalogueInput

Source: https://tweaked.cc/module/redstone.html

Get the redstone input signal strength for a specific side.

```APIDOC
## getAnalogueInput

### Description
Get the redstone input signal strength for a specific side.

### Parameters
1. side `string` The side to get.

### Returns
1. `number` The input signal strength, between 0 and 15.
```

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

### Complete settings

Source: https://tweaked.cc/library/cc.completion.html

Use `completion.setting` to complete valid setting names. This is useful for commands that modify or query computer settings.

```lua
local completion = require "cc.completion"
read(nil, nil, completion.setting)
```

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

### getAnalogInput

Source: https://tweaked.cc/module/redstone.html

Get the redstone input signal strength for a specific side.

```APIDOC
## getAnalogInput

### Description
Get the redstone input signal strength for a specific side.

### Parameters
1. side `string` The side to get.

### Returns
1. `number` The input signal strength, between 0 and 15.
```

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

### getAnalogueOutput

Source: https://tweaked.cc/module/redstone.html

Get the redstone output signal strength for a specific side.

```APIDOC
## getAnalogueOutput

### Description
Get the redstone output signal strength for a specific side.

### Parameters
1. side `string` The side to get.

### Returns
1. `number` The output signal strength, between 0 and 15.

### See also
* **`setAnalogOutput`**
```

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

### Make HTTP Request with Options

Source: https://tweaked.cc/module/http.html

Make an HTTP request with detailed options including URL, method, headers, and timeout.

```lua
http.request {
  url = "https://example.tweaked.cc/api/data",
  method = "POST",
  headers = {
    ["Content-Type"] = "application/json",
    ["Authorization"] = "Bearer YOUR_TOKEN"
  },
  body = "{\"key\": \"value\"}",
  timeout = 5
}
```

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

### Write 'Hello, world!' to an adjacent monitor

Source: https://tweaked.cc/peripheral/monitor.html

Finds an adjacent monitor and writes 'Hello, world!' to it starting at the first position. Ensure a monitor peripheral is available.

```lua
local monitor = peripheral.find("monitor")
monitor.setCursorPos(1, 1)
monitor.write("Hello, world!")
```

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

### getAnalogOutput

Source: https://tweaked.cc/module/redstone.html

Get the redstone output signal strength for a specific side.

```APIDOC
## getAnalogOutput

### Description
Get the redstone output signal strength for a specific side.

### Parameters
1. side `string` The side to get.

### Returns
1. `number` The output signal strength, between 0 and 15.

### See also
* **`setAnalogOutput`**
```

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

### Connect to Websocket and Print Handshake Headers

Source: https://tweaked.cc/module/http.html

Establishes a websocket connection and prints the headers received during the handshake. The connection is closed afterward.

```lua
local ws = http.websocket("wss://example.tweaked.cc/echo")
print(textutils.serialize(ws.getResponseHeaders()))
-- => {
--  Connection = "Upgrade",
--  Upgrade = "websocket",
--  ...
-- }
ws.close()
```

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

### settings.define

Source: https://tweaked.cc/module/settings.html

Define a new setting with optional properties like description, default value, and type.

```APIDOC
## settings.define

### Description
Define a new setting, optionally specifying various properties about it. While settings do not have to be added before being used, doing so allows you to provide defaults and additional metadata.

### Parameters
  1. name `string` - The name of this option
  2. options? { description? = `string`, default? = `any`, type? = `string` }
Options for this setting. This table accepts the following fields:
     * `description`: A description which may be printed when running the `set` program.
     * `default`: A default value, which is returned by `settings.get` if the setting has not been changed.
     * `type`: Require values to be of this type. Setting the value to another type will error. Must be one of: `"number"`, `"string"`, `"boolean"`, or `"table"`.

### Changes
  * **New in version 1.87.0**
```

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

### getAudioTitle

Source: https://tweaked.cc/module/disk.html

Gets the title of the audio track from a music record in the drive.

```APIDOC
## getAudioTitle(name)

### Description
Get the title of the audio track from the music record in the drive. This generally returns the same as `disk.getLabel` for records.

### Parameters
  * name `string` - The name of the disk drive.

### Returns
  * `string` | false | nil - The track title, `false` if there is not a music record in the drive or `nil` if no drive is present.
```

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

### getItemDetail(slot)

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

Get detailed information about an item in a specific slot.

```APIDOC
## getItemDetail(slot)

### Description
Get detailed information about an item.

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

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

### Throws
* If the slot is out of range.

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

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

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

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

### help.completeTopic(prefix)

Source: https://tweaked.cc/module/help.html

Provides a list of topic endings that match a given prefix, useful for auto-completing help topic input.

```APIDOC
## completeTopic(prefix)

### Description
Returns a list of topic endings that match the prefix. Can be used with `read` to allow input of a help topic.

### Parameters
1. prefix `string` The prefix to match

### Returns
1. `table` A list of matching topics.

### Changes
* **New in version 1.74**
```

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

### getFuelLimit

Source: https://tweaked.cc/module/turtle.html

Gets the maximum amount of fuel the turtle can hold. This can be a number or 'unlimited'.

```APIDOC
## getFuelLimit()

### Description
Get the maximum amount of fuel this turtle can hold.
By default, normal turtles have a limit of 20,000 and advanced turtles of 100,000.

### Returns
  1. `number` The maximum amount of fuel a turtle can hold.

#### Or
  1. "unlimited" If turtles do not consume fuel when moving.

### See also
  * **`getFuelLevel`**
  * **`refuel`**

### Changes
  * **New in version 1.6**
```

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

### list()

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

List all items in this inventory, returning basic information for each slot.

```APIDOC
## list()

### Description
List all items in this 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 an 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, and so empty slots will be `nil` - it is recommended to loop over using `pairs` rather than `ipairs`.

### Returns
* { `table` | nil... } Basic information about all items in this inventory.

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

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

### Basic Block Information Example

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

Shows the structure of basic block information, including name and state. The state table contains block-specific properties.

```lua
{
    name = "minecraft:farmland",
    state = {
        moisture = 7
    }
}
```

```lua
{
    name = "minecraft:piston",
    state = {
        facing = "up",
        extended = true
    }
}
```

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

### Get Directory Name

Source: https://tweaked.cc/module/fs.html

Extracts the directory name from a given file path.

```lua
fs.getDir("rom/startup.lua")
-- => rom
```

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

### shell.complete

Source: https://tweaked.cc/module/shell.html

Provides command-line completion suggestions for a given input string, completing program names or arguments.

```APIDOC
## shell.complete

### Description
Complete a shell command line.

### Parameters
1. sLine `string` The input to complete.

### Returns
1. { `string` } | nil The list of possible completions.

### See also
* **`_G.read`**For more information about completion.
* **`shell.completeProgram`**
* **`shell.setCompletionFunction`**
* **`shell.getCompletionInfo`**

### Changes
* **New in version 1.74**
```

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

### Get Current Process Index

Source: https://tweaked.cc/module/multishell.html

Returns the index of the process that is currently executing.

```lua
multishell.getCurrent()
```

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

### Get Redstone Input

Source: https://tweaked.cc/peripheral/redstone_relay.html

Retrieves the current redstone input state (on or off) for a specified side.

```lua
redstone.getInput("left")
```

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

### Get Redstone Output

Source: https://tweaked.cc/peripheral/redstone_relay.html

Retrieves the current redstone output state (on or off) for a specified side.

```lua
redstone.getOutput("bottom")
```

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

### Launch New Process and Set Title

Source: https://tweaked.cc/module/multishell.html

Starts a new process with a specified environment, program path, and arguments. The returned process ID can be used immediately to set the title or switch focus, but may change after yielding.

```lua
local id = multishell.launch({}, "/rom/programs/fun/hello.lua")
multishell.setTitle(id, "Hello!")
```

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

### getItemLimit(slot)

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

Get the maximum number of items that can be stored in a specific inventory slot.

```APIDOC
## getItemLimit(slot)

### Description
Get the maximum number of items which can be stored in this slot. Typically this will be limited to 64 items. However, some inventories (such as barrels or caches) can store hundreds or thousands of items in one slot.

### Parameters
* slot `number` - The slot

### Returns
* `number` - The maximum number of items in this slot.

### Throws
* If the slot is out of range.

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

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

### choice

Source: https://tweaked.cc/library/cc.shell.completion.html

Wraps `cc.completion.choice` as a `build` compatible function.

```APIDOC
## choice
    
### Description
Wraps `cc.completion.choice` as a `build` compatible function.
```

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

### settings.load

Source: https://tweaked.cc/module/settings.html

Load settings from a specified file, defaulting to ".settings".

```APIDOC
## settings.load

### Description
Load settings from the given file.

### Parameters
  1. path? `string` - The path to the settings file. Defaults to ".settings".
```

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

### write

Source: https://tweaked.cc/peripheral/printer.html

Writes text to the current page. Ensure a page has been started with `newPage()` before calling this function.

```APIDOC
## write(text)

### Description
Writes text to the current page.

### Parameters
- **text** (string) - The value to write to the page.

### Throws
- If any values couldn't be converted to a string, or if no page is started.
```

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

### Get currently selected inventory slot

Source: https://tweaked.cc/module/turtle.html

Returns the index of the currently selected inventory slot.

```lua
turtle.getSelectedSlot()
```

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

### Lookup computers by protocol

Source: https://tweaked.cc/module/rednet.html

Searches the network for computers hosting a specific protocol. Returns a list of responding computer IDs.

```lua
rednet.lookup(protocol, hostname, timeout)
```

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

### Get Text Color

Source: https://tweaked.cc/peripheral/monitor.html

Returns the current text color. This function is available from version 1.74.

```lua
term.getTextColour()
```

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

### Construct and use custom require

Source: https://tweaked.cc/library/cc.require.html

Builds a custom `require` and `package` implementation and inserts them into a new environment. This allows for isolated module loading separate from the global environment.

```lua
local r = require "cc.require"
local env = setmetatable({}, { __index = _ENV })
env.require, env.package = r.make(env, "/")

-- Now we have our own require function, separate to the original.
local r2 = env.require "cc.require"
print(r, r2)
```

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

### getAnalogInput

Source: https://tweaked.cc/peripheral/redstone_relay.html

Gets the redstone input signal strength for a specific side. The value is between 0 and 15.

```APIDOC
## getAnalogInput(side)

### Description
Get the redstone input signal strength for a specific side.

### Parameters
  * **side** (`string`) - The side to get.

### Returns
  * `number` - The input signal strength, between 0 and 15.
```

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

### runCommand

Source: https://tweaked.cc/peripheral/command.html

Executes the command block's configured command once.

```APIDOC
## runCommand

### Description
Execute the command block once.

### Returns
* `boolean` If the command completed successfully.
* `string` | nil A failure message.
```

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

### Spawn new parallel functions within waitForAll

Source: https://tweaked.cc/module/parallel.html

Demonstrates how to use the `spawn` argument within a `parallel.waitForAll` call to initiate new parallel tasks dynamically.

```lua
parallel.waitForAll(function(spawn)
    spawn(function() sleep(1); print("Finished 1") end)
    spawn(function() sleep(2); print("Finished 2") end)
end)
```
Tokens:
Raw