> ## 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.

# Overview

> api.client: you (your local player), position, health, weapon, team, and status.

Read what your local player is doing right now: who you are, where you are, your team, weapon, health, and status effects like being scoped, flashed, or defusing. Every getter returns the current value the moment you call it. Use the signals to run code the instant something changes.

Anything that needs a character (like position or health) comes back as `nil` or `0` while you're dead or respawning, so always check before you use it.

`api.client` has a shared core that works in every game, plus a few per-game extras. In Phantom Forces and Overkill, only the `onHit` / `onKill` signals exist — none of the getters or other signals. In [universal mode](/universal/overview) the shared core is there too, and it reads whatever your resolvers tell it. See [Game support](/game-support) for how to write scripts that run anywhere.

<CardGroup cols={2}>
  <Card title="Shared" icon="globe" href="/client/shared">
    Identity, character, health, position, velocity, team, plus your hit / kill signals.
  </Card>

  <Card title="Bloxstrike" icon="bomb" href="/client/bloxstrike">
    Weapon, ammo, money, armor, flash, scope, defuse, hostages, spectators.
  </Card>

  <Card title="Rivals" icon="swords" href="/client/rivals">
    Equipped item, duel state, aim, level, ELO.
  </Card>

  <Card title="Apocalypse Rising 2" icon="radiation" href="/client/apocalypse-rising-2">
    Held item, hydration, energy, vehicle, inventory.
  </Card>

  <Card title="Types" icon="brackets-curly" href="/reference/types#client-types">
    ArmorState, AmmoState, LoadoutEntry, EquippedItem, Item.
  </Card>
</CardGroup>