> ## Documentation Index
> Fetch the complete documentation index at: https://docs.projectreal.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# disassemble

> Disassembles a Luau function and returns a formatted bytecode listing string. Argument 1 must be a function; otherwise a type error reports expected function. The closure must be valid and must not be a C closure; invalid closures raise "invalid closure" and C closures raise "cannot disassemble C closure". When an optional second argument is present, the function reads Recursive, ShowLines, ShowConstants, and StringPreviewMax from it. Boolean option fields override the matching defaults, and a numeric StringPreviewMax overrides the default string preview length. Indata structureions are decoded with the bytecode decoder before formatting. The output always has one trailing newline and the function has no registered alias.

Disassembles a Luau function and returns a formatted bytecode listing string. Argument 1 must be a function; otherwise a type error reports expected function. The closure must be valid and must not be a C closure; invalid closures raise "invalid closure" and C closures raise "cannot disassemble C closure". When an optional second argument is present, the function reads Recursive, ShowLines, ShowConstants, and StringPreviewMax from it. Boolean option fields override the matching defaults, and a numeric StringPreviewMax overrides the default string preview length. Indata structureions are decoded with the bytecode decoder before formatting. The output always has one trailing newline and the function has no registered alias.

## Syntax

```lua theme={null}
disassemble(callback: function, options?: DisassembleOptions): string
```

## Arguments

| Name       | Type                 | Required | Description                                                                                                                                                        |
| ---------- | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `callback` | `function`           | Yes      | Luau function to disassemble. C closures are rejected.                                                                                                             |
| `options`  | `DisassembleOptions` | No       | Optional table read for Recursive, ShowLines, ShowConstants, and StringPreviewMax. Missing fields or fields with the wrong type leave the default value unchanged. |

## Returns

| Name       | Type     | Description                                         |
| ---------- | -------- | --------------------------------------------------- |
| `assembly` | `string` | Formatted disassembly text with a trailing newline. |

## Types

### DisassembleOptions

Controls how Luau bytecode is rendered in the disassembly output.

| Name               | Type      | Required | Description                                                                 |
| ------------------ | --------- | -------- | --------------------------------------------------------------------------- |
| `Recursive`        | `boolean` | No       | Includes nested child prototypes in the output.                             |
| `ShowLines`        | `boolean` | No       | Shows source line numbers next to instructions when line data is available. |
| `ShowConstants`    | `boolean` | No       | Lists the constant table for each prototype.                                |
| `StringPreviewMax` | `integer` | No       | Limits the number of characters shown when previewing string constants.     |

## Example

Disassemble a callback with selected output options.

```lua theme={null}
local assembly = disassemble(function(value)
    return value * 2
end, {
    Recursive = false,
    ShowLines = true,
    ShowConstants = true,
})

print(assembly)
```