Function Dump/Roblox Specific Functions

< [[Function Dump]] | [[Roblox Specific Functions]]

Unlocked Functions

These functions, methods and otherwise were added to Lua by the developers to make scripting easier and more powerful. These may include functions for specific objects, such as Vector3 or CFrame classes. They are listed here as well as on the Scripting page for easier reference.

Delay(Float t, Function f) or delay(Float t, Function f)

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

Example

function returntime(delay, gametime)
   print("The delay was " .. delay)
   print("The game time is " .. gametime)
end

Delay(4, returntime)

Will result in:

The delay was 4.0257607937525
The game time is 61.028665867139

LoadRobloxLibrary(String libraryName)

Returns a library, 'libraryName' if it exists. Else, it returns nil and an error message for use with the assert function. Its a sort of copy of LoadLibrary except LoadRobloxLibrary can be used by anyone.

Example

local lib=assert(LoadRobloxLibrary("RbxGui"))
print(lib)
local lib2=assert(LoadRobloxLibrary("InexistantLibrary"))
print(lib2)
--> errors "Unknown library InexistantLibrary" because of assert

print(v, ···)

Whatever parameters are inside print(), it will put in the output as a string to be seen.

This is very useful for sending information about how a script is running to the output window. There is no restrictions to what can be used in print(). print() has an infinite number of parameters, and will put them all in the output in a line.

Example

a = 5
print(a)

Will result in:

5

---

print("Hello, world!")

Will result in:

Hello, world!

---

print("hello",3,"everyone!")

Will result in:

hello  3  everyone!

printidentity(v, ···)

Echos the security level of the current thread, and the last argument passed in, if supplied.

Example

printidentity()

Will result in:

Current identity is 2

---

printidentity(1, 5)

Will result in:

5 2

Spawn(Function f)

Executes function "f" after thread next yields. The function "f" is called with 2 arguments: The elapsed time and the current game time.

Example

function returntime(delay, gametime)
   print("The delay was " .. delay)
   print("The game time is " .. gametime)
end

Spawn(returntime)

Will result in:

The delay was 0.038302775910779 
The game time is 61.028665867139

tick()

Returns the time in UNIX time, which is the number of seconds since the Unix epoch, January 1st, 1970. This time advances without game running, network synchronization, or wait(). Using tick() in a LocalScript may result in a differrent number that if you were to use it in a Script, which will fetch a user's computer time. tick() is very accurate. Because of its high accuracy, it can be used to measure the time a certain function takes to execute by calling it before and after an operation has been done, then finding the difference.

Example

print( math.floor( tick() / (60 * 60 * 24) ) )

Results in how many days have passed since January 1, 1970.

Example

now = tick();
a = 50;
b = 250;
c = a + b;
later = tick();
print(later - now);

Results in how many seconds it took to fetch a and b, to add them together, and to store them to c.

More information on tick can be found here

time()

Returns returns the current game time in seconds. Game time only updates during wait() and must be synchronized across network.

Example

Start your place and let it run for a little while. In the Command Line type:

print(time())

Will result in some number, indicating how many seconds the game has been running for.

version() or Version()

Returns Roblox's current version.

Example

print(version())

Will result in a string that represents the current version of your roblox client. Formatted as x.x.x.x

Wait(Float t) or wait(Float t)

Yields the current thread until "t" seconds have elapsed. If t is not specified, then it yields for a very short period of time (usually close to 1/30th of a second). The function returns 2 values: The elapsed time and the current game time.

Example

print(Wait(1))

Will result in:

1.004991560393 566.78806415454

Locked Functions

These are functions that are used by the game to protect it, its clients, and its clients' computers. Using them will cause an error unless you are using the Command Bar or a CoreScript.

crash__()

Crashes the game. This is used by the game when it can no longer function correctly. You can run it in your Command Bar but make sure you save your work prior to that.

Example

If using the Command Bar or a CoreScript...

crash__() --> crashes the game

If using a Script or LocalScript...

crash__() --> Unknown exception

LoadLibrary(String libraryName)

Returns a developer library, 'libraryName' if it exists. Else, it returns nil and an error message for use with the assert function. Its a sort of copy of LoadRobloxLibrary except LoadLibrary is restricted for Roblox developers only.

Example

local lib=assert(LoadLibrary("RbxGui"))
print(lib)
local lib2=assert(LoadLibrary("InexistantLibrary"))
print(lib2)
--> errors "Unknown library InexistantLibrary" because of assert

settings()

Returns the Client's Global Settings object. The Global Settings this returns are the exact same as the settings you see when you go to Tools > Settings.

Example

If you're using the Command Bar or a CoreScript...

print( settings() ) --> Global Settings

If you're using a Script or a LocalScript...

print( settings() ) --> Unknown exception

Stats() or stats()

Returns the Client's Stats object. The Stats it returns are the ones you see on you screen when you press CTRL+F1 or CTRL+F2 in a game.

Example

If you're using the Command Bar or a CoreScript...

print( stats() ) --> Stats
print( stats() == game.Stats ) --> true

If you're using a Script or a LocalScript...

print( stats() ) --> Unknown exception
print( stats() == game.Stats ) --> Unknown exception

UserSettings()

Returns the Client's GlobalBasicSettings object. The GlobalSettings this returns are edited when you use the Control Editor to change your controls.

Example

If you're using the Command Bar or a CoreScript...

print( UserSettings().className == "GlobalBasicSettings" ) --> true

If you're using a Script or a LocalScript...

print( UserSettings().className == "GlobalBasicSettings" ) --> Unknown exception