> For the complete documentation index, see [llms.txt](https://jumpathy.gitbook.io/betterchat-v3/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jumpathy.gitbook.io/betterchat-v3/server/player-attributes.md).

# Player attributes

Each player is assigned attributes that do something related to the chat by default.

![](/files/EdREu7NPVkfPeAXv6Cgt)

### DisplayName \<string>

The 'DisplayName' attribute can be changed to update the player's nickname in the chat. It defaults to the regular player's display name if display names are enabled by the configuration.

![](/files/1CtglmW1NJDIXHoD22p0)

```lua
player:SetAttribute("DisplayName","Troll")
```

### ChatColor \<color3>

This attribute changes the player's chat color, default is white.

```lua
player:SetAttribue("ChatColor",Color3.fromRGB(255,0,0)) --> Red chat color!
```

### DisplayNameColor \<color3>

The player's display name color is defined by this attribute.

{% hint style="info" %}
To prevent the DisplayNameColor from changing when you set another DisplayName, change the '***ChangeDisplayNameColorWhenAttributeChanged***' setting in the configuration module.
{% endhint %}

```lua
player:SetAttribute("DisplayNameColor",Color3.fromRGB(255,0,0)) --> Red display name >:)
```

### NameColor \<color3>

The player's actual name color is defined by this attribute.

![](/files/OnVQ8TMFHykRoLzyAvFU)![](/files/hyodshDpGVGJn8U7AAea)

```lua
player:SetAttribute("NameColor",Color3.fromRGB(0,255,0)) --> green!
```

### Muted \<boolean>

The player's muted status in chat can be determined by this attribute.

```lua
player:SetAttribute("Muted",true)
```

### UseTeamColor \<boolean>

Use team color over custom name color?

```lua
player:SetAttribute("UseTeamColor",false)
```


---

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

```
GET https://jumpathy.gitbook.io/betterchat-v3/server/player-attributes.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.