> For the complete documentation index, see [llms.txt](https://duckys-playground.gitbook.io/wave/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://duckys-playground.gitbook.io/wave/libraries/debug.md).

# Debug

### Get Constant

{% code lineNumbers="true" %}

```typescript
<variant> debug.getconstant(<function> f, <int> idx)
```

{% endcode %}

* Returns the constant at index `idx` in function `f` or level `f`.

***

### Get Constants

{% code lineNumbers="true" %}

```typescript
<table> debug.getconstants(<function> f)
```

{% endcode %}

* Returns the constants in function `f` or at level `f`.

***

### Get Info

{% code lineNumbers="true" %}

```typescript
<table> debug.getinfo(<function> f)
```

{% endcode %}

* Returns a table of information about function `f`.

#### Info:

|     Name    |   Type   |                        Description                        |
| :---------: | :------: | :-------------------------------------------------------: |
|     name    |  String  |                 The name of the function.                 |
|  short\_src |  String  |                A shorter version of source.               |
|     what    |  String  | What the function is: Lua = Lua function - C = C function |
| currentline |  Integer |             The line that is currently active.            |
|     nups    |  Integer |       The number of upvalues that the function has.       |
|     func    | Function |                The function that is active.               |
|    source   |  String  |              Where the function was defined.              |

***

### Get Proto

{% code lineNumbers="true" %}

```typescript
<table, function> debug.getproto(<function> f, <int> idx, <bool?> activated)
```

{% endcode %}

* Gets the inner `function` of `f` at `index`.

***

### Get Protos

{% code lineNumbers="true" %}

```typescript
<table> debug.getprotos(<function fn>)
```

{% endcode %}

* Retrieves all prototype functions used inside `fn`.

***

### Get Registry

{% code lineNumbers="true" %}

```typescript
<table> debug.getregistry(<void>)
```

{% endcode %}

* Returns the Lua registry.

***

### Get Stack

{% code lineNumbers="true" %}

```typescript
<table> debug.getstack(<function> f, <int> idx)
```

{% endcode %}

* Gets the method stack at level or function `f`.

***

### Get Upvalue

{% code lineNumbers="true" %}

```typescript
<variant> debug.getupvalue(union<function, number> f, <number> idx)
```

{% endcode %}

* Returns the upvalue with name `idx` in function or level `f`.

***

### Get Upvalues

{% code lineNumbers="true" %}

```typescript
<table> debug.getupvalues(<function> f)
```

{% endcode %}

* Retrieve the upvalues in function `f` or at level `f`.

***

### Set Constant

{% code lineNumbers="true" %}

```typescript
<void> debug.setconstant(<function> f, <int> idx, union<number, bool, string> value)
```

{% endcode %}

* Set constant `idx` to tuple `value` at level or function `f`.

***

### Set Metatable

{% code lineNumbers="true" %}

```typescript
<table> debug.setmetatable(<table> o, <table> mt)  
```

{% endcode %}

* Set the metatable of `o` to `mt`.

***

### Set Proto

{% code lineNumbers="true" %}

```typescript
<void> debug.setproto(<function> fi, <number> index, <function> replacement)
```

{% endcode %}

* Replaces `fi` at `index` with function `replacement` at level or function `fi`.

***

### Set Stack

{% code lineNumbers="true" %}

```typescript
<void> debug.setstack(<function> f, <int> idx, <table> value)
```

{% endcode %}

* Sets the stack indice at `indice` to `value` at level or function `f`.

***

### Set Upvalue

{% code lineNumbers="true" %}

```typescript
<void> debug.setupvalue(<function> f, <int> idx, <table> value)
```

{% endcode %}

* Set upvalue `idx` to `value` at level or function `f`.

***

### Valid Level

{% code lineNumbers="true" %}

```typescript
<bool> validlevel(<function fn>, <int level>)
```

{% endcode %}

* Checks if `fn` can run at `level`.

> Alternative: `isvalidlevel`

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://duckys-playground.gitbook.io/wave/libraries/debug.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.