ESP

Elements you define show up in the ESP builder, where the user places and toggles them. Your evaluate supplies the value for each entity.

import esp from "@native/esp";

evaluate runs once per entity every tick, but only while the user has the element switched on. You don’t draw anything yourself: return a value and the builder draws it.

Overview

Kinds

esp.enemy, esp.team, esp.dropped, context.

Elements

text, bar, icon, group.

Return values

Text and bar shapes.

Handles and helpers

enabled, preview, dispose, esp.health, esp.money.

Kinds

Each kind is a property of esp and decides which entities its elements see.

Kind	Evaluates
`esp.enemy`	Enemy `C_CSPlayerPawn`s, dead ones included. Never the local player.
`esp.team`	Teammates, same rules. `mp_teammates_are_enemies` moves everyone to `enemy`.
`esp.dropped`	Weapons, grenades and C4 lying in the world. Held weapons are drawn with their player.

They’re named exports too: import { enemy } from "@native/esp";.

context

kind.context: ((entity) => Ctx) | null

Runs once per entity per tick, before the elements. Whatever it returns is the ctx every evaluate of the kind gets, so shared reads happen once. A throw hides all of the kind’s elements on that entity for the tick. Set it to null to remove it.

esp.enemy.context = (pawn) => ({ hp: pawn.m_iHealth, name: pawn.controller?.m_iszPlayerName ?? "" });

esp.enemy.text("name", (pawn, ctx) => ctx.name || null);

Elements

kind.text(name, options?, evaluate)
kind.bar(name, options?, evaluate)
kind.icon(name, options?, evaluate)

name is the element’s identity within the kind and type. Define the same one again and the new element takes over: same builder slot, same user layout, and the old handle goes dead.

Option
`label`	Label in the builder. Default `name`.
`area`	Starting spot: `"top"`, `"bottom"`, `"left"`, `"right"` or `"center"`. The user can drag it elsewhere.
`preview`	What the builder preview shows. Same shape as the `evaluate` result.
`enabled`	Your own switch, default `true`. `false` hides it everywhere and skips `evaluate`.

label, preview and enabled also take a function, a signal or a ui control, and follow it. Hand enabled a switch from your settings page and you’re done:

const showHp = ui.page("ESP").group("Flags").switch("HP", { default: true });

esp.enemy.text("hp", { area: "top", preview: "100", enabled: showHp },
    (pawn) => ({ text: pawn.m_iHealth, color: esp.health(pawn.m_iHealth) }));

A throw inside evaluate, or a value of the wrong shape, hides the element on that entity for the tick and lands in the global error event. Once, not 128 times a second: you hear about it again only after it ran a clean tick.

text

A line of text. Return a string or number, a style object, or null to hide it.

esp.enemy.text("hp", { area: "top", preview: "100" },
    (pawn) => ({ text: pawn.m_iHealth, color: pawn.m_iHealth < 30 ? "#f44" : "#fff" }));

bar

A bar. Return the fill as 0..1, a style object, or null to hide it.

esp.enemy.bar("armor", { area: "left", preview: 1 },
    (pawn) => ({ value: pawn.m_ArmorValue, max: 100, color: "#48f" }));

icon

Works like text, but always drawn with the "weapon-icons" font: the text is the glyph. esp.weaponIcon finds it for you.

esp.dropped.icon("weapon", { area: "top", preview: "W" }, (weapon) => esp.weaponIcon(weapon));

group

kind.group({ key: esp.text(options?) | esp.bar(options?) | esp.icon(options?) }, evaluate): EspGroup

Several elements fed by one evaluate per entity. Return an object with a value per key; a missing key hides that element, null hides them all. Each key is a normal element with its own handle.

esp.enemy.group({
    weapon: esp.icon({ area: "bottom", preview: "W" }),
    money: esp.text({ area: "bottom", preview: "$4,750" }),
}, (pawn) => ({
    weapon: esp.weaponIcon(pawn),
    money: esp.money(pawn.controller?.m_pInGameMoneyServices?.m_iAccount ?? 0),
}));

