Skip to content

player


is_connected

bool player.is_connected(int index)

Returns true if the player is connected
Example Usage
local connected = player.is_connected(--[[index]])

is_in_vehicle

bool player.is_in_vehicle(int index)

Returns true if the player is in a vehicle
Example Usage
local in_vehicle = player.is_in_vehicle(--[[index]])

is_alive

bool player.is_alive(int index)

Returns true if the player is alive
Example Usage
local alive = player.is_alive(--[[index]])

get_name

string player.get_name(int index)

Returns the player's name
Example Usage
local name = player.get_name(--[[index]])

get_ped

int player.get_ped(int index)

Returns the player's ped as a script guid
Example Usage
local ped = player.get_ped(--[[index]])

get_mount

int player.get_mount(int index)

Returns the player's mount as a script guid
Example Usage
local mount = player.get_mount(--[[index]])

get_owned_mount

int player.get_owned_mount(int index)

Returns the player's owned mount as a script guid
Example Usage
local owned_mount = player.get_owned_mount(--[[index]])

get_entity

int player.get_entity(int index)

Returns the player's top-level entity as a script guid
Example Usage
local entity = player.get_entity(--[[index]])

get_heading

float player.get_heading(int index)

Returns the player's current heading
Example Usage
local heading = player.get_heading(--[[index]])

get_health

float player.get_health(int index)

Returns the player's current health
Example Usage
local health = player.get_health(--[[index]])

get_ip

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

Returns the player's ip
Example Usage
local b1, b2, b3, b4 = player.get_ip(--[[index]])

get_port

int player.get_port(int index)

Returns the player's port
Example Usage
local port = player.get_port(--[[index]])

get_rockstar_id

int player.get_rockstar_id(int index)

Returns the player's rockstar id
Example Usage
local rid = player.get_rockstar_id(--[[index]])