> ## 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.

<div className="real-function-page">
  ```lua theme={null}
  disassemble(callback: function, options?: DisassembleOptions): string
  ```

  ## 参数

  <ParamField path={"callback"} type={"function"} required>
    Luau function to disassemble. C closures are rejected.
  </ParamField>

  <ParamField path={"options"} type={"DisassembleOptions"}>
    Optional table read for Recursive, ShowLines, ShowConstants, and StringPreviewMax. Missing fields or fields with the wrong type leave the default value unchanged.
  </ParamField>

  ## 返回值

  <ResponseField name={"assembly"} type={"string"}>
    Formatted disassembly text with a trailing newline.
  </ResponseField>

  ## 类型

  ### DisassembleOptions

  控制 Luau 字节码在反汇编输出中的呈现方式。

  | Name               | Type      | Required | 说明                  |
  | ------------------ | --------- | -------- | ------------------- |
  | `Recursive`        | `boolean` | No       | 在输出中包括嵌套子原型。        |
  | `ShowLines`        | `boolean` | No       | 当行数据可用时，在指令旁边显示源行号。 |
  | `ShowConstants`    | `boolean` | No       | 列出每个原型的常量表。         |
  | `StringPreviewMax` | `integer` | No       | 限制预览字符串常量时显示的字符数。   |

  ## 示例

  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)
  ```
</div>