Skip to main content
Sentivel Endorsed by RayfieldStatus pages and uptime monitoring for whatever you ship. Free to start.Take a look Rayfield:CreateWindow(props) creates the window and returns its handle. Tabs, tags, notifications, popups, and theme changes all come from that handle.
A Rayfield Gen2 window with tabs and elements

​
Properties

​
string
default:"\"Rayfield Window\""
The window title.
​
string
A smaller line beneath the title.
​
string | table
default:"\"default\""
A built-in theme name ("default", "cobalt", "ember", "amethyst", "frost", "rose") or a theme table. See Themes.
​
string | number
An icon shown beside the title.
​
string
default:"\"Rayfield\""
Label on the collapsed pill while the window is hidden.
​
string | number
default:"Rayfield icon"
Icon on the collapsed pill while the window is hidden.
​
table
Enables saving. See Saving.
​
string
default:"player's locale"
Pins the language. Leave it out to follow the player’s Roblox language. See Localization.
​
table
Language tables keyed by locale id.
​
function
A custom resolver used instead of tables.
​
Enum.Font | Font
default:"BuilderSans"
A stand-in font shown in secure mode while the brand font downloads.

​
Methods

The window handle exposes everything you need at runtime.

​
Building

​
Tab
Add a tab. See Tabs and groups.
​
Tag
Add a pill beside the title. See Tags.

​
Messages

​
Show a notification card in the corner. See Notifications.
​
Drop a toast in from the top. See Notifications.
​
Popup
Float a modal dialog or changelog over a dimmed backdrop. See Popups.

​
Visibility

​
Reveal the window.
​
Collapse the window.
​
Toggle between shown and hidden.
​
Collapse to the top bar.
​
Go to a tab by its handle or name. Selects it, so the tab strip follows. Equivalent to tab:Select().
​
Destroy the interface.
​
boolean
true once Unload has run. The handle is spent after that.

​
Theme and language

​
Restyle everything at runtime. Colours and numeric values tween across; corner radii, fonts, and gradients apply instantly.
​
Switch every label to another language live.
​
Swap the copy resolver.
​
Add a language pack at runtime.

​
Saving

​
boolean
Save now. Pass a name to target a saved configuration, or leave it out for the default file.
​
boolean
Load now.
​
{ string }
Names of the saved configurations.
​
boolean
Delete a saved configuration.
​
string, string
The directory and full path of the config file.
​
any
Read a saved value by its flag. Also available as window.Flags[flag].
​
boolean
Write a saved value by its flag. This updates the UI and fires the callback. Returns false if the flag is unknown.