Skip to content

utils.md

Latest commit

 

History

History
146 lines (107 loc) · 6.85 KB

utils.md

File metadata and controls

146 lines (107 loc) · 6.85 KB
Raw

geode.utils

Summary

Small helpers under geode.utils are documented here. Larger ones have their own page. For signatures, use editor autocomplete from type stubs.

Libraries

Module Page Role
geode.utils.web web Async HTTP requests
geode.utils.base64 base64 Base64 encode and decode
geode.utils.permission permission OS permission checks
geode.utils.game game Exit, restart, uninstaller

Related top-level helpers outside this prefix:

Top-level helpers

These functions sit directly on geode.utils, not in a child table.

Function Role
formatSystemError Turn a system error code into text
getDisplayFactor Ratio of physical pixels to logical pixels on one axis
getInputTimestamp Latest input timestamp in seconds
getSafeAreaRect Safe area rectangle relative to the window size

platform

Function Role
getString Human-readable platform label for crash logs and compatibility checks
isWine Whether the Windows build runs under Wine. Always false on other platforms

thread

Read or set the current thread name for debugging and logging.

Function Role
getDefaultName Default thread name
getName Current name, or the default when no custom name was set
setName Assign a custom name

clipboard

geode.utils.clipboard reads and writes the system clipboard as plain text. Use it for paste into a text field or copy a result for the user.

Function Role
read Current clipboard text. Empty string when empty or read fails
write Copy text to the clipboard. Returns success as a boolean 
local clip = geode.utils.clipboard

local paste = clip.read()
if paste ~= "" then
    print("clipboard:", paste)
end

clip.write("copied from Luau")

random

geode.utils.random generates random strings and UUIDs from Geode's PRNG. They are not cryptographically secure.

Length arguments use the wide-integer binding rule. The stub types them as string. At runtime you must pass a decimal integer string such as "16", not a bare number.

Function Role
generateUUID Random UUID v4 string
generateHexString Random lowercase hex string with the given length
generateAlphanumericString Random string using [0-9A-Za-z]
generateString(length, alphabet) Random string from a custom alphabet. Length comes first, as an integer string. alphabet must not be empty
choice Random value from a dense, one-based array 
local rand = geode.utils.random

local id = rand.generateUUID()
print(id)

local token = rand.generateHexString("16")
print(token)

local code = rand.generateString("8", "ABCDEFGHJKMNPQRSTUVWXYZ23456789")
print(code)

local direction = rand.choice({ "left", "right" })
print(direction)

choice ignores non-array fields. It errors when the array is empty or has holes.

string

geode.utils.string holds small string helpers from Geode. They do not replace Luau's built-in string library.

Function Role
trim, trimLeft, trimRight Remove whitespace or a custom character set from ends
toLower, toUpper Case-changed copy
contains, startsWith, endsWith Substring tests
replace Swap every occurrence of one substring for another
remove Delete every occurrence of a substring
filter Keep only characters in a given set
normalize Collapse repeated spaces per Geode rules
count Count byte occurrences. Pass c as a byte value such as string.byte("e"). Result is a decimal integer string 
local str = geode.utils.string

local id = str.trim("  hello  ")
print(str.startsWith(id, "hel"))            -- true
print(str.replace(id, "hello", "world"))    -- world
print(str.count("hello", string.byte("l"))) -- "2"

Related

Source

  • src/bindings/geode/GeodeSmallBindings.cpp
  • tools/luau_codegen/model/free_fn_sources.py
  • tools/luau_codegen/emit/luau_types/manual_fields.py
  • tools/luau_codegen/policy/free_functions.py
  • build/luauapi-gen/src/
  • types/geode.d.luau