Roblox
Built-in library for manipulating Roblox place & model files
Example usage
Section titled “Example usage”local fs = require("@lune/fs")local roblox = require("@lune/roblox")
-- Reading a place filelocal placeFile = fs.readFile("myPlaceFile.rbxl")local game = roblox.deserializePlace(placeFile)
-- Manipulating and reading instances - just like in Roblox!local workspace = game:GetService("Workspace")for _, child in workspace:GetChildren() do print("Found child " .. child.Name .. " of class " .. child.ClassName)end
-- Writing a place filelocal newPlaceFile = roblox.serializePlace(game)fs.writeFile("myPlaceFile.rbxl", newPlaceFile)
Functions
Section titled “Functions”deserializePlace
Section titled “deserializePlace”Deserializes a place into a DataModel instance.
This function accepts a string of contents, not a file path.
If reading a place file from a file path is desired, fs.readFile
can be used and the resulting string may be passed to this function.
Example usage
Section titled “Example usage”local fs = require("@lune/fs")local roblox = require("@lune/roblox")
local placeFile = fs.readFile("filePath.rbxl")local game = roblox.deserializePlace(placeFile)
Parameters
Section titled “Parameters”contents
The contents of the place to read
Returns
Section titled “Returns”- DataModel
deserializeModel
Section titled “deserializeModel”Deserializes a model into an array of instances.
This function accepts a string of contents, not a file path.
If reading a model file from a file path is desired, fs.readFile
can be used and the resulting string may be passed to this function.
Example usage
Section titled “Example usage”local fs = require("@lune/fs")local roblox = require("@lune/roblox")
local modelFile = fs.readFile("filePath.rbxm")local instances = roblox.deserializeModel(modelFile)
Parameters
Section titled “Parameters”contents
The contents of the model to read
Returns
Section titled “Returns”- { Instance }
serializePlace
Section titled “serializePlace”Serializes a place from a DataModel instance.
This string can then be written to a file, or sent over the network.
Example usage
Section titled “Example usage”local fs = require("@lune/fs")local roblox = require("@lune/roblox")
local placeFile = roblox.serializePlace(game)fs.writeFile("filePath.rbxl", placeFile)
Parameters
Section titled “Parameters”-
dataModel
The DataModel for the place to serialize -
xml
If the place should be serialized as xml or not. Defaults tofalse
, meaning the place gets serialized using the binary format and not xml.
Returns
Section titled “Returns”- string
serializeModel
Section titled “serializeModel”Serializes one or more instances as a model.
This string can then be written to a file, or sent over the network.
Example usage
Section titled “Example usage”local fs = require("@lune/fs")local roblox = require("@lune/roblox")
local modelFile = roblox.serializeModel({ instance1, instance2, ... })fs.writeFile("filePath.rbxm", modelFile)
Parameters
Section titled “Parameters”-
instances
The array of instances to serialize -
xml
If the model should be serialized as xml or not. Defaults tofalse
, meaning the model gets serialized using the binary format and not xml.
Returns
Section titled “Returns”- string
getAuthCookie
Section titled “getAuthCookie”Gets the current auth cookie, for usage with Roblox web APIs.
Note that this auth cookie is formatted for use as a “Cookie” header,
and that it contains restrictions so that it may only be used for
official Roblox endpoints. To get the raw cookie value without any
additional formatting, you can pass true
as the first and only parameter.
Example usage
Section titled “Example usage”local roblox = require("@lune/roblox")local serde = require("@lune/serde")local net = require("@lune/net")
local cookie = roblox.getAuthCookie()assert(cookie ~= nil, "Failed to get roblox auth cookie")
local myPrivatePlaceId = 1234567890
local response = net.request({ url = "https://assetdelivery.roblox.com/v2/assetId/" .. tostring(myPrivatePlaceId), headers = { Cookie = cookie, },})
local responseTable = serde.decode("json", response.body)local responseLocation = responseTable.locations[1].locationprint("Download link to place: " .. responseLocation)
Parameters
Section titled “Parameters”raw
If the cookie should be returned as a pure value or not. Defaults to false
Returns
Section titled “Returns”- string?
getReflectionDatabase
Section titled “getReflectionDatabase”Gets the bundled reflection database.
This database contains information about Roblox enums, classes, and their properties.
Example usage
Section titled “Example usage”local roblox = require("@lune/roblox")
local db = roblox.getReflectionDatabase()
print("There are", #db:GetClassNames(), "classes in the reflection database")
print("All base instance properties:")
local class = db:GetClass("Instance")for name, prop in class.Properties do print(string.format( "- %s with datatype %s and default value %s", prop.Name, prop.Datatype, tostring(class.DefaultProperties[prop.Name]) ))end
Returns
Section titled “Returns”- Database
implementProperty
Section titled “implementProperty”Implements a property for all instances of the given className
.
This takes into account class hierarchies, so implementing a property
for the BasePart
class will also implement it for Part
and others,
unless a more specific implementation is added to the Part
class directly.
Behavior
Section titled “Behavior”The given getter
callback will be called each time the property is
indexed, with the instance as its one and only argument. The setter
callback, if given, will be called each time the property should be set,
with the instance as the first argument and the property value as second.
Example usage
Section titled “Example usage”local roblox = require("@lune/roblox")
local part = roblox.Instance.new("Part")
local propertyValues = {}roblox.implementProperty( "BasePart", "CoolProp", function(instance) if propertyValues[instance] == nil then propertyValues[instance] = 0 end propertyValues[instance] += 1 return propertyValues[instance] end, function(instance, value) propertyValues[instance] = value end)
print(part.CoolProp) --> 1print(part.CoolProp) --> 2print(part.CoolProp) --> 3
part.CoolProp = 10
print(part.CoolProp) --> 11print(part.CoolProp) --> 12print(part.CoolProp) --> 13
Parameters
Section titled “Parameters”-
className
The class to implement the property for. -
propertyName
The name of the property to implement. -
getter
The function which will be called to get the property value when indexed. -
setter
The function which will be called to set the property value when indexed. Defaults to a function that will error with a message saying the property is read-only.
implementMethod
Section titled “implementMethod”Implements a method for all instances of the given className
.
This takes into account class hierarchies, so implementing a method
for the BasePart
class will also implement it for Part
and others,
unless a more specific implementation is added to the Part
class directly.
Behavior
Section titled “Behavior”The given callback
will be called every time the method is called,
and will receive the instance it was called on as its first argument.
The remaining arguments will be what the caller passed to the method, and
all values returned from the callback will then be returned to the caller.
Example usage
Section titled “Example usage”local roblox = require("@lune/roblox")
local part = roblox.Instance.new("Part")
roblox.implementMethod("BasePart", "TestMethod", function(instance, ...) print("Called TestMethod on instance", instance, "with", ...)end)
part:TestMethod("Hello", "world!")--> Called TestMethod on instance Part with Hello, world!
Parameters
Section titled “Parameters”-
className
The class to implement the method for. -
methodName
The name of the method to implement. -
callback
The function which will be called when the method is called.
studioApplicationPath
Section titled “studioApplicationPath”Returns the path to the system’s Roblox Studio executable.
There is no guarantee that this will exist, but if Studio is installed this is where it will be.
Example usage
Section titled “Example usage”local roblox = require("@lune/roblox")
local pathToStudio = roblox.studioApplicationPath()print("Studio is located at:", pathToStudio)
Returns
Section titled “Returns”- string
studioContentPath
Section titled “studioContentPath”Returns the path to the Content
folder of the system’s current Studio
install.
This folder will always exist if Studio is installed.
Example usage
Section titled “Example usage”local roblox = require("@lune/roblox")
local pathToContent = roblox.studioContentPath()print("Studio's content folder is located at:", pathToContent)
Returns
Section titled “Returns”- string
studioPluginPath
Section titled “studioPluginPath”Returns the path to the plugin
folder of the system’s current Studio
install. This is the path where local plugins are installed.
This folder may not exist if the user has never installed a local plugin. It will also not necessarily take into account custom plugin directories set from Studio.
Example usage
Section titled “Example usage”local roblox = require("@lune/roblox")
local pathToPluginFolder = roblox.studioPluginPath()print("Studio's plugin folder is located at:", pathToPluginFolder)
Returns
Section titled “Returns”- string
studioBuiltinPluginPath
Section titled “studioBuiltinPluginPath”Returns the path to the BuiltInPlugin
folder of the system’s current
Studio install. This is the path where built-in plugins like the ToolBox
are installed.
This folder will always exist if Studio is installed.
Example usage
Section titled “Example usage”local roblox = require("@lune/roblox")
local pathToPluginFolder = roblox.studioBuiltinPluginPath()print("Studio's built-in plugin folder is located at:", pathToPluginFolder)
Returns
Section titled “Returns”- string