TF2 host API

Full Markdown reference
tf2.info()Retail + Classified
-- -> {api_version, game_id, game, map, preview, sequence, generation,
--     engine_time, tick_interval}
local info=tf2.info()
print(info.game,info.map,info.api_version)
tf2.capabilities()Retail + Classified
-- -> {snapshots, projection, settings, shared_ui, four_teams,
--     civilian, mvm, viewmodel_offsets, native_hooks, entity_filters,
--     active_weapon, condition_list, feature_info, tick_math, capture_features}
local caps=tf2.capabilities()
if caps.civilian then print(tf2.class_name(10)) end
tf2.session()Retail + Classified
-- -> {allowed, data_available, in_game, preview, stopped, menu_open, entity_count}
local state=tf2.session()
if state.data_available then print(state.entity_count) end
tf2.local_player()Retail + Classified
-- -> {handle, team, class_id, class_name, health, alive, on_ground, flags,
--     position, eye_position, velocity, view_angles, speed, sequence, generation} or nil
local me=tf2.local_player()
if me then print(me.class_name,me.health,me.speed) end
tf2.active_weapon()Retail + Classified
-- -> {handle, item_id, sequence, generation} or nil
-- Local active weapon from the same snapshot as local_player().
-- nil without a resolved item ID/handle, or without available game data.
local weapon=tf2.active_weapon()
if weapon then print(weapon.handle,weapon.item_id) end
-- No ammo, attributes, weapon ownership or inventory changes are implied.
tf2.players([filter])Retail + Classified
-- Same filters and copied fields as entities(), restricted to player kind.
-- Local player remains available separately through local_player().
for _,p in ipairs(tf2.players{team=2,class_id=3,limit=8}) do
    print(p.class_name,p.name,p.model)
end
-- Capture order is preserved; limit does not sort by distance.
tf2.entities([filter])Retail + Classified
-- Optional filter fields: kind, relationship, max_distance (metres),
-- team (integer), class_id (integer), type (exact host type), limit (0..8192).
for _,entity in ipairs(tf2.entities{kind='player',relationship='enemy',max_distance=150}) do
    print(entity.handle,entity.name,entity.distance_m)
