Players

Reference for the players API.

Functions

players.me

Return your local player.

function players.me(): player

players.target

Return the selected player from inside Lexis.

function players.target(): player

players.is_target_session

If the current Lexis player target is the session.

function players.is_target_session(): bool

players.get

Return a player via index.

---@param index integer
function players.get(index): player

players.list

Return a list of player for each player in the session.

function players.list(): player[]

Types

player

Field	Type
name	string
id	integer
ped	integer
ped_ptr	memory_address
vehicle	integer
vehicle_ptr	memory_address
weapon_entity	integer
weapon_ptr	memory_address
entity	integer
entity_ptr	memory_address
model	integer
vehicle_model	integer
weapon_model	integer
last_synced_model	integer
heading	number
coords	scr_vec3
rotation	scr_vec3
cam_rotation	scr_vec3
waypoint	vec2
net_player	memory_address
connected	bool
exists	bool
alive	bool
in_vehicle	bool
weapon_in_hand	bool
shooting	bool
driver	bool
aiming	bool
active_bounty	bool
freemode_host	bool
friend	bool
controller	bool
modder	bool
bounty	integer
rank	integer
cash	integer
bank	integer
wallet	integer
kd	number
playtime	integer
blacklist	integer
force_entity_sync	bool
rockstar_id	integer
ip_address	integer
in_ceo	bool
boss	bool
host_token	integer
in_interior	bool
gang_id	integer

---@param object memory_address
---@param type net_object|integer
---@param node data_node|integer
function player:force_sync_node(object, type, node): nil

---@param coords vec3|scr_vec3
function player:teleport(coords): nil

---@param event_hash integer
---@param params table
function player:script_event(event_hash, params): nil

---@param type net_object|integer
---@param node data_node|integer
---@param mods table
function player:modify_outgoing_node(type, node, mods): nil

Examples

local target = players.target()

mods = {}
mods[0x119] = {node_data_type.bool, true}

target:modify_outgoing_node(net_object.automobile, data_node.vehicle_control, mods)
target:force_sync_node(game.net_obj_from_entity(players.me().vehicle), net_object.automobile, data_node.vehicle_control)