LGF Utility
Lua
Client
Utils
Player Class

Player Class

The LGF.Player module provides a set of methods for retrieving player information. The available methods are only usable in the client context.

---@module 
LGF.Player

Available Methods

LGF.Player:Ped

---@return number
LGF.Player:Ped()
  • Returns the Entity Handle of the current player.

LGF.Player:Index

---@return number
LGF.Player:Index()
  • Returns the server ID of the current player.

LGF.Player:PlayerId

---@return number
LGF.Player:PlayerId()
  • Returns the player ID of the current player.

LGF.Player:Coords

---@return table
LGF.Player:Coords()
  • Returns the coordinates of the current player’s Ped. The coordinates are returned as a table with x, y, and z values.