Rayfield Gen2

https://docs.sirius.menu/rayfield-gen2
Admin
Rayfield Gen2 is a redesigned UI library for Roblox scripts, offering a complete set of...
Tokens:19,035
Snippets:240
Trust Score:5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Navigate, ChangeTheme, and ToggleHide Example

Source: https://docs.sirius.menu/rayfield-gen2/windows

Demonstrates three window methods in sequence: navigating to a tab named 'Home', changing the theme to 'ember', and toggling the window's hidden state. Use these methods to control the window at runtime.

```lua
window:Navigate("Home")
window:ChangeTheme("ember")
window:ToggleHide()
```

--------------------------------

### window:Toast examples (basic and enriched)

Source: https://docs.sirius.menu/rayfield-gen2/notifications

Shows two toast usages: a single-line toast with title and icon, and a multi-line toast with subtitle and avatar. Toasts slide from top or bottom and support custom duration and position.

```lua
window:Toast({ title = "Saved", icon = 125823673784681 })
```

```lua
window:Toast({
    title = "Nova",
    subtitle = "joined the server",
    avatar = 1,
})
```

--------------------------------

### window:Notify example

Source: https://docs.sirius.menu/rayfield-gen2/notifications

Creates a notification card in the bottom-right corner with title, content, and optional duration in seconds. If duration is omitted, it defaults to between 3 and 9 seconds based on text length.

```lua
window:Notify({
    title = "Auto-saved",
    content = "Your configuration was saved.",
    duration = 5,
})
```

--------------------------------

### Handle: .value

Source: https://docs.sirius.menu/rayfield-gen2/elements/keybinds

Gets the current bind of the keybind element.

```APIDOC
## Handle: .value

### Description
Gets the current bind of the keybind element.

### Method
Get

### Parameters
None

### Response
#### Success Response
- **value** (EnumItem) - The current bind.
```

--------------------------------

### Custom theme example: Recolour tab selector

Source: https://docs.sirius.menu/rayfield-gen2/themes

Use this snippet to create a custom theme that only overrides the tab selector colors. All other theme keys fall back to the default theme. The TabStroke key is a ColorSequence that accepts a single Color3, which is widened to a flat gradient. This example sets TabColor, TabBackground, and TabStroke.

```lua
Rayfield:CreateWindow({
    theme = {
        TabColor = Color3.fromRGB(255, 255, 255),
        TabBackground = ColorSequence.new(Color3.fromRGB(24, 132, 246), Color3.fromRGB(12, 108, 230)),
        TabStroke = ColorSequence.new(Color3.fromRGB(96, 176, 255), Color3.fromRGB(40, 132, 246)),
    },
})
```

--------------------------------

### Get(flag)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Reads a saved value by its flag. Also available as window.Flags[flag].

```APIDOC
## Get(flag)

### Description
Reads a saved value by its flag. Also available as window.Flags[flag].

### Method
Get

### Parameters
- **flag** (string) - Required - The flag name.

### Returns
- **any** - The saved value.

```

--------------------------------

### console:Get()

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Returns the lines currently held in the console, oldest first, joined by newlines.

```APIDOC
## console:Get()

### Description
Returns the lines currently held in the console, oldest first, joined by newlines.

### Method
Get

### Parameters
None.

### Request Example
```lua
local content = console:Get()
```

### Response
#### Success Response
- **content** (string) - The lines currently held, oldest first, joined by newlines.
```

--------------------------------

### Reading and writing saved values via flags

Source: https://docs.sirius.menu/rayfield-gen2/saving

Access saved values directly through window.Flags or the window:Get() and window:Set() methods. Setting a flag updates the UI and fires callbacks. window:Set() returns false if the flag is unknown. Iterate all saved values with a for loop over window.Flags.

```lua
if window.Flags.AutoSprint then ... end   -- read a live value
window.Flags.AutoSprint = false           -- set it, updates the UI and fires the callback

window:Get("FieldOfView")                 -- the same read, as a method
window:Set("FieldOfView", 100)            -- the same write, returns false if the flag is unknown

for flag, value in window.Flags do        -- iterate every saved value
    print(flag, value)
end
```

--------------------------------

### Create a Window with Tab and Elements

Source: https://docs.sirius.menu/rayfield-gen2/getting-started

Creates a window with a tab, a button, and a toggle. The button shows a notification, and the toggle prints its value.

```lua
local window = Rayfield:CreateWindow({
    name = "Example Hub",
    subtitle = "Rayfield Gen2",
    sidebarLayout = true,
})

local tab = window:CreateTab({ name = "Home", icon = 93364949241311 })

tab:CreateButton({
    name = "Say hello",
    callback = function()
        window:Notify({ title = "Hello", content = "Your first element works." })
    end,
})

tab:CreateToggle({
    name = "Auto Sprint",
    callback = function(value)
        print("Auto Sprint:", value)
    end,
})
```

--------------------------------

