Skip to main content

General Settings

Name
string
The name for the ESP setting.
Model
Instance
required
The object instance that will be used for ESP.
TextModel
Instance
Optional object instance for text display in ESP.
Visible
boolean
default:"true"
Determines if the ESP is visible.
Color
Color3
default:"Color3.new()"
The main color for the ESP elements.
MaxDistance
number
default:"5000"
Maximum distance at which the ESP will be displayed.
StudsOffset
Vector3
default:"Vector3.new()"
Offset for the ESP’s position in studs.
TextSize
number
default:"16"
Size of the text in ESP if applicable.
ESPType
string
default:"Highlight"
The type of ESP adornment. Types: Text, SphereAdornment, CylinderAdornment, Adornment, SelectionBox, Highlight.
Thickness
number
default:"0.1"
Thickness of the ESP element.
Transparency
number
default:"0.65"
Transparency of the ESP element.
These settings are only for the SelectionBox ESPType.
SurfaceColor
Color3
default:"null"
The surface color of the ESP adornment.
These settings are only for the Highlight ESPType.
FillColor
Color3
default:"Color3.new()"
The fill color of the ESP adornment.
OutlineColor
Color3
default:"Color3.new(1, 1, 1)"
The outline color of the ESP adornment.
FillTransparency
number
default:"0.65"
The transparency of the ESP’s fill.
OutlineTransparency
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.
Enabled
boolean
default:"false"
Enables or disables the tracer.
Color
Color3
default:"Color3.new()"
The color of the tracer line.
Thickness
number
default:"2"
Thickness of the tracer line.
Transparency
number
default:"0"
Transparency of the tracer line.
Transparency for tracers is opposite to Roblox.
From
string
default:"Bottom"
Starting position for the tracer line. Types: Top, Bottom, Center, Mouse.
Enabled
boolean
default:"false"
Enables or disables the arrow ESP.
Color
Color3
default:"Color3.new()"
The color of the arrow.
CenterOffset
number
default:"null"
Offset for the center position of the arrow.
OnDestroy
BindableEvent
default:"null"
Event triggered upon destruction of the ESP.
OnDestroyFunc
function
default:"null"
Function executed when the ESP is destroyed.
BeforeUpdate
function
default:"null"
Function executed before updating all of the ESP elements (after the distance check). The ESP table is passed as an argument to the function.
AfterUpdate
function
default:"null"
Function executed after updating all of the ESP elements. The ESP table is passed as an argument to the function.

General

ESP:Clear

ESPLibrary:Clear() -- Clears every ESP.

ESP:Destroy

ESPLibrary:Destroy() -- Destroys the ESP library. (You need to reload the ESP library using the loadstring after using this function)

ESP:Add

ESPLibrary:Add(< ESPSettings here >) -- Creates a new ESP element.
-- Look in the examples section for more information.

Response

All ESP Functions have a same return value.
Deleted
boolean
Indicates if the ESP element is deleted.
Destroy
function
This function deletes the ESP element.
ESPElement:Destroy()
Show
function
This function makes the ESP element visible.
ESPElement:Show()
Hide
function
This function makes the ESP element invisible.
ESPElement:Hide()
ToggleVisibility
function
Toggles the visibility of the ESP element.
ESPElement:ToggleVisibility()

Updating current ESP

To change any of the setting for the current ESP, edit the CurrentSettings table:
Not every setting can be updated.
ESPElement.CurrentSettings.< Setting Here > = < Value Here >
Example:
ESPElement.CurrentSettings.Name = "New Name"