Skip to main content
Every script gets one api table. You can read its fields but not replace them. Limerence runs in more than one game, so which namespaces exist (and which calls live inside them) depends on where you are. See Game support before writing scripts meant to run in more than one game.

​
Members

​
name
string
required
Your script’s filename, without the .luau extension. Anything you save uses this as a prefix: luau.{api.name}.{key}.
​
ui
table
required
Tabs, sections, widgets. UI overview.
​
utility
table
required
Signal connect and the asset index. Utility.
​
bind
table
required
Keybinds the user set on UI elements. Bind.
​
legitbot
table
required
Aim / triggerbot state and hooks. Legitbot.
​
ragebot
table
Automatic ragebot fire. Bloxstrike, Rivals, and Apocalypse Rising 2. Ragebot.
​
autoloot
table
Watch and shape the Auto Loot feature. Apocalypse Rising 2 only. Autoloot.
​
client
table
required
Your local player: shared core plus per-game extras. Client.
​
players
table
required
Every other player in the match. Players.
​
game
table
required
Match state. Contents differ per game (Bloxstrike: bomb/hostages/gamemode/dropped items; Rivals: match/placeables; Apocalypse Rising 2: world pings). Game.
​
onUnload
function
required
Run a callback once when the script unloads. See onUnload below.

​
onUnload

api.onUnload(callback: () -> ()): ()
Run your callback once when the script unloads (manual unload, file delete, or reload). Use this for anything auto-cleanup doesn’t handle, like stopping a listener you created with OnChange or OnUpdate. 
local stop = handle:OnUpdate(applyColor)
api.onUnload(stop)

UI

Utility

Bind

Legitbot

Ragebot

Autoloot

Client

Players

Game

Types