User Data

Useing Steam User Data

Like what you're seeing?

Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude. These articles are made possible by our GitHub Sponsors ... become a sponsor today!

Introduction

using HeathenEngineering.SteamworksIntegration;

public struct UserData : IEquatable<CSteamID>, 
                         IEquatable<ulong>, 
                         IEquatable<UserData>

You can create a UserData object by assigning a ulong or CSteamID value or by using the Get methods defined below.

UserData user_fromUlong = 1234566;
UserData user_fromCSteamID = new CSteamID(1234566);
UserData user = UserData.Get(1234566);

//A static helper to get the local user's UserData object
UserData thisUser = UserData.Me;

The UserData object provides quick and efficient access to the details and artefacts pertaining to any given user. Heathen's UserData object is interchangeable with CSteamID and ulong and can be created by simply casting or assigning from those values.

The UserData object is a structure and as such is a value type, it only stores the CSteamID of the user it relates to and reads all other information at the time of request from Steam's local cache. As this object reads from the Steam cache it is possible to try to read data for a user that is not cashed resulting in empty or partial information.

In general, you can only access user information for a user that the local user "knows". This is defined by Steam as users that:

• Are friends

• Share a clan or group (some limitations apply regarding large groups)

• Share a lobby

• Share a game server

You may be able to get limited information for additional users such as users found on a leaderboard that you have queried.

If you need to request information for a user your local user does not "know" you should call API.Friends.Client.RequestUserInformation(user, getNameOnly). You should avoid doing this if possible, in most cases there is no reason to get a user's information for a user that the local user does not "know".

Fields and Attributes

Me

public static UserData Me => get;

This simply returns the local user's UserData and is the same as calling API.User.Client.Id

ID

public CSteamID id;

The underlying native ID for this clan

SteamId

public ulong SteamId { get; set; }

The underlying ulong value of the CSteamID

AccountId

public AccountID_t { get; set; }

The account ID segment of the full CSteamID, to understand more read this article.

FriendId

public uint FriendId { get; set; }

The underlying uint value of the AccountID_t segment of the CSteamID, to understand more read this article.

IsValid

public bool IsValid => get;

This indicates rather or not the underlying CSteamID is of the proper Universe and Type it does not indicate that it is a valid entry. E.g. this tells you if the data is of the right shape ... not that it equates to a valid entry in Steam client.

IsMe

public bool IsMe => get;

This is true if this UserData object is the local user

Avatar

You can use the SetUserAvatar component to more easily manage a given user's avatar texture. The SetUserAvatar component will assign a RawImage with the texture and will monitor Steam API for changes to that avatar thus if that user changes their avatar image it will automatically update the RawImage texture.

public Texture2D Avatar => get;

This is the texture loaded for this user's avatar if it has been loaded. Note you must call LoadAvatar for this user before this value will be set i.e.

if(user.Avatar == null)
    user.LoadAvatar((result) =>
    {
        rawImage.texture = result;
    });
else
    rawImage.texture = user.Avatar;

Name

You can use the SetUserName component to more easily manage a given user's name. The SetUserName component will assign a uGUI Text or TMPro Text with the name or nickname of the indicated user and will update it if that name should change.

public string Name => get;

This reads the user's Steam Name

Nickname

You can use the SetUserName component to more easily manage a given user's name. The SetUserName component will assign a uGUI Text or TMPro Text with the name or nickname of the indicated user and will update it if that name should change.

public string Nickname => get;

This reads the nickname set for this user by the local user if any. If none then this will be the same as Name.

State

public EPersonaState State => get;

Returns the EPersonaState value for this user.

InGame

public bool InGame => get;

Is this user in a game?

GameInfo

public FriendGameInfo_t GameInfo => get;

Returns the FriendGameInfo_t describing the game ID, connection information and lobby ID if any that this user is related to.

Level

public int Level => get;

Gets the Steam user level for this user.

AccountId

public AccountID_t AccountId => get;

Returns the AccountID_t also called a "Friend ID" this is mostly used internally by Steam API but is used in a few API calls such as UGC Query.

FriendId

public uint FriendId => get;

Returns the uint value of the AccountId.

Methods

ClearRichPresence

public static void ClearRichPresence()

Clears the rich presence data for the local user.

Get

public static UserData Get( .. );

This method is a static method that can be used to fetch the user data for any given user or for the local user. You can pass in a CSteamID or its ulong equivlent to fetch the user data for other users. If you do not pass in an id this method will return the local user's user data.

GetGamePlayed

public bool GetGamePlayed(out FriendGameInfo_t gameInfo);

Functionally the same as calling API.Friends.Client.GetFriendGamePlayed(user.cSteamId, out results). This returns rather or not the user is in a game and if so the results will be populated with information about that game.

InviteToGame

public void InviteToGame(string connectString)

Invites the target user to a game passing in the connection string. This will cause the GameRichPrecenseJoinRequest event to be raised on the invited user if present in game, or will launch the game with the connectionString in the command line if not.

InviteToLobby

public bool InviteToLobby(LobbyData lobby)

Invites the target user to join a specific lobby. This will cause the GameLobbyJoinRequest event to be raised on the invited user when accepted if present in game or will launch the game with the lobby ID in the command line if not in game.

LoadAvatar

public void LoadAvatar(Action<Texture2D> callback);

Functionally the same as calling API.Friends.Client.GetFriendAvatar(user.cSteamId) . This starts the process of loading the avatar image from Steam cashe if its not already loaded into memory.

The callback on this method will include the loaded texture, the loaded texture can also be found via user.Avatar.

//Assuming a RawImage named rawImage;
user.LoadAvatar((result) =>
{
    rawImage.texture = result;
});

SendMessage

public bool SendMessage(string message);

Sends the user a message via the Replay To Friend feature.

If this returns false then the current user is rate or chat limited by Valve.

SetRichPresence

public static bool SetRichPresence(string key, string value)

Sets a rich presence value on the local user.