Skip to main content
Rivals only. Guard with if api.client.x then before calling on other games.

Getters

CallReturnsWhat it tells you
getEquipped()EquippedItem?Your equipped fighter item ({ Name, Rounds?, Capacity? }). See EquippedItem.
getEnvironmentId()stringCurrent environment/zone id ("" when none).
isInDuel()booleantrue while you’re in a duel.
isCrouching()booleantrue while crouched.
isSliding()booleantrue while sliding.
isFirstPerson()booleantrue while in first person.
isFrozen()booleantrue while your entity is frozen.
isInvincible()booleantrue while your entity has spawn protection / is invincible.
isHidden()booleantrue while hidden (emote / cutscene).
getVelocity()Vector3Your current velocity.
getAimCFrame()CFrameYour aim CFrame.
getControls()stringCurrent controls/state string.
getItems(){ string }Names of items you’re carrying.
getLevel()numberYour account level.
getWinStreak()numberYour duels win streak.
getDisplayElo()numberYour displayed ELO.

Signals

Call :Connect(callback) on these. They get cleaned up when your script unloads.
SignalYour callback receives
onEquippedChanged(item): your fighter item changed

Example

if api.client.isInDuel then
    api.client.onEquippedChanged:Connect(function(item)
        print("equipped:", item and item.Name)
    end)
end