Namespaces

player

Methods

Returns true if the player is connected

function player.is_connected(index: int): bool

-- example usage
local connected = player.is_connected(--[[index]])

Returns true if the player is in a vehicle

function player.is_in_vehicle(index: int): bool

-- example usage
local in_vehicle = player.is_in_vehicle(--[[index]])

Returns true if the player is alive

function player.is_alive(index: int): bool

-- example usage
local alive = player.is_alive(--[[index]])

Returns the player's name

function player.get_name(index: int): string

-- example usage
local name = player.get_name(--[[index]])

Returns the player's ped as a script guid

function player.get_ped(index: int): int

-- example usage
local ped = player.get_ped(--[[index]])

Returns the player's mount as a script guid

function player.get_mount(index: int): int

-- example usage
local mount = player.get_mount(--[[index]])

Returns the player's owned mount as a script guid

function player.get_owned_mount(index: int): int

-- example usage
local owned_mount = player.get_owned_mount(--[[index]])

Returns the player's top-level entity as a script guid

function player.get_entity(index: int): int

-- example usage
local entity = player.get_entity(--[[index]])

Returns the player's current heading

function player.get_heading(index: int): float

-- example usage
local heading = player.get_heading(--[[index]])

Returns the player's current health

function player.get_health(index: int): float

-- example usage
local health = player.get_health(--[[index]])

Returns the player's ip

function player.get_ip(index: int): int, int, int, int

-- example usage
local b1, b2, b3, b4 = player.get_ip(--[[index]])

Returns the player's port

function player.get_port(index: int): int

-- example usage
local port = player.get_port(--[[index]])

Returns the player's rockstar id

function player.get_rockstar_id(index: int): int

-- example usage
local rid = player.get_rockstar_id(--[[index]])