lune/docs/pages/Roblox - API Reference.md

API Reference

Welcome to the API reference page for the built-in roblox library!

All of the following static functions, classes, and datatypes can be imported using require("@lune/roblox").

Static Functions

readPlaceFile

Reads a place file into a DataModel instance.

local roblox = require("@lune/roblox")
local game = roblox.readPlaceFile("filePath.rbxl")

readModelFile

Reads a model file into a table of instances.

local roblox = require("@lune/roblox")
local instances = roblox.readModelFile("filePath.rbxm")

writePlaceFile

Writes a DataModel instance to a place file.

local roblox = require("@lune/roblox")
roblox.writePlaceFile("filePath.rbxl", game)

writeModelFile

Writes one or more instances to a model file.

local roblox = require("@lune/roblox")
roblox.writeModelFile("filePath.rbxm", { instance1, instance2, ... })

Classes

Instance

Currently implemented APIs:

• new - note that this does not include the second parent argument
• Clone
• Destroy
• ClearAllChildren
• FindFirstAncestor
• FindFirstAncestorOfClass
• FindFirstAncestorWhichIsA
• FindFirstChild
• FindFirstChildOfClass
• FindFirstChildWhichIsA
• FindFirstDescendant
• GetChildren
• GetDescendants
• GetFullName
• IsA
• IsAncestorOf
• IsDescendantOf

Not yet implemented, but planned:

• GetAttribute
• GetAttributes
• SetAttribute

DataModel

Currently implemented APIs:

• GetService
• FindService

Datatypes

Currently implemented datatypes:

• Axes
• BrickColor
• CFrame
• Color3
• ColorSequence
• ColorSequenceKeypoint
• Enum
• Faces
• Font
• NumberRange
• NumberSequence
• NumberSequenceKeypoint
• PhysicalProperties
• Ray
• Rect
• Region3
• Region3int16
• UDim
• UDim2
• Vector2
• Vector2int16
• Vector3
• Vector3int16

Note that these datatypes are kept as up-to-date as possible, but some very new members may be missing.