The Roblox API Reference project aims to provide a quick and accessible reference for the Roblox Lua API.
This site is generated by the
rbxapiref tool, the source of
which is available on GitHub. The
rbxapiref tool parses the machine-generated "API dumps"
from each version of Roblox, and presents the derived information as a
human-readable website. An API dump is a file containing data about the
elements of the API, including classes, members, enums, types, and more.
Hand-written, supplementary documentation may be found in generated pages, derived from the robloxapi/doc repository. The documentation status page shows the progress for documentation across the site.
This project is an alternative to the Roblox Developer Hub API Reference Manual. The DevHub provides official, canonical, up-to-date documentation for the Roblox Lua API.
This site is hosted statically on GitHub Pages.
If you find a bug, have a suggestion, or otherwise wish to contribute, you may post an issue or make a pull request on the issues page.
Roblox is the best place to Imagine with Friends. With the largest user-generated online gaming platform, and over 15 million games created by users, Roblox is the #1 gaming site for kids and teens (comScore). Every day, virtual explorers come to Roblox to create adventures, play games, role play, and learn with their friends in a family-friendly, immersive, 3D environment.
Lua is a powerful, efficient, lightweight, embeddable scripting language. It supports procedural programming, object-oriented programming, functional programming, data-driven programming, and data description.
The source code of the
rbxapiref tool is available under the MIT license.
This site and non-generated documentation is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
This site is not affiliated with Roblox Corporation.