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

​
Handle methods

MethodReturnsWhat it tells you
getEnvironmentId()stringTheir environment/zone id.
getItems(){ string }Names of items they carry.
getVelocity()Vector3Their velocity.
getLevel() / getWinStreak() / getDisplayElo()numberAccount level, win streak, ELO.
isInDuel() / isSpectating() / isCrouching() / isSliding() / isFirstPerson()booleanMovement / duel state.
isFrozen() / isInvincible() / isHidden() / isBlocking() / isDeflecting()booleanCombat / visibility state.
isHealing()booleantrue while they use a medkit.

​
Signals

Call :Connect(callback) on these; your callback gets player first. They get cleaned up when your script unloads.
SignalYour callback receives
onEnvironmentChanged(player, environmentId)
onFrozenChanged(player, frozen)
onInvincibleChanged(player, invincible)
onDuelChanged(player, inDuel)
onBlockingChanged(player, blocking)
onDeflectingChanged(player, deflecting)
onHealingChanged(player, healing)

​
Example

if api.players.onDuelChanged then
    api.players.onDuelChanged:Connect(function(player, inDuel)
        print(player.Name, inDuel and "entered a duel" or "left a duel")
    end)
end