if api.client.x then before calling on other games.
Getters
Signals
Call:Connect(callback) on these. They get cleaned up when your script unloads.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Rivals-only local-player calls: equipped item, duel state, aim, level, ELO.
if api.client.x then before calling on other games.
| Call | Returns | What it tells you |
|---|---|---|
getEquipped() | EquippedItem? | Your equipped fighter item ({ Name, Rounds?, Capacity? }). See EquippedItem. |
getEnvironmentId() | string | Current environment/zone id ("" when none). |
isInDuel() | boolean | true while you’re in a duel. |
isCrouching() | boolean | true while crouched. |
isSliding() | boolean | true while sliding. |
isFirstPerson() | boolean | true while in first person. |
isFrozen() | boolean | true while your entity is frozen. |
isInvincible() | boolean | true while your entity has spawn protection / is invincible. |
isHidden() | boolean | true while hidden (emote / cutscene). |
getAimCFrame() | CFrame | Your aim CFrame. |
getControls() | string | Current controls/state string. |
getItems() | { string } | Names of items you’re carrying. |
getLevel() | number | Your account level. |
getWinStreak() | number | Your duels win streak. |
getDisplayElo() | number | Your displayed ELO. |
:Connect(callback) on these. They get cleaned up when your script unloads.
| Signal | Your callback receives |
|---|---|
onEquippedChanged | (item): your fighter item changed |
if api.client.isInDuel then
api.client.onEquippedChanged:Connect(function(item)
print("equipped:", item and item.Name)
end)
end