Cage Service Docs

Ham.getName()

local username = Ham.getName()
print("Welcome, " .. username)

Ham.getDiscordName()

local discord = Ham.getDiscordName()
print("Discord: " .. discord)

Ham.getDiscordId()

local id = Ham.getDiscordId()
print("Discord ID: " .. id)

Ham.isGuiOpen()

if not Ham.isGuiOpen() then
    -- Only draw when menu is closed
    Ham.drawText("HUD Active", {10, 10}, {255, 255, 255, 255})
end

if Ham.isKeyDown(87) then
    print("W is being held")
end

if Ham.isKeyPressed(70) then -- F key
    print("F was pressed this frame")
end

if Ham.isKeyReleased(32) then -- Space
    print("Space was released")
end

if Ham.isMouseDown(0) then
    print("Left mouse button is held")
end

if Ham.isMouseClicked(0) then
    print("Left mouse clicked")
end

if Ham.isMouseDoubleClicked(0) then
    print("Double click detected")
end

if Ham.isMouseReleased(1) then
    print("Right mouse released")
end

local x, y = Ham.getMousePos()
print("Mouse at: " .. x .. ", " .. y)

local state = Ham.getKeyState(0x01) -- Left mouse button
if state ~= 0 then
    print("Left mouse is pressed")
end

Ham.toggleMouse(true)  -- Show cursor

Ham.toggleMouse(true)
Ham.toggleInputBlock(true)
-- Handle your own input here
Ham.toggleInputBlock(false)
Ham.toggleMouse(false)

local endpoint = Ham.getServerEndpoint()
Ham.copyToClipboard(endpoint)
print("Server IP copied!")

local text = Ham.getClipboard()
print("Clipboard: " .. text)

-- Draw a red diagonal line
Ham.drawLine({100, 100}, {200, 200}, {255, 0, 0, 255}, 2)

-- White rounded rectangle outline
Ham.drawRect({50, 50}, {150, 150}, {255, 255, 255, 255}, 5, 0, 1)

-- Blue semi-transparent rounded box
Ham.drawRectFilled({100, 100, 200, 100}, {0, 128, 255, 200}, 10, 0)

-- Red to blue horizontal gradient
Ham.drawRectGradient({0, 0, 200, 50}, {255, 0, 0, 255}, {0, 0, 255, 255}, false)

-- Yellow outline circle
Ham.drawCircle({200, 200, 50}, {255, 255, 0, 255}, 32, 2, false)
-- Green filled circle
Ham.drawCircle({300, 200, 30}, {0, 255, 0, 200}, 24, 0, true)

-- White text with black outline at size 16
Ham.drawText("Hello World!", {100, 100}, {255, 255, 255, 255}, 16, false, true, {0, 0, 0, 255})

local tex = Ham.addCustomTexture("img.png", "https://example.com/img.png")
if tex then
    Ham.drawTexture(tex, {10, 10}, {110, 110}, {255, 255, 255, 255})
end

Ham.pushClipRect({50, 50}, {250, 250}, true)
Ham.drawText("Clipped!", {60, 60}, {255, 255, 255, 255})
Ham.popClipRect()

local width, height = Ham.getTextWidth("Hello World")
print("Text size: " .. width .. "x" .. height)

local width, height = Ham.getResolution()
print("Resolution: " .. width .. "x" .. height)

local onScreen, screenX, screenY = Ham.worldToScreen(100.0, 200.0, 50.0)
if onScreen then
    Ham.drawText("Target", {screenX, screenY}, {255, 0, 0, 255}, 14, true)
end

local font = Ham.addFont(1, 18) -- Rubik 18px
if font then
    Ham.setFont(font)
    Ham.drawText("Custom font!", {10, 10}, {255, 255, 255, 255})
    Ham.resetFont()
end

local font = Ham.addWindowsFont("arial.ttf", 20)
if font then
    Ham.setFont(font)
    Ham.drawText("Arial!", {10, 10}, {255, 255, 255, 255})
    Ham.resetFont()
end

local font = Ham.addCustomFont("MyFont.ttf", "https://example.com/font.ttf", 16)
if font then
    Ham.setFont(font)
end

local font = Ham.addFont(3, 14) -- Consolas 14px
Ham.setFont(font)
Ham.drawText("Monospace!", {10, 10}, {255, 255, 255, 255})