### Create a console with initial text

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Creates a console with a name and initial text. The text is displayed as monospaced content inside the console.

```lua
tab:CreateConsole({
    name = "Example",
    text = [[print("Hello world")]],
})
```

--------------------------------

### CreateWindow with configuration table for auto-save

Source: https://docs.sirius.menu/rayfield-gen2/saving

Pass a configuration table to CreateWindow to enable automatic state persistence. autoSave saves on change, autoLoad loads on first open, fileName sets the config file name, and customFolder optionally places the file in a subfolder. Files are written to Rayfield/Configurations/[customFolder/]<fileName>.rfld.

```lua
local window = Rayfield:CreateWindow({
    name = "Example Hub",
    configuration = {
        autoSave = true,      -- save on change
        autoLoad = true,      -- load on first open
        fileName = "MyConfig",
        customFolder = "MyGame", -- optional
    },
})
```

--------------------------------

### Input Handle: .value

Source: https://docs.sirius.menu/rayfield-gen2/elements/inputs

Gets the current text of the Input element. This is a read-only property on the handle returned by CreateInput.

```APIDOC
## Input Handle: .value

### Description
Gets the current text of the Input element. This is a read-only property on the handle returned by CreateInput.

### Method
GET

### Endpoint
InputHandle.value

### Parameters
None

### Response
#### Success Response (200)
- **value** (string) - The current text.

#### Response Example
```lua
local currentText = inputHandle.value
```
```

--------------------------------

### Create a follow console and append a line

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Creates a console with follow mode enabled and a maximum line count, then appends a line. New lines pin to the bottom and the oldest line rolls off when the buffer is full.

```lua
local console = tab:CreateConsole({
    name = "Console",
    height = 130,
    follow = true,
    maxLines = 200,
})

console:Append("player joined")
```

--------------------------------

### Manual save and load with window:Save() and window:Load()

Source: https://docs.sirius.menu/rayfield-gen2/saving

Use window:Save() to write the current state and window:Load() to restore it manually. This is useful when automatic saving is disabled or when you need explicit control over when state is persisted.

```lua
window:Save()
window:Load()
```

--------------------------------

### Show()

Source: https://docs.sirius.menu/rayfield-gen2/windows

Reveals the window.

```APIDOC
## Show()

### Description
Reveals the window.

### Method
Show

```

--------------------------------

### Multiple named configurations with window:Save, Load, ListConfigs, DeleteConfig

Source: https://docs.sirius.menu/rayfield-gen2/saving

Pass a name to window:Save() and window:Load() to manage multiple configurations. window:ListConfigs() returns a table of saved configuration names, and window:DeleteConfig() removes a named configuration. Named configurations are stored beside the default file in the same folder.

```lua
window:Save("PvP Loadout")     -- write the current state to a named configuration
window:Load("PvP Loadout")     -- restore it later
window:ListConfigs()           -- { "PvP Loadout", ... }
window:DeleteConfig("PvP Loadout")
```

--------------------------------

### Create a Keybind

Source: https://docs.sirius.menu/rayfield-gen2/elements/keybinds

Initializes a new keybind element on a tab. Keybinds must be created directly on the tab level rather than within a group.

```lua
tab:CreateKeybind({
    name = "Sprint",
    value = Enum.KeyCode.LeftShift,
    callback = function(key)
        print("Pressed", key)
    end,
})
```

--------------------------------

### Create a ColorPicker with tab:CreateColorPicker

Source: https://docs.sirius.menu/rayfield-gen2/elements/color-pickers

Creates a full-width color picker on a tab. The callback receives the selected color and alpha on every change. Color pickers must be created directly on the tab, not inside a group.

```lua
tab:CreateColorPicker({
    name = "Highlight",
    color = Color3.fromRGB(96, 205, 255),
    callback = function(color, alpha)
        print(color, alpha)
    end,
})
```

--------------------------------

### ListConfigs()

Source: https://docs.sirius.menu/rayfield-gen2/windows

Returns the names of the saved configurations.

```APIDOC
## ListConfigs()

### Description
Returns the names of the saved configurations.

### Method
ListConfigs

### Returns
- **{ string }** - A list of configuration names.

```

--------------------------------

### Create a tab with window:CreateTab

Source: https://docs.sirius.menu/rayfield-gen2/tabs

Creates a new tab in the window. The first visible tab opens automatically. A tab needs at least one of `name` or `icon`. The returned handle can be used to create elements, sections, and groups.

```lua
local tab = window:CreateTab({ name = "Combat", icon = 93364949241311 })
```

--------------------------------

### Load(name?)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Loads a saved configuration.

```APIDOC
## Load(name?)

### Description
Loads a saved configuration.

### Method
Load

### Parameters
- **name** (string, optional) - The configuration name to load.

### Returns
- **boolean** - Whether the load succeeded.

```

--------------------------------

### Enable Saving with Configuration

