Skip to content

player_object.md

Latest commit

 

History

History
54 lines (34 loc) · 1012 Bytes

player_object.md

File metadata and controls

54 lines (34 loc) · 1012 Bytes
Raw

Player Object

The Player object represents a connected player session.

It is available in certain events such as:

The Player object is read-only from Lua unless explicitly documented otherwise.

player:getName()

Returns the player's display name.

Returns: string

local name = event.player:getName()

player:getUUID()

Returns the player's unique UUID.

Returns: string

local uuid = event.player:getUUID()

player:getServer()

Returns the name of the backend server the player is currently connected to.

Returns: string | nil

Returns nil if the player is not yet connected to a backend.

Player Example

proxy:on("session_connected", function(event)
    local player = event.player

    log("Name: " .. player:getName())
    log("UUID: " .. player:getUUID())
    log("Server: " .. tostring(player:getServer()))
end)