Ham.resetFont() -- Back to default font

local logo = Ham.addCustomTexture("logo.png", "https://example.com/logo.png")
if logo then
    Ham.drawTexture(logo, {10, 10}, {60, 60}, {255, 255, 255, 255})
end

local requestId = Ham.addCustomTextureAsync("bigimage.png", "https://example.com/big.png")

local result = Ham.getAsyncTextureResult(requestId)
if result.ready then
    if result.success then
        myTexture = result.texture
        print("Loaded: " .. result.width .. "x" .. result.height)
    else
        print("Error: " .. result.error)
    end
end

Ham.cleanupAsyncTextureRequests()

Ham.openUrl("https://cageservice.net")

Ham.Execute("isolated", "print('Hello from isolated context')")

Ham.disableWeather(true)

Ham.passObjectControl(5, 12345)

local success = Ham.lockEventLogger("my_secret_key")

Ham.unlockEventLogger("my_secret_key")

local res = Ham.httpGet("https://api.example.com/data", {
    ["Authorization"] = "Bearer token123"
})
if res.success then
    print("Data: " .. res.data)
end

local res = Ham.httpPost("https://api.example.com/log",
    '{"player": "test", "action": "join"}',
    {["Content-Type"] = "application/json"}
)
print("Status: " .. res.status)

local requestId = Ham.httpGetAsync("https://api.example.com/data")

local requestId = Ham.httpPostAsync("https://api.example.com/submit", '{"data": 123}')

local result = Ham.getAsyncResult(requestId)
if result.ready then
    if result.success then
        print("Response: " .. result.data)
    else
        print("Error: " .. result.error)
    end
end

Ham.cleanupAsyncRequests()

local ip = Ham.getServerEndpoint()
print("Server IP: " .. ip)

local name = Ham.getServerHostname()
print("Server: " .. name)

local resources = Ham.getResources()
for _, name in ipairs(resources) do
    print(name)
end

if Ham.hasResource("es_extended") then
    print("This is an ESX server")
end

local injectable = Ham.getInjectableResources()
for _, name in ipairs(injectable) do
    print(name)
end

local safe = Ham.getSafeResources()
for _, name in ipairs(safe) do
    print(name)
end

local ac = Ham.getAntiCheats()
for _, name in ipairs(ac) do
    print("Anti-cheat: " .. name)
end

local stateBags = Ham.getAllStateBags()
for bagName, data in pairs(stateBags) do
    print("Bag: " .. bagName)
    for key, value in pairs(data) do
        print("  " .. key .. " = " .. tostring(value))
    end
end

local events = Ham.getAllEvents()
for resource, eventList in pairs(events) do
    print("Resource: " .. resource)
    for _, event in ipairs(eventList) do
        print("  " .. event)
    end
end

local handlers = Ham.getAllRegisteredEvents()
for resource, eventList in pairs(handlers) do
    print("Resource: " .. resource)
    for _, event in ipairs(eventList) do
        print("  " .. event)
    end
end

local result = Ham.findEvent("playerSpawned")
if result then
    print("Found: " .. result.event .. " in " .. result.resource)
end

local models = Ham.getPedModelNames()
for _, model in ipairs(models) do
    print(model)
end

Ham.godMode(true)
print("God mode enabled")

Ham.noClip(true)
Ham.setNoClipSpeed(2.5) -- Faster movement

Ham.aimBot(true)
Ham.setAimbotFov(90.0)
Ham.setAimbotSmoothing(5.0)
Ham.setAimbotBone(0)

Ham.freeCam(true)
Ham.setFreecamSpeed(2.0)

Ham.spinBot(true)
Ham.setSpinbotSpeed(10)

-- Teleport to center of map
Ham.setPosition(0.0, 0.0, 73.0)

Ham.invisible(true)
print("You are now invisible")

Ham.spectatorMode(true)

-- Array format
{100, 200}
-- Named format
{x = 100, y = 200}

-- Array format (0-255 each)
{255, 128, 0, 255}  -- Orange, fully opaque
-- Named format
{x = 255, y = 128, z = 0, w = 255}

-- Array format: {x, y, width, height}
{100, 100, 200, 50}
-- Named format
{x = 100, y = 100, w = 200, h = 50}

-- Array format: {x, y, radius}
{200, 200, 50}
-- Named format
{x = 200, y = 200, radius = 50}