Player
Methods of Player objects. Nyx Lua API v1.
Player:index
Section titled Player:indexPlayer:index() -> number?Entity index; nil once the player is gone (as every Player method).
Player:name
Section titled Player:namePlayer:name() -> string?Name.
Player:steam_id
Section titled Player:steam_idPlayer:steam_id() -> string?SteamID64 as a string ("BOT" for bots).
Player:team
Section titled Player:teamPlayer:team() -> number?Team number (2 T, 3 CT).
Player:is_enemy
Section titled Player:is_enemyPlayer:is_enemy() -> boolean?On the other playing team (everyone else in deathmatch). Spectators and unassigned players never are.
Player:is_alive
Section titled Player:is_alivePlayer:is_alive() -> boolean?Alive.
Player:is_dormant
Section titled Player:is_dormantPlayer:is_dormant() -> boolean?Not networked this frame.
Player:is_local
Section titled Player:is_localPlayer:is_local() -> boolean?The local player.
Player:health
Section titled Player:healthPlayer:health() -> number?Health.
Player:armor
Section titled Player:armorPlayer:armor() -> number?Armour.
Player:has_helmet
Section titled Player:has_helmetPlayer:has_helmet() -> boolean?Has a helmet.
Player:has_defuser
Section titled Player:has_defuserPlayer:has_defuser() -> boolean?Has a defuse kit.
Player:money
Section titled Player:moneyPlayer:money() -> number?Money.
Player:origin
Section titled Player:originPlayer:origin() -> vector?Feet position.
Player:velocity
Section titled Player:velocityPlayer:velocity() -> vector?Velocity.
Player:eye_pos
Section titled Player:eye_posPlayer:eye_pos() -> vector?Eye position.
Player:bone
Section titled Player:bonePlayer:bone(name: string) -> vector?A bone: pelvis, spine_0..2, neck_0, head, chest, arm_upper_L, ... ankle_R.
Player:hitbox
Section titled Player:hitboxPlayer:hitbox(name: string) -> vector?A hitbox centre: head, neck, chest, stomach, pelvis.
Player:bbox
Section titled Player:bboxPlayer:bbox() -> (number?, number?, number?, number?)Screen box x0, y0, x1, y1, or nil off screen.
Player:is_visible
Section titled Player:is_visiblePlayer: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
Section titled Player:flagsPlayer:flags() -> { on_ground: boolean, ducking: boolean, scoped: boolean, flashed: boolean }?Movement and state flags.
Player:weapon
Section titled Player:weaponPlayer:weapon() -> { name: string, class: string, def_index: number, clip: number, reserve: number, inaccuracy: number }?The active weapon.
Player:view_angles
Section titled Player:view_anglesPlayer:view_angles() -> vector?Local player only: pitch, yaw, roll.
Player:observer_target
Section titled Player:observer_targetPlayer:observer_target() -> Player?Local player only: who the camera follows.
Nyx Lua API v1 · release commit-4b659d9c3810 · d0f772c99281