s&box docs
API ReferenceSandbox

Friendclass

object→Friend
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed struct Sandbox.Friend

Constructors2

Showing 2 constructors

Methods3

Showing 3 methods

public string GetRichPresence(string key)PUBLIC

Returns a string that was possibly set by rich presence

ParameterTypeDescription
keystring—
Returns:string—

public void OpenAddFriendOverlay()PUBLIC

Opens the Steam overlay with a popup that allows the local Steam user to confirm whether to add this user to their Steam friends list.

Returns:void—

public void OpenInOverlay()PUBLIC

Opens the Steam overlay web browser to their user profile.

Returns:void—

Properties11

Showing 11 properties

public ulong Sandbox.Friend.Id { get; set; }PUBLICGETSET

The friend's Steam Id

Returns:ulong—

public bool Sandbox.Friend.IsAway { get; set; }PUBLICGETSET

Returns true if your friend is away

Returns:bool—

public bool Sandbox.Friend.IsBlocked { get; set; }PUBLICGETSET

Returns true if you have blocked/ignored this user

Returns:bool—

public bool Sandbox.Friend.IsBusy { get; set; }PUBLICGETSET

Returns true if this friend is marked as busy

Returns:bool—

public bool Sandbox.Friend.IsFriend { get; set; }PUBLICGETSET

Returns true if this user is your friend

Returns:bool—

public bool Sandbox.Friend.IsMe { get; set; }PUBLICGETSET

Returns true if this friend is the local user

Returns:bool—

public bool Sandbox.Friend.IsOnline { get; set; }PUBLICGETSET

Returns true if your friend is online

Returns:bool—

public bool Sandbox.Friend.IsPlayingAGame { get; set; }PUBLICGETSET

Returns true if they're playing any game

Returns:bool—

public bool Sandbox.Friend.IsPlayingThisGame { get; set; }PUBLICGETSET

Returns true if they're playing this game

Returns:bool—

public bool Sandbox.Friend.IsSnoozing { get; set; }PUBLICGETSET

Returns true if this friend is marked as snoozing

Returns:bool—

public string Sandbox.Friend.Name { get; set; }PUBLICGETSET

The friend's name

Returns:string—

Related Guides

→Testing Multiplayer

FontNameAttribute.ctor()

Previous Page

Id

Next Page

On this page

Constructorspublic Friend(System.Int64 steamid)public Friend(System.UInt64 steamid)Methodspublic System.String GetRichPresence(System.String key)public System.Void OpenAddFriendOverlay()public System.Void OpenInOverlay()Propertiespublic System.UInt64 Sandbox.Friend.Id { get; set; }public System.Boolean Sandbox.Friend.IsAway { get; set; }public System.Boolean Sandbox.Friend.IsBlocked { get; set; }public System.Boolean Sandbox.Friend.IsBusy { get; set; }public System.Boolean Sandbox.Friend.IsFriend { get; set; }public System.Boolean Sandbox.Friend.IsMe { get; set; }public System.Boolean Sandbox.Friend.IsOnline { get; set; }public System.Boolean Sandbox.Friend.IsPlayingAGame { get; set; }public System.Boolean Sandbox.Friend.IsPlayingThisGame { get; set; }public System.Boolean Sandbox.Friend.IsSnoozing { get; set; }public System.String Sandbox.Friend.Name { get; set; }Metadata