> 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/functions/console.md).

# Console

### Clear

{% code lineNumbers="true" %}

```typescript
<void> rconsoleclear(<void>)
```

{% endcode %}

* Clears all text from the console.

***

### Close

{% code lineNumbers="true" %}

```typescript
<void> rconsoleclose(<void>)
```

{% endcode %}

* Closes the console.

> Alternative: `rconsoledestroy`

***

### Create

{% code lineNumbers="true" %}

```typescript
<void> rconsolecreate(<void>)
```

{% endcode %}

* Creates a new console window for logging and interaction.

***

### Debug

{% code lineNumbers="true" %}

```typescript
<void> rconsoledebug(<string text>)
```

{% endcode %}

* Prints a debug message to the console in a distinct debug color/style.

***

### Error

{% code lineNumbers="true" %}

```typescript
<void> rconsoleerr(<string> text)
```

{% endcode %}

* Prints `text` into the console, with <mark style="color:red;">`[ERROR]`</mark> written before it.

***

### Info

{% code lineNumbers="true" %}

```typescript
<void> rconsoleinfo(<string> text)
```

{% endcode %}

* Prints `text` into the console, with <mark style="color:yellow;">`[INFO]`</mark> written before it.

***

### Input

{% code lineNumbers="true" %}

```typescript
<string> rconsoleinput(<void>)
```

{% endcode %}

* Yields the current thread until the user inputs text and presses `Enter`. Returns the input they put in.

***

### Name

{% code lineNumbers="true" %}

```typescript
<void> rconsolename(<string> title)
```

{% endcode %}

* Sets the console's title to `title`.

> Alternative: `rconsolesettitle`

***

### Print

{% code lineNumbers="true" %}

```typescript
<void> rconsoleprint(<string> text)
```

{% endcode %}

* Prints `text` into the console.

***

### Print Console

{% code lineNumbers="true" %}

```typescript
<void> printconsole(<string> message, <byte> red, <byte> green, <byte> blue)
```

{% endcode %}

* Prints `message` into the internal and integrated console with RGB value.

***

#### Console Colors:

|      Name     |        Type        |
| :-----------: | :----------------: |
|     Black     |      @@BLACK@@     |
|      Blue     |      @@BLUE@@      |
|     Green     |      @@GREEN@@     |
|      Cyan     |      @@CYAN@@      |
|      Red      |       @@RED@@      |
|    Magenta    |     @@MAGENTA@@    |
|   Light Gray  |   @@LIGHT\_GRAY@@  |
|   Dark Gray   |   @@DARK\_GRAY@@   |
|   Light Blue  |   @@LIGHT\_BLUE@@  |
|  Light Green  |  @@LIGHT\_GREEN@@  |
|   Light Cyan  |   @@LIGHT\_CYAN@@  |
|   Light Red   |   @@LIGHT\_RED@@   |
| Light Magenta | @@LIGHT\_MAGENTA@@ |
|     Yellow    |     @@YELLOW@@     |
|     White     |      @@WHITE@@     |

Example:

{% code lineNumbers="true" %}

```lua
rconsolename("console") -- Sets the name of the console to 'console'
rconsoleprint("gamer\n")
rconsoleprint("@@YELLOW@@") -- Changes the text color to Yellow
rconsoleprint("gamer but yellow\n")
rconsoleerr("omg error!")
rconsolewarn("omg warning!")
wait(3)
rconsoleclear() -- Clears all text
wait(1)
rconsoleclose() -- Closes the console
```

{% endcode %}

You must use `\n` at the end of `rconsoleprint` to make a new line.

`rconsoleinfo`, `rconsolewarn`, and `rconsoleerr` do this automatically.<br>

***


---

# 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/functions/console.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.