object.status

Type String
Revision Release 2024.3703
Keywords steam, steamworks, getUserInfo, UserInfo, status
See also steamworks.getUserInfo()
steamworks.*

Overview

A string indicating a user’s current online status. This is a setting that a user can set under the Steam client’s Friends menu.

This will be one of the following strings:

Example

local steamworks = require( "plugin.steamworks" )

-- Print the currently logged in user's current online status
local userInfo = steamworks.getUserInfo()

if ( userInfo ) then
    print( "User Status: " .. userInfo.status )
end