C# Class Steamworks.SteamFriends

activates the game overlay, with an optional dialog to open

valid options are "Friends", "Community", "Players", "Settings", "OfficialGameGroup", "Stats", "Achievements"

activates game overlay to open the invite dialog. Invitations will be sent for the provided lobby.

activates game overlay to store page for app

activates game overlay to a specific place

valid options are

"steamid" - opens the overlay web browser to the specified user or groups profile

"chat" - opens a chat window to the specified user, or joins the group chat

"jointrade" - opens a window to a Steam Trading session that was started with the ISteamEconomy/StartTrade Web API

"stats" - opens the overlay web browser to the specified user's stats

"achievements" - opens the overlay web browser to the specified user's achievements

"friendadd" - opens the overlay in minimal mode prompting the user to add the target user as a friend

"friendremove" - opens the overlay in minimal mode prompting the user to remove the target friend

"friendrequestaccept" - opens the overlay in minimal mode prompting the user to accept an incoming friend invite

"friendrequestignore" - opens the overlay in minimal mode prompting the user to ignore an incoming friend invite

activates game overlay web browser directly to the specified URL

full address with protocol type is required, e.g. http://www.steamgames.com/

for clans a user is a member of, they will have reasonably up-to-date information, but for others you'll have to download the info to have the latest

returns the most recent information we have about what's happening in a clan

clan (group) iteration and access functions

returns the steamID of a clan officer, by index, of range [0,GetClanOfficerCount)

returns the number of officers in a clan (including the owner)

iteration of clan officers - can only be done when a RequestClanOfficerList() call has completed

returns the steamID of the clan owner

recently-played-with friends iteration

this iterates the entire list of users recently played with, across games

GetFriendCoplayTime() returns as a unix time

following apis

returns the steamID of a user

iFriend is a index of range [0, GetFriendCount())

iFriendsFlags must be the same value as used in GetFriendCount()

the returned CSteamID can then be used by all the functions below to access details about the user

friend iteration

takes a set of k_EFriendFlags, and returns the number of users the client knows about who meet that criteria

then GetFriendByIndex() can then be used to return the id's of each of those users

iterators for getting users in a chat room, lobby, game server or clan

note that large clans that cannot be iterated by the local user

note that the current user must be in a lobby to retrieve CSteamIDs of other users in that lobby

steamIDSource can be the steamID of a group, game server, lobby or chat room

returns true if the friend is actually in a game, and fills in pFriendGameInfo with an extra details

returns the name another user - guaranteed to not be NULL.

same rules as GetFriendPersonaState() apply as to whether or not the user knowns the name of the other user

note that on first joining a lobby, chat room or game server the local user will not known the name of the other users automatically; that information will arrive asyncronously

accesses old friends names - returns an empty string when their are no more items in the history

returns the current status of the specified user

this will only be known by the local user if steamIDFriend is in their friends list; on the same game server; in a chat room or lobby; or in a small group with the local user

returns a relationship to a user

friends steam level

friend grouping (tag) apis

returns the number of friends groups

returns the friends group ID for the given index (invalid indices return k_FriendsGroupID_Invalid)

returns the number of members in a given friends group

gets up to nMembersCount members of the given friends group, if fewer exist than requested those positions' SteamIDs will be invalid

returns the name for the given friends group (NULL in the case of invalid friends group IDs)

gets the large (184x184) avatar of the current user, which is a handle to be used in IClientUtils::GetImageRGBA(), or 0 if none set

returns -1 if this image has yet to be loaded, in this case wait for a AvatarImageLoaded_t callback and then call this again

gets the medium (64x64) avatar of the current user, which is a handle to be used in IClientUtils::GetImageRGBA(), or 0 if none set

returns the local players name - guaranteed to not be NULL.

this is the same name as on the users community profile page

this is stored in UTF-8 format

like all the other interface functions that return a char *, it's important that this pointer is not saved

off; it will eventually be free'd or re-allocated

gets the status of the current user

Returns nickname the current user has set for the specified player. Returns NULL if the no nickname has been set for that player.

gets the small (32x32) avatar of the current user, which is a handle to be used in IClientUtils::GetImageRGBA(), or 0 if none set

if current user is chat restricted, he can't send or receive any text/voice chat messages.

the user can't see custom avatars. But the user can be online and send/recv game invites.

a chat restricted user can't add friends or join any groups.

returns true if the specified user meets any of the criteria specified in iFriendFlags

iFriendFlags can be the union (binary or, |) of one or more k_EFriendFlags values

rich invite support

if the target accepts the invite, the pchConnectString gets added to the command-line for launching the game

if the game is already running, a GameRichPresenceJoinRequested_t callback is posted containing the connect string

invites can only be sent to friends

interact with the Steam (game overlay / desktop)

returns true if the local user can see that steamIDUser is a member or in steamIDSource

chat interface for games

this allows in-game access to group (clan) chats from in the game

the behavior is somewhat sophisticated, because the user may or may not be already in the group chat from outside the game or in the overlay

use ActivateGameOverlayToUser( "chat", steamIDClan ) to open the in-game overlay version of the chat

requests information about a clan officer list

when complete, data is returned in ClanOfficerListResponse_t call result

this makes available the calls below

you can only ask about clans that a user is a member of

note that this won't download avatars automatically; if you get an officer,

and no avatar image is available, call RequestUserInformation( steamID, false ) to download the avatar

Requests rich presence for a specific user.

requests information about a user - persona name & avatar

if bRequireNameOnly is set, then the avatar of a user isn't downloaded

- it's a lot slower to download avatars and churns the local cache, so if you don't need avatars, don't request them

if returns true, it means that data is being requested, and a PersonaStateChanged_t callback will be posted when it's retrieved

if returns false, it means that we already have all the details about that user, and functions can be called immediately

User is in a game pressing the talk button (will suppress the microphone for all voice comms from the Steam friends UI)

peer-to-peer chat interception

this is so you can show P2P chats inline in the game

Sets the player name, stores it on the server and publishes the changes to all friends who are online.

Changes take place locally immediately, and a PersonaStateChange_t is posted, presuming success.

The final results are available through the return value SteamAPICall_t, using SetPersonaNameResponse_t.

If the name change fails to happen on the server, then an additional global PersonaStateChange_t will be posted

to change the name back, in addition to the SetPersonaNameResponse_t callback.

Mark a target user as 'played with'. This is a client-side only feature that requires that the calling user is

in game

Rich Presence data is automatically shared between friends who are in the same game

Each user has a set of Key/Value pairs

Note the following limits: k_cchMaxRichPresenceKeys, k_cchMaxRichPresenceKeyLength, k_cchMaxRichPresenceValueLength

There are two magic keys:

"status" - a UTF-8 string that will show up in the 'view game info' dialog in the Steam friends list

"connect" - a UTF-8 string that contains the command-line for how a friend can connect to a game

GetFriendRichPresence() returns an empty string "" if no value is set

SetRichPresence() to a NULL or an empty string deletes the key

You can iterate the current set of keys for a friend with GetFriendRichPresenceKeyCount()

and GetFriendRichPresenceKeyByIndex() (typically only used for debugging)