General Settings
ESPSettings
ESPSettings
string
required
The name for the ESP setting.
Instance
required
The object instance that will be used for ESP.
Instance
Optional object instance for text display in ESP.
boolean
default:"true"
Determines if the ESP is visible.
Color3
default:"Color3.new()"
The main color for the ESP instances.
number
default:"5000"
Maximum distance at which the ESP will be displayed.
Vector3
default:"Vector3.new()"
Offset for the ESP’s position in studs.
number
default:"16"
Size of the text in ESP if applicable.
string
required
The type of ESP adornment. Types:
Text, SphereAdornment, CylinderAdornment, Adornment, SelectionBox, Highlight.number
default:"0.1"
Thickness of the ESP instance.
number
default:"0.65"
Transparency of the ESP instance.
SelectionBox
SelectionBox
These settings are only for the
SelectionBox ESPType.Color3
default:"null"
The surface color of the ESP adornment.
Highlight
Highlight
These settings are only for the
Highlight ESPType.Color3
default:"Color3.new()"
The fill color of the ESP adornment.
Color3
default:"Color3.new(1, 1, 1)"
The outline color of the ESP adornment.
number
default:"0.65"
The transparency of the ESP’s fill.
number
default:"0"
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
boolean
default:"false"
Enables or disables the tracer.
Color3
default:"Color3.new()"
The color of the tracer line.
number
default:"2"
Thickness of the tracer line.
number
default:"0"
Transparency of the tracer line.
string
default:"Bottom"
Starting position for the tracer line. Types:
Top, Bottom, Center, Mouse.Arrow
Arrow
Box2D
Box2D
boolean
default:"false"
Enables or disables the 2D box ESP.
Color3
default:"Color3.new()"
The color of the 2D box outline and fill.
number
default:"1"
Thickness of the 2D box outline.
number
default:"0"
Transparency of the 2D box outline (0 = opaque, 1 = invisible).
boolean
default:"false"
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
boolean
default:"false"
Enables or disables the 3D box ESP.
Color3
default:"Color3.new()"
The color of the 3D box lines.
number
default:"1"
Thickness of the 3D box lines.
number
default:"0"
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
boolean
default:"false"
Enables or disables the skeleton ESP.
Color3
default:"Color3.new()"
The color of the skeleton lines.
number
default:"1"
Thickness of the skeleton lines.
number
default:"0"
Transparency of the skeleton lines (0 = opaque, 1 = invisible).
Skeleton ESP automatically detects R6 and R15 rig types and draws lines connecting character joints.
BindableEvent
default:"null"
Event triggered upon destruction of the ESP.
function
default:"null"
Function executed when the ESP is destroyed.
function
default:"null"
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
default:"null"
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
boolean
Indicates if the ESP instance is deleted.
Destroy
Destroy
function
This function deletes the ESP instance.
Show
Show
function
This function makes the ESP instance visible.
Hide
Hide
function
This function makes the ESP instance invisible.
ToggleVisibility
ToggleVisibility
function
Toggles the visibility of the ESP instance.
SetEveryColor
SetEveryColor
function
Sets the color for all ESP elements at once (Main Color, Fill, Outline, etc).
Example:
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.