RbxLibrary

What is a library?

In Roblox, the term library doesn't mean "an educational, academical place to gain informational knowledge." Rather, libraries in Roblox are simply extensions of the API, which include developer-created Lua code which can be included in any script with ease.

How do I use a library?

To find out what methods are in the library, you can first check for documentation on the wiki, or search the forums. A preferrable way, but slightly more complicated, is to use the library's built-in documentation.

First, we need to load the library, which can be done with the LoadLibrary function:

assert(LoadLibrary('RbxGui'))

That loads the contents of RbxGui, a library. However, we need to store it in a variable, to use it.

local RbxGui = assert(LoadLibrary('RbxGui'))

Now, to see the contents, we can use a simple loop, with the handy GetApi method:

for _, val in pairs(RbxGui:GetApi()) do
	print(val)
end

That will print everything in the table out for us, so we know at least what there is in there.

Then, we can find how to use the functions that are in the library using the Help function. All the libraries have an Help function that lets us know how to use the functions it contains. Let's try with the CreateSlider function:

local RbxGui = assert(LoadLibrary('RbxGui'))
print(RbxGui.Help("CreateSlider"))

This will print some informations about how to use the function in the output.

Existing Libraries

Here is a list of the currently existing libraries:

• RbxGui
• RbxUtility
• RbxStatus
• RbxGear
• RbxStamper