API Reference Overview

Complete reference for Kinetic's Lua API.

API Namespaces

Kinetic's API is organized into logical namespaces:

Core APIs

Namespace	Description	Page
kinetic	System info, notifications	System API
kinetic.players	Player data and filtering	Players API
kinetic.esp	ESP control	ESP API
kinetic.aimbot	Aimbot configuration	Aimbot API

Drawing & Display

Namespace	Description	Page
kinetic.draw	2D drawing functions	Drawing API
kinetic.camera	Screen and projection	Camera API
kinetic.widgets	Custom widgets	Widget API

Input & Interaction

Namespace	Description	Page
kinetic.input	Keyboard and mouse	Input API
kinetic.target	Aimbot target info	Utility API

Game Integration

Namespace	Description	Page
kinetic.roblox	Roblox instance navigation	Roblox API
kinetic.config	Save/load configurations	Config API

Utilities

Namespace	Description	Page
kinetic.math	Math helpers	Utility API
kinetic.utils	Utility functions	Utility API
kinetic.world	World properties	Utility API
kinetic.menu	Menu state	Utility API

Quick Reference

Most Used Functions

-- Players
local players = kinetic.players.get_all()
local closest = kinetic.players.get_closest()
local local_player = kinetic.players.get_local()

-- Drawing
kinetic.draw.text({x, y}, {r, g, b}, "Text")
kinetic.draw.box({x1, y1}, {x2, y2}, {r, g, b})
kinetic.draw.circle({x, y}, {r, g, b}, radius)

-- ESP Control
kinetic.esp.set_enabled(true)
kinetic.esp.set_boxes(true)

-- Input
if kinetic.input.is_key_down(0x45) then  -- E key
    -- Do something
end

-- Notifications
kinetic.notify("Title", "Message", 3.0)

-- Roblox
local datamodel = kinetic.roblox.get_datamodel()
local name = kinetic.roblox.get_name(addr)
local children = kinetic.roblox.get_children(addr)

Callbacks

Scripts can define callbacks that Kinetic will call:

-- Called every frame
kinetic.on_frame = function(delta_time)
    -- Your code here
end

-- Called when player joins
kinetic.on_player_added = function(player_address)
    -- Player joined
end

-- Called when player leaves
kinetic.on_player_removed = function(player_address)
    -- Player left
end

-- Called when aimbot locks target
kinetic.on_target_locked = function(player_address)
    -- Target locked
end

-- Called when aimbot hits target
kinetic.on_target_hit = function(player_address)
    -- Target hit
end

Data Types

Player Object

{
    address = 0x...,      -- Memory address
    name = "PlayerName",  -- Player name
    health = 100,         -- Current health
    max_health = 100,     -- Maximum health
    distance = 50.5,      -- Distance in studs
    position = {          -- Position (if available)
        x = 0,
        y = 0,
        z = 0
    }
}

Position Table

{
    x = 0,  -- X coordinate
    y = 0,  -- Y coordinate
    z = 0   -- Z coordinate
}

Screen Position

{
    x = 100,         -- Screen X
    y = 200,         -- Screen Y
    visible = true   -- Is on screen
}

Color Array

{r, g, b}  -- RGB values 0-255
-- Example: {255, 0, 0} = Red

Error Handling

Always check return values:

-- Check if player exists
local player = kinetic.players.get_local()
if player then
    print("Health: " .. player.health)
end

-- Check if position exists
if player.position then
    print("X: " .. player.position.x)
end

-- Check if address is valid
if addr and addr ~= 0 then
    local name = kinetic.roblox.get_name(addr)
end

-- Use pcall for safety
local success, result = pcall(function()
    return kinetic.roblox.get_name(addr)
end)
if success then
    print("Name: " .. result)
end

Performance Tips

1. Cache values - Don't call functions repeatedly

-- Bad
for i = 1, 100 do
    local players = kinetic.players.get_all()  -- Called 100 times!
end

-- Good
local players = kinetic.players.get_all()  -- Called once
for i = 1, #players do
    -- Use players
end

1. Minimize drawing - Drawing is expensive

-- Only draw when needed
if show_esp then
    kinetic.draw.text({10, 10}, {255, 255, 255}, "ESP Active")
end

1. Use player cache - It's optimized

-- Use this (cached, fast)
local players = kinetic.players.get_all()

-- Not this (slow, direct reads)
local datamodel = kinetic.roblox.get_datamodel()
-- ... manual player enumeration

Next Steps

• System API - Core system functions

• Players API - Player data access

• Drawing API - Drawing functions

• Roblox API - Game instance navigation