Skip to content

st.User — Player Object (Server) ​

All methods are accessible via st.framework:getUser(source) or User:get(source).

lua
local user = st.framework:getUser(source)

-- Identity
user.source                       -- integer source ID
user.identifier                   -- ESX identifier or QB citizenid
user:getName()                    -- Steam/Rockstar display name
user:getRPName()                  -- "FirstName LastName" (ESX) or QB name
user:getPhoneNumber()             -- string or nil
user:getPlayerIdentifier()        -- identifier string
user:IsOnline()                   -- boolean

-- Job
user:getJob()                     -- job table (ESX) or job table (QB)
user:getJobName()                 -- string job name
user:getJobGrade()                -- number grade
user:getGradeName()               -- string grade name
user:setJob(name, grade)          -- set job

-- Gang (QB only)
user:getGang()                    -- gang name string

-- Group
user:getGroup()                   -- player group/permission level

-- Money
user:getMoney(moneyType)          -- number (moneyType: "cash" | "bank" | "black_money")
user:HasMoney(moneyType, amount)  -- boolean
user:RemoveMoney(moneyType, amount) -- boolean (false if insufficient funds)
user:addMoney(moneyType, amount)  -- no return

-- Inventory (delegates to st.inventory)
user:CanCarryItem(item, count, metadata)         -- boolean
user:GetItem(item, metadata)                     -- item table
user:GetItemCount(item, metadata)                -- number
user:GetInventoryItems(item, metadata)           -- table of slots
user:GetInventoryItemsCount(item, metadata)      -- number
user:AddItem(item, count, metadata, slot)        -- boolean
user:RemoveItem(item, count, metadata, slot)     -- boolean

-- Misc
user:refresh()   -- re-fetch player data from framework

Getting a user by identifier (offline safe) ​

lua
local user = st.framework:getUserByIdentifier("license:abc123")
if user:IsOnline() then
    -- player is connected
end