s&box docs
API ReferenceSandbox

public sealed struct Sandbox.Friend

Broader workflow and conceptual references connected to this API.

Testing Multiplayer

The number one best way to test multiplayer is to have someone join your game.. but that's obviously not always possible.

Constructors

Showing 2 constructors

Methods

Showing 3 methods

public string GetRichPresence(string key)

Returns a string that was possibly set by rich presence

public void OpenAddFriendOverlay()

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.

public void OpenInOverlay()

Opens the Steam overlay web browser to their user profile.

Properties

Showing 10 properties

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

The friend's Steam Id

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

Returns true if your friend is away

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

Returns true if this friend is marked as busy

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

Returns true if this user is your friend

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

Returns true if this friend is the local user

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

Returns true if your friend is online

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

Returns true if they're playing any game

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

Returns true if they're playing this game

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

Returns true if this friend is marked as snoozing

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

The friend's name

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.Friend

FontNameAttribute

Previous Page

Frustum

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.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