# Types and Options

## Esp Types

* Boxes
* Tracers
* Names
* Skeletons
* HealthBars
* HeadDots
* LookTracers

## Misc Types

* MouseVisibility
* Highlights
* NPC
* Other

## Esp Options

{% tabs %}
{% tab title="All" %}
All **esp types** have these options.

| Name             | Type    | Default       |
| ---------------- | ------- | ------------- |
| Enabled          | Boolean | true          |
| Transparency     | Number  | 1             |
| Color            | Color3  | 255, 255, 255 |
| UseTeamColor     | Boolean | true          |
| RainbowColor     | Boolean | false         |
| Outline          | Boolean | true          |
| OutlineColor     | Color3  | 0, 0, 0       |
| OutlineThickness | Number  | 1             |
| {% endtab %}     |         |               |

{% tab title="Boxes" %}
Displays a Box around characters.

| Name         | Type   | Default |
| ------------ | ------ | ------- |
| Thickness    | Number | 1       |
| {% endtab %} |        |         |

{% tab title="Tracers" %}
Displays a line that connects to the character.

| Name      | Type   | Default |
| --------- | ------ | ------- |
| Origin    | String | Top     |
| Thickness | Number | 1       |

Origins:

* Top
* Center
* Bottom
* Mouse
  {% endtab %}

{% tab title="Names" %}
Displays the player's name above the character.\
Additional data such as distance and health will also be displayed below the character if their corresponding option is enabled.

| Name             | Type         | Default          |
| ---------------- | ------------ | ---------------- |
| Font             | Drawing.Font | Drawing.Fonts.UI |
| Size             | Number       | 18               |
| Outline          | Boolean      | true             |
| OutlineColor     | Color3       | 0, 0, 0          |
| ShowDistance     | Boolean      | false            |
| ShowHealth       | Boolean      | true             |
| UseDisplayName   | Boolean      | false            |
| DistanceDataType | String       | m                |
| HealthDataType   | String       | Percentage       |
| {% endtab %}     |              |                  |

{% tab title="Skeletons" %}
Displays a line for each body part, creating a skeleton.

| Name         | Type   | Default |
| ------------ | ------ | ------- |
| Thickness    | Number | 1       |
| {% endtab %} |        |         |

{% tab title="HealthBars" %}
Displays a health bar below the character.

| Name           | Type    | Default |
| -------------- | ------- | ------- |
| Origin         | String  | None    |
| OutlineBarOnly | Boolean | true    |

Origins:

* None
* Left
* Right
  {% endtab %}

{% tab title="HeadDots" %}
Displays a circle on the character's head.

| Name         | Type    | Default |
| ------------ | ------- | ------- |
| Thickness    | Number  | 1       |
| Filled       | Boolean | false   |
| Scale        | Number  | 1       |
| {% endtab %} |         |         |

{% tab title="LookTracers" %}
Displays a line that originates from the character's head and extends forwards by a certain distance, indicating the direction the head is facing.

| Name          | Type    | Default |
| ------------- | ------- | ------- |
| Thickness     | Number  | 1       |
| Filled        | Boolean | false   |
| Scale         | Number  | 1       |
| {% endtab %}  |         |         |
| {% endtabs %} |         |         |

## Misc Options

{% tabs %}
{% tab title="MouseVisibility" %}
When enabled, selected esp objects that are within the radius will have their transparency modified to reduce mouse obstruction.

| Name         | Type    | Default                                                                                                                                                                                                     |
| ------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enabled      | Boolean | true                                                                                                                                                                                                        |
| Radius       | Number  | 60                                                                                                                                                                                                          |
| Transparency | Number  | 0.3                                                                                                                                                                                                         |
| Selected     | Table   | <p>{</p><p>    Boxes = true,</p><p>    Tracers = true,</p><p>    Names = true,</p><p>    Skeletons = true,</p><p>    HealthBars = true,</p><p>    HeadDots = true,</p><p>    LookTracers = true</p><p>}</p> |
| {% endtab %} |         |                                                                                                                                                                                                             |

{% tab title="Highlights" %}
Players specified within the table will be highlighted by modifying their esp color and transparency to the corresponding color and transparency.

| Name         | Type    | Default     |
| ------------ | ------- | ----------- |
| Enabled      | Boolean | false       |
| Players      | Table   | `{}`        |
| Transparency | Number  | 1           |
| Color        | Color3  | 255, 150, 0 |
| AlwaysOnTop  | Boolean | true        |
| {% endtab %} |         |             |

{% tab title="NPC" %}
NPC objects, or esp that has been added to a Model via `esp:Add()`, will use the following options if they have been overridden. Otherwise, it will use the corresponding type's options.

| Name         | Type    | Default                                                                                                                                                                                                     |
| ------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Color        | Color3  | 150, 150, 150                                                                                                                                                                                               |
| Transparency | Number  | 1                                                                                                                                                                                                           |
| RainbowColor | Boolean | false                                                                                                                                                                                                       |
| Overrides    | Table   | <p>{</p><p>    Boxes = true,</p><p>    Tracers = true,</p><p>    Names = true,</p><p>    Skeletons = true,</p><p>    HealthBars = true,</p><p>    HeadDots = true,</p><p>    LookTracers = true</p><p>}</p> |
| {% endtab %} |         |                                                                                                                                                                                                             |

{% tab title="Other" %}

| Name            | Type                         | Default  |
| --------------- | ---------------------------- | -------- |
| TeamCheck       | Boolean                      | false    |
| ToggleKey       | String or EnumItem (KeyCode) | RightAlt |
| RefreshRate     | Number                       | 10       |
| MaximumDistance | Number                       | 500      |
| FaceCamera      | Boolean                      | false    |
| AlignPoints     | Boolean                      | false    |
| {% endtab %}    |                              |          |
| {% endtabs %}   |                              |          |