end
tf2.entity(handle)Retail + Classified
-- Decimal string, opaque ID, or unsigned 32-bit full numeric handle -> entity or nil
local list=tf2.entities()
if list[1] then print(tf2.entity(list[1].handle).name) end
tf2.bones(handle)Retail + Classified
-- -> array of {from={x,y,z}, to={x,y,z}}
local entities=tf2.entities{kind='player'}
if entities[1] then print(#tf2.bones(entities[1].handle)) end
tf2.condition(handle, index)Retail + Classified
-- index 0..159 -> boolean; false for unavailable/non-player data
local entities=tf2.entities{kind='player'}
if entities[1] then print(tf2.condition(entities[1].handle,4)) end
tf2.conditions(handle)Retail + Classified
-- -> ascending array of active numeric condition indices (0..159).
-- Empty for missing/non-player data, preview, Stop or an unavailable session.
local players=tf2.players{limit=1}
if players[1] then
    for _,index in ipairs(tf2.conditions(players[1].handle)) do print(index) end
end
-- Indices retain each edition's meaning; no cross-edition names are assumed.
tf2.camera()Retail + Classified
-- -> {position, angles, width, height} or nil
local camera=tf2.camera()
if camera then print(camera.width,camera.height) end
tf2.world_to_screen(position)Retail + Classified
-- Source {x,y,z} -> {x,y,on_screen} or nil
ui.overlay('tf2_player_labels',function()
    for _,e in ipairs(tf2.entities{kind='player'}) do
        local p=tf2.world_to_screen(e.position)
        if p and p.on_screen then render.text(p.x,p.y,e.name,{1,1,1,1}) end
    end
end)
tf2.screen_box(handle)Retail + Classified
-- -> {left,top,right,bottom,width,height,fitted} or nil
ui.overlay('tf2_box_example',function()
    for _,e in ipairs(tf2.entities{kind='player',relationship='enemy'}) do
        local b=tf2.screen_box(e.handle)
        if b then render.rect(b.left,b.top,b.width,b.height,{.2,.8,1,1}) end
    end
end)
tf2.setting(id, field [, value])Retail + Classified
-- field 'style' or 'distance' -> normalized numeric value
local old=tf2.setting('view.camera_fov','distance')
tf2.setting('view.camera_fov','distance',100)
features.set('view.camera_fov',true)
tf2.feature_info(id)Retail + Classified
-- -> copied {id,label,category,enabled,independent_activation,style,style_count,
--            distance,distance_min,distance_max,blocked,blocked_reason} or nil
-- blocked_reason is absent when unlocked; unknown IDs return nil.
local f=tf2.feature_info('view.camera_fov')
if f then print(f.distance_min,f.distance_max,f.blocked_reason) end
-- Host numeric slots use the feature's own units. Editing this table does not
-- change settings; setting()/features.set() still enforce host policy locks.
tf2.has_feature(id)Retail + Classified
-- -> boolean; useful for edition-specific controls
if tf2.has_feature('mvm.wave_panel') then features.set('mvm.wave_panel',true) end
tf2.keybind(id [, action [, mode]])Retail + Classified
-- -> key, mode, capturing, waiting
-- actions: 'capture', 'clear', 'mode'; modes: 0 Hold, 1 Toggle, 2 Always, 3 Hold off
local key,mode=tf2.keybind('aim.key')
print(key,mode)
tf2.object_preview(kind, chams [, layer])Retail + Classified
-- UI callback only. kind: "weapons", "health", "ammo", "items".
-- false uses the selected object's ESP settings; true uses chams.target.
ui.subtab("visuals", "custom.weapons", "Weapons", function()
    tf2.object_preview("weapons", false)
end)
tf2.model_preview(chams [, layer])Retail + Classified
-- UI callback only; draws the product's actual class model preview
local tab=ui.tab('model_inspector','Model inspector')
ui.subtab(tab,'model','Model',function() tf2.model_preview(false) end)
tf2.chams_preview_controls(layer, player_settings)Retail + Classified
-- UI callback only. 1 = Visible, 2 = Invisible; returns clicked selection.
layer = tf2.chams_preview_controls(layer, true)
tf2.model_preview(true, layer)
-- Object previews accept the same optional layer as their third argument.
-- Omit layer (or pass 0) for the original combined preview.
tf2.class_name(id), tf2.team_name(id)Retail + Classified
print(tf2.class_name(1),tf2.team_name(2)) -- Scout, RED
tf2.classes(), tf2.teams()Retail + Classified
-- -> independent arrays of {id,name}, ordered by numeric engine ID.
-- Classes: retail 1..9; Classified 1..10 (Civilian).
-- Teams include Unassigned/Spectator: retail 0..3; Classified 0..5.
for _,c in ipairs(tf2.classes()) do print(c.id,c.name) end
for _,t in ipairs(tf2.teams()) do print(t.id,t.name) end
tf2.angle_forward(angles)Retail + Classified
-- {x=pitch,y=yaw,z=roll} degrees -> unit Source-space {x,y,z}.
-- Roll has no effect on the forward vector.
local forward=tf2.angle_forward({x=0,y=90,z=0}) -- approximately {0,1,0}
tf2.time_to_ticks(seconds), tf2.ticks_to_time(ticks)Retail + Classified
-- Uses the current captured tick_interval. Never assumes a fixed tick rate.
-- Returns nil without live data or a valid positive interval.
-- seconds must be nonnegative; ticks must be a nonnegative integer.
-- time_to_ticks rounds to the nearest integer, with half ticks rounded up.
local ticks=tf2.time_to_ticks(.25)
if ticks then print(ticks,tf2.ticks_to_time(ticks)) end
tf2.vecRetail + Classified
local a={x=3,y=4,z=0}
local b={x=1,y=0,z=0}
local sum=tf2.vec.add(a,b)
local difference=tf2.vec.sub(a,b)
local scaled=tf2.vec.scale(a,2)
local dot=tf2.vec.dot(a,b)
local length=tf2.vec.length(a)
local distance=tf2.vec.distance(a,b)
local unit=tf2.vec.normalize(a) -- nil for near-zero length
local cross=tf2.vec.cross(a,b) -- right-handed cross product
local horizontal=tf2.vec.length2d(a) -- ignores Z
local between=tf2.vec.lerp(a,b,.5) -- interpolation amount clamps to 0..1
tf2.angle_to(eye, point), tf2.angle_fov(from, to)Retail + Classified
local angles=tf2.angle_to({x=0,y=0,z=0},{x=100,y=0,z=50})
local degrees=tf2.angle_fov({x=0,y=0,z=0},angles)
tf2.to_metres(units), tf2.to_units(metres)Retail + Classified
local metres=tf2.to_metres(100)
print(metres,tf2.to_units(metres))
Built-in feature familiesRetail + Classified
Family IDs
Aim profiles aim.*, aim.rage.*, combat.profile
Trigger profiles trigger.*, trigger.rage.*
Movement/view movement.bhop, movement.strafe, view.camera_fov, view.model_fov
Player ESP esp.*, esp.teammate.*
Item ESP esp.world.health.*, esp.world.ammo.*, esp.world.weapons.*
Chams targets chams.players, teammates, self, arms, weapon, world_weapon, buildings, items, dropped_weapons
tf2.capture.feature(options, policy)Retail + Classified
-- Loading only. Same options/ownership as features.add; returns a feature ID.
-- policy is required: "supported" or "disable".
local hud=tf2.capture.feature({id='hud',label='Custom HUD',default=true},'supported')
local effect=tf2.capture.feature({id='effect',label='Scene effect'},'disable')
-- "supported" keeps overlay-only features available. It does not hide native
-- rendering, audio or gameplay effects. Only declare work the overlay can protect.
-- "disable" turns the feature off and locks UI/writes/actions/hotkeys while enabled.
-- Unlocking does not turn it back on. Tuning and the declaration survive profiles.
-- A script can only declare its own new features; built-in locks cannot be changed.
ui.overlay('custom_hud',function()
    if features.active(hud) then render.text(20,120,'Custom HUD',{1,1,1,1}) end
end)
-- Standard controls automatically show the disabled blur and hover explanation:
local tab=ui.tab('custom_capture','Custom capture')
ui.subtab(tab,'controls','Controls',function() ui.feature(effect) end)
tf2.capture.enabled([boolean])Retail + Classified
-- No argument: read the requested switch. Boolean: set and enforce immediately.
-- Also emits the portable capture_protection_changed event on transitions.
local previous=tf2.capture.enabled()
-- tf2.capture.enabled(true)
-- Enabled is not proof that the renderer/recorder supports exclusion.
tf2.capture.status()Retail + Classified
-- -> {available,enabled,active,preview,renderer_status}
local state=tf2.capture.status()
print(state.enabled,state.active,state.renderer_status)
-- active means the last reported renderer status was "Active: protected overlay"
-- while enabled; it is always false in preview. This is not recorder verification.
-- Native render status describes the last completed renderer update.
-- Portable aliases: capture_protection.status(), .enabled(), .active().
-- The portable status uses "message" for the renderer_status string.
tf2.capture.policy(id)Retail + Classified
-- -> "supported", "disable", or "unclassified"; unknown IDs raise an error.
-- This reports TF2 declarations. Plain features.add Lua features are unclassified
-- here; their portable capture_protection declaration still applies.
print(tf2.capture.policy('chams.players.visible')) -- disable
-- To inspect the effective current lock, use features.blocked_reason(id).
events.on('capture_protection_changed', callback)Retail + Classified
local pending={}
events.on('capture_protection_changed',function()
    if capture_protection.enabled() then
        pending={} -- Also cancel your own active effects/audio/resources here.
    end
end)
events.on('shutdown',function() pending={} end)
-- Events fire on requested on/off transitions, not every frame or renderer retry.
-- Update/draw callbacks still run: gate feature work with features.active(id).
-- Portable alternative to the factory:
local id=features.add{id='scene',label='Scene effect',capture_protection='disable'}
-- capture_protection='safe' opts an overlay-only feature in; omission defaults to disable.
tf2.capture_page()Retail + Classified
ui.subtab("settings", "protection", "Capture Protection", function()
    tf2.capture_page()
end)
tf2.capture_scope([feature_id,] callback)Retail + Classified
-- UI drawing callback only; child code still runs to draw disabled controls.
-- Optional ID uses that feature's actual policy (including supported features).
tf2.capture_scope("chams.players.visible",function()
    ui.feature("chams.players.visible")
end)
-- Legacy capture_scope(callback) always locks the group while protection is on.
-- Keep effects in gated update callbacks; this is a drawing scope, not a sandbox.
settings.capture_protectionRetail + Classified
local enabled = features.get("settings.capture_protection")
features.set("settings.capture_protection", true)

-- Protected native writes return the host's disabled-feature explanation.
local ok, reason = pcall(features.set, "chams.players.visible", true)
if not ok then print(reason) end
features.set("view.thirdperson", enabled)Retail + Classified
features.set("view.thirdperson", true)
tf2.setting("view.thirdperson_distance", "distance", 150) -- 30..400
features.set("view.thirdperson_collision", true)
features.set("view.thirdperson_scoped", true) -- first person while scoped
tf2.setting("view.thirdperson_shoulder", "distance", units)Retail + Classified
tf2.setting("view.thirdperson_shoulder", "distance", 24) -- -64..64
tf2.setting("view.thirdperson_height", "distance", 12)   -- -64..64
features.set("view.thirdperson_swap", true)
features.set("vfx.no_fog", enabled)Retail + Classified
features.set("vfx.no_fog", true)
features.set("vfx.no_sky_fog", true)
features.set("vfx.remove.<effect>", enabled)Retail + Classified
-- water, invulnerability, milk, jarate, bleeding, stealth, bonk, gas, burning
features.set("vfx.remove.jarate", true)
local state = tf2.feature_info("vfx.remove.jarate")
if state.blocked then print(state.blocked_reason) end
features.set("vfx.pure_bypass", enabled)Retail + Classified
-- Applies when the engine loads its server material whitelist.
-- Enable before joining; restart if a whitelist was already loaded.
features.set("vfx.pure_bypass", true)
Free camera and movement assistsRetail + Classified
features.set("view.freecam", true)
tf2.setting("view.freecam_speed", "distance", 600) -- units per second, 50..2000
tf2.setting("view.freecam_boost", "distance", 2) -- Speed key multiplier, 1..5
features.set("movement.strafe", true)
features.set("movement.prespeed", true) -- brief acceleration before a stationary jump
features.set("movement.rev_jump", true) -- Heavy, idle minigun, fresh secondary press
local flight = tf2.feature_info("view.freecam")
-- Capture Protection disables and locks free camera, preserving its tuning.
features.set("view.freecam", false)

Shared UI API

Full Markdown reference
Getting startedShared UI
local enabled = features.add {
    id = "enabled", label = "My feature", default = false,
    category = "My Tools", description = "My custom feature", key = "F8"
}
local tab = ui.tab("tools", "My Tools")
ui.subtab(tab, "general", "General", function()
    ui.group("Options", function()
        ui.feature(enabled)
    end)
end)
LocalizationShared UI
ui.subtab("settings", "localized_stats", "Info", function()
    imgui.text(string.format(ui.tr("Speed: %.0f units/s"), 250))
end)
Lua console diagnosticsShared UI
[ERROR] [Lua error] My overlay | events.update (runtime)
My overlay.lua:12: attempt to index a nil value
stack traceback:
    My overlay.lua:12: in local 'read_player'
    My overlay.lua:20: in function <My overlay.lua:19>
This callback was disabled. Fix the error and run the script again.
Register a featureShared UI
local id = features.add {
    id = "example",                 -- required local ID, 1-80 characters
    label = "Example",              -- defaults to local ID
    category = "My Tools / General", -- defaults to "Scripts"
    description = "What this does",
    default = false,                -- initial enabled state
    key = "F8",                     -- optional key, Toggle mode
    active_list = true,             -- include effective toggles in Active Features
    capture_protection = "disable", -- "disable" (default) or "safe"
    kind = "toggle"                 -- "toggle" or "action"
}
local action = features.add {
    id = "refresh", label = "Refresh", kind = "action",
    on_trigger = function() print("Refresh requested") end
}
Read and change featuresShared UI
Function Behavior
features.get(id) Returns the saved enabled boolean (false while host/capture-blocked), or nil for an unknown ID.
features.set(id, boolean) Changes enabled state; rejects unknown IDs.
features.active(id) Returns effective hotkey state, including Hold/Hold Off.
features.trigger(id) Activates an action, including its callback and overlay flash.
features.bind(id, key, mode) Sets a key and mode. Empty key clears the key.
features.color(id, r, g, b, a) Sets RGBA color; components must be 0-1. Alpha defaults to 1.
features.blocked_reason(id) Returns the host/capture blocking reason or nil. Unknown IDs are rejected.
features.list() Returns an array of tables with id, label, category, description, kind, enabled.
ui.feature(id) Draws the standard feature row, including applicable gear/color/hotkey controls.
ui.keybind(id [, label]) Draws shared capture, Clear and activation mode for an existing feature; drawing callbacks only. Label defaults to Key.
Capture ProtectionShared UI
Function Behavior
capture_protection.status() Returns {available, enabled, active, message} from the host. enabled is requested protection; active means the protected surface is ready. A failed or paused surface can be enabled but inactive.
capture_protection.enabled() Returns the requested protection state, including when the surface fails or the application is in the background.
capture_protection.active() Returns true only when the host reports an available, enabled and active protected surface.
events.on("capture_protection_changed", callback) Runs when requested protection changes. Read the state inside the callback and restore prior native effects when enabling protection. Register during script loading.
local hud = features.add {
    id="hud", label="Protected HUD", default=true,
    capture_protection="safe"
}
local world = features.add {
    id="world", label="World effect", default=false,
    capture_protection="disable"
}
ui.tab("capture", "Capture Protection", function()
    ui.group("Features", function()
        ui.feature(hud)
        ui.feature(world)
        ui.keybind(world)
    end)
end)
events.on("capture_protection_changed", function()
    if capture_protection.enabled() then
        -- Restore any native effects previously applied by this script.
    end
end)
events.on("update", function()
    if not features.active(world) then return end
    -- Apply host-supported behavior here.
end)
Independent health overlaysShared UI
features.set("esp.health", true)
features.set("esp.health_text", true)
features.bind("esp.health_text", "F7", "toggle")
ui.tab("health_overlays", "Health", function()
    ui.feature("esp.health")
    ui.feature("esp.health_text")
end)
Inline key captureShared UI
ui.tab("aim_controls", "Aimbot", function()
    ui.group("Activation", function()
        ui.feature("host.aim")
        ui.keybind("host.aim", "Aim key")
    end)
end)
Tabs and sub-tabsShared UI
local tab = ui.tab("tools", "My Tools")
local subtab = ui.subtab(tab, "display", "Display", function()
    imgui.text("My page")
end)
ui.subtab("settings", "my_settings", "My Script", function()
    imgui.text("An extra page beside the built-in settings.")
end)
Groups and columnsShared UI
ui.columns(3, function()
    ui.group("First", function() imgui.text("First column") end)
    ui.next_column()
    ui.group("Second", function() imgui.text("Second column") end)
    ui.next_column()
    ui.group("Third", function() imgui.text("Third column") end)
end)
Independent menus and attached windowsShared UI
local window = ui.window("inspector", "My Inspector", {
    width = 360, height = 280,
    menu_only = false,
    attach = "none"
}, function()
    imgui.text("Independent menu")
    if imgui.button("Show main menu") then ui.menu_visible(true) end
end)
ImGui controlsShared UI
local amount, enabled, text = 50, false, "Hello"
ui.window("example", "Controls", {}, function()
    local changed
    changed, enabled = imgui.checkbox("Enabled", enabled)
    changed, amount = imgui.slider_float("Amount", amount, 0, 100)
    changed, text = imgui.input_text("Text", text)
end)
Function Return / behavior
imgui.text(text) Unwrapped text; treats the string as text, not a printf format.
imgui.text_colored(text, rgba) Colored text.
imgui.button(label [, width, height]) Returns true on activation; dimensions default to automatic.
ui.selectable(label, selected [, width, height]) Plain text row using the host selection highlight. Returns true on mouse activation; selection remains caller-owned. Zero dimensions use available width and text height.
imgui.checkbox(label, value) Returns changed, boolean.
imgui.slider_float(label, value, min, max[, options]) Returns changed, number. Optional {style="track"} uses a slim track and separate value.
imgui.slider_int(label, value, min, max[, options]) Returns changed, integer-valued number. Optional {style="track"} uses a slim track and separate value.
imgui.input_text(label, text) Returns changed, string; maximum 4095 bytes.
imgui.combo(label, index, items) Returns changed, selected index. Indices start at 1; 1-128 items.
imgui.color_edit(label, rgba) Returns changed, RGBA table.
imgui.same_line([spacing, local_x]) Places the next item on the same line; default style spacing.
imgui.separator() Separator line.
imgui.spacing([height]) Vertical space; default 4 physical pixels.
imgui.tooltip(text) Tooltip when the preceding item is hovered.
imgui.progress(fraction) Progress bar; fraction is clamped to 0-1.
imgui.available() Returns available content width, height.
imgui.cursor() Returns cursor x, y in screen coordinates.
imgui.set_cursor(x, y) Sets the next cursor position in window-local coordinates.
imgui.is_item_hovered() Returns whether the preceding item is hovered.
imgui.child(id, width, height, draw [, options]) Scoped scrollable child; 0 uses remaining size. Options: border, padding (retain WindowPadding without a visible border), horizontal_scroll.
imgui.disabled(boolean, draw) Scoped disabled controls.
imgui.with_style(colors, draw) Scoped color overrides, restored even after callback errors.
imgui.window(title, options, draw) Scoped independent ImGui window.
Selectable catalog rowsShared UI
local selected = 1
local catalog = {"Crowbar", "Health kit"}
ui.tab("catalog", "Spawner", function()
    ui.group("Items", function()
        for index, label in ipairs(catalog) do
            if ui.selectable(label .. "##item_" .. index, selected == index) then
                selected = index
            end
        end
        imgui.disabled(true, function()
            ui.selectable("Unavailable item", false)
        end)
    end)
    if ui.button("Spawn item") then
        print("Spawn requested for " .. catalog[selected])
        -- Invoke the host's actual spawn API here.
    end
end)
Overlays and drawingShared UI
ui.overlay("status", function()
    local width, height = engine.viewport()
    render.rect(20, height - 60, 240, 36, {0.05, 0.07, 0.09, 0.9}, true, 4)
    render.text(30, height - 51, "Lua overlay", {0.4, 0.8, 1, 1}, 14)
end)
Function Arguments
render.text(x, y, text, rgba [, size]) Text; size defaults to 13 and is limited to 8-80.
render.line(x1, y1, x2, y2, rgba [, thickness]) Line; default thickness 1.
render.rect(x, y, width, height, rgba [, filled, rounding]) Filled or outlined rectangle; default outline, rounding 0.
render.circle(x, y, radius, rgba [, filled, thickness]) Filled or outlined circle; default outline, thickness 1.
Themes and UI overridesShared UI
ui.theme {
    rounding = 5,
    colors = {
        WindowBg = {0.06, 0.07, 0.1, 1},
        Text = {0.9, 0.92, 1, 1},
        CheckMark = {0.75, 0.4, 1, 1},
        SliderGrab = {0.75, 0.4, 1, 1},
        Button = {0.22, 0.15, 0.32, 1},
        ButtonHovered = {0.32, 0.22, 0.45, 1}
    }
}
ui.override("settings/interface", function()
    imgui.text("My replacement settings page")
    if imgui.button("Log") then print("Replacement works") end
end)
Events and host informationShared UI
events.on("update", function()
    -- Read feature state and call a project-provided API here.
end)
events.on("shutdown", function()
    print("Cleaning up my script")
end)
Function Return
engine.time() ImGui elapsed time in seconds.
engine.delta_time() Frame delta in seconds.
engine.fps() ImGui's smoothed frame rate.
engine.viewport() Host viewport width, height.
print(...), base.log(...) Write to the shared console.
Porting and game-specific APIsShared UI
extern "C" {
#include "lua.h"
#include "lauxlib.h"
}

app.scripts().registerHostApi = [](lua_State* L) {
    lua_newtable(L);
    lua_pushcfunction(L, [](lua_State* state) -> int {
        lua_pushstring(state, "My Game");
        return 1;
    });
    lua_setfield(L, -2, "name");
    lua_setglobal(L, "game");
};
app.scripts().run(source, app.features(), logCallback, "My Script");
auto names = app.scripts().running();
app.scripts().stop("My Script");
app.scripts().stopAll();
app.navigateScript("lua:My Script:tools", "lua:My Script:general");
app.setApiDocsVisible(true, false); // true = attach left, false = attach right
Custom product controlsShared UI
local values = {features.get("aim.common"), features.get("aim.special")}
local changed, selected = ui.multi_combo("Targets", values, {"Common infected", "Special infected"})
if changed then
    features.set("aim.common", selected[1])
    features.set("aim.special", selected[2])
end
Entity colorsShared UI
Signature Behavior
esp_colors.available() Returns whether the host registered classification color support.
esp_colors.categories() Returns the 13 stable category IDs in display order.
esp_colors.enabled([boolean]) Reads or sets the category master. Unsupported hosts return false; writes fail.
esp_colors.get(category) Returns enabled, color, second_color and tint_fill; returns nil without host support.
esp_colors.set(category, settings) Atomically applies supplied fields. RGBA arrays require exactly four finite numbers from 0 to 1.
esp_colors.reset([category]) Resets one category, or all categories and the master when omitted.
ui.entity_colors() Draws the category dropdown inline inside a Filters group. Non-Global categories expose Override global; enabled overrides show a color picker and settings popup. Returns false without host support.
if esp_colors.available() then
    esp_colors.set("npc_friendly", {
        enabled = true,
        color = {0.2, 0.9, 0.4, 1},
        second_color = {0.1, 0.5, 0.2, 1},
        tint_fill = false
    })
    ui.window("entity_colors", "Entity colors", function()
        ui.group("Filters", function() ui.entity_colors() end)
    end)
end
Native controlsShared UI
local changed, enabled = imgui.checkbox("Enabled", enabled)
imgui.set_next_item_width(140)
changed, amount = imgui.slider_float("Amount", amount, 0, 1)
changed, count = imgui.slider_int("Count", count, 0, 10)
changed, choice = imgui.combo("Mode", choice, {"First", "Second"})
changed, amount = imgui.drag_float("Drag", amount, 0, 1, 0.01)
changed, count = imgui.drag_int("Count", count, 0, 100, 1)
if imgui.radio_button("Mode A", choice == 1) then choice = 1 end
imgui.text_wrapped("A longer description that wraps within the current layout.")
Themed widgetsShared UI
-- widgets and ui.widgets are the same table. Legacy ui.* names remain compatible.
local changed, enabled = widgets.toggle("Enabled", enabled)
changed, amount = widgets.slider("Amount", amount, 0, 1)
changed, count = widgets.slider_int("Count", count, 0, 10)
changed, choice = widgets.combo("Mode", choice, {"First", "Second"})
changed, selected = widgets.multi_combo("Targets", selected, {"One", "Two"})
if widgets.button("Apply") then print("Applied") end
widgets.columns(2, function()
    widgets.group("First", function() widgets.toggle("Example", false) end)
    widgets.next_column()
    widgets.group("Second", function() imgui.text("Shared theme") end)
end)
imgui.table and columnsShared UI
imgui.table("layout", 2, {borders=false, resizable=true, row_bg=false,
    width=0, height=0, scroll_y=false}, function()
    -- Width is a stretch weight unless fixed=true. Setup precedes any rows.
    imgui.table_setup_column("Controls", 1, false)
    imgui.table_setup_column("Preview", 1, false)
    imgui.table_headers_row()
    imgui.table_next_row(24) -- optional minimum row height
    imgui.table_next_column()
    imgui.text("Column one")
    imgui.table_set_column(2) -- one-based
    imgui.child("preview", 0, 100, function() imgui.text("Column two") end,
        {border=true, horizontal_scroll=true})
end)
Groups, IDs and placementShared UI
imgui.with_id("unique_scope", function()
    imgui.group(function()
        local x,y = imgui.cursor_local()
        imgui.set_cursor(x+8,y)
        imgui.button("Repeated label")
        imgui.same_line(8)
        imgui.dummy(12,24)
    end)
end)
local screenX,screenY = imgui.cursor()
imgui.set_cursor_screen(screenX,screenY)
local width,height = imgui.available()
local windowX,windowY = imgui.window_pos()
local windowWidth,windowHeight = imgui.window_size()
local textWidth,textHeight = imgui.text_size("Measure me")
imgui.with_font_sizeShared UI
imgui.with_font_size(14, function()
    imgui.text("Readable standalone text")
    imgui.checkbox("Enabled", true)
end)
imgui.with_style_varsShared UI
imgui.with_style_vars({WindowPadding={8,8},FramePadding={4,2},ItemSpacing={5,3},
    CellPadding={4,3},WindowRounding=3,FrameRounding=0,GrabMinSize=9},function()
    imgui.button("Compact")
end)
Tabs and treesShared UI
imgui.tab_bar("pages",function()
    imgui.tab_item("Main",function() imgui.text("Main page") end)
    imgui.tab_item("Settings",function() imgui.text("Settings page") end)
end)
imgui.tree("Details",function() imgui.text("Expanded details") end)
Hit targets and inputShared UI
local x,y = imgui.cursor()
if imgui.invisible_button("custom_toggle", 120, 24) then enabled = not enabled end
local hovered,active = imgui.is_item_hovered(),imgui.is_item_active()
local x1,y1,x2,y2 = imgui.item_rect()
local mouseX,mouseY = imgui.mouse_pos()
local deltaX,deltaY = imgui.mouse_delta()
local down = imgui.is_mouse_down(0) -- 0 left, 1 right, 2 middle, 3/4 extra
local clicked,released = imgui.is_mouse_clicked(0),imgui.is_mouse_released(0)
local itemClicked = imgui.is_item_clicked(0)
draw.rect(x,y+4,30,16,enabled and {0.5,0.8,0.2,1} or {0.2,0.2,0.2,1},true,8)
draw.circle(x+(enabled and 22 or 8),y+12,5,{1,1,1,1},true)
draw.text(x+40,y+5,"Custom toggle",{1,1,1,1},13)
Window drawing and clippingShared UI
-- Screen coordinates. draw.* uses the current window's draw list and clipping.
-- render.* retains the existing foreground overlay behavior.
draw.text(x,y,"Label",{1,1,1,1},13)
draw.line(x,y,x+100,y,{0.5,0.8,0.2,1},2)
draw.rect(x,y,100,30,{0.1,0.1,0.1,1},true,4)
draw.circle(x+12,y+12,8,{1,1,1,1},false,2)
draw.triangle(x,y,x+12,y,x+6,y+8,{1,1,1,1},true,1)
imgui.with_clip_rect(x,y,x+100,y+30,function()
    draw.text(x,y,"Clipped content",{1,1,1,1},13)
end)
Custom dropdowns and popupsShared UI
if imgui.button("Custom dropdown") then imgui.open_popup("choices") end
imgui.popup("choices",function()
    if imgui.selectable("First",choice==1) then choice=1 end
    if imgui.selectable("Second",choice==2) then choice=2 end
    -- selectable(label, selected [, width, height, keep_open])
    -- With keep_open=true, Lua can build a multi-select list.
end)
imgui.combo_custom("Custom combo",tostring(choice),function()
    if imgui.button("Use first") then choice=1;imgui.close_popup() end
end)
Slim slider appearanceShared UI
imgui.set_next_item_width(170)
changed, amount = imgui.slider_float("Amount", amount, 0, 1, {style="track"})
changed, count = imgui.slider_int("Count", count, 0, 100, {style="track"})
-- Default / {style="native"}: standard Dear ImGui slider.
-- Track: drag to adjust; click the value / Ctrl-click to type.
-- Arrow adjustment is available when the host enables ImGui keyboard navigation.
-- Track numeric entry clamps to the supplied range. Colors and sizing use ImGui style.
Compact example GUIShared UI
-- Run ImGui Demo.lua from Lua > Scripts; F10 toggles visibility.
-- Main: native ImGui widgets aligned in titled panels and responsive columns.
-- Visuals: Lua-drawn toggles, slider and dropdown contents with a live local preview.
-- Settings: accent/footer preferences and optional widgets.* controls.