General Settings
ESPSettings
ESPSettings
The name for the ESP setting.
The object instance that will be used for ESP.
Optional object instance for text display in ESP.
Determines if the ESP is visible.
The main color for the ESP instances.
Maximum distance at which the ESP will be displayed.
Offset for the ESP’s position in studs.
Size of the text in ESP if applicable.
The type of ESP adornment. Types:
Text, SphereAdornment, CylinderAdornment, Adornment, SelectionBox, Highlight.Thickness of the ESP instance.
Transparency of the ESP instance.
SelectionBox
SelectionBox
These settings are only for the
SelectionBox ESPType.The surface color of the ESP adornment.
Highlight
Highlight
These settings are only for the
Highlight ESPType.The fill color of the ESP adornment.
The outline color of the ESP adornment.
The transparency of the ESP’s fill.
The transparency of the ESP’s outline.
All
Adornment Types use already existing Color and Transparency setting, no need to add them again to the settings table.Tracer
Tracer
Enables or disables the tracer.
The color of the tracer line.
Thickness of the tracer line.
Transparency of the tracer line.
Starting position for the tracer line. Types:
Top, Bottom, Center, Mouse.Arrow
Arrow
Enables or disables the arrow ESP.
The color of the arrow.
Offset for the center position of the arrow (distance from screen center in pixels * 0.001).
Arrow only shows when the target is off-screen.
Box2D
Box2D
Enables or disables the 2D box ESP.
The color of the 2D box outline and fill.
Thickness of the 2D box outline.
Transparency of the 2D box outline (0 = opaque, 1 = invisible).
If
true, fills the 2D box with a semi-transparent background.Box2D creates a rectangular bounding box around the target on your screen.
Box3D
Box3D
Enables or disables the 3D box ESP.
The color of the 3D box lines.
Thickness of the 3D box lines.
Transparency of the 3D box lines (0 = opaque, 1 = invisible).
Box3D creates a 3D wireframe box showing all 8 corners of the target’s bounding box.
Skeleton
Skeleton
Enables or disables the skeleton ESP.
The color of the skeleton lines.
Thickness of the skeleton lines.
Transparency of the skeleton lines (0 = opaque, 1 = invisible).
Skeleton ESP automatically detects R6 and R15 rig types and draws lines connecting character joints.
Event triggered upon destruction of the ESP.
Function executed when the ESP is destroyed.
Function executed before updating all of the ESP instances (after the distance check).
The
ESP table is passed as an argument to the function.Function executed after updating all of the ESP instances.
The
ESP table is passed as an argument to the function.Library Functions
ESPLibrary:Clear
Removes all active ESP instances from the library.ESPLibrary:Destroy
Completely destroys the ESP library and cleans up all resources. After calling this, you must reload the library using the loadstring.Creating ESP Instance
Creates a new ESP instance with the specified settings. Returns an ESP object that you can use to control the ESP.See the Examples page for more detailed usage examples.
ESP Instance Functions
When you create an ESP instance, it returns an object with several functions and properties:Deleted
Deleted
Indicates if the ESP instance is deleted.
Destroy
Destroy
This function deletes the ESP instance.
Show
Show
This function makes the ESP instance visible.
Hide
Hide
This function makes the ESP instance invisible.
ToggleVisibility
ToggleVisibility
Toggles the visibility of the ESP instance.
SetEveryColor
SetEveryColor
Sets the color for all ESP elements at once (Main Color, Fill, Outline, etc).
Example:
| Parameter | Type | Description |
|---|---|---|
Color | Color3 | The new color to apply. |
IncludeComponents | boolean? | If true, also updates colors for components like Tracers, Boxes, etc. |
Updating ESP instance
You can modify ESP settings after creation by editing theCurrentSettings table:
Not every setting can be updated dynamically. Settings like
Model and ESPType cannot be changed after creation.