System API

Core system functions and information.

Functions

kinetic.version

Get the Kinetic version string.

local version = kinetic.version
print("Kinetic version: " .. version)  -- "1.0.0"

Returns: string - Version number

---

kinetic.fps()

Get the current frames per second.

local fps = kinetic.fps()
print("FPS: " .. fps)

Returns: number - Current FPS

Example:

kinetic.on_frame = function(delta_time)
    local fps = kinetic.fps()
    
    -- Color based on FPS
    local color
    if fps >= 60 then
        color = {0, 255, 0}  -- Green
    elseif fps >= 30 then
        color = {255, 255, 0}  -- Yellow
    else
        color = {255, 0, 0}  -- Red
    end
    
    kinetic.draw.text({10, 10}, color, string.format("FPS: %.0f", fps))
end

---

kinetic.player_count()

Get the number of players currently in the game.

local count = kinetic.player_count()
print("Players in game: " .. count)

Returns: number - Player count

---

kinetic.notify()

Show a notification on screen.

kinetic.notify(title, message, duration)

Parameters:

• title (string) - Notification title

• message (string) - Notification message

• duration (number) - How long to show (seconds)

Example:

-- Show notification for 3 seconds
kinetic.notify("Info", "Script loaded successfully!", 3.0)

-- Show warning
kinetic.notify("Warning", "Low health detected", 2.0)

-- Show error
kinetic.notify("Error", "Failed to load config", 5.0)

Complete Example

script_info = {
    name = "System Monitor",
    author = "Kinetic",
    version = "1.0.0"
}

-- Show startup notification
kinetic.notify("System Monitor", "Loaded v" .. kinetic.version, 3.0)

kinetic.on_frame = function(delta_time)
    local y = 10
    
    -- Version
    kinetic.draw.text({10, y}, {255, 255, 255}, "Kinetic v" .. kinetic.version)
    y = y + 20
    
    -- FPS
    local fps = kinetic.fps()
    local fps_color = fps >= 60 and {0, 255, 0} or {255, 255, 0}
    kinetic.draw.text({10, y}, fps_color, string.format("FPS: %.0f", fps))
    y = y + 20
    
    -- Player count
    local count = kinetic.player_count()
    kinetic.draw.text({10, y}, {255, 255, 255}, "Players: " .. count)
end

Notification Types

While there's only one notify() function, you can use different titles to indicate type:

-- Info
kinetic.notify("Info", "Something happened", 3.0)

-- Success
kinetic.notify("Success", "Operation completed", 3.0)

-- Warning
kinetic.notify("Warning", "Be careful", 3.0)

-- Error
kinetic.notify("Error", "Something went wrong", 5.0)

-- Custom
kinetic.notify("ESP", "Enabled", 2.0)
kinetic.notify("Aimbot", "Target locked", 1.0)

Tips

• Keep notifications short - Users need to read them quickly

• Use appropriate durations - 2-3 seconds for info, 5+ for errors

• Don't spam - Too many notifications are annoying

• Use clear titles - Users should know what the notification is about

Next Steps

• Players API - Access player data

• Drawing API - Draw on screen

• Input API - Check keyboard/mouse input