> ## Documentation Index
> Fetch the complete documentation index at: https://luau.limerence.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Rivals

> Rivals-only local-player calls: equipped item, duel state, aim, level, ELO.

**Rivals only.** Guard with `if api.client.x then` before calling on other games.

## Getters

| Call                 | Returns         | What it tells you                                                                                               |
| -------------------- | --------------- | --------------------------------------------------------------------------------------------------------------- |
| `getEquipped()`      | `EquippedItem?` | Your equipped fighter item (`{ Name, Rounds?, Capacity? }`). See [EquippedItem](/reference/types#client-types). |
| `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.                                                                                             |

## Signals

Call `:Connect(callback)` on these. They get cleaned up when your script unloads.

| Signal              | Your callback receives              |
| ------------------- | ----------------------------------- |
| `onEquippedChanged` | `(item)`: your fighter item changed |

## Example

```luau theme={null}
if api.client.isInDuel then
    api.client.onEquippedChanged:Connect(function(item)
        print("equipped:", item and item.Name)
    end)
end
```