Roblox / Game API

Navigate and interact with Roblox game instances.

Overview

The Roblox API provides address-based access to game instances. All functions work with memory addresses (numbers).

Core Functions

get_datamodel()

Get the root DataModel address.

local datamodel = kinetic.roblox.get_datamodel()

is_valid()

Check if an instance address is valid.

if kinetic.roblox.is_valid(addr) then
    -- Instance is valid
end

Properties

get_name()

local name = kinetic.roblox.get_name(addr)

get_class_name()

local class = kinetic.roblox.get_class_name(addr)

get_parent()

local parent_addr = kinetic.roblox.get_parent(addr)

Navigation

get_children()

local children = kinetic.roblox.get_children(addr)
for i, child_addr in ipairs(children) do
    local name = kinetic.roblox.get_name(child_addr)
    print(i .. ". " .. name)
end

find_first_child()

local child_addr = kinetic.roblox.find_first_child(parent_addr, "ChildName")

find_first_child_of_class()

local child_addr = kinetic.roblox.find_first_child_of_class(parent_addr, "ClassName")

Player/Character

get_character()

local character_addr = kinetic.roblox.get_character(player_addr)

get_team()

local team_name = kinetic.roblox.get_team(player_addr)

Humanoid

get_health() / get_max_health()

local health = kinetic.roblox.get_health(humanoid_addr)
local max_health = kinetic.roblox.get_max_health(humanoid_addr)

Position

get_position()

local pos = kinetic.roblox.get_position(part_addr)
if pos then
    print("Position: " .. pos.x .. ", " .. pos.y .. ", " .. pos.z)
end

Complete Example

-- Get DataModel
local datamodel = kinetic.roblox.get_datamodel()

-- Find Players service
local players_addr = kinetic.roblox.find_first_child_of_class(datamodel, "Players")

-- Get all players
local players = kinetic.roblox.get_children(players_addr)

for i, player_addr in ipairs(players) do
    local name = kinetic.roblox.get_name(player_addr)
    print("Player: " .. name)
    
    -- Get character
    local character_addr = kinetic.roblox.get_character(player_addr)
    if character_addr and character_addr ~= 0 then
        -- Get humanoid
        local humanoid_addr = kinetic.roblox.find_first_child_of_class(character_addr, "Humanoid")
        if humanoid_addr and humanoid_addr ~= 0 then
            local health = kinetic.roblox.get_health(humanoid_addr)
            print("  Health: " .. health)
        end
    end
end

For complete documentation, see ROBLOX_API_REFERENCE.md

Next Steps

• Players API - Easier player access

• Camera API - Project positions