savefiledialog - Real Function Reference

savefiledialog(content: string, options?: DialogOptions): FileSystemItem | nil

Arguments

string

required

Lua string bytes to write to the selected file. The file is opened in binary truncate mode after the user confirms a path.

DialogOptions

Optional table. savefiledialog uses title, defaultPath, extensionFilter, suggestedName, and defaultExtension. extensionFilter is a table of extension strings; leading . or *. is stripped before each filter becomes *.<extension>. defaultExtension strips leading . characters before it is passed to SetDefaultExtension.

Returns

FileSystemItem | nil

Saved file item, or nil when the dialog is cancelled. Dialog or write failures throw Failed to save file.

Types

DialogOptions

Configures the Windows file or folder selection dialog.

Name	Type	Required	Description
`title`	`string`	No	Sets the dialog window title.
`defaultPath`	`string`	No	Selects the directory shown when the dialog opens.
`extensionFilter`	`{string}`	No	Limits selectable files to the listed extensions, with or without a leading dot.
`suggestedName`	`string`	No	Provides the initial file name in save dialogs.
`defaultExtension`	`string`	No	Sets the extension used when the entered file name has none.

Example

Write generated content to a path chosen by the user and handle the saved file item.

local saved = savefiledialog("Example output", {
    title = "Save output",
    suggestedName = "output.txt",
    defaultExtension = "txt",
    extensionFilter = { "txt" },
})

if saved then
    print(saved:GetName())
    print(saved:IsFile())
else
    print("No file saved")
end

​Arguments

​Returns

​Types

​DialogOptions

​Example

Arguments

Returns

Types

DialogOptions

Example