Widget API

Create custom draggable on-screen widgets.

The Widget API is going to be in BETA for a while, expect bugs, especially because we are the first external to implement this in place of menu manipulation.

Functions

create()

Create a new widget.

kinetic.widgets.create(name, x, y, width, height)

Parameters:

• name (string) - Unique widget name

• x, y (numbers) - Initial position

• width, height (numbers) - Widget size

set_enabled() / get_enabled()

kinetic.widgets.set_enabled(name, true)
local enabled = kinetic.widgets.get_enabled(name)

set_position() / get_position()

kinetic.widgets.set_position(name, x, y)
local pos = kinetic.widgets.get_position(name)

set_lines()

Set the content function for the widget.

kinetic.widgets.set_lines(name, function()
    return {
        "Line 1",
        "Line 2",
        "Line 3"
    }
end)

Complete Example

script_info = {
    name = "Player Info Widget",
    version = "1.0.0"
}

-- Create widget
kinetic.widgets.create("player_info", 10, 100, 200, 100)

-- Set content
kinetic.widgets.set_lines("player_info", function()
    local lines = {}
    
    -- Title
    table.insert(lines, "=== Player Info ===")
    
    -- Local player
    local local_player = kinetic.players.get_local()
    if local_player then
        table.insert(lines, "Name: " .. local_player.name)
        table.insert(lines, string.format("Health: %.0f/%.0f", 
            local_player.health, local_player.max_health))
    end
    
    -- Player count
    local count = kinetic.player_count()
    table.insert(lines, "Players: " .. count)
    
    -- FPS
    local fps = kinetic.fps()
    table.insert(lines, string.format("FPS: %.0f", fps))
    
    return lines
end)

-- Enable widget
kinetic.widgets.set_enabled("player_info", true)

kinetic.notify("Widget", "Player Info created", 2.0)

Next Steps

• Drawing API - Custom drawing

• Players API - Get player data