Skip to main content
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

​
name
string
default:"\"Rayfield Window\""
The window title.
​
subtitle
string
A smaller line beneath the title.
​
theme
string | table
default:"\"default\""
A built-in theme name ("default", "cobalt", "ember", "amethyst", "frost", "rose") or a theme table. See Themes.
​
icon
string | number
An icon shown beside the title.
​
configuration
table
Enables saving. See Saving.
​
locale
string
default:"player's locale"
Pins the language. Leave it out to follow the player’s Roblox language. See Localization.
​
translations
table
Language tables keyed by locale id.
​
translator
function
A custom resolver used instead of tables.
​
fallbackFont
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

​
CreateTab(props)
Tab
Add a tab. See Tabs and groups.
​
CreateTag(props)
Tag
Add a pill beside the title. See Tags.

​
Messages

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

​
Visibility

​
Show()
Reveal the window.
​
Hide()
Collapse the window.
​
ToggleHide()
Toggle between shown and hidden.
​
ToggleMinimise()
Collapse to the top bar.
​
Navigate(tab)
Jump to a tab by its handle or name.
​
Unload()
Destroy the interface.

​
Theme and language

​
ChangeTheme(theme)
Restyle everything at runtime. Colours and sizes tween across.
​
SetLocale(id)
Switch every label to another language live.
​
SetTranslator(fn)
Swap the copy resolver.
​
RegisterTranslations(t)
Add a language pack at runtime.

​
Saving

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