Miscellaneous
The miscellaneous functions are a temporary collection of functions that are not yet categorized.
identifyexecutor
function identifyexecutor(): (string, string)Returns the name and version of the current executor.
Aliases
getexecutorname
lz4compress
function lz4compress(data: string): stringCompresses data using LZ4 compression.
Parameters
data- The uncompressed data.
Example
local text = "Hello, world! Hello, world! Goodbye, world!"
print(#text) --> 43
print(#lz4compress(text)) --> 34lz4decompress
function lz4decompress(data: string, size: number): stringDecompresses data using LZ4 compression, with the decompressed size specified by size.
Parameters
data- The compressed data.size- The size of the decompressed data.
Example
local text = "Hello, world! Hello, world!"
local compressed = lz4compress(text)
print(lz4decompress(compressed, #text)) --> "Hello, world! Hello, world!"messagebox
⏰ Yields
function messagebox(text: string, caption: string, flags: number): numberCreates a message box with the specified text, caption, and flags. Yields until the message box is closed, and returns the user input code.
Documentation regarding the flags and return codes can be found here.
Parameters
text- The text to display in the message box.caption- The caption of the message box.flags- The flags to use.
Example
Prompts the user with a message box with three options and a warning icon:
local MB_ICONWARNING = 0x00000030
local MB_CANCELTRYCONTINUE = 0x00000006
local MB_DEFBUTTON2 = 0x00000100
local IDCANCEL = 0x00000002
local IDTRYAGAIN = 0x00000004
local IDCONTINUE = 0x00000005
local input = messagebox(
"Resource not available\nDo you want to try again?",
"Resource not found",
bit32.bor(MB_ICONWARNING, MB_CANCELTRYCONTINUE, MB_DEFBUTTON2)
)
if input == IDCANCEL then
print("Canceled")
elseif input == IDTRYAGAIN then
print("Try again")
elseif input == IDCONTINUE then
print("Continue")
endqueue_on_teleport
function queue_on_teleport(code: string): ()Queues the specified script to be executed after the player teleports to a different place.
Parameters
code- The script to execute.
Aliases
queueonteleport- Will supercede this function in the future.
Example
local source = game:GetObjects("rbxassetid://1234")[1].Source
queue_on_teleport(source)
loadstring(source)()request
⏰ Yields
function request(options: HttpRequest): HttpResponseSends an HTTP request using the specified options. Yields until the request is complete, and returns the response.
Request
Url
string
The URL for the request.
Method
string
The HTTP method to use. Can be GET, POST, PATCH, or PUT.
Body
string?
The body of the request.
Headers
table?
A table of headers.
Cookies
table?
A table of cookies.
Response
Body
string
The body of the response.
StatusCode
number
The number status code of the response.
StatusMessage
string
The status message of the response.
Success
boolean
Whether or not the request was successful.
Headers
table
A dictionary of headers.
Headers
The executor provides the following headers for identification on a web server:
PREFIX-User-Identifier
A string unique to each user, and does not change if the script executor is used across computers.
PREFIX-Fingerprint
The hardware identifier of the user.
User-Agent
The name and version of the executor.
Parameters
options- The options to use.
Aliases
http.requesthttp_request
Example
local response = request({
Url = "http://example.com/",
Method = "GET",
})
print(response.StatusCode .. " - " .. response.StatusMessage) --> 200 - HTTP/1.1 200 OKsetclipboard
function setclipboard(text: string): ()Copies text to the clipboard.
Parameters
text- The text to copy.
Aliases
toclipboard
Example
local character = game:GetService("Players").LocalPlayer.Character
local components = table.pack(character.PrimaryPart.CFrame:GetComponents())
setclipboard("CFrame.new(" .. table.concat(components, ", ") .. ")")setfpscap
function setfpscap(fps: number): ()Sets the in-game FPS cap to fps. If fps is 0, the FPS cap is disabled.
Parameters
fps- The FPS cap.
Example
setfpscap(0) -- Unlocks the FPS capLast updated