Return values

Returned keys override the user’s builder settings for that entity and tick. Keys you leave out keep what the user set.

Return	`text` / `icon`	`bar`
`null`, `undefined`, `false`	hidden	hidden
string	the text	not allowed
number	the text, as `String()` prints it	fill, `0..1`
object	text style	bar style

Text style

For text and icon.

Key
`text`	String or number.
`color`, `colorAlt`	`ColorLike`. `colorAlt` switches to a gradient.
`colorMode`	`"solid"` or `"gradient"`.
`size`	Font size in pixels.
`font`	Text only: `"segoe"`, `"tahoma"`, `"verdana"`, `"arial"` or `"weapon-icons"`.
`outline`	`boolean`.
`visible`	`false` hides the element and ignores the other keys.

Bar style

Key
`value`, `max`	The bar shows `value / max`, clamped to `0..1`. `max` defaults to `1`.
`text`	String or number the bar carries.
`color`, `colorAlt`	`ColorLike`. `colorAlt` switches to a gradient.
`colorMode`	`"solid"`, `"gradient"`, or `"value"` (blends `color` when empty to `colorAlt` when full).
`thickness`, `rounding`	Pixels.
`divisions`	Number of segments, `0` for one solid bar.
`reverse`, `outline`	`boolean`.
`outlineThickness`	Pixels, `0..16`.
`visible`	`false` hides the element and ignores the other keys.

Element handles

text, bar and icon return an EspElement.

Member
`alive`	`false` after `dispose()`, a replacement or unload.
`name`, `type`, `kind`	`type` is `"text"`, `"bar"` or `"icon"`.
`label`	Read or rename. A plain value ends a reactive one.
`enabled`	Your switch. Takes a value, a function or a signal.
`enabledByUser`	Whether the user has it switched on in the builder.
`preview`	Read or replace. `undefined` removes it.
`dispose()`	Removes it from the builder. Also `using`.

On a dead handle reads return null and writes throw ESTALE. A group’s handle has alive, elements (by key) and dispose(). kind.elements lists a kind’s live elements, kind.clear() and esp.clear() remove them, and unload removes everything anyway.

const armor = esp.enemy.bar("armor", (pawn) => pawn.m_ArmorValue / 100);

on("keydown", (e) => {
    if (e.code === "F7") armor.enabled = !armor.enabled;
});

Helpers

Helper
`esp.health(hp, max = 100)`	A `Color`: green when full, yellow at half, red when empty.
`esp.money(amount)`	`"$4,750"`.
`esp.distance(entity, digits = 0)`	Distance from the local player: `"12m"`. `""` when it’s unknown.
`esp.weaponIcon(value)`	The weapon-icon glyph of a definition index, a weapon or a pawn’s active weapon. `""` if none.

Example

Name, health, weapon and money for enemies, ammo on dropped weapons.

import esp from "@native/esp";

esp.enemy.context = (pawn) => ({ hp: pawn.m_iHealth });

esp.enemy.text("name", { area: "top", preview: "Player" },
    (pawn) => pawn.controller?.m_iszPlayerName || null);

esp.enemy.bar("health", { area: "left", preview: 1 },
    (pawn, ctx) => ctx.hp > 0 && { value: ctx.hp, max: 100, color: esp.health(ctx.hp) });

esp.enemy.group({
    weapon: esp.icon({ area: "bottom", preview: "W" }),
    distance: esp.text({ area: "bottom", preview: "12m" }),
}, (pawn) => ({ weapon: esp.weaponIcon(pawn), distance: esp.distance(pawn) }));

esp.dropped.text("ammo", { area: "bottom", preview: "30" },
    (weapon) => (weapon.m_iClip1 > 0 ? weapon.m_iClip1 : null));

Overview

Modules

Types

Overview

Kinds

Elements

Return values

Handles and helpers

Kinds

context

Elements

text

bar

icon

group

Return values

Text style

Bar style

Element handles

Helpers

Example