# Player UI Prompt

The player UI prompt uses the native inventory interface and places all of the online players into it to allow players to select a player.

| PlayerUI Prompt |                                                                                                |
| --------------- | ---------------------------------------------------------------------------------------------- |
| Prompt Argument | `-p:<filter>` (space after is required)                                                        |
| Break lines     | No                                                                                             |
| Color Support   | Yes, UI colors configuration can be found in `prompt-config.yml`                               |
| Configurable    | [Yes (`prompt-config.yml`)](/commandprompter/configuration/prompts-configuration/player-ui.md) |

### Filters

Filters are used to filter out player heads from the Player UI. You also have the ability to customize the head's display by changing its format in the [configuration](/commandprompter/configuration/prompts-configuration/player-ui/filter-format.md) name depending on the filter.

**Available filters so far**:&#x20;

| Filter              | Key               | Description                                                                                       |
| ------------------- | ----------------- | ------------------------------------------------------------------------------------------------- |
| **World**           | `w`               | only show players on the same world as the prompted player.                                       |
| **Radial**          | `r<radius value>` | only show players within a specific radius of the prompted player.                                |
| Towny Town          | `tt`              | only show players with the same town of the prompted player.                                      |
| Towny Nation        | `tn`              | only show players under the same nation of the prompted player.                                   |
| Husk Towns          | `ht`              | only show players with the same town of the prompted player.                                      |
| LuckPerms Own Group | `lpo`             | only show players with the same group as the prompter player.                                     |
| LuckPerms Group     | `lpg<groupname>;` | <p>only show players with the defined group.<br><br>the filter must end with <code>;</code> !</p> |
| Self Filter         | `s`               | filter out the player that invoked the prompt.                                                    |

*additional filters will be added in the future*

{% hint style="info" %}
You can combine filters. So if you want to mix radial and world filter you can have the following filter ``wr10 or `r10w`. The format of the filter that comes first will be used.``
{% endhint %}

**Example**

The example below shows the command with a prompt and a corresponding image of its appearance

```
/mute <-p Who do you want to mute?>
```

![](https://i.imgur.com/1aPNEWf.png)

Video example:

{% embed url="<https://cdn.discordapp.com/attachments/936346802951716880/1184752613003108392/2023-12-13_23-51-00.mp4?ex=658d1dda&hm=b4bcf5e70a5ec0109536bbcf05f97f9512752b3bf79d2fcc14dd6ba131347731&is=657aa8da>" %}


---

# Agent Instructions: 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:

```
GET https://cyr1en.gitbook.io/commandprompter/prompts/player-ui-prompt.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.