Lua from Modern Roblox (Luau): Difference between revisions

Latest revision as of 21:05, 18 October 2024

Work In Progress
This is currently being worked on! Check back later for more information... hopefully.

Lua in classic versions of Roblox does not differ much from the current year fundamentally - mostly just the lack of certain Lua functions. This page aims to document the majority of unavailable features as well as provide workarounds (AKA "polyfills").

Modern versions of Roblox use Luau, a scripting language heavily based on Lua 5.1 with performance and utility improvements. Luau is open-source.

Before Luau, Roblox used Lua 5.1, adding backported features over time. In classic versions (2006-2012), there are no backported features from later versions of Lua (as far as we know).

@@ Line 2: / Line 2: @@
+<!-- TODO:
+the rest of it.
+as well as go back and provide links to both modern documentation and, if it exists, documentation here on each thing, function, property, etc. -->
 Lua in classic versions of Roblox does not differ much from the current year fundamentally - mostly just the lack of certain Lua functions. This page aims to document the majority of unavailable features as well as provide workarounds (AKA "polyfills").
@@ Line 9: / Line 12: @@
 == Libraries ==
+[https://create.roblox.com/docs/en-us/reference/engine/libraries Modern documentation]
 === bit32 ===
 The bit32 library provides functions to perform bitwise operations. It was a backported feature from Lua 5.2, so it is unavailable.
+=== buffer ===
+A buffer is an object that represents a fixed-size mutable block of memory. The buffer library provides functions for creation and manipulation of buffer objects, providing all its functions inside the global buffer variable. Buffer provides a simple and faster way of working with compact binary data.
+Here, it is unavailable.
 === [[Function Dump/Coroutine Manipulation|coroutine]] ===
 The coroutine library provides coroutines, allowing multiple tasks to be performed at the same time within a single script.
-=== coroutine.close() ===
+==== coroutine.close() ====
 The close function is unavailable.
@@ Line 89: / Line 98: @@
 === task ===
-In later versions, the task library allows for functions and threads to be scheduled with the Task Scheduler. It is unavailable here.
+In later versions, the task library allows for functions and threads to be scheduled with the Task Scheduler. It is unavailable here. Instead, use <code>coroutine</code>, <code>delay</code>, <code>spawn</code>, and <code>wait</code>, or alternative implementations of these.
 === utf8 ===
@@ Line 97: / Line 106: @@
 === Lua Globals ===
+[https://create.roblox.com/docs/en-us/reference/engine/globals/LuaGlobals Modern documentation]
+The following is a list of functions and variables that are native to Lua. These functions can be used in a standard installation of Lua 5.1.4, though there are some differences in how some of these work on Roblox.
+==== rawlen() ====
+[https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#rawlen Modern documentation]
+The rawlen function is unavailable.
+=== Roblox Global Properties ===
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals Modern documentation link]
+Roblox has several unique built-in functions and variables in its Lua implementation. These are only found on Roblox and are not packaged by default with Lua.
+==== Functions ====
+===== DebuggerManager() =====
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals#DebuggerManager Modern documentation]
+The DebuggerManager function is unavailable.
+===== elapsedTime() =====
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals#elapsedTime Modern documentation]
+The elapsedTime function is unavailable.
+===== PluginManager() =====
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals#PluginManager Modern documentation]
+The PluginManager function is available in clients with plugin support (August 2011+).
+===== require() =====
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals#require Modern documentation]
+The require function is unavailable. (ModuleScripts were added in 2013.)
+===== typeof() =====
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals#typeof Modern documentation]
-=== Roblox Globals ===
+The typeof function is unavailable. To get the type of standard Lua data types, use Lua 5.1's built in <code>type</code> function.
+===== UserSettings() =====
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals#typeof Modern documentation]
+The UserSettings function is available in 2011+ clients.
+===== warn() =====
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals#warn Modern documentation]
+The warn function is unavailable.
+==== Properties ====
+===== plugin =====
+[https://create.roblox.com/docs/en-us/reference/engine/globals/RobloxGlobals#plugin Modern documentation]
+The plugin property is available in clients with plugin support (August 2011+).
 == Data Types ==
-=== CFrame ===
+=== [[Axes]] ===
+=== [[BrickColor]] ===
+=== CatalogSearchParams ===
+=== [[CFrame]] ===
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame Modern documentation]
+==== Constructors ====
+===== CFrame.lookAt() =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#lookAt Modern documentation]
+The lookAt function is unavailable. Instead, use <code>CFrame.new(pos, lookAt)</code> if <code>up</code> is not something other than <code>Vector3.new(0, 1, 0)</code>.
+===== CFrame.lookAlong() =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#lookAlong Modern documentation]
+The lookAlong function is unavailable.
+===== CFrame.fromEulerAngles() =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#fromEulerAngles Modern documentation]
+The fromEulerAngles function is unavailable.
+===== CFrame.fromEulerAnglesYXZ() =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#fromEulerAnglesYXZ Modern documentation]
+The fromEulerAnglesYXZ function is unavailable.
+===== CFrame.Angles() =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#Angles Modern documentation]
+The Angles function is available in 2010+ clients. For older clients, use the equivalent fromEulerAnglesXYZ function.
+===== CFrame.fromOrientation() =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#fromOrientation Modern documentation]
+The fromOrientation function is unavailable.
+===== CFrame.fromAxisAngle() =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#fromOrientation Modern documentation]
+The fromOrientation function is unavailable.
+===== CFrame.fromMatrix() =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#fromMatrix Modern documentation]
+The fromMatrix function is unavailable.
+==== Properties ====
+===== CFrame.identity =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#identity Modern documentation]
+The identity property is unavailable.
+===== CFrame.Position =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#Position Modern documentation]
+The Position property is unavailable. Instead, use the equivalent <code>p</code> property.
+===== CFrame.Rotation =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#Rotation Modern documentation]
+The Rotation property is unavailable.
+===== CFrame.LookVector =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#LookVector Modern documentation]
+The LookVector property is unavailable. Instead, use the equivalent <code>lookVector</code> (lowercase first letter) property.
+===== CFrame.RightVector =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#RightVector Modern documentation]
+The RightVector property is unavailable.
+===== CFrame.UpVector =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#UpVector Modern documentation]
+The UpVector property is unavailable.
+===== CFrame.XVector =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#XVector Modern documentation]
+The XVector property is unavailable.
+===== CFrame.YVector =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#YVector Modern documentation]
+The YVector property is unavailable.
+===== CFrame.ZVector =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#ZVector Modern documentation]
+The ZVector property is unavailable.
+==== Methods ====
+===== CFrame:Inverse =====
+[https://create.roblox.com/docs/en-us/reference/engine/datatypes/CFrame#Inverse Modern documentation]
+The Inverse method is unavailable. Instead, use the equivalent <code>inverse</code> (lowercase first letter) method.
+=== [[Color3]] ===
+=== ColorSequence ===
+=== ColorSequenceKeypoint ===
+=== Content ===
+=== DateTime ===
+=== DockWidgetPluginGuiInfo ===
+=== [[Enum]] ===
+=== EnumItem ===
+=== [[Enums]] ===
+=== [[Faces (DataType)|Faces]] ===
+=== FloatCurveKey ===
+=== Font ===
+=== Instance ===
+=== NumberRange ===
+=== NumberSequence ===
+=== NumberSequenceKeypoint ===
+=== OverlapParams ===
+=== Path2DControlPoint ===
+=== PathWaypoint ===
+=== PhysicalProperties ===
+=== Random ===
+=== [[Ray]] ===
+=== RaycastParams ===
+=== RaycastResult ===
+=== [[RBXScriptConnection]] ===
+=== [[RBXScriptSignal]] ===
+=== Rect ===
+=== [[Region3]] ===
+=== Region3int16 ===
+=== Secret ===
+=== SharedTable ===
+=== TweenInfo ===
+=== [[UDim]] ===
+=== [[UDim2]] ===
+=== [[Vector2]] ===
+=== Vector2int16 ===
+=== [[Vector3]] ===
+=== Vector3int16 ===

Lua from Modern Roblox (Luau): Difference between revisions

Latest revision as of 21:05, 18 October 2024

Libraries

bit32

buffer

coroutine.close()

coroutine.isyieldable()

debug

math.clamp()

math.noise()

math.round()

math.sign()

os

string.pack()

string.packsize()

string.split()

string.unpack()

table.clear()

table.clone()

table.create()

table.find()

table.freeze()

table.isfrozen()

table.move()

table.pack()

table.unpack()

task

utf8

Globals

Lua Globals

rawlen()

Roblox Global Properties

Functions

DebuggerManager()

elapsedTime()

PluginManager()

require()

typeof()

UserSettings()

warn()

Properties

plugin

Data Types

CatalogSearchParams

Constructors

CFrame.lookAt()

CFrame.lookAlong()

CFrame.fromEulerAngles()

CFrame.fromEulerAnglesYXZ()

CFrame.Angles()

CFrame.fromOrientation()

CFrame.fromAxisAngle()

CFrame.fromMatrix()

Properties

CFrame.identity

CFrame.Position

CFrame.Rotation

CFrame.LookVector

CFrame.RightVector

CFrame.UpVector

CFrame.XVector

CFrame.YVector

CFrame.ZVector

Methods

CFrame:Inverse

ColorSequence

ColorSequenceKeypoint

Content

DateTime

DockWidgetPluginGuiInfo

EnumItem

FloatCurveKey

Font

Instance

NumberRange

NumberSequence

NumberSequenceKeypoint

OverlapParams

Path2DControlPoint

PathWaypoint