Skip to content

Utility

Miscellaneous utility functions for common tasks like clipboard management, executor identification, window state, and more.

identifyexecutor

Returns the name and version of the executor.

Aliases: getexecutorname, whatexecutor

lua
identifyexecutor() -> string, string

Returns:

  • string — Executor name (e.g., "Volcano")
  • string — Executor version

Example

lua
local name, version = identifyexecutor()
print(name, version) --> "Volcano" "1.0.0"

gethwid

Returns a unique hardware identifier string for the current machine.

lua
gethwid() -> string

Example

lua
local hwid = gethwid()
print("HWID:", hwid)

randomstring

Generates a random alphanumeric string of the specified length.

lua
randomstring(length: number) -> string
ParameterTypeDescription
lengthnumberThe desired string length

Example

lua
local str = randomstring(16)
print(str) --> e.g. "a8Fb3kL9mNp2qR7x"

info

Prints system and executor information to the output.

lua
info() -> void

Example

lua
info() -- Prints executor info

messagebox

Displays a Windows MessageBox dialog. Returns the button clicked.

lua
messagebox(text: string, caption: string?, type: number?) -> number
ParameterTypeDefaultDescription
textstringMessage body text
captionstring?""Window title
typenumber?0MessageBox type flags

Common Type Values

ValueButtons
0OK
1OK / Cancel
4Yes / No
3Yes / No / Cancel

Example

lua
local result = messagebox("Do you want to continue?", "Confirm", 4)
if result == 6 then -- 6 = Yes
    print("User clicked Yes")
end

setfpscap

Sets the FPS (frames per second) cap. Pass 0 to uncap.

Aliases: unlockfps, fpsunlock, fpsunlocker, setfps, setfpsmax, setfpslimit

lua
setfpscap(fps: number) -> void
ParameterTypeDescription
fpsnumberThe FPS cap to set (0 to uncap)

Example

lua
setfpscap(240) -- Cap at 240 FPS
setfpscap(0)   -- Uncap FPS

isrbxactive

Returns true if the Roblox game window is currently focused/active.

Aliases: isgameactive, isrobloxactive, isfocused, iswindowactive

lua
isrbxactive() -> boolean

Example

lua
if isrbxactive() then
    print("Game window is focused")
else
    print("Game window is not focused")
end

setclipboard

Copies data to the system clipboard.

Aliases: setrbxclipboard, toclipboard

lua
setclipboard(data: string) -> void
ParameterTypeDescription
datastringThe text to copy to clipboard

Example

lua
setclipboard("Hello, clipboard!")
print("Text copied!")

isnetworkowner

Returns true if the local client is the network owner of the given BasePart.

lua
isnetworkowner(part: BasePart) -> boolean
ParameterTypeDescription
partBasePartThe part to check ownership of

Example

lua
local part = workspace.Part
if isnetworkowner(part) then
    print("We own this part's physics")
end

getfflag

Returns the value of a Roblox Fast Flag.

Aliases: getflag, get_fflag

lua
getfflag(name: string) -> string
ParameterTypeDescription
namestringThe FFlag name

Example

lua
local value = getfflag("TaskSchedulerTargetFps")
print("Target FPS:", value)

setfflag

Sets the value of a Roblox Fast Flag.

Aliases: setflag, set_fflag

lua
setfflag(name: string, value: string) -> void
ParameterTypeDescription
namestringThe FFlag name
valuestringThe value to set

Example

lua
setfflag("TaskSchedulerTargetFps", "240")

Global Variables

Volcano_Loaded

A boolean that is true once Volcano has fully initialized.

lua
if Volcano_Loaded then
    print("Volcano is ready!")
end

IsVolcano

A boolean that is true when the script is running inside Volcano.

lua
if IsVolcano then
    print("Running in Volcano")
end

shared

A shared table accessible across all scripts. Useful for cross-script communication.

lua
shared.myValue = 42
-- In another script:
print(shared.myValue) --> 42

_G

The global table shared between all scripts. Similar to shared.

lua
_G.counter = (_G.counter or 0) + 1
print("Script executed", _G.counter, "times")