Source: https://docs.sirius.menu/rayfield-gen2/getting-started

Passes a configuration table to the window to enable saving. Values are automatically saved and restored with their original types.

```lua
local window = Rayfield:CreateWindow({
    name = "Example Hub",
    configuration = {
        autoSave = true,
        autoLoad = true,
        fileName = "ExampleHub",
    },
})
```

--------------------------------

### Create a progress bar with steps

Source: https://docs.sirius.menu/rayfield-gen2/elements/progress

Creates a progress bar with a name, 5 steps, and an initial value of 2. The track is drawn as segments, and the value reads as '2/5'.

```lua
tab:CreateProgress({ name = "Setup", steps = 5, value = 2 }) -- reads "2/5"

```

--------------------------------

### Create and update a Stat

Source: https://docs.sirius.menu/rayfield-gen2/elements/stats

Demonstrates initializing a Stat component within a tab and updating its value using the Set method.

```lua
local revenue = tab:CreateStat({
    name = "Revenue",
    prefix = "$",
    value = 12400,
})

revenue:Set(revenue.value + 500)
```

--------------------------------

### Navigate(tab)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Goes to a tab by its handle or name. Selects it, so the tab strip follows. Equivalent to tab:Select().

```APIDOC
## Navigate(tab)

### Description
Goes to a tab by its handle or name. Selects it, so the tab strip follows. Equivalent to tab:Select().

### Method
Navigate

### Parameters
- **tab** (Tab or string) - Required - The tab handle or name to navigate to.

```

--------------------------------

### Create a section with tab:CreateSection

Source: https://docs.sirius.menu/rayfield-gen2/tabs

Creates a section heading that labels the controls beneath it. The returned handle reorders like any element.

```lua
tab:CreateSection({ name = "Aiming", icon = 93364949241311 })
```

--------------------------------

### Save(name?)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Saves now. Pass a name to target a saved configuration, or leave it out for the default file.

```APIDOC
## Save(name?)

### Description
Saves now. Pass a name to target a saved configuration, or leave it out for the default file.

### Method
Save

### Parameters
- **name** (string, optional) - The configuration name to save to.

### Returns
- **boolean** - Whether the save succeeded.

```

--------------------------------

### GetPath()

Source: https://docs.sirius.menu/rayfield-gen2/windows

Returns the directory and full path of the config file.

```APIDOC
## GetPath()

### Description
Returns the directory and full path of the config file.

### Method
GetPath

### Returns
- **string, string** - The directory and full path.

```

--------------------------------

### ChangeTheme(theme)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Restyles everything at runtime. Colours and numeric values tween across; corner radii, fonts, and gradients apply instantly.

```APIDOC
## ChangeTheme(theme)

### Description
Restyles everything at runtime. Colours and numeric values tween across; corner radii, fonts, and gradients apply instantly.

### Method
ChangeTheme

### Parameters
- **theme** (any) - Required - The theme to apply.

```

--------------------------------

### Create Input with numeric and callback

Source: https://docs.sirius.menu/rayfield-gen2/elements/inputs

Creates an input field with a label, numeric-only mode, initial value, placeholder, and a callback that prints the committed text. Inputs are full-width and must be created directly on the tab, not inside a group.

```lua
tab:CreateInput({
    name = "Max players",
    numeric = true,
    value = "16",
    placeholder = "Enter a number",
    callback = function(text)
        print("Committed:", text)
    end,
})
```

--------------------------------

### console:Copy()

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Puts the body on the clipboard. Returns false where the executor provides no setclipboard.

```APIDOC
## console:Copy()

### Description
Puts the body on the clipboard. Returns `false` where the executor provides no `setclipboard`.

### Method
Copy

### Parameters
None.

### Request Example
```lua
local success = console:Copy()
```

### Response
#### Success Response
- **success** (boolean) - Returns `false` where the executor provides no `setclipboard`.
```

--------------------------------

### tab:CreateConsole

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Creates a new Console element with the given options. Returns a console handle with methods to manipulate the console.

```APIDOC
## tab:CreateConsole

### Description
Creates a new Console element with the specified properties. The console displays monospaced text and can be configured with options like height, follow, and maxLines.

### Method
CreateConsole

### Parameters
#### Properties
- **name** (string) - Optional - A label above the block.
- **description** (string) - Optional - Hint text under the block.
- **text** (string, default: "") - The initial body. `code` also works.
- **height** (number, default: 120) - How tall the panel stands, in pixels. Floors at 48.
- **follow** (boolean, default: false) - Jump to the newest line on `Append`, the way a console does.
- **maxLines** (number, default: 200) - How many lines to keep. Past this the oldest roll off the top.

### Request Example
```lua
tab:CreateConsole({
    name = "Example",
    text = [[print("Hello world")]],
})
```

### Response
#### Success Response
Returns a console handle with methods to manipulate the console.

#### Response Example
```lua
local console = tab:CreateConsole({
    name = "Console",
    height = 130,
    follow = true,
    maxLines = 200,
})
```
```

