Scripting

For beginner tutorials, go to the Lua Help page.

This article is a portal for Roblox scripting and related articles.

Lua Programming Language

ROBLOX uses Lua 5.1, a simple scripting language that can be embedded into games or programs (parent applications). ROBLOX developers have added in functionality to Lua so that users can create interactive content, like tools, buttons, leaderboards, and more.

• Lua Website
• Programming in Lua (first edition)
• Lua Documentation

Tutorials

The Roblox Wiki offers many tutorials for learning Lua.

• Lua Help
• Scripting Book

Environments and Libraries

An environment can be described as a place where variables live. Each script has its own environment.

• Environment

A library is a group of functions that can be used to make scripting easier. For security purposes, some functions have been removed from Roblox to prevent access to system resources.

ROBLOX loads the coroutine, string, table, math, and basic function libraries.

• Function Dump

Math

One important feature that all programming languages use is math. For more information, and usage, read the following articles:

• Basic math
• Variables
• Conditional statements
• Random numbers
• How To Increase and Decrease Vector3 Values

Types

All values in Lua have their own type. These values can be stored in variables, passed as arguments to other functions, and returned as results.

• Data Types

Basic Types

Every value in Lua will be one of these types:

• nil
• boolean
• number
• string
• function
• userdata
• thread
• table

Roblox-Defined Types

These are special types created by and available only in Roblox.

• Vector3 -- Represents 3-dimensional coordinates. These are used for things like a brick's size or position.
• Vector2 -- Represents 2-dimensional coordinates.
• CFrame -- Holds a position and a rotation. These define the rotation of bricks.
• Color3 -- Makes colors using an RGB format.
• BrickColor -- Defines a specific color for bricks.
• UDim2 -- Holds a Scale and Offset position for Guis.

Global Functions

Roblox defines the following global variables (and many others):

• game

  is a reference to the DataModel instance that is the root of the object hierarchy.

• Workspace

  is a shortcut for the Workspace instance that is a child of the DataModel.

• script

  is a reference to the Script instance that is the owner of the referencing code. (not applicable for the Command toolbar)

• print(...)

  echoes each argument to the output panel.

• error(e,level)

  the Roblox implementation of error is much the same as print, echoing the first argument (in red text) to the output panel, only raising an error as well.

• time()

  returns the current game time in seconds. Is simply an accessor for the game's internal time count, such that the statement

  time() == time()

  is true.

• tick()

  returns the OS time in seconds, queries the OS every time it is called, such that the statement

  tick() == tick()

  is false.

• wait(t)

  yields the current thread and resumes it after "t" seconds have elapsed. If t is not specified, then it yields for one frame (approx. 1/30 sec). The function returns 2 values: The elapsed time and the current game time.

• delay(t, f)

  Asynchronously executes function "f" after "t" seconds have elapsed. The function "f" is called with 2 arguments: The elapsed time and the current game time.

• Spawn(f)

  This function spawns a new thread. Argument "f" is a function that will execute in a new Thread.

• LoadLibrary(library)

  Loads the library "library." The argument to this function is a string. The most commonly loaded library is RbxGui.

Roblox Objects

Objects are what make Roblox work. Everything seen in-game is an object, as well as everything visible in the Explorer panel. All Objects have Properties, Functions and Events.

• Class Reference

Common Mistakes

The slightest misspelling, or even incorrect capitalization will result in your script failing to work. REMEMBER: Look at the Output to check for errors. If this doesn't help, back-track and make sure everything is perfect. If you think there is a problem, or you need help in general, request help on the Forum.

See Common Scripting Mistakes and Debugging. For more help, see the 'See Also' section at the bottom of the page.

See Also

In the beginning:...

• Your First Script
• Basic Scripting
• Loops
• How To Increase and Decrease Vector3 Values
• In-Depth Scripting Guide

Scripting Tutorials and Articles:

• In-Depth Scripting Guide
• Teleportation
• How to Make Conveyor Belts
• How to make circles

General Information:

• Random numbers
• Conditional statements
• Variables
• Flowcharts
• Generic for
• Bool
• String
• Linked lists
• Functions
• Tables

Support:

• Bug log