Instances · Function

saveinstance

Serializes the game DataModel (or a subtree) to an RBXL/RBXLX file.

function saveinstance(optionsoptionstable?Configuration table. Keys: FilePath (string), DecompileMode (string: "sponge"|"none"), SavePlayers (boolean), ShowStatus (boolean), IgnoreDefaultProps (boolean), IgnoreList (table of class names).?: table): void

Usage

Save full game

saveinstance({
  FilePath = "saved_game.rbxlx",
  DecompileMode = "sponge",
  ShowStatus = true,
})

Save workspace only

saveinstance({
  FilePath = "workspace_only.rbxlx",
  IgnoreList = {"Chat", "Players"},
  DecompileMode = "none",
})

Options

Key	Type	Default	Description
FilePath	string	"game.rbxlx"	Output file path in the workspace.
DecompileMode	string	"sponge"	Script decompilation mode. "sponge" uses the Sponge Decompiler, "none" skips.
SavePlayers	boolean	false	Include Player instances and their character models.
ShowStatus	boolean	true	Print progress messages to the executor console.
IgnoreDefaultProps	boolean	true	Omit properties that match their class defaults.
IgnoreList	table	{}	Array of class names to exclude from serialization.