Skip to main content
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 the shared core is there too, and it reads whatever your resolvers tell it. See Game support for how to write scripts that run anywhere.

Shared

Identity, character, health, position, velocity, team, plus your hit / kill signals.

Bloxstrike

Weapon, ammo, money, armor, flash, scope, defuse, hostages, spectators.

Rivals

Equipped item, duel state, aim, level, ELO.

Apocalypse Rising 2

Held item, hydration, energy, vehicle, inventory.

Types

ArmorState, AmmoState, LoadoutEntry, EquippedItem, Item.