--------------------------------

### window:Toast(props)

Source: https://docs.sirius.menu/rayfield-gen2/notifications

Drops a pill in from the top centre or rises from the bottom centre, newest on top. Use it for quick, low-weight confirmations.

```APIDOC
## window:Toast(props)

### Description
Drops a pill in from the top centre or rises from the bottom centre, newest on top. Use it for quick, low-weight confirmations.

### Method
Toast

### Parameters
#### Request Body
- **title** (string) - Required - The main line.
- **subtitle** (string) - Optional - A second line.
- **subtitleAbove** (boolean) - Optional - Put the subtitle above the title.
- **icon** (string | number) - Optional - An icon.
- **avatar** (number) - Optional - A user id, shown as their headshot.
- **minWidth** (number) - Optional - A floor on the width. Caps at the pill's maximum width of 320.
- **duration** (number) - Optional - How long it stays on screen, in seconds. Defaults to a duration based on the text length, between 3 and 9.
- **position** ("Top" | "Bottom") - Optional - Where the toast appears. "Top" drops in from above; "Bottom" rises from below. Default is "Top".

### Request Example
```lua
window:Toast({ title = "Saved", icon = 125823673784681 })

window:Toast({
    title = "Nova",
    subtitle = "joined the server",
    avatar = 1,
})
```

### Response
No return value documented.
```

--------------------------------

### console:Set(text)

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Replaces the entire body of the console with the given text.

```APIDOC
## console:Set(text)

### Description
Replaces the whole body of the console with the provided text.

### Method
Set

### Parameters
#### Arguments
- **text** (string) - The new content to set as the console body.

### Request Example
```lua
console:Set("new content")
```

### Response
No explicit return value.
```

--------------------------------

### window:CreateTab

Source: https://docs.sirius.menu/rayfield-gen2/tabs

Creates a new tab in the window. The first visible tab opens automatically. Requires at least one of name or icon.

```APIDOC
## window:CreateTab

### Description
Adds a tab to the window. The first visible tab opens automatically. A tab needs at least one of `name` or `icon`.

### Method
CreateTab

### Endpoint
window:CreateTab(props)

### Parameters
#### Request Body
- **name** (string) - Optional - The tab label.
- **icon** (string | number) - Optional - An icon shown beside the label.

### Request Example
```lua
local tab = window:CreateTab({ name = "Combat", icon = 93364949241311 })
```

### Response
#### Success Response
Returns a tab handle that can create elements, sections, and groups. The handle also has `Select(noAnimation?)`, `Deselect(noAnimation?)`, and `Remove()` methods.

#### Response Example
```lua
-- tab handle usage
tab:Select(true) -- select without animation
tab:Deselect() -- deselect with animation
tab:Remove() -- remove the tab
```
```

--------------------------------

### Rayfield:CreateWindow with translations

Source: https://docs.sirius.menu/rayfield-gen2/localization

Creates a window with translation tables keyed by locale id. Each table maps English source strings to translated strings.

```APIDOC
## Rayfield:CreateWindow

### Description
Creates a new Rayfield window with optional translation tables for localization.

### Parameters
#### translations (table) - Optional
- A table keyed by locale id (e.g., "fr", "es"). Each value is a table mapping English source strings to translated strings.

### Request Example
```lua
Rayfield:CreateWindow({
    name = "Example",
    translations = {
        fr = { ["Auto Sprint"] = "Sprint auto", ["Signed in as"] = "Connecté en tant que" },
        es = { ["Auto Sprint"] = "Sprint automático" },
    },
})
```
```

--------------------------------

### Rayfield Gen2 Build Header Comment

Source: https://docs.sirius.menu/rayfield-gen2/preview

The bundle opens with a header comment naming the version and commit. Quote this line when reporting issues encountered on preview.

```lua
-- Rayfield Gen2 v1.2.0-preview (a1b2c3d, 2026-08-20)
```

--------------------------------

### Create window with translation tables

Source: https://docs.sirius.menu/rayfield-gen2/localization

Pass a translations table keyed by locale id (e.g., 'fr', 'es') to Rayfield:CreateWindow. Each key is an English string, and values are the translated strings. Omitted strings fall back to English.

```lua
Rayfield:CreateWindow({
    name = "Example",
    translations = {
        fr = { ["Auto Sprint"] = "Sprint auto", ["Signed in as"] = "Connecté en tant que" },
        es = { ["Auto Sprint"] = "Sprint automático" },
    },
})
```

--------------------------------

### Load Rayfield Gen2 Preview

Source: https://docs.sirius.menu/rayfield-gen2/preview

Loads the preview build of Rayfield Gen2 from the dev branch. This channel is not a supported release and may change or be dropped at any time.

```lua
local Rayfield = loadstring(game:HttpGet("https://sirius.menu/gen2-preview"))()
```

