Class SteamUserLink
Link a SteamUser to their Netcode for GameObjects ID.
Inheritance
Namespace: KaijuSolutions.SteamMultiplayerEngine.NetcodeForGameObjects
Syntax
public sealed class SteamUserLink : NetworkBehaviourProperties
Display
The rich presence localization token that will be displayed in a user's selected language in the Steam client UI for this SteamUser.
Declaration
public string Display { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Group
The rich presence group for this SteamUser.
Declaration
public string Group { get; }Property Value
| Type | Description |
|---|---|
| System.String |
GroupSize
The rich presence group size for this SteamUser.
Declaration
public int GroupSize { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Icon
The icon of this SteamUser.
Declaration
public Texture2D Icon { get; }Property Value
| Type | Description |
|---|---|
| Texture2D |
IconSize
The size of icon we want for the SteamUser.
Large = 128 x 128.
Medium = 64 x 64.
Small = 32 x 32.
None = No icon.
Declaration
public SteamIconSize IconSize { get; set; }Property Value
| Type | Description |
|---|---|
| SteamIconSize |
Id
The ID of the SteamUser this is for.
Declaration
public ulong Id { get; }Property Value
| Type | Description |
|---|---|
| System.UInt64 |
Level
The level for this SteamUser.
Declaration
public int Level { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Name
The name of the SteamUser.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Relationship
The relationship with this SteamUser.
Declaration
public SteamRelationship Relationship { get; }Property Value
| Type | Description |
|---|---|
| SteamRelationship |
RichPresence
All rich presence for this SteamUser.
Declaration
public Dictionary<string, string> RichPresence { get; }Property Value
| Type | Description |
|---|---|
| Dictionary<System.String, System.String> |
State
The state of this SteamUser.
Declaration
public SteamState State { get; }Property Value
| Type | Description |
|---|---|
| SteamState |
Status
The rich presence status to display when someone views this user's game info for this SteamUser.
Declaration
public string Status { get; }Property Value
| Type | Description |
|---|---|
| System.String |
User
The user this object is linked to.
Declaration
public SteamUser User { get; }Property Value
| Type | Description |
|---|---|
| SteamUser |
Valid
Check if this SteamUser is valid or not.
Declaration
public bool Valid { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Voice
The voice playback source for this SteamUser.
Declaration
public AudioSource Voice { get; set; }Property Value
| Type | Description |
|---|---|
| AudioSource |
Methods
GetMemberData(String)
Get a data value for this SteamUser in our lobby.
Declaration
public string GetMemberData(string key)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The value to get. |
Returns
| Type | Description |
|---|---|
| System.String | The given value. Will return an empty string if we are not in a lobby, the assigned user is not in our lobby, the data did not exist, or there was an error. |
GetRichPresence(String)
Get a rich presence of this SteamUser.
Declaration
public string GetRichPresence(string key)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The key. |
Returns
| Type | Description |
|---|---|
| System.String | The rich presence value or an empty string if it was not set. |
OnNetworkSpawn()
Gets called when the
Declaration
public override void OnNetworkSpawn()