> For the complete documentation index, see [llms.txt](https://atiysus-organization.gitbook.io/aty-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://atiysus-organization.gitbook.io/aty-scripts/ui-kit/usage/text-ui.md).

# Text UI

## Text UI Usage Guide

### **Triggering a Text UI**

To trigger a text ui, use the following function:

```lua
aty.openTextUi("E", "Vending", "Press to open the vending machine.", "green")
```

***

## **Text UI Parameters**

### **Key**

* `"E"`\
  The key of the text ui.\
  **Type**: `string`

### **Title**

* `"Vending"`\
  The title of the text ui.\
  **Type**: `string`

### **Description**

* `"Press to open the vending machine."`\
  Detailed instructions or information displayed within the text ui.\
  **Type**: `string`

### **Color**

* `"green"`\
  A color for the text ui that you think looks the best.\
  **Type**: `string`\
  **Colors**: `green`, `blue`, `black`, `red`

***

## Closing a Text UI

```lua
aty.closeTextUi()
```