Skip to content

Player

Methods of Player objects. Nyx Lua API v1.

Player:index() -> number?

Entity index; nil once the player is gone (as every Player method).

Player:name() -> string?

Name.

Player:steam_id() -> string?

SteamID64 as a string ("BOT" for bots).

Player:team() -> number?

Team number (2 T, 3 CT).

Player:is_enemy() -> boolean?

On the other playing team (everyone else in deathmatch). Spectators and unassigned players never are.

Player:is_alive() -> boolean?

Alive.

Player:is_dormant() -> boolean?

Not networked this frame.

Player:is_local() -> boolean?

The local player.

Player:health() -> number?

Health.

Player:armor() -> number?

Armour.

Player:has_helmet() -> boolean?

Has a helmet.

Player:has_defuser() -> boolean?

Has a defuse kit.

Player:money() -> number?

Money.

Player:origin() -> vector?

Feet position.

Player:velocity() -> vector?

Velocity.

Player:eye_pos() -> vector?

Eye position.

Player:bone(name: string) -> vector?

A bone: pelvis, spine_0..2, neck_0, head, chest, arm_upper_L, ... ankle_R.

Player:hitbox(name: string) -> vector?

A hitbox centre: head, neck, chest, stomach, pelvis.

Player:bbox() -> (number?, number?, number?, number?)

Screen box x0, y0, x1, y1, or nil off screen.

Player:is_visible() -> boolean?

Visible from the local player's eyes. nil when the trace is refused: during a level change, outside a match, in frame_stage on any stage but 5 (render start), or when either player's pawn is no longer the one this frame saw.

Player:flags() -> { on_ground: boolean, ducking: boolean, scoped: boolean, flashed: boolean }?

Movement and state flags.

Player:weapon() -> { name: string, class: string, def_index: number, clip: number, reserve: number, inaccuracy: number }?

The active weapon.

Player:view_angles() -> vector?

Local player only: pitch, yaw, roll.

Player:observer_target() -> Player?

Local player only: who the camera follows.