--------------------------------

### Create a progress bar with a range and set its value

Source: https://docs.sirius.menu/rayfield-gen2/elements/progress

Creates a progress bar with a name, range from 0 to 100, and an initial value of 35. Then sets the value to 80 using the Set method.

```lua
local download = tab:CreateProgress({
    name = "Download",
    range = { 0, 100 },
    value = 35,
})

download:Set(80)

```

--------------------------------

### ToggleMinimise()

Source: https://docs.sirius.menu/rayfield-gen2/windows

Collapses to the top bar.

```APIDOC
## ToggleMinimise()

### Description
Collapses to the top bar.

### Method
ToggleMinimise

```

--------------------------------

### Switch locale live with SetLocale

Source: https://docs.sirius.menu/rayfield-gen2/localization

Call window:SetLocale with a locale id (e.g., 'fr') to switch languages at runtime without rebuilding the window.

```lua
window:SetLocale("fr")
```

--------------------------------

### Rayfield:CreateWindow with translator

Source: https://docs.sirius.menu/rayfield-gen2/localization

Creates a window with a custom translator function that resolves copy before falling back to translation tables.

```APIDOC
## Rayfield:CreateWindow

### Description
Creates a new Rayfield window with a custom translator function for resolving localized strings.

### Parameters
#### translator (function) - Optional
- A function `(source, localeId)` that returns a translated string, or `nil` to fall back to translation tables.

### Request Example
```lua
Rayfield:CreateWindow({
    name = "Example",
    translator = function(source, localeId)
        return myTranslationService(source, localeId)  -- or nil to fall back
    end,
})
```
```

--------------------------------

### console:SetHeight(height)

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Changes how tall the panel stands.

```APIDOC
## console:SetHeight(height)

### Description
Changes how tall the panel stands.

### Method
SetHeight

### Parameters
#### Arguments
- **height** (number) - The new height in pixels.

### Request Example
```lua
console:SetHeight(150)
```

### Response
No explicit return value.
```

--------------------------------

### Create sidebar sections with window:CreateSection

Source: https://docs.sirius.menu/rayfield-gen2/tabs

Creates a section in the tab rail, grouping the tabs created after it. The rail only exists in the sidebar layout; under the default top strip, `window:CreateSection` does nothing. The returned handle has `Remove()`.

```lua
window:CreateSection({ name = "General" })
window:CreateTab({ name = "Home", icon = 93364949241311 })
window:CreateTab({ name = "Combat" })

window:CreateSection({ name = "Reference" })
window:CreateTab({ name = "About" })
```

--------------------------------

### Changelog popup with boxes

Source: https://docs.sirius.menu/rayfield-gen2/popups

Use this snippet to display a changelog popup with a title, subtitle, and a list of boxes. Each box can have a title, description, and icon. The options include a single primary button labeled 'Got it'.

```lua
window:Popup({
    title = "What's new",
    subtitle = "Version 2.1",
    boxes = {
        { title = "Modal popups", description = "A new centred dialog.", icon = 93364949241311 },
        { title = "Faster reveals", description = "Pages open instantly." },
    },
    options = { { text = "Got it", style = "primary" } },
})
```

--------------------------------

### Register translation pack at runtime

Source: https://docs.sirius.menu/rayfield-gen2/localization

Use window:RegisterTranslations to add a new translation pack at runtime. The table is keyed by locale id and contains English-to-translated string mappings.

```lua
window:RegisterTranslations({ de = { ["Auto Sprint"] = "Auto-Sprint" } })
```

--------------------------------

### window:Notify(props)

Source: https://docs.sirius.menu/rayfield-gen2/notifications

Shows a notification card in the bottom-right corner. Hover to pause the timer, click to dismiss. The stack holds six at a time; the oldest retires early to make room.

```APIDOC
## window:Notify(props)

### Description
Shows a notification card in the bottom-right corner. Hover to pause the timer, click to dismiss. The stack holds six at a time; the oldest retires early to make room.

### Method
Notify

### Parameters
#### Request Body
- **title** (string) - Required - The first line.
- **content** (string) - Required - The body text. Wraps.
- **icon** (string | number) - Optional - An icon.
- **duration** (number) - Optional - How long it stays on screen, in seconds. Defaults to a duration based on the text length, between 3 and 9.

### Request Example
```lua
window:Notify({
    title = "Auto-saved",
    content = "Your configuration was saved.",
    duration = 5,
})
```

### Response
No return value documented.
```

--------------------------------

### tab:CreateKeybind

Source: https://docs.sirius.menu/rayfield-gen2/elements/keybinds

Creates a new keybind element on the tab. The keybind captures a key or mouse button, and the callback fires on each press or in hold mode.

```APIDOC
## tab:CreateKeybind

### Description
Creates a keybind element on the tab. The keybind captures a key or mouse button, and the callback fires on each press or in hold mode.

### Method
CreateKeybind

### Parameters
#### Properties
- **name** (string) - Required - The label.
- **description** (string) - Optional - Hint text under the label.
- **icon** (string | number) - Optional - An icon shown beside the label.
- **value** (EnumItem | string) - Optional - The initial bind. A `KeyCode`, a mouse button, or its name.
- **hold** (boolean) - Optional, default: false - Hold mode. See below.
- **holdThreshold** (number) - Optional, default: 0.2 - Seconds to hold before a press counts, in hold mode.
- **flag** (string) - Optional, default: derived from name - The save key.
- **forgetState** (boolean) - Optional, default: false - Skip saving.
- **callback** (function) - Required - See below.
- **onChanged** (function) - Optional - Runs with the new key when the bind itself changes.

### Request Example
```lua
tab:CreateKeybind({
    name = "Sprint",
    value = Enum.KeyCode.LeftShift,
    callback = function(key)
        print("Pressed", key)
    end,
})
```

### Response
#### Success Response
No explicit response is documented. The created keybind element is returned implicitly.

### Notes
- Keybinds are full-width and live at the tab level. Create them directly on the tab, not inside a group.
- By default `callback(key)` fires on each press. In hold mode it fires `callback(true)` once the key is held past the threshold and `callback(false)` on release, so a quick tap is ignored.
```

--------------------------------

### window:Popup

Source: https://docs.sirius.menu/rayfield-gen2/popups

Floats a modal card over a dimmed backdrop. Use it for a decision or a changelog. Returns a handle with a Close() method.

```APIDOC
## window:Popup

### Description
Floats a modal card over a dimmed backdrop. Use it for a decision or a changelog. Returns a handle with a Close() method.

### Method
Function call

### Endpoint
window:Popup(props)

### Parameters
#### Request Body
- **title** (string) - Optional - The heading. Default is "Popup".
- **subtitle** (string) - Optional - A smaller line beneath the title.
- **icon** (string | number) - Optional - An icon beside the title.
- **content** (string) - Optional - A body paragraph. Wraps, and scrolls inside the card when long.
- **boxes** ({ box }) - Optional - A list of cards, shown instead of a paragraph. Each `box` takes `title`, and optional `description` and `icon`.
- **options** ({ option }) - Optional - Footer buttons. Each `option` takes `text`, an optional `style` ("neutral", "primary", or "danger"), and an optional `callback` that runs before the popup closes. Default is one dismiss button.
- **dismissable** (boolean) - Optional - Let the player click the backdrop or press Escape to close. Default is true.

### Request Example
```lua
window:Popup({
    title = "Reset everything?",
    content = "This clears every saved value. You can't undo it.",
    options = {
        { text = "Cancel" },
        { text = "Reset", style = "danger", callback = function() end },
    },
})
```

### Response
#### Success Response
Returns a handle with a `Close()` method.

#### Response Example
```lua
local popup = window:Popup({ title = "Hello" })
popup:Close()
```
```

--------------------------------

### CreateTab(props)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Adds a new tab to the window. See the Tabs and groups documentation for details on the props structure.

```APIDOC
## CreateTab(props)

### Description
Adds a new tab to the window. See the Tabs and groups documentation for details on the props structure.

### Method
CreateTab

### Parameters
- **props** (table) - Required - Properties for the new tab, as described in the Tabs and groups documentation.

### Returns
- **Tab** - The created tab handle.

```

--------------------------------

### Choice dialog with Popup

Source: https://docs.sirius.menu/rayfield-gen2/popups

Use this snippet to create a confirmation dialog with a title, content, and options. The options include a Cancel button and a danger-styled Reset button with a callback. The popup returns a handle with a Close() method.

```lua
window:Popup({
    title = "Reset everything?",
    content = "This clears every saved value. You can't undo it.",
    options = {
        { text = "Cancel" },
        { text = "Reset", style = "danger", callback = function() end },
    },
})
```

--------------------------------

### Create and Set a Toggle in Lua

Source: https://docs.sirius.menu/rayfield-gen2/elements/toggles

Creates a toggle named 'Auto Sprint' with a callback that prints the new value, then sets the toggle to false. The 'flag' property is used as the save key, and 'value' sets the initial state.

```lua
local sprint = tab:CreateToggle({
    name = "Auto Sprint",
    flag = "AutoSprint",
    value = true,
    callback = function(value)
        print("Auto Sprint:", value)
    end,
})

sprint:Set(false)
```

--------------------------------

### window:CreateSection

Source: https://docs.sirius.menu/rayfield-gen2/tabs

Creates a section heading in the sidebar rail, grouping tabs created after it. Only works in sidebar layout; does nothing in default top strip layout.

```APIDOC
## window:CreateSection

### Description
Adds a section heading to the sidebar rail, grouping the tabs created after it. Only functions when `sidebarLayout = true`; in the default top strip layout, this does nothing.

### Method
CreateSection

### Endpoint
window:CreateSection(props)

### Parameters
#### Request Body
- **name** (string) - Required - The section label.
- **icon** (string | number) - Optional - An icon shown beside the label.

### Request Example
```lua
window:CreateSection({ name = "General" })
window:CreateTab({ name = "Home", icon = 93364949241311 })
window:CreateTab({ name = "Combat" })

window:CreateSection({ name = "Reference" })
window:CreateTab({ name = "About" })
```

### Response
#### Success Response
Returns a section handle with a `Remove()` method.
```

--------------------------------

### window:RegisterTranslations

Source: https://docs.sirius.menu/rayfield-gen2/localization

Adds a new translation pack at runtime, merging it with existing translations.

```APIDOC
## window:RegisterTranslations

### Description
Registers additional translation tables for one or more locales at runtime.

### Parameters
#### translations (table) - Required
- A table keyed by locale id, each containing a mapping of English source strings to translated strings.

### Request Example
```lua
window:RegisterTranslations({ de = { ["Auto Sprint"] = "Auto-Sprint" } })
```
```

--------------------------------

### Create a grid with nested groups

Source: https://docs.sirius.menu/rayfield-gen2/tabs

Creates a two-column grid by nesting groups. The outer group defaults to a row direction, and each inner group uses `direction = "column"` to stack its toggles vertically. Groups can also hold sliders, dropdowns, and sections.

```lua
local grid = tab:CreateGroup()

local left = grid:CreateGroup({ direction = "column" })
left:CreateToggle({ name = "Aimbot" })
left:CreateToggle({ name = "Triggerbot" })

local right = grid:CreateGroup({ direction = "column" })
right:CreateToggle({ name = "ESP" })
right:CreateToggle({ name = "Tracers" })
```

--------------------------------

### SetLocale(id)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Switches every label to another language live.

```APIDOC
## SetLocale(id)

### Description
Switches every label to another language live.

### Method
SetLocale

### Parameters
- **id** (string) - Required - The locale identifier.

```

--------------------------------

### Popup(props)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Floats a modal dialog or changelog over a dimmed backdrop. See the Popups documentation for details.

```APIDOC
## Popup(props)

### Description
Floats a modal dialog or changelog over a dimmed backdrop. See the Popups documentation for details.

### Method
Popup

### Parameters
- **props** (table) - Required - Properties for the popup, as described in the Popups documentation.

### Returns
- **Popup** - The created popup handle.

```

--------------------------------

### Set(flag, value)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Writes a saved value by its flag. This updates the UI and fires the callback. Returns false if the flag is unknown.

```APIDOC
## Set(flag, value)

### Description
Writes a saved value by its flag. This updates the UI and fires the callback. Returns false if the flag is unknown.

### Method
Set

### Parameters
- **flag** (string) - Required - The flag name.
- **value** (any) - Required - The value to save.

### Returns
- **boolean** - Whether the write succeeded.

```

--------------------------------

### MoveToTop()

Source: https://docs.sirius.menu/rayfield-gen2/elements/overview

Moves the element to the top of its tab.

```APIDOC
## MoveToTop()

### Description
Moves the element to the top of its tab.

### Method
MoveToTop
```

--------------------------------

### Hide()

Source: https://docs.sirius.menu/rayfield-gen2/windows

Collapses the window.

```APIDOC
## Hide()

### Description
Collapses the window.

### Method
Hide

```

--------------------------------

### tab:CreateSection

Source: https://docs.sirius.menu/rayfield-gen2/tabs

Creates a section heading within a tab to label controls beneath it. Returns a handle that reorders like any element.

```APIDOC
## tab:CreateSection

### Description
Adds a section heading to the tab, labeling the controls beneath it. The returned handle can be reordered like any element.

### Method
CreateSection

### Endpoint
tab:CreateSection(props)

### Parameters
#### Request Body
- **name** (string) - Required - The section label.
- **icon** (string | number) - Optional - An icon shown beside the label.

### Request Example
```lua
tab:CreateSection({ name = "Aiming", icon = 93364949241311 })
```

### Response
#### Success Response
Returns a section handle that can be reordered or removed.
```

--------------------------------

### Load Rayfield Gen2 Stable

Source: https://docs.sirius.menu/rayfield-gen2/preview

Loads the stable release of Rayfield Gen2. Use this channel for scripts you hand to other people, as it is supported and stable.

```lua
local Rayfield = loadstring(game:HttpGet("https://sirius.menu/gen2"))()
```

--------------------------------

### MoveToBottom()

Source: https://docs.sirius.menu/rayfield-gen2/elements/overview

Moves the element to the bottom of its tab.

```APIDOC
## MoveToBottom()

### Description
Moves the element to the bottom of its tab.

### Method
MoveToBottom
```

--------------------------------

### Toast(props)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Drops a toast in from the top. See the Notifications documentation for details.

```APIDOC
## Toast(props)

### Description
Drops a toast in from the top. See the Notifications documentation for details.

### Method
Toast

### Parameters
- **props** (table) - Required - Properties for the toast, as described in the Notifications documentation.

```

--------------------------------

### console:Clear()

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Empties the console content.

```APIDOC
## console:Clear()

### Description
Empties the console content.

### Method
Clear

### Parameters
None.

### Request Example
```lua
console:Clear()
```

### Response
No explicit return value.
```

--------------------------------

### window:SetLocale

Source: https://docs.sirius.menu/rayfield-gen2/localization

Switches the active locale at runtime, updating all translated labels immediately without rebuilding the window.

```APIDOC
## window:SetLocale

### Description
Sets the current locale for the window, causing all translatable strings to re-resolve.

### Parameters
#### localeId (string) - Required
- The locale identifier (e.g., "fr", "pt-br").

### Request Example
```lua
window:SetLocale("fr")
```
```

--------------------------------

### Handle: Set(value, skipChanged?)

Source: https://docs.sirius.menu/rayfield-gen2/elements/keybinds

Sets the bind of the keybind element. Optionally skips the onChanged callback. If the key is the menu toggle key, the bind is refused with a warning.

```APIDOC
## Handle: Set(value, skipChanged?)

### Description
Sets the bind of the keybind element. Optionally skips the onChanged callback. If the key is the menu toggle key, the bind is refused with a warning and the current one is kept.

### Method
Set

### Parameters
- **value** (EnumItem) - Required - The new bind.
- **skipChanged** (boolean) - Optional - Pass `true` to skip `onChanged`.

### Response
#### Success Response
No explicit response is documented.
```

--------------------------------

### Input Handle: Set(value, skipCallback?)

Source: https://docs.sirius.menu/rayfield-gen2/elements/inputs

Sets the text of the Input element. Optionally skips the callback when the second argument is true.

```APIDOC
## Input Handle: Set(value, skipCallback?)

### Description
Sets the text of the Input element. Optionally skips the callback when the second argument is true.

### Method
UPDATE

### Endpoint
InputHandle:Set

### Parameters
#### Arguments
- **value** (string) - Required - The new text to set.
- **skipCallback** (boolean) - Optional - If true, the callback will not be triggered.

### Request Example
```lua
inputHandle:Set("New text")
```

### Response
#### Success Response (200)
No return value.
```

--------------------------------

### console:Append(line)

Source: https://docs.sirius.menu/rayfield-gen2/elements/console

Adds a line to the end of the console. Multi-line strings are split so the line cap still counts properly.

```APIDOC
## console:Append(line)

### Description
Adds a line to the end of the console. Multi-line strings are split, so the line cap still counts properly.

### Method
Append

### Parameters
#### Arguments
- **line** (string) - The line to append to the console.

### Request Example
```lua
console:Append("player joined")
```

### Response
No explicit return value.
```

--------------------------------

### tab:CreateInput

Source: https://docs.sirius.menu/rayfield-gen2/elements/inputs

Creates a new Input element on a tab. The input commits its value when the player clicks away or presses Enter, not on every keystroke.

```APIDOC
## tab:CreateInput

### Description
Creates a new Input element on a tab. The input commits its value when the player clicks away or presses Enter, not on every keystroke.

### Method
CREATE

### Endpoint
tab:CreateInput

### Parameters
#### Properties
- **name** (string) - Required - The label.
- **description** (string) - Optional - Hint text under the label.
- **icon** (string | number) - Optional - An icon shown beside the label.
- **value** (string) - Optional - The initial text.
- **placeholder** (string) - Optional - Ghost text shown while the field is empty.
- **numeric** (boolean, default: false) - Optional - Accept numbers only. Commits a clean number, and reverts to the previous value if the text is malformed.
- **clearOnFocus** (boolean, default: false) - Optional - Empty the field when it gains focus.
- **flag** (string, default: derived from name) - Optional - The save key.
- **forgetState** (boolean, default: false) - Optional - Skip saving.
- **callback** (function) - Optional - Runs with the text on commit.

### Request Example
```lua
tab:CreateInput({
    name = "Max players",
    numeric = true,
    value = "16",
    placeholder = "Enter a number",
    callback = function(text)
        print("Committed:", text)
    end,
})
```

### Response
#### Success Response (200)
- **element** (object) - The created Input element handle.

#### Response Example
```lua
-- Returns the Input element handle
```
```

--------------------------------

### SetProfile(text?)

Source: https://docs.sirius.menu/rayfield-gen2/windows

Sets the line under the player's name in the sidebar rail. Pass nothing to remove it. Players can hide the block from settings.

```APIDOC
## SetProfile(text?)

### Description
Sets the line under the player's name in the sidebar rail. Pass nothing to remove it. Players can hide the block from settings.

### Method
SetProfile

### Parameters
- **text** (string, optional) - The profile text to display. Omit to clear.

```
Tokens:
Raw