Über diese Schnittstelle können Sie auf Informationen zu einzelnen Benutzern zugreifen und mit dem Steam-Overlay interagieren.

Memberfunktionen

Memberfunktionen für ISteamFriends werden über die globale Accessorfunktion SteamFriends() aufgerufen.

ActivateGameOverlay

Name	Typ	Beschreibung
pchDialog	const char *	Das zu öffnende Dialogfenster. Gültige Optionen sind: „friends“, „community“, „players“, „settings“, „officialgamegroup“, „stats“, „achievements“.

Aktiviert das Steam-Overlay mit einem entsprechenden Dialogfenster.

Dies entspricht einem Aufruf von ActivateGameOverlayToUser mit steamID = ISteamUser::GetSteamID.

Beispiel

ActivateGameOverlayInviteDialog

Name	Typ	Beschreibung
steamIDLobby	CSteamID	Die Steam-ID der Lobby, in die ausgewählte Benutzer eingeladen werden.

Aktiviert das Steam-Overlay mit dem Einladungsdialogfenster. Über dieses Dialogfenster verschickte Einladungen gelten für die angegebene Lobby.

ActivateGameOverlayToStore

Name	Typ	Beschreibung
nAppID	AppId_t	Die App-ID, deren Shopseite angezeigt werden soll.
eFlag	EOverlayToStoreFlag	Flags, um das Verhalten beim Öffnen der Seite zu steuern.

Aktiviert das Steam-Overlay zur Steam-Shopseite für die angegebene Anwendung.

Die Verwendung von k_uAppIdInvalid bringt den Benutzer zur Hauptseite des Steam-Shops.

ActivateGameOverlayToUser

Name	Typ	Beschreibung
pchDialog	const char *	Das zu öffnende Dialogfenster.
steamID	CSteamID	Die Steam-ID des Kontexts, in dem dieses Dialogfenster geöffnet werden soll.

Aktiviert das Steam-Overlay zum angegebenen Dialogfenster.

Zulässige Optionen für pchDialog sind:

• „steamid“: Öffnet den Overlay-Webbrowser für das angegebene Benutzer- oder Gruppenprofil.
  
• „chat“: Öffnet ein Chatfenster mit dem angegebenen Benutzer oder tritt dem Gruppenchat der angegebenen Gruppe bei.
  
• „jointrade“: Öffnet ein Fenster zu einer Steam-Handelssitzung, die mit der Web-API ISteamEconomy/StartTrade gestartet wurde.
  
• „stats“: Öffnet den Overlay-Webbrowser für die Statistiken des angegebenen Benutzers.
  
• „achievements“: Öffnet den Overlay-Webbrowser für die Errungenschaften des angegebenen Benutzers.
  
• „friendadd“: Öffnet das Overlay im Minimalmodus und fordert den Benutzer auf, den angegebenen Benutzer als Freund hinzuzufügen.
  
• „friendremove“: Öffnet das Overlay im Minimalmodus und fordert den Benutzer auf, den angegebenen Benutzer als Freund zu entfernen.
  
• „friendrequestaccept“: Öffnet das Overlay im Minimalmodus und fordert den Benutzer auf, eine eingegangene Freundschaftsanfrage zu akzeptieren.
  
• „friendrequestignore“: Öffnet das Overlay im Minimalmodus und fordert den Benutzer auf, eine eingegangene Freundschaftsanfrage zu ignorieren.

ActivateGameOverlayToWebPage

Name	Typ	Beschreibung
pchURL	const char *	Die zu öffnende Website. (Es ist eine vollständig angegebene Adresse inklusive Protokoll erforderlich, z. B.: „http://www.steampowered.com“)
eMode	EActivateGameOverlayToWebPageMode	Modus für die Webseite. Standardwert: k_EActivateGameOverlayToWebPageMode_Default

Aktiviert den Steam-Overlay-Webbrowser für die angegebene URL.

ClearRichPresence

Löscht alle Schlüssel/Werte für die erweiterte Anwesenheit des aktuellen Benutzers.

CloseClanChatWindowInSteam

Name	Typ	Beschreibung
steamIDClanChat	CSteamID	Die Steam-ID des zu schließenden Steam-Gruppenchats.

Schließt den angegebenen Steam-Gruppenchat in der Steam-Benutzeroberfläche.

Rückgabewert: bool
true, wenn der Benutzer den Steam-Gruppenchat erfolgreich verlassen hat.
false, wenn sich der Benutzer nicht im angegebenen Steam-Gruppenchat befindet.

Siehe auch: IsClanChatWindowOpenInSteam, OpenClanChatWindowInSteam

DownloadClanActivityCounts

Name	Typ	Beschreibung
psteamIDClans	CSteamID *	Eine Liste von Steam-Gruppen, für die die aktualisierten Daten abgerufen werden sollen.
cClansToRequest	int	Dies MUSS die Anzahl von Gruppen in psteamIDClans sein.

Aktualisiert die Aktivitätsdaten von Steam-Gruppen oder ruft die Daten von Gruppen ab, von denen der aktuelle Benutzer kein Mitglied ist.

Nach Empfang des Rückrufs können mit GetClanActivityCounts die aktuellen Benutzerzahlen abgerufen werden.

Rückgabewert: SteamAPICall_t zur Verwendung mit einem Aufrufergebnis von DownloadClanActivityCountsResult_t.

EnumerateFollowingList

Name	Typ	Beschreibung
unStartIndex	uint32	Der Startindex, ab dem gefolgte Benutzer zurückgegeben werden sollen. Dieser sollte beim ersten Aufruf 0 sein.

Ruft die Liste von Benutzern ab, denen der aktuelle Benutzer folgt.

Sie können Personen folgen, die nicht Ihre Freunde sind. Wenn Sie einem Benutzer folgen, können Sie Updates empfangen, wenn dieser beispielsweise neue Inhalte im Steam Workshop veröffentlicht.

HINWEIS: Dies gibt bis zu k_cEnumerateFollowersMax Benutzer gleichzeitig zurück. Wenn der aktuelle Benutzer noch mehr Personen folgt, müssen Sie diese Funktion wiederholt aufrufen, wobei unStartIndex der Gesamtanzahl der gefolgten Benutzer entsprechen muss, die Sie bisher erhalten haben.
Beispiel: Wenn Sie 50 gefolgte Benutzer empfangen haben und der Benutzer 105 Benutzern folgt, müssen Sie diese Funktion mit unStartIndex = 50 erneut aufrufen, um die nächsten 50 zu erhalten, und anschließend noch einmal mit unStartIndex = 100, um die restlichen 5 Benutzer zu erhalten.

Rückgabewert: SteamAPICall_t zur Verwendung mit einem Aufrufergebnis von FriendsEnumerateFollowingList_t.


Beispiel:

GetChatMemberByIndex

Name	Typ	Beschreibung
steamIDClan	CSteamID	Dies MUSS dieselbe Quelle sein, die im vorherigen Aufruf von GetClanChatMemberCount verwendet wurde!
iUser	int	Ein Index zwischen 0 und GetClanChatMemberCount.

Ruft die Steam-ID am angegebenen Index in einem Steam-Gruppenchat ab.

HINWEIS: Sie müssen GetClanChatMemberCount aufrufen, bevor Sie diese Funktion aufrufen.

Rückgabewert: CSteamID
Ungültige Indizes geben k_steamIDNil zurück.

GetClanActivityCounts

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-Gruppe, deren Aktivitäten abgerufen werden sollen.
pnOnline	int *	Gibt die Anzahl der Mitglieder zurück, die online sind.
pnInGame	int *	Gibt die Anzahl der Mitglieder zurück, die im Spiel sind (ohne die Mitglieder, deren Status auf „Offline“ gesetzt ist).
pnChatting	int *	Gibt die Anzahl der Mitglieder zurück, die im Gruppenchat sind.

Ruft die neuesten uns vorliegenden Informationen darüber ab, was die Benutzer in einer Steam-Gruppe machen.

Dies kann nur Daten abrufen, die dem lokalen Client bekannt sind. Um Daten zu aktualisieren oder Daten aus einer Gruppe abzurufen, in denen der aktuelle Benutzer nicht Mitglied ist, müssen Sie DownloadClanActivityCounts aufrufen.

Rückgabewert: bool
true, wenn die Daten erfolgreich zurückgegeben wurden.
false, wenn die angegebene Steam-ID ungültig ist oder der lokale Client keine Informationen über die Steam-Gruppe hat; alle anderen Parameter werden auf 0 gesetzt.

GetClanByIndex

Name	Typ	Beschreibung
iClan	int	Ein Index zwischen 0 und GetClanCount.

Ruft die Steam-ID der Steam-Gruppe am angegebenen Index ab.

HINWEIS: Sie müssen GetClanCount aufrufen, bevor Sie diese Funktion aufrufen.

Rückgabewert: CSteamID
Ungültige Indizes geben k_steamIDNil zurück.

GetClanChatMemberCount

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-Gruppe, deren Anzahl Chatmitglieder abgerufen werden soll.

Ruft die Anzahl von Benutzern in einem Steam-Gruppenchat ab.

HINWEIS: Große Steam-Gruppen können nicht vom lokalen Benutzer durchlaufen werden.

HINWEIS: Der aktuelle Benutzer muss in der Lobby sein, um die Steam-IDs anderer Benutzer in dieser Lobby abrufen zu können.

Das Ergebnis wird zum Durchlaufen verwendet. Nachdem diese Funktion aufgerufen wurde, kann GetChatMemberByIndex verwendet werden, um die Steam-ID jedes Benutzers im Chat abzurufen.

Rückgabewert: int
0 , wenn die angegebene Steam-ID ungültig ist oder wenn der lokale Benutzer nicht über die Daten verfügt.

GetClanChatMessage

Name	Typ	Beschreibung
steamIDClanChat	CSteamID	Die Steam-ID des Steam-Gruppenchats.
iMessage	int	Der Index der Nachricht. Dies sollte dem Feld m_iMessageID von GameConnectedClanChatMsg_t entsprechen.
prgchText	void *	Der Puffer, in den die Chatnachricht kopiert wird. (Sollte groß genug sein, um 2048 UTF-8-Zeichen aufnehmen zu können. Dies bedeutet 8192 Bytes + 1 für „\0“.)
cchTextMax	int	Die Größe von prgchText.
peChatEntryType	EChatEntryType *	Gibt den Typ des empfangenen Chat-Eintrags zurück.
psteamidChatter	CSteamID *	Gibt die Steam-ID des Benutzers zurück, der die Nachricht gesendet hat.

Liefert die Daten von einer Steam-Gruppenchatnachricht.

Diese Funktion sollte ausschließlich als Reaktion auf einen GameConnectedClanChatMsg_t-Rückruf aufgerufen werden.

Rückgabewert: int
Die Anzahl Bytes, die in prgchText kopiert wurden.
Gibt 0 zurück und setzt peChatEntryType auf k_EChatEntryTypeInvalid, wenn sich der aktuelle Nutzer nicht im angegebenen Steam-Gruppenchat befindet oder wenn der angegebene Index in iMessage ungültig ist.

GetClanCount

Ruft die Anzahl der Steam-Gruppen ab, in denen der aktuelle Benutzer Mitglied ist.

Das Ergebnis wird zum Durchlaufen verwendet. Nachdem diese Funktion aufgerufen wurde, kann GetClanByIndex verwendet werden, um die Steam-ID jeder Steam-Gruppe abzurufen.

Rückgabewert: int
Die Anzahl der Steam-Gruppen, in denen der Benutzer Mitglied ist.

Beispiel:

GetClanName

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-Gruppe, deren Name abgerufen werden soll.

Liefert den Anzeigenamen für die angegebene Steam-Gruppe, wenn die Gruppe dem lokalen Client bekannt ist.

Rückgabewert: const char *
Der Steam-Gruppenname im UTF-8-Format. Gibt einen leeren String ("") zurück, wenn die angegebene Steam-ID ungültig oder die Gruppe dem Benutzer nicht bekannt ist.

Siehe auch: GetFriendsGroupCount

GetClanOfficerByIndex

Name	Typ	Beschreibung
steamIDClan	CSteamID	Dies muss dieselbe Steam-Gruppe sein, die im vorherigen Aufruf von GetClanOfficerCount verwendet wurde!
iOfficer	int	Ein Index zwischen 0 und GetClanOfficerCount.

Liefert die Steam-ID des Administrators am angegebenen Index in einer Steam-Gruppe.

HINWEIS: Sie müssen GetClanOfficerCount aufrufen, bevor Sie diese Funktion aufrufen.

Rückgabewert: CSteamID
k_steamIDNil, wenn steamIDClan oder iOfficer ungültig sind.

GetClanOfficerCount

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-Gruppe, deren Anzahl Administratoren abgerufen werden soll.

Liefert die Anzahl der Administratoren und Moderatoren in der angegebenen Steam-Gruppe.

Dies schließt auch den Besitzer der Steam-Gruppe ein.

Das Ergebnis wird zum Durchlaufen verwendet. Nachdem diese Funktion aufgerufen wurde, kann GetClanOfficerByIndex verwendet werden, um die Steam-ID jedes Administrators im Chat abzurufen.

HINWEIS: Sie müssen zunächst RequestClanOfficerList aufrufen, um die erforderlichen Daten abzurufen!

Rückgabewert: int
Die Anzahl der Administratoren in der Steam-Gruppe. Gibt 0 zurück, wenn steamIDClan ungültig ist oder RequestClanOfficerList nicht für diese Gruppe aufgerufen wurde.

GetClanOwner

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-ID der Steam-Gruppe, deren Besitzer abgerufen werden soll.

Ruft den Besitzer einer Steam-Gruppe ab.

HINWEIS: Sie müssen zunächst RequestClanOfficerList aufrufen, um die erforderlichen Daten abzurufen!

Rückgabewert: CSteamID
Gibt k_steamIDNil zurück, wenn steamIDClan ungültig ist oder RequestClanOfficerList nicht für diese Gruppe aufgerufen wurde.

GetClanTag

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-Gruppe, deren Kürzel abgerufen werden soll.

Liefert das eindeutige Kürzel für die angegebene Steam-Gruppe, wenn die Gruppe dem lokalen Client bekannt ist.

Das Steam-Gruppenkürzel ist eine eindeutige Methode, um die Gruppe zu identifizieren, und ist auf eine Länge von 12 Zeichen begrenzt. In manchen Spielen wird dieses Kürzel neben dem Namen von Gruppenmitgliedern angezeigt.

Rückgabewert: const char *
Das Kürzel der Steam-Gruppe im UTF-8-Format. Gibt einen leeren String ("") zurück, wenn die bereitgestellte Steam-ID ungültig oder die Gruppe dem Benutzer nicht bekannt ist.

Siehe auch: GetFriendsGroupCount

GetCoplayFriend

Name	Typ	Beschreibung
iCoplayFriend	int	Ein Index zwischen 0 und GetCoplayFriendCount.

Liefert die Steam-ID des Benutzers, mit dem zuletzt gespielt wurde, am angegebenen Index.

HINWEIS: Sie müssen GetCoplayFriendCount aufrufen, bevor Sie diese Funktion aufrufen.

Rückgabewert: CSteamID
Ungültige Indizes geben k_steamIDNil zurück.

GetCoplayFriendCount

Liefert die Anzahl der Spieler, mit denen der aktuelle Benutzer zuletzt spielübergreifend gespielt hat.

Das Ergebnis wird zum Durchlaufen verwendet. Nachdem diese Funktion aufgerufen wurde, kann GetCoplayFriend verwendet werden, um die Steam-ID jedes Spielers abzurufen.

Diese Spieler wurden durch vorherige Aufrufe von SetPlayedWith festgelegt.

Rückgabewert: int
Die Anzahl der Benutzer, mit denen der aktuelle Benutzer zuletzt gespielt hat.

Beispiel:

GetFollowerCount

Name	Typ	Beschreibung
steamID	CSteamID	Der Benutzer, für den die Anzahl der Follower abgerufen werden soll.

Ruft die Anzahl der Benutzer ab, die dem angegebenen Benutzer folgen.

Rückgabewert: SteamAPICall_t zur Verwendung mit einem Aufrufergebnis von FriendsGetFollowerCount_t.


Beispiel:

GetFriendByIndex

Name	Typ	Beschreibung
iFriend	int	Ein Index zwischen 0 und GetFriendCount.
iFriendFlags	int	Eine kombinierte Menge (binäres Oder) von EFriendFlags. Dies muss derselbe Wert sein, der im vorherigen Aufruf von GetFriendCount verwendet wurde.

Ruft die Steam-ID des Benutzers am angegebenen Index ab.

HINWEIS: Sie müssen GetFriendCount aufrufen, bevor Sie diese Funktion aufrufen.

Rückgabewert: CSteamID
Ungültige Indizes geben k_steamIDNil zurück.

GetFriendCoplayGame

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des Benutzers auf der Liste der letzten Mitspieler, um das gespielte Spiel abzurufen.

Liefert die App-ID des Spiels, das dieser Benutzer mit jemandem auf seiner Liste der letzten Mitspieler gespielt hat.

Rückgabewert: AppId_t
Steam-IDs, die nicht auf der Liste der letzten Mitspieler stehen, geben k_uAppIdInvalid zurück.

GetFriendCoplayTime

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des Benutzers auf der Liste der letzten Mitspieler, für den der Zeitstempel abgerufen werden soll.

Ruft den Zeitstempel des Zeitpunkts ab, an dem der Benutzer mit jemandem auf seiner Liste der letzten Mitspieler gespielt hat.

Rückgabewert: int
Der Zeitpunkt wird in Unixzeit angegeben, also in Sekunden seit dem 1. Januar 1970 UTC.
Steam-IDs, die nicht auf der Liste der letzten Mitspieler stehen, geben 0 zurück.

GetFriendCount

Name	Typ	Beschreibung
iFriendFlags	int	Eine kombinierte Menge (binäres Oder) von einem oder mehreren EFriendFlags.

Liefert die Anzahl der dem Client bekannten Benutzern, die den angegebenen Kriterien entsprechen. (Freunde, blockiert, Benutzer auf demselben Server usw.)

Das Ergebnis kann zum Durchlaufen verwendet werden. Nachdem diese Funktion aufgerufen wurde, kann GetFriendByIndex aufgerufen werden, um die Steam-ID jedes Benutzers abzurufen.

Rückgabewert: int
Die Anzahl der Benutzer, die die angegebenen Kriterien erfüllen.

HINWEIS: Gibt -1 zurück, wenn der Nutzer nicht angemeldet ist.

Beispiel:

GetFriendCountFromSource

Name	Typ	Beschreibung
steamIDSource	CSteamID	Die Steam-Gruppe, der Chat, die Lobby oder der Spielserver, deren oder dessen Benutzerzahl abgerufen werden soll.

Liefert die Anzahl der Benutzer in einer Quelle (Steam-Gruppe, Chat, Lobby oder Spielserver).

HINWEIS: Große Steam-Gruppen können nicht vom lokalen Benutzer durchlaufen werden.

HINWEIS: Wenn Sie die Anzahl der Lobbymitglieder abrufen, sollten Sie stattdessen ISteamMatchmaking::GetNumLobbyMembers verwenden.

Das Ergebnis wird zum Durchlaufen verwendet. Nachdem diese Funktion aufgerufen wurde, kann GetFriendFromSourceByIndex verwendet werden, um die Steam-ID jedes Benutzers in der Quelle abzurufen.

Rückgabewert: int
0, wenn die angegebene Steam-ID ungültig ist oder wenn der lokale Benutzer nicht über die Daten verfügt.

GetFriendFromSourceByIndex

Name	Typ	Beschreibung
steamIDSource	CSteamID	Dies MUSS dieselbe Quelle sein, die im vorherigen Aufruf von GetFriendCountFromSource verwendet wurde!
iFriend	int	Ein Index zwischen 0 und GetFriendCountFromSource.

Liefert die Steam-ID am angegebenen Index von einer Quelle (Steam-Gruppe, Chat, Lobby oder Spielserver).

HINWEIS: Sie müssen GetFriendCountFromSource aufrufen, bevor Sie diese Funktion aufrufen.

Rückgabewert: CSteamID
Ungültige Indizes geben k_steamIDNil zurück.

GetFriendGamePlayed

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des anderen Benutzers.
pFriendGameInfo	FriendGameInfo_t *	Liest die Details ein, wenn sich der Benutzer in einem Spiel befindet.

Überprüft, ob sich der angegebene Freund in einem Spiel befindet, und ruft Informationen über das Spiel ab, wenn dies der Fall ist.

Rückgabewert: bool
true, wenn der Benutzer ein Freund ist und sich in einem Spiel befindet; andernfalls false.

GetFriendMessage

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des Freunds, der diese Nachricht gesendet hat.
iMessageID	int	Der Index der Nachricht. Dies sollte dem Feld m_iMessageID von GameConnectedFriendChatMsg_t entsprechen.
pvData	void *	Der Puffer, in den die Chatnachricht kopiert wird.
cubData	int	Die Größe von pvData.
peChatEntryType	EChatEntryType *	Gibt den Typ des empfangenen Chateintrags zurück.

Ruft die Daten einer Nachricht von einem Steam-Freund ab.

Diese Funktion sollte ausschließlich als Reaktion auf einen GameConnectedFriendChatMsg_t-Rückruf aufgerufen werden.

Rückgabewert: int
Die Anzahl Bytes, die in pvData kopiert wurden.
Gibt 0 zurück und setzt peChatEntryType auf k_EChatEntryTypeInvalid, wenn der aktuelle Benutzer einer Chat-Einschränkung unterliegt, wenn die angegebene Steam-ID kein Freund ist oder wenn der angegebene Index in iMessageID ungültig ist.

GetFriendPersonaName

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des anderen Benutzers.

Liefert den Anzeigenamen des angegebenen Benutzers.

Dieser ist dem aktuellen Benutzer nur dann bekannt, wenn sich der andere Benutzer in seiner Freundesliste, auf demselben Spielserver, in einem Chat oder einer Lobby oder zusammen mit dem lokalen Benutzer in einer kleinen Steam-Gruppe befindet.

HINWEIS: Beim ersten Beitritt einer Lobby, eines Chats oder eines Spielservers erfährt der aktuelle Benutzer die Anzeigenamen der anderen Benutzer nicht automatisch; diese Informationen erhält er asynchron über PersonaStateChange_t-Rückrufe.

Der Anzeigename des aktuellen Benutzers kann mit GetPersonaName abgefragt werden.

Rückgabewert: const char *
Der Anzeigename des aktuellen Benutzers im UTF-8-Format. Kann nicht NULL sein.

Gibt einen leeren String ("") oder "[unknown]" zurück, wenn die Steam-ID ungültig oder dem Aufrufenden nicht bekannt ist.

GetFriendPersonaNameHistory

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des anderen Benutzers.
iPersonaName	int	Der Index des zu empfangenden Verlaufs. 0 ist der aktuelle Anzeigename, 1 ist der vorherige Anzeigename, bevor dieser geändert wurde usw.

Liefert einen der vorherigen Anzeigenamen des angegebenen Benutzers.

Dies funktioniert nur bei Anzeigenamen, die der aktuelle Benutzer am lokalen Computer gesehen hat.

Rückgabewert: const char *
Der alte Anzeigename des Spielers am angegebenen Index. Gibt einen leeren String zurück, wenn keine weiteren Elemente im Verlauf enthalten sind.

GetFriendPersonaState

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des anderen Benutzers.

Liefert den aktuellen Status des angegebenen Benutzers.

Dieser ist dem aktuellen Benutzer nur dann bekannt, wenn sich der andere Benutzer in seiner Freundesliste, auf demselben Spielserver, in einem Chat oder einer Lobby oder zusammen mit dem lokalen Benutzer in einer kleinen Steam-Gruppe befindet.

Verwenden Sie GetPersonaState, um den Status des aktuellen Benutzers abzurufen.

Rückgabewert: EPersonaState
Der Freundesstatus des angegebenen Benutzers. (Online, Offline, Im Spiel usw.)

GetFriendRelationship

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des anderen Benutzers.

Liefert eine Beziehung zum angegebenen Benutzer.

Rückgabewert: EFriendRelationship
Wie die Benutzer einander kennen.

GetFriendRichPresence

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Der Freund, für den der Wert für erweiterte Anwesenheit abgerufen werden soll.
pchKey	const char *	Der Schlüssel für erweiterte Anwesenheit, der angefordert werden soll.

Liefert einen Wert für erweiterte Anwesenheit von einem angegebenen Freund.

Rückgabewert: const char *
Gibt einen leeren String ("") zurück, wenn der angegebene Schlüssel nicht gesetzt ist.

Siehe auch: RequestFriendRichPresence, SetRichPresence

GetFriendRichPresenceKeyByIndex

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Dies sollte derselbe Benutzer sein, der auch im vorherigen Aufruf von GetFriendRichPresenceKeyCount angegeben wurde!
iKey	int	Ein Index zwischen 0 und GetFriendRichPresenceKeyCount.

Rückgabewert: const char *
Gibt einen leeren String ("") zurück, wenn der Index ungültig ist oder für den angegebenen Benutzer keine Daten für erweiterte Anwesenheit zur Verfügung stehen.

GetFriendRichPresenceKeyCount

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des Benutzers, dessen Anzahl von Schlüsseln für erweiterte Anwesenheit abgerufen werden soll.

Liefert die Anzahl der Schlüssel für erweiterte Anwesenheit, die für den angegebenen Benutzer gesetzt sind.

Das Ergebnis wird zum Durchlaufen verwendet. Nachdem diese Funktion aufgerufen wurde, kann GetFriendRichPresenceKeyByIndex verwendet werden, um Schlüssel für erweiterte Anwensenheit zu erhalten.

Dies wird in der Regel ausschließlich zum Debuggen verwendet.

Rückgabewert: int
Gibt 0 zurück, wenn keine Informationen für erweiterte Anwesenheit für den angegebenen Benutzer vorhanden sind.

GetFriendsGroupCount

Liefert die Anzahl der Freundesgruppen (Kürzel), die der Benutzer erstellt hat.

Das Ergebnis wird zum Durchlaufen verwendet. Nachdem diese Funktion aufgerufen wurde, kann GetFriendsGroupIDByIndex verwendet werden, um die Steam-ID jeder Freundesgruppe abzurufen.

Verwechseln Sie Freundesgruppen nicht mit Steam-Gruppen. Letztere können mit GetClanCount abgefragt werden.

Rückgabewert: int
Die Anzahl der Freundesgruppen des aktuellen Benutzers.

Beispiel:

GetFriendsGroupIDByIndex

Name	Typ	Beschreibung
iFG	int	Ein Index zwischen 0 und GetFriendsGroupCount.

Liefert die Freundesgruppen-ID für den angegebenen Index.

HINWEIS: Sie müssen GetFriendGroupCount aufrufen, bevor Sie diese Funktion aufrufen.

Rückgabewert: FriendsGroupID_t
Ungültige Indizes geben k_FriendsGroupID_Invalid zurück.

GetFriendsGroupMembersCount

Name	Typ	Beschreibung
friendsGroupID	FriendsGroupID_t	Die Freundesgruppen-ID, für die die Anzahl der darin enthaltenen Freunde abgefragt werden soll.

Liefert die Anzahl der Freunde in der angegebenen Freundesgruppe.

Diese Funktion sollte aufgerufen werden, bevor die Liste von Freunden mit GetFriendsGroupMembersList abgerufen wird.

Rückgabewert: int
Die Anzahl der Freunde in der angegebenen Freundesgruppe.

Siehe auch: GetFriendsGroupCount

GetFriendsGroupMembersList

Name	Typ	Beschreibung
friendsGroupID	FriendsGroupID_t	Die Freundesgruppen-ID, für die die Liste ihrer Mitglieder abgerufen werden soll.
pOutSteamIDMembers	CSteamID *	Array, in das die Steam-IDs der Freunde eingelesen werden sollen.
nMembersCount	int	Dies sollte der Anzahl der Elemente von pOutSteamIDMembers und dem von GetFriendsGroupMembersCount zurückgegebenen Wert entsprechen.

Liefert die Anzahl der Freunde in der angegebenen Freundesgruppe.

Wenn weniger Freunde existieren als angefordert wurden, sind die Steam-IDs an diesen Positionen ungültig.

Sie müssen GetFriendsGroupMembersCount aufrufen, bevor Sie diese Funktion aufrufen, um das Array pOutSteamIDMembers mit der richtigen Größe erzeugen zu können!

Siehe auch: GetFriendsGroupCount

GetFriendsGroupName

Name	Typ	Beschreibung
friendsGroupID	FriendsGroupID_t	Die Freundesgruppen-ID, deren Name abgerufen werden soll.

Liefert den Namen der angegebenen Freundesgruppe.

Rückgabewert: const char *
Der Name der Freundesgruppe im UTF-8-Format. Gibt NULL zurück, wenn die Gruppen-ID ungültig ist.

Siehe auch: GetFriendsGroupCount

GetFriendSteamLevel

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des Benutzers.

Liefert das Steam-Level des angegebenen Benutzers.

Sie können die Steam-ID des lokalen Benutzers (ISteamUser::GetSteamID) verwenden, um dessen Level abzurufen.

Rückgabewert: int
Das Steam-Level, falls verfügbar.

Wenn das Steam-Level des angegebenen Benutzers nicht sofort verfügbar ist, wird 0 zurückgegeben und eine Anfrage an die Steam-Server gesendet. Wenn das Level heruntergeladen wurde, wird ein PersonaStateChange_t-Rückruf ausgelöst, bei dem m_nChangeFlags das Flag k_EPersonaChangeSteamLevel enthält.

GetLargeFriendAvatar

Name	Typ	Beschreibung
steamIDFriend	CSteamID

Ruft einen Handle zum großen (128 × 128 Pixel) Avatar für den angegebenen Benutzer ab.

Sie können ISteamUser::GetSteamID übergeben, um den Avatar des aktuellen Benutzers abzurufen.

HINWEIS: Dies funktioniert nur bei Benutzern, die dem lokalen Benutzer bekannt sind. Der lokale Benutzer kennt automatisch seine Freunde, Benutzer auf angeforderten Bestenlisten und Benutzer, die sich in einer selben Quelle befinden (Steam-Gruppe, Chat, Lobby oder Spielserver). Wenn der abgefragte Benutzer dem lokalen Benutzer nicht bekannt ist, müssen Sie RequestUserInformation aufrufen, um den Avatar lokal zwischenzuspeichern.

Rückgabewert: int
Löst einen AvatarImageLoaded_t-Rückruf aus.
Ein Steam-Bild-Handle, der mit ISteamUtils::GetImageSize und ISteamUtils::GetImageRGBA verwendet wird.
Gibt 0 zurück, wenn der Benutzer kein Avatar festgelegt hat.
Gibt -1 zurück, wenn die Avatar-Bilddaten noch nicht geladen wurden, und asynchron heruntergeladen werden. Warten Sie in diesem Fall auf den Rückruf AvatarImageLoaded_t und rufen Sie diese Funktion anschließend erneut auf.

Siehe auch: GetMediumFriendAvatar, GetSmallFriendAvatar

GetMediumFriendAvatar

Name	Typ	Beschreibung
steamIDFriend	CSteamID

Ruft einen Handle zum mittelgroßen (64 × 64 Pixel) Avatar für den angegebenen Benutzer ab.

Sie können ISteamUser::GetSteamID übergeben, um den Avatar des aktuellen Benutzers abzurufen.

HINWEIS: Dies funktioniert nur bei Benutzern, die dem lokalen Benutzer bekannt sind. Der lokale Benutzer kennt automatisch seine Freunde, Benutzer auf angeforderten Bestenlisten und Benutzer, die sich in einer selben Quelle befinden (Steam-Gruppe, Chat, Lobby oder Spielserver). Wenn der abgefragte Benutzer dem lokalen Benutzer nicht bekannt ist, müssen Sie RequestUserInformation aufrufen, um den Avatar lokal zwischenzuspeichern.

Rückgabewert: int
Ein Steam-Bild-Handle, der mit ISteamUtils::GetImageSize und ISteamUtils::GetImageRGBA verwendet wird.
Gibt 0 zurück, wenn der Benutzer kein Avatar festgelegt hat.

Siehe auch: GetLargeFriendAvatar, GetSmallFriendAvatar

GetPersonaName

Liefert den Anzeigenamen des aktuellen Benutzers.

Dies ist derselbe Name, der auf der Communityprofilseite des Benutzers angezeigt wird.

Der Anzeigename anderer Benutzer kann mit GetFriendPersonaName abgefragt werden.

Rückgabewert: const char *
Der Anzeigename des aktuellen Benutzers im UTF-8-Format. Kann nicht NULL sein.

GetPersonaState

Liefert den Freundesstatus des aktuellen Benutzers.

Verwenden Sie GetPersonaState, um den Status anderer Benutzer abzurufen.

Rückgabewert: EPersonaState
Der Freundesstatus des aktuellen Benutzers. (Online, Offline, Im Spiel usw.)

GetPlayerNickname

Name	Typ	Beschreibung
steamIDPlayer	CSteamID	Die Steam-ID des Benutzers.

Liefert den Spitznamen, den der aktuelle Benutzer für den angegebenen Benutzer festgelegt hat.

Rückgabewert: const char *
NULL, wenn kein Spitzname für diesen Benutzer festgelegt wurde.

GetSmallFriendAvatar

Name	Typ	Beschreibung
steamIDFriend	CSteamID

Ruft einen Handle zum kleinen (32 × 32 Pixel) Avatar für den angegebenen Benutzer ab.

Sie können ISteamUser::GetSteamID übergeben, um den Avatar des aktuellen Benutzers abzurufen.

HINWEIS: Dies funktioniert nur bei Benutzern, die dem lokalen Benutzer bekannt sind. Der lokale Benutzer kennt automatisch seine Freunde, Benutzer auf angeforderten Bestenlisten und Benutzer, die sich in einer selben Quelle befinden (Steam-Gruppe, Chat, Lobby oder Spielserver). Wenn der abgefragte Benutzer dem lokalen Benutzer nicht bekannt ist, müssen Sie RequestUserInformation aufrufen, um den Avatar lokal zwischenzuspeichern.

Rückgabewert: int
Ein Steam-Bild-Handle, der mit ISteamUtils::GetImageSize und ISteamUtils::GetImageRGBA verwendet wird.
Gibt 0 zurück, wenn der Benutzer kein Avatar festgelegt hat.

Siehe auch: GetLargeFriendAvatar, GetMediumFriendAvatar

GetUserRestrictions

Überprüft, ob der aktuelle Benutzer einer Chateinschränkung unterliegt.

Wenn er einer Chateinschränkung unterliegt, kann er keine Text- oder Sprachchatnachrichten senden oder empfangen und keine benutzerdefinierten Avatare sehen.
Ein Benutzer mit Chateinschränkung kann weder Freunde hinzufügen noch Gruppen beitreten.
Eingeschränkte Benutzer können weiterhin online sein und Spieleinladungen senden und empfangen.

Rückgabewert: uint32
Siehe: EUserRestriction

HasFriend

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Der Steam-Benutzer, dessen Freundesstatus überprüft werden soll.
iFriendFlags	int	Eine kombinierte Menge (binäres Oder) von einem oder mehreren EFriendFlags.

Überprüft, ob der Benutzer die angegebenen Kriterien erfüllt. (Freunde, blockiert, Benutzer auf demselben Server usw.)

Rückgabewert: bool
true, wenn der angegebene Benutzer eins der angegebenen Kriterien in iFriendFlags erfüllt; andernfalls false.

InviteUserToGame

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des einzuladenden Freunds.
pchConnectString	const char *	Ein String, durch den dem Freund mitgeteilt wird, wie er dem Spiel beitreten kann (d. h. die IP des Spielservers). Darf nicht länger sein als k_cchMaxRichPresenceValueLength.

Lädt einen Freund oder ein Clanmitglied mit dem angegebenen Einladungsstring in das aktuelle Spiel ein.

Wenn der Empfänger der Einladung diese annimmt, wird der in pchConnectString enthaltene String beim Starten des Spiels zur Befehlszeile hinzugefügt.
Wenn das Spiel bereits läuft, wird ein GameRichPresenceJoinRequested_t-Rückruf mit dem Verbindungsstring ausgelöst.

Rückgabewert: bool
Löst einen GameRichPresenceJoinRequested_t-Rückruf aus.
true, wenn die Einladung erfolgreich gesendet wurde.
false bei den folgenden Bedingungen:

• Die angegebene Steam-ID steamIDFriend ist ungültig.
  
• Die angegebene Steam-ID steamIDFriend ist weder Freund des aktuellen Benutzers noch befindet sie sich in derselben Steam-Gruppe wie der aktuelle Benutzer.
  
• Der angegebene Verbindungsstring pchConnectString ist zu lang.

Siehe auch: ISteamMatchmaking::InviteUserToLobby

IsClanChatAdmin

Name	Typ	Beschreibung
steamIDClanChat	CSteamID	Die Steam-ID des Steam-Gruppenchats.
steamIDUser	CSteamID	Die Steam-ID des Benutzers, dessen Admin-Status überprüft werden soll.

Überprüft, ob ein Benutzer im Steam-Gruppenchat ein Admin ist.

Rückgabewert: bool
true, wenn der angegebene Benutzer ein Admin ist.
false, wenn der Benutzer kein Admin ist, wenn sich der aktuelle Benutzer nicht im angegebenen Chat befindet oder wenn sich der angegebene Benutzer nicht im Chat befindet.

IsClanPublic

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-ID der Steam-Gruppe.

Überprüft, ob die Steam-Gruppe öffentlich ist.

Rückgabewert: bool
true, wenn die angegebene Gruppe öffentlich ist.
false, wenn sie nicht öffentlich ist.

IsClanOfficialGameGroup

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-ID der Steam-Gruppe.

Überprüft, ob die Steam-Gruppe eine offizielle Spielgruppe oder ein offizieller Communityhub ist.

Rückgabewert: bool
true, wenn die Steam-Gruppe eine offizielle Spielgruppe oder ein offizieller Communityhub ist.
false, wenn sie keine offizielle Spielgruppe oder offizieller Communityhub ist.

IsClanChatWindowOpenInSteam

Name	Typ	Beschreibung
steamIDClanChat	CSteamID	Die Steam-ID des zu überprüfenden Steam-Gruppenchats.

Überprüft, ob der Steam-Gruppenchat in der Steam-Benutzeroberfläche geöffnet ist.

Rückgabewert: bool
true, wenn der angegebene Steam-Gruppenchat geöffnet ist; andernfalls false.
Gibt false auch dann zurück, wenn der angegebene Steam-Gruppenchat unbekannt ist.

Siehe auch: OpenClanChatWindowInSteam, CloseClanChatWindowInSteam

IsFollowing

Name	Typ	Beschreibung
steamID	CSteamID	Die zu überprüfende Steam-ID, ob wir ihr folgen.

Überprüft, ob der aktuelle Benutzer dem angegebenen Benutzer folgt.

Rückgabewert: SteamAPICall_t zur Verwendung mit einem Aufrufergebnis von FriendsIsFollowing_t.


Beispiel:

IsUserInSource

Name	Typ	Beschreibung
steamIDUser	CSteamID	Der zu überprüfende Benutzer, ob er in der Quelle ist.
steamIDSource	CSteamID	Die zu überprüfende Quelle für den Benutzer.

Überprüft, ob sich der angegebene Benutzer in der angegebenen Quelle (Steam-Gruppe, Chat, Lobby oder Spielserver) befindet.

Rückgabewert: bool
true, wenn der lokale Benutzer sehen kann, dass steamIDUser sich in der angegebenen Quelle steamIDSource befindet; andernfalls false.

JoinClanChatRoom

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-ID der beizutretenden Steam-Gruppe.

Ermöglicht dem Benutzer, direkt im Spiel Steam-Gruppenchats (Clanchats) beizutreten.

Das Verhalten ist recht kompliziert, weil der Benutzer eventuell bereits außerhalb des Spiels oder im Overlay im Gruppenchat ist.

Mit ActivateGameOverlayToUser kann die Overlay-Version des Chats geöffnet werden.

Wenn Sie einem Steam-Gruppenchat beigetreten sind, sollten Sie auf die folgenden Rückrufe achten:

• GameConnectedClanChatMsg_t
  
• GameConnectedChatJoin_t
  
• GameConnectedChatLeave_t

Rückgabewert: SteamAPICall_t zur Verwendung mit einem Aufrufergebnis von JoinClanChatRoomCompletionResult_t.
Löst einen GameConnectedChatJoin_t-Rückruf aus.
Löst einen GameConnectedClanChatMsg_t-Rückruf aus.


Siehe auch: LeaveClanChatRoom, GetClanChatMemberCount, GetChatMemberByIndex, SendClanChatMessage, GetClanChatMessage, IsClanChatAdmin, IsClanChatWindowOpenInSteam

LeaveClanChatRoom

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-ID des zu verlassenden Steam-Gruppenchats.

Verlässt einen Steam-Gruppenchat, dem der Benutzer zuvor mit JoinClanChatRoom beigetreten ist.

Rückgabewert: bool
Löst einen GameConnectedChatLeave_t-Rückruf aus.
true, wenn sich der Benutzer im angegebenen Chat befindet; andernfalls false.

OpenClanChatWindowInSteam

Name	Typ	Beschreibung
steamIDClanChat	CSteamID	Die Steam-ID des zu öffnenden Steam-Gruppenchats.

Öffnet den angegebenen Steam-Gruppenchat in der Steam-Benutzeroberfläche.

Rückgabewert: bool
true, wenn der Benutzer den Steam-Gruppenchat erfolgreich betreten hat.
false unter den folgenden Umständen:

• Der angegebene Steam-Gruppenchat existiert nicht oder der Benutzer hat keinen Zugriff, um ihm beizutreten.
  
• Der aktuelle Benutzer unterliegt derzeit einer Durchsatzbegrenzung.
  
• Der aktuelle Benutzer unterliegt einer Chateinschränkung.

Siehe auch: IsClanChatWindowOpenInSteam, CloseClanChatWindowInSteam

ReplyToFriendMessage

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des Freunds, an den die Nachricht gesendet werden soll.
pchMsgToSend	const char *	Die zu sendende Nachricht im UTF-8-Format.

Sendet eine Nachricht an einen Steam-Freund.

Rückgabewert: bool
true, wenn die Nachricht erfolgreich gesendet wurde.
false, wenn der aktuelle Benutzer einer Durchsatzbegrenzung oder einer Chateinschränkung unterliegt.

RequestClanOfficerList

Name	Typ	Beschreibung
steamIDClan	CSteamID	Die Steam-Gruppe, deren Administratorenliste abgerufen werden soll.

Fordert Informationen über Steam-Gruppenadministratoren (Administratoren und Moderatoren) an.

HINWEIS: Diese Informationen können nur für Steam-Gruppen angefordert werden, in denen ein Benutzer Mitglied ist.
HINWEIS: Avatare für die Administratoren werden nicht automatisch heruntergeladen. Wenn für einen Administrator kein Avatar-Bild verfügbar ist, rufen Sie RequestUserInformation auf, um den Avatar herunterzuladen.

Rückgabewert: SteamAPICall_t zur Verwendung mit einem Aufrufergebnis von ClanOfficerListResponse_t.


Siehe auch: GetClanOwner, GetClanOfficerCount, GetClanOfficerByIndex

Beispiel:

RequestFriendRichPresence

Name	Typ	Beschreibung
steamIDFriend	CSteamID	Die Steam-ID des Benutzers, dessen erweiterte Anwesenheit angefordert werden soll.

Fordert Daten zur erweiterten Anwesenheit für den angegebenen Benutzer an.

Dies dient dazu, die Informationen zur erweiterten Anwesenheit von einem Benutzer abzurufen, der kein Freund des aktuellen Benutzers ist, z. B. von jemandem in derselben Lobby oder auf demselben Spielserver.

Diese Funktion unterliegt einer Durchsatzbegrenzung. Wenn Sie sie für einen bestimmten Benutzer zu oft aufrufen, übermittelt sie lediglich sofort einen Rückruf, ohne neue Daten vom Server anzufordern.

Rückgabewert: void
Löst einen FriendRichPresenceUpdate_t-Rückruf aus.


Siehe auch: GetFriendRichPresence, SetRichPresence

RequestUserInformation

Name	Typ	Beschreibung
steamIDUser	CSteamID	Der Benutzer, dessen Informationen abgefragt werden sollen.
bRequireNameOnly	bool	Nur den Anzeigenamen abrufen (true)? Oder Name und Avatar (false)?

Fordert den Anzeigenamen und optional auch den Avatar des angegebenen Benutzers an.

HINWEIS: Da das Herunterladen von Avataren viel langsamer ist und den lokalen Zwischenspeicher stark beansprucht, sollten Sie keine Avatare anfordern, wenn Sie sie nicht benötigen.

Rückgabewert: bool
Löst einen PersonaStateChange_t-Rückruf aus.
true bedeutet, dass die Daten angefordert wurden und ein PersonaStateChange_t-Rückruf ausgelöst wird, wenn sie abgerufen wurden.
false bedeutet, dass wir bereits alle Details über diesen Benutzer haben und dass Funktionen, die diese Informationen erfordern, sofort verwendet werden können.

SendClanChatMessage

Name	Typ	Beschreibung
steamIDClanChat	CSteamID	Die Steam-ID des Gruppenchats, an den die Nachricht gesendet werden soll.
pchText	const char *	Die zu sendende Nachricht im UTF-8-Format. Sie kann bis zu 2048 Zeichen lang sein.

Sendet eine Nachricht an einen Steam-Gruppenchat.

Rückgabewert: bool
true, wenn die Nachricht erfolgreich gesendet wurde.
false unter den folgenden Umständen:

• Der aktuelle Benutzer ist nicht im angegebenen Gruppenchat.
  
• Der aktuelle Benutzer ist nicht mit Steam verbunden.
  
• Der aktuelle Benutzer unterliegt einer Durchsatzbegrenzung.
  
• Der aktuelle Benutzer unterliegt einer Chateinschränkung.
  
• Die Nachricht in pchText überschreitet 2048 Zeichen.

SetInGameVoiceSpeaking

Name	Typ	Beschreibung
steamIDUser	CSteamID	Nicht verwendet.
bSpeaking	bool	Hat der Benutzer im Spiel zu sprechen begonnen (true) oder aufgehört zu sprechen (false)?

Teilen Sie Steam mit, dass der Benutzer derzeit den Sprachchat im Spiel verwendet.

Dadurch wird das Mikrofon für jegliche Sprachkommunikation in der Steam-Benutzeroberfläche unterdrückt.

SetListenForFriendsMessages

Name	Typ	Beschreibung
bInterceptEnabled	bool	Nachrichten von Freunden abfangen an- (true) oder ausschalten (false)?

Lauscht auf Chatnachrichten von Steam-Freunden.

Diese Chatnachrichten können dann im Spiel angezeigt werden. Beispielsweise das Chatsystem in Dota 2.

Nachdem Sie dies aktiviert haben, erhalten Sie jedes Mal GameConnectedFriendChatMsg_t-Rückrufe, wenn der Benutzer eine Chatnachricht erhält. Die eigentliche Nachrichtendaten für diesem Rückruf können mit GetFriendMessage abgerufen werden. Mit ReplyToFriendMessage können Nachrichten versendet werden.

Rückgabewert: bool
Löst einen GameConnectedFriendChatMsg_t-Rückruf aus.
Gibt immer true zurück.

SetPersonaName

Name	Typ	Beschreibung
pchPersonaName	const char *	Der neue Anzeigename des Benutzers. Darf k_cchPersonaNameMax Bytes nicht überschreiten.

Stellt den Anzeigenamen des aktuellen Benutzers ein, speichert ihn auf dem Server und veröffentlicht die Änderungen für alle Freunde, die online sind.

Die Änderungen werden lokal sofort übernommen und bei Erfolg wird ein PersonaStateChange_t-Rückruf ausgelöst.

Falls die Namensänderung auf dem Server fehlschlägt, wird ein weiterer PersonaStateChange_t-Rückruf ausgelöst, um den Namen wieder zurück zu ändern, und das Endergebnis wird im Aufrufergebnis zur Verfügung gestellt.

Rückgabewert: SteamAPICall_t zur Verwendung mit einem Aufrufergebnis von SetPersonaNameResponse_t.

SetPlayedWith

Name	Typ	Beschreibung
steamIDUserPlayedWith	CSteamID	Der andere Benutzer, mit dem wir gespielt haben.

Markiert den angegebenen Benutzer als „Zusammen gespielt“.

HINWEIS: Der aktuelle Benutzer muss sich zusammen mit dem anderen Spieler im Spiel befinden, damit diese Verknüpfung funktioniert.

Spieler, mit denen Sie kürzlich gespielt haben, können Sie hier in der Steam Community und im Steam-Overlay anzeigen.

SetRichPresence

Name	Typ	Beschreibung
pchKey	const char *	Der zu setzende „Schlüssel“ für erweiterte Anwesenheit. Darf nicht länger sein als k_cchMaxRichPresenceKeyLength.
pchValue	const char *	Der mit pchKey zu verknüpfende Wert für erweiterte Anwesenheit. Darf nicht langer sein als k_cchMaxRichPresenceValueLength. Falls dieser Wert ein leerer String ("") oder NULL ist, wird der Schlüssel entfernt.

Stellt einen Schlüssel/Wert für erweiterte Anwesenheit für den aktuellen Benutzer ein, der automatisch mit allen Freunden geteilt wird, die dasselbe Spiel spielen.

Jeder Benutzer kann bis zu k_cchMaxRichPresenceKeys (20) Schlüssel setzen.

Es gibt zwei spezielle Schlüssel, die dazu verwendet werden, Spiele anzuzeigen oder ihnen beizutreten:

• status: Ein UTF-8-String, der in der Steam-Freundesliste im Dialogfenster „Spielinformationen anzeigen“ angezeigt wird.
  
• connect: Ein UTF-8-String, der die Befehlszeile enthält, mit der ein Freund die Verbindung zu einem Spiel herstellen kann. Hierdurch wird die Schaltfläche „Spiel beitreten“ im Dialogfenster „Spielinformationen anzeigen“, im Kontextmenü der Steam-Freundesliste und auf dem Steam-Communityprofil des Spielers aktiviert. Stellen Sie sicher, dass Ihre Anwendung ISteamApps::GetLaunchCommandLine implementiert, damit Sie die Pop-up-Warnung beim Start über die Kommandozeile deaktivieren können.

Es gibt noch drei weitere spezielle Schlüssel, die im neuen Steam Chat verwendet werden:

• „steam_display“: Nennt ein Lokalisierungstoken für erweiterte Anwesenheit, das in der vom Nutzer eingestellten Sprache im Steam-Client erscheint. Weitere Informationen, inklusive eines Links zu einer Seite, auf der Sie die Daten für erweiterte Anwesenheit testen können, finden Sie unter: Lokalisierung von erweiterter Anwesenheit. Wenn kein gültiges Lokalisierungstoken für steam_display festgelegt ist, wird die erweiterte Anwesenheit nicht im Steam-Client dargestellt.
  
• „steam_player_group“: Informiert den Steam-Client darüber, dass der Spieler Mitglied einer bestimmten Gruppe ist. Spieler derselben Gruppe können an verschiedenen Orten der Steam-Benutzeroberfläche gemeinsam gruppiert werden. Dieser String identifiziert eine Gruppe, einen Server oder eine andere, für Ihr Spiel relevante, Gruppierung. Der String selbst wird Nutzern nicht angezeigt.
  
• „steam_player_group_size“: Wenn dieser Wert gesetzt ist, gibt er die Anzahl der Spieler in steam_player_group an. Der Steam-Client zeigt mithilfe dieser Zahl zusätzliche Informationen über eine Gruppe an, wenn nicht alle Mitglieder zur Freundesliste eines Nutzers gehören. (Z. B. „Bob, Peter und 4 weitere“.)
  
  
  
  Mit ClearRichPresence können alle Schlüssel des aktuellen Nutzers gelöscht werden.
  
  Weitere Informationen zum Abfragen von Schlüsseln für erweiterte Anwesenheit für Freunde: GetFriendRichPresence.
  
  Rückgabewert: bool
  true, wenn die erweiterte Anwesenheit erfolgreich eingestellt wurde.
  false bei den folgenden Bedingungen:
  
  • pchKey war länger als k_cchMaxRichPresenceKeyLength oder hatte eine Länge von 0.
    
  • pchValue war länger als k_cchMaxRichPresenceValueLength.
    
  • Der Nutzer hat die maximale Anzahl von Schlüsseln für erweiterte Anwesenheit erreicht, siehe: k_cchMaxRichPresenceKeys.

  RequestEquippedProfileItems

  SteamAPICall_t RequestEquippedProfileItems( CSteamID steamID);

  Name	Typ	Beschreibung
  steamID	CSteamID	Der Benutzer, dessen ausgerüstete Gegenstände abgerufen werden sollen.

  
  Fordert von Steam die Liste ausgerüsteter Steam-Community-Profilgegenstände für den gegebenen Benutzer an.
  
  Rückgabewert: SteamAPICall_t zur Verwendung mit einem Aufrufergebnis von EquippedProfileItems_t.

  BHasEquippedProfileItem

  bool BHasEquippedProfileItem( CSteamID steamID, ECommunityProfileItemType itemType);

  Name	Typ	Beschreibung
  steamID	CSteamID	Der Benutzer, dessen ausgerüstete Gegenstände Sie bereits abgerufen haben.
  itemType	ECommunityProfileItemType	Der Gegenstandstyp, dessen Ausrüstungsstatus abgerufen werden soll.

  
  Nach Aufruf von RequestEquippedProfileItems kann über diese Funktion überprüft werden, ob der Benutzer einen Profilgegenstand ausgerüstet hat.
  
  Rückgabewert: bool
  true, wenn der angegebene Gegenstandstyp vom Benutzer ausgerüstet wurde.
  false, wenn der angegebene Gegenstandstyp vom Benutzer nicht ausgerüstet wurde.
  
  Siehe auch: RequestEquippedProfileItems, GetProfileItemPropertyString, GetProfileItemPropertyUint

  GetProfileItemPropertyString

  char * GetProfileItemPropertyString( CSteamID steamID, ECommunityProfileItemType itemType, ECommunityProfileItemProperty prop);

  Name	Typ	Beschreibung
  steamID	CSteamID	Der Benutzer, dessen ausgerüstete Gegenstände Sie bereits abgerufen haben.
  itemType	ECommunityProfileItemType	Der Gegenstandstyp, dessen Eigenschaft abgerufen werden soll.
  prop	ECommunityProfileItemProperty	Die als Zeichenkette abzurufende Eigenschaft.

  
  Liefert eine Eigenschaft eines vom Benutzer ausgerüsteten Profilgegenstands als Zeichenkette.
  
  Rückgabewert: const char *
  
  Siehe auch: RequestEquippedProfileItems, GetProfileItemPropertyUint

  GetProfileItemPropertyUint

  bool GetProfileItemPropertyUint( CSteamID steamID, ECommunityProfileItemType itemType, ECommunityProfileItemProperty prop);

  Name	Typ	Beschreibung
  steamID	CSteamID	Der Benutzer, dessen ausgerüstete Gegenstände Sie bereits abgerufen haben.
  itemType	ECommunityProfileItemType	Der Gegenstandstyp, dessen Eigenschaft abgerufen werden soll.
  prop	ECommunityProfileItemProperty	Die als Integer abzurufende Eigenschaft.

  
  Liefert eine Eigenschaft eines vom Benutzer ausgerüsteten Profilgegenstands als Integer ohne Vorzeichen.
  
  Rückgabewert: uint64
  
  Siehe auch: RequestEquippedProfileItems, GetProfileItemPropertyString

  Rückrufe

  Diese Rückrufe können durch den Aufruf von SteamAPI_RunCallbacks ausgelöst werden. Viele davon werden als Reaktion auf die Memberfunktionen von ISteamFriends ausgelöst.

  AvatarImageLoaded_t

  Wird ausgelöst, wenn ein großer Avatar geladen wurde, falls Sie versucht haben, ihn anzufordern, als er nicht verfügbar war.
  
  

  Name	Typ	Beschreibung
  m_steamID	CSteamID	Die Steam-ID, für die der Avatar geladen wurde.
  m_iImage	int	Der Steam-Bild-Handle des jetzt geladenen Bilds.
  m_iWide	int	Breite des geladenen Bilds.
  m_iTall	int	Höhe des geladenen Bilds.

  
  Verknüpfte Funktionen: GetLargeFriendAvatar

  ClanOfficerListResponse_t

  Signalisiert die Antwort auf einen Aufruf zum Anfordern einer Administratorliste.
  
  

  Name	Typ	Beschreibung
  m_steamIDClan	CSteamID	Die Steam-Gruppe, für die wir gerade die Administratorliste erhalten haben.
  m_cOfficers	int	Die Anzahl der Administratoren in der Gruppe. Diese ist identisch mit GetClanOfficerCount.
  m_bSuccess	uint8	War der Aufruf erfolgreich? Falls nicht, war die Verbindung zu Steam möglicherweise vorübergehend unterbrochen. Wenn dies true zurückgibt, bedeutet dies nicht zwangsläufig, dass alle Informationen zu einer Steam-Gruppe heruntergeladen wurden.

  
  Verknüpfte Funktionen: RequestClanOfficerList

  DownloadClanActivityCountsResult_t

  Wird ausgelöst, wenn eine Steam-Gruppenaktivität empfangen wurde.
  
  

  Name	Typ	Beschreibung
  m_bSuccess	bool	War der Aufruf erfolgreich?

  
  Verknüpfte Funktionen: GetFriendsGroupCount

  FriendRichPresenceUpdate_t

  Wird ausgelöst, wenn Daten für erweiterte Anwesenheit für einen Benutzer aktualisiert wurden. Dies kann automatisch geschehen, wenn Freunde im selben Spiel ihre erweiterte Anwesenheit aktualisieren, oder nach einem Aufruf von RequestFriendRichPresence.
  
  

  Name	Typ	Beschreibung
  m_steamIDFriend	CSteamID	Die Steam-ID des Benutzers, dessen erweiterte Anwesenheit sich geändert hat.
  m_nAppID	AppId_t	Die App-ID des Spiels. Diese sollte immer das aktuelle Spiel sein.

  
  Verknüpfte Funktionen: RequestFriendRichPresence

  FriendsEnumerateFollowingList_t

  Gibt das Ergebnis von EnumerateFollowingList zurück.
  
  

  Name	Typ	Beschreibung
  m_eResult	EResult	Das Ergebnis der Operation.
  m_rgSteamID	CSteamID［k_cEnumerateFollowersMax］	Die Liste der Benutzer, denen wir folgen.
  m_nResultsReturned	int32	Die Anzahl der in m_rgSteamID zurückgegebenen Werte.
  m_nTotalResultCount	int32	Die Gesamtanzahl der Personen, denen wir folgen. Falls diese größer als m_nResultsReturned ist, rufen Sie EnumerateFollowingList mit m_nResultsReturned als Index auf, um den nächsten Satz gefolgter Benutzer abzufragen.

  
  Verknüpfte Funktionen: EnumerateFollowingList

  FriendsGetFollowerCount_t

  Gibt das Ergebnis von GetFollowerCount zurück.
  
  

  Name	Typ	Beschreibung
  m_eResult	EResult	Das Ergebnis der Operation.
  m_steamID	CSteamID	Die Steam-ID des Benutzers, für den wir die Anzahl der gefolgten Benutzer angefordert haben.
  m_nCount	int	Die Anzahl der vom Benutzer gefolgten Benutzer.

  
  Verknüpfte Funktionen: GetFollowerCount

  FriendsIsFollowing_t

  Gibt das Ergebnis von IsFollowing zurück.
  
  

  Name	Typ	Beschreibung
  m_eResult	EResult	Das Ergebnis der Operation.
  m_steamID	CSteamID	Die überprüfte Steam-ID.
  m_bIsFollowing	bool	Folgen wir diesem Benutzer? (true) oder nicht? (false)

  
  Verknüpfte Funktionen: IsFollowing

  GameConnectedChatJoin_t

  Wird ausgelöst, wenn ein Benutzer einem Steam-Gruppenchat beigetreten ist, in dem wir uns befinden.
  
  

  Name	Typ	Beschreibung
  m_steamIDClanChat	CSteamID	Die Steam-ID des Chats, dem ein Benutzer beigetreten ist.
  m_steamIDUser	CSteamID	Die Steam-ID des Benutzers, der dem Chat beigetreten ist.

  
  Verknüpfte Funktionen: JoinClanChatRoom

  GameConnectedChatLeave_t

  Wird ausgelöst, wenn ein Benutzer einen Steam-Gruppenchat verlassen hat, in dem wir uns befinden.
  
  

  Name	Typ	Beschreibung
  m_steamIDClanChat	CSteamID	Die Steam-ID des Chats, den ein Benutzer verlassen hat.
  m_steamIDUser	CSteamID	Die Steam-ID des Benutzers, der den Chat verlassen hat.
  m_bKicked	bool	Wurde der Benutzer von einem Administrator herausgeworfen (true) oder nicht (false)?
  m_bDropped	bool	Wurde die Verbindung des Benutzers zu Steam unterbrochen (true) oder hat dieser den Chat auf andere Weise verlassen (false)?

  
  Verknüpfte Funktionen: LeaveClanChatRoom

  GameConnectedClanChatMsg_t

  Wird ausgelöst, wenn in einem Steam-Gruppenchat, in dem wir uns befinden, eine Chatnachricht empfangen wurde.
  
  

  Name	Typ	Beschreibung
  m_steamIDClanChat	CSteamID	Die Steam-ID des Chats, in dem die Nachricht empfangen wurde.
  m_steamIDUser	CSteamID	Die Steam-ID des Benutzers, der die Nachricht gesendet hat.
  m_iMessageID	int	Index der Nachricht, um mit GetClanChatMessage die eigentlichen Daten zu erhalten.

  
  Verknüpfte Funktionen: JoinClanChatRoom

  GameConnectedFriendChatMsg_t

  Wird ausgelöst, wenn eine Chatnachricht von einem Freund empfangen wurde.
  
  

  Name	Typ	Beschreibung
  m_steamIDUser	CSteamID	Die Steam-ID des Freunds, der die Nachricht gesendet hat.
  m_iMessageID	int	Index der Nachricht, um mit GetFriendMessage die eigentlichen Daten zu erhalten.

  
  Verknüpfte Funktionen: SetListenForFriendsMessages

  GameLobbyJoinRequested_t

  Wird ausgelöst, wenn der Benutzer versucht, über seine Freundesliste oder über eine Einladung einer Lobby beizutreten. Wenn dieser Rückruf empfangen wird, sollte der Spiel-Client versuchen, die Verbindung zur angegebenen Lobby herzustellen. Falls das Spiel noch nicht ausgeführt wird, wird es stattdessen mit dem Befehlszeilenparameter +connect_lobby <64-Bit-Steam-ID der Lobby> gestartet.
  
  

  Name	Typ	Beschreibung
  m_steamIDLobby	CSteamID	Die Steam-ID der Lobby, zu der eine Verbindung hergestellt werden soll.
  m_steamIDFriend	CSteamID	Der Freund, über den der Nutzer beigetreten ist. Diese Steam-ID ist ungültig, wenn der Nutzer nicht direkt über einen Freund beigetreten ist.

  
  HINWEIS: Dieser Rückruf wird ausgelöst, wenn ein Nutzer einer Lobby beitritt. Wenn der Nutzer einem Spiel beitritt, wird der Rückruf GameRichPresenceJoinRequested_t ausgelöst.

  GameOverlayActivated_t

  Wird ausgelöst, wenn das Steam-Overlay aktiviert oder deaktiviert wird. Das Spiel kann dies dazu verwenden, um Einzelspielerspiele zu pausieren oder wiederaufzunehmen.
  
  

  Name	Typ	Beschreibung
  m_bActive	uint8	1, wenn das Overlay gerade aktiviert wurde. Andernfalls 0.

  GameRichPresenceJoinRequested_t

  Wird ausgelöst, wenn der Benutzer versucht, über seine Freundesliste einem Spiel beizutreten, oder nachdem ein Benutzer eine Einladung von einem Freund mit InviteUserToGame annimmt.
  
  

  Name	Typ	Beschreibung
  m_steamIDFriend	CSteamID	Der Freund, über den der Nutzer beigetreten ist. Diese Steam-ID ist ungültig, wenn der Nutzer nicht direkt über einen Freund beigetreten ist.
  m_rgchConnect	char［k_cchMaxRichPresenceValueLength］	Der mit dem Schlüssel für erweiterte Anwesenheit „connect“ verknüpfte Wert.

  
  Verknüpfte Funktionen: InviteUserToGame
  
  HINWEIS: Diese Rückruf wird ausgelöst, wenn ein Nutzer einem Spiel beitritt. Wenn der Nutzer einer Lobby beitritt, wird der Rückruf GameLobbyJoinRequested_t ausgelöst.

  GameServerChangeRequested_t

  Wird ausgelöst, wenn der Benutzer über seine Freundesliste versucht, einem anderen Spielserver beizutreten. Wenn dieser Rückruf ausgelöst wird, sollte der Spiel-Client versuchen, die Verbindung zum angegebenen Server herzustellen.
  
  

  Name	Typ	Beschreibung
  m_rgchServer	char［64］	Serveradresse (z. B. „127.0.0.1:27015“ oder „tf2.valvesoftware.com“)
  m_rgchPassword	char［64］	Serverpasswort, falls vorhanden.

  JoinClanChatRoomCompletionResult_t

  Wird ausgelöst, wenn der Benutzer versucht hat über JoinClanChatRoom einem Steam-Gruppenchat beizutreten.
  
  

  Name	Typ	Beschreibung
  m_steamIDClanChat	CSteamID	Die Steam-ID des Chats, dem ein Benutzer beigetreten ist.
  m_eChatRoomEnterResponse	EChatRoomEnterResponse	Das Ergebnis der Operation.

  
  Verknüpfte Funktionen: JoinClanChatRoom

  PersonaStateChange_t

  Wird ausgelöst, wenn sich der Status eines Freunds ändert.
  
  

  Name	Typ	Beschreibung
  m_ulSteamID	uint64	Steam-ID des Benutzers, bei dem sich etwas geändert hat.
  m_nChangeFlags	int	Eine bitweise Menge von EPersonaChange-Werten.

  
  Verknüpfte Funktionen: RequestUserInformation

  SetPersonaNameResponse_t

  Meldet das Ergebnis eines Versuchs, den Anzeigenamen des aktuellen Benutzers zu ändern.
  
  

  Name	Typ	Beschreibung
  m_bSuccess	bool	true, wenn die Namensänderung erfolgreich war.
  m_bLocalSuccess	bool	true, wenn die Namensänderung lokal gespeichert wurde. Die Kommunikation mit Steam war möglicherweise nicht möglich.
  m_result	EResult	Das Ergebnis der Operation.

  
  Verknüpfte Funktionen: SetPersonaName

  Strukturen

  Dies sind Strukturen, die von Funktionen in ISteamFriends zurückgegeben werden und/oder mit denen diese Funktionen interagieren.

  FriendGameInfo_t

  Informationen über das Spiel, das ein Freund spielt.
  Beziehbar von: GetFriendGamePlayed.
  
  

  Name	Typ	Beschreibung
  m_gameID	CGameID	Die Spiel-ID des Spiels, das der Freund spielt.
  m_unGameIP	uint32	Die IP-Adresse des Servers, auf dem der Freund spielt.
  m_usGamePort	uint16	Der Port des Servers, auf dem der Freund spielt.
  m_usQueryPort	uint16	Der Abfrageport des Servers, auf dem der Freund spielt.
  m_steamIDLobby	CSteamID	Die Steam-ID der Lobby, in der sich der Freund befindet.

  FriendSessionStateInfo_t

  Informationen über Benutzersitzungen. (Nur zur internen Verwendung durch Steam.)
  
  

  Name	Typ	Beschreibung
  m_uiOnlineSessionInstances	uint32
  m_uiPublishedToFriendsSessionInstance	uint8

  EquippedProfileItemsChanged_t

  Rückruf für den Fall, dass sich die Steam-Community-Profilgegenstände eines Benutzers geändert haben. Dieser Rückruf kann sich auf den aktuellen Benutzer oder dessen Freunde beziehen.
  
  

  Name	Typ	Beschreibung
  m_steamID	CSteamID

  EquippedProfileItems_t

  Aufrufergebnis von RequestEquippedProfileItems. Löst auch einen Rückruf aus.
  
  

  Name	Typ	Beschreibung
  m_eResult	EResult
  m_bHasAnimatedAvatar	CSteamID
  m_bHasAvatarFrame	bool
  m_bHasProfileModifier	bool
  m_bHasProfileBackground	bool
  m_bHasMiniProfileBackground	bool

  Enums

  Dies sind Aufzählungstypen, die zur Verwendung mit ISteamFriends definiert sind.

  EFriendFlags

  Flags zum Aufzählen der Freundesliste oder zur schnellen Überprüfung der Beziehung zwischen Benutzern.
  
  

  Name	Wert	Beschreibung
  k_EFriendFlagNone	0x00	Keine.
  k_EFriendFlagBlocked	0x01	Benutzer, dessen Kontaktaufnahme mit dem aktuellen Benutzer von diesem blockiert wurde.
  k_EFriendFlagFriendshipRequested	0x02	Benutzer, die eine Freundschaftsanfrage an den aktuellen Benutzer geschickt haben.
  k_EFriendFlagImmediate	0x04	Die „regulären“ Freunde des aktuellen Benutzers.
  k_EFriendFlagClanMember	0x08	Benutzer, die sich in einer derselben (kleinen) Steam-Gruppen wie der aktuelle Benutzer befinden.
  k_EFriendFlagOnGameServer	0x10	Spieler, die sich auf demselben Spielserver befinden, wie durch SetPlayedWith festgelegt.
  k_EFriendFlagRequestingFriendship	0x80	Benutzer, an die der aktuelle Benutzer Freundschaftsanfragen geschickt hat.
  k_EFriendFlagRequestingInfo	0x100	Benutzer, die nach einem Aufruf von RequestUserInformation derzeit zusätzliche Informationen über sich selbst senden.
  k_EFriendFlagIgnored	0x200	Benutzer, deren Kontaktaufnahme der aktuelle Benutzer ignoriert hat.
  k_EFriendFlagIgnoredFriend	0x400	Benutzer, die den aktuellen Benutzer ignoriert haben, dem aktuellen Benutzer jedoch weiterhin bekannt sind.
  k_EFriendFlagChatMember	0x1000	Benutzer in einem derselben Chats.
  k_EFriendFlagAll	0xFFFF	Gibt alle Freund-Flags zurück.

  EFriendRelationship

  Deklariert die Menge der Beziehungen, die Steam-Benutzer haben können.
  
  

  Name	Wert	Beschreibung
  k_EFriendRelationshipNone	0	Die Benutzer haben keine Beziehung.
  k_EFriendRelationshipBlocked	1	Der Benutzer hat gerade eine Freundschaftsanfrage ignoriert. Dies wird nicht gespeichert.
  k_EFriendRelationshipRequestRecipient	2	Der Benutzer hat eine Freundschaftsanfrage an den aktuellen Benutzer gesendet.
  k_EFriendRelationshipFriend	3	Ein „regulärer“ Freund.
  k_EFriendRelationshipRequestInitiator	4	Der aktuelle Benutzer hat eine Freundschaftsanfrage gesendet.
  k_EFriendRelationshipIgnored	5	Der aktuelle Benutzer hat Kommentare, Chats usw. von diesem anderen Benutzer explizit blockiert. Dies wird gespeichert.
  k_EFriendRelationshipIgnoredFriend	6	Der Benutzer hat den aktuellen Benutzer ignoriert.
  k_EFriendRelationshipSuggested_DEPRECATED	6	Veraltet; wird nicht mehr verwendet.
  k_EFriendRelationshipMax	8	Die Gesamtanzahl der Freundesbeziehungen, die für Schleifenverarbeitung und Verifizierung verwendet werden.

  EOverlayToStoreFlag

  Diese Werte werden mit ActivateGameOverlayToStore als Parameter an den Shop übergeben und verändern das Verhalten beim Öffnen der Seite.
  
  

  Name	Wert	Beschreibung
  k_EOverlayToStoreFlag_None	0	Nein
  k_EOverlayToStoreFlag_AddToCart	1	Deprecated, now works the same as k_EOverlayToStoreFlag_AddToCartAndShow.
  k_EOverlayToStoreFlag_AddToCartAndShow	2	Fügt die angegebene App-ID zum Warenkorb des Benutzers hinzu und zeigt die Shopseite an.

  EPersonaChange

  Wird in PersonaStateChange_t::m_nChangeFlags verwendet, um Änderungen an einem Benutzer zu beschreiben.
  Diese Flags beschreiben, welche kürzlichen Änderungen dem Client bekannt geworden sind. Daher werden beim Start Änderungen an Name, Avatar und Beziehung jedes Freundes angezeigt.
  
  

  Name	Wert	Beschreibung
  k_EPersonaChangeName	0x0001
  k_EPersonaChangeStatus	0x0002
  k_EPersonaChangeComeOnline	0x0004
  k_EPersonaChangeGoneOffline	0x0008
  k_EPersonaChangeGamePlayed	0x0010
  k_EPersonaChangeGameServer	0x0020
  k_EPersonaChangeAvatar	0x0040
  k_EPersonaChangeJoinedSource	0x0080
  k_EPersonaChangeLeftSource	0x0100
  k_EPersonaChangeRelationshipChanged	0x0200
  k_EPersonaChangeNameFirstSet	0x0400
  k_EPersonaChangeFacebookInfo	0x0800
  k_EPersonaChangeNickname	0x1000
  k_EPersonaChangeSteamLevel	0x2000

  EPersonaState

  Liste der Status, die ein Steam-Freund haben kann.
  
  

  Name	Wert	Beschreibung
  k_EPersonaStateOffline	0	Freund ist derzeit nicht angemeldet.
  k_EPersonaStateOnline	1	Freund ist angemeldet.
  k_EPersonaStateBusy	2	Der Freund ist angemeldet, hat aber „Bitte nicht stören“ ausgewählt.
  k_EPersonaStateAway	3	Automatische Abwesenheitsfunktion.
  k_EPersonaStateSnooze	4	Automatische Abwesenheitsfunktion für lange Zeiträume.
  k_EPersonaStateLookingToTrade	5	Online, möchte handeln.
  k_EPersonaStateLookingToPlay	6	Online, möchte spielen.
  k_EPersonaStateMax	7	Die Gesamtanzahl der Status. Wird nur für Schleifenverarbeitung und Validierung verwendet.

  EUserRestriction

  Flags für Benutzereinschränkungen. Werden von GetUserRestrictions zurückgegeben.
  
  

  Name	Wert	Beschreibung
  k_nUserRestrictionNone	0	Keine Chat- oder Inhaltseinschränkung bekannt.
  k_nUserRestrictionUnknown	1	Wir wissen es noch nicht; der Benutzer ist offline.
  k_nUserRestrictionAnyChat	2	Der Benutzer darf (bzw. kann) keine Chatnachrichten senden oder empfangen.
  k_nUserRestrictionVoiceChat	4	Der Benutzer darf (bzw. kann) keine Nachrichten in Sprachchats senden oder empfangen.
  k_nUserRestrictionGroupChat	8	Der Benutzer darf (bzw. kann) keine Nachrichten in Gruppenchats senden oder empfangen.
  k_nUserRestrictionRating	16	Der Benutzer ist gemäß der Einstufung in der aktuellen Region zu jung.
  k_nUserRestrictionGameInvites	32	Der Benutzer kann keine Spieleinladungen senden oder empfangen (z. B. wenn er ein Mobilgerät verwendet).
  k_nUserRestrictionTrading	64	Der Benutzer kann nicht handeln (z. B. wenn er eine Konsole oder ein Mobilgerät verwendet).

  ECommunityProfileItemType

  Arten von Steam-Communityprofilgegenständen
  
  

  Name	Wert	Beschreibung
  k_ECommunityProfileItemType_AnimatedAvatar	0	Animiertes Avatarbild (GIF)
  k_ECommunityProfileItemType_AvatarFrame	1	Profilrahmen (darf als animierte PNG vorliegen)
  k_ECommunityProfileItemType_ProfileModifier	2	Überschreibender Sonderprofilgegenstand wie saisonales Profil oder Künstlerprofil
  k_ECommunityProfileItemType_ProfileBackground	3	Profilhintergrundbild oder -video
  k_ECommunityProfileItemType_MiniProfileBackground	4	Hintergrundbild oder -video, das für einen Nutzer beim Drüberfahren mit dem Mauszeiger angezeigt wird

  ECommunityProfileItemProperty

  Eigenschaften von Steam-Community-Profilgegenständen. Siehe GetProfileItemPropertyString und GetProfileItemPropertyUint.
  
  

  Name	Wert	Beschreibung
  k_ECommunityProfileItemProperty_ImageSmall	0	URL zur kleinen bzw. animierten Version des Bildes
  k_ECommunityProfileItemProperty_ImageLarge	1	URL zur großen bzw. statischen Version des Bildes
  k_ECommunityProfileItemProperty_InternalName	2	Interner Name, wie er auf der Partner-Website festgelegt wurde (für Debugging)
  k_ECommunityProfileItemProperty_Title	3	Lokalisierter Name des Gegenstands
  k_ECommunityProfileItemProperty_Description	4	Lokalisierte Beschreibung des Gegenstands
  k_ECommunityProfileItemProperty_AppID	5	App-ID des Gegenstands (Integer ohne Vorzeichen)
  k_ECommunityProfileItemProperty_TypeID	6	Typ-ID des Gegenstands, einzigartig für die App-ID (Integer ohne Vorzeichen)
  k_ECommunityProfileItemProperty_Class	7	„Klasse“ oder Typ des Gegenstands (interner Wert, Integer ohne Vorzeichen)
  k_ECommunityProfileItemProperty_MovieWebM	8	URL zur Webm-Videodatei
  k_ECommunityProfileItemProperty_MovieMP4	9	URL zur mp4-Videodatei
  k_ECommunityProfileItemProperty_MovieWebMSmall	10	URL zur kleinen Webm-Videodatei
  k_ECommunityProfileItemProperty_MovieMP4Small	11	URL zur kleinen mp4-Videodatei

  EActivateGameOverlayToWebPageMode

  Webseitenmodi für das Spieloverlay
  
  

  Name	Wert	Beschreibung
  k_EActivateGameOverlayToWebPageMode_Default	0	Der Browser wird neben allen anderen, bereits vom Nutzer im Overlay geöffneten, Fenstern geöffnet. Das Fenster bleibt geöffnet, auch wenn der Nutzer das Overlay schließt und dann wieder öffnet.
  k_EActivateGameOverlayToWebPageMode_Modal	1	Der Browser wird in einer speziellen Overlay-Konfiguration geöffnet, die alle anderen bereits vom Nutzer im Overlay geöffneten Fenstern versteckt. Wenn der Nutzer das Overlay schließt, wird das Browserfenster ebenfalls geschlossen. Wenn der Nutzer das Browserfenster schließt, wird das Overlay automatisch geschlossen.

  Typdefinitionen

  Dies sind Typdefinitionen, die zur Verwendung mit ISteamFriends definiert sind.
  
  

  Name	Basistyp	Beschreibung
  FriendsGroupID_t	int16	Freundesgruppenbezeichner (Gruppenkürzel).

  Konstanten

  Dies sind Konstanten, die zur Verwendung mit ISteamFriends definiert sind.
  
  

  Name	Typ	Wert	Beschreibung
  k_cchMaxFriendsGroupName	int	64	Die maximal zulässige Länge eines Freundesgruppennamens (ohne den Null-Terminator).
  k_cchMaxRichPresenceKeyLength	int	64	Die maximal zulässige Länge eines Schlüssels für erweiterte Anwesenheit.
  k_cchMaxRichPresenceKeys	int	20	Die maximale Anzahl von Schlüsseln für erweiterte Anwesenheit.
  k_cchMaxRichPresenceValueLength	int	256	Die maximal zulässige Länge eines Werts für erweiterte Anwesenheit.
  k_cchPersonaNameMax	int	128	Die maximale Anzahl von UTF-8-Bytes im Profilnamen (Anzeigename) eines Benutzers.
  k_cEnumerateFollowersMax	int	50	Die maximale Anzahl der gefolgten Benutzer, die bei einem Aufruf von FriendsEnumerateFollowingList_t auf einmal zurückgegeben werden.
  k_cFriendsGroupLimit	int	100	Veraltet; wird nicht mehr verwendet.
  k_cubChatMetadataMax	uint32	8192	Die maximale Größe von Metadaten in Bytes, die ein Chat, eine Lobby oder ein Mitglied eines Chats oder einer Lobby haben kann.
  k_cwchPersonaNameMax	int	32	Die maximal zulässige Anzahl von UTF-16-Zeichen im Profilnamen (Anzeigename) eines Benutzers.
  k_FriendsGroupID_Invalid	FriendsGroupID_t	−1	Ungültiger Freundesgruppenbezeichner.
  STEAMFRIENDS_INTERFACE_VERSION	const char *	„SteamFriends015“

  Lokalisierung für erweiterte Anwesenheit

  
  Die Lokalisierung für erweiterte Anwesenheit erfolgt über eine Liste von Tokennnamen und -werten für jede unterstützte Sprache. Tokennamen beginnen mit # und können aus alphanumerischen Zeichen und Unterstrichen bestehen. Tokenwerte enthalten lokalisierten Text und können darüber hinaus auch Variablen enthalten, die Teile eines Strings durch andere Werte für erweiterte Anwesenheit ersetzen.
  
  
• Die einfachste Art eines Tokens ist ein einfacher lokalisierter Text:
  
  "#Status_AtMainMenu" "Im Hauptmenü"
  Falls im obigen Beispiel mithilfe von SetRichPresence steam_display auf #Status_AtMainMenu gesetzt wird, steht neben den Spielerinformationen im Steam-Client „Im Hauptmenü“.
  
  
• Variablen funktionieren folgendermaßen:
  
  "#StatusWithScore" "Punkte: %score%"
  Wenn, wie in diesem Fall, mithilfe von SetRichPresence steam_display auf „#StatusWithScore“ und „score“ auf „3“ gestellt wird, steht neben den Spielerinformationen im Steam-Client „Punkte: 3“.
  
  
• Variablen können auch weitere lokalisierte Texte enthalten. Dazu wird ein Teil des Strings in geschweifte Klammern gesetzt. Beispiel:
  
  "#PlayingHero" "Spielt: {#Hero_%hero%}" "#Hero_Tidehunter" "Tidehunter"
  Hierbei werden zuerst die Variablen in dem durch geschweifte Klammern markierten Teil des Strings ersetzt und anschließend der entsprechende Tag lokalisiert. Wenn in diesem Beispiel steam_display auf „#PlayingHero“ und „hero“ auf „Tidehunter“ gestellt wird, lokalisiert der Steam-Client „#Hero_Tidehunter“ und zeigt „Spielt: Tidehunter“ an.
  ^{HINWEIS: Schlüssel für erweiterte Anwesenheit in Variablen dürfen nur alphanumerische Zeichen, Unterstriche und Doppelpunkte enthalten.}
  
  Falls ein Lokalisierungs-Token nicht gefunden wird, greift das System auf Englisch als Standardsprache zurück. Falls das englische Token nicht gefunden wird, wird die erweiterte Anwesenheit nicht im Steam-Client dargestellt. Ähnlich verhält es sich, wenn ein Token eine Variable mit einem nicht gesetzten Schlüssel für erweiterte Anwesenheit angibt, dann wird die erweiterte Anwesenheit im Steam-Client nicht angezeigt.
  
  Der Spielentwickler stellt die Lokalisierungsdatei für erweiterte Anwesenheit im Abschnitt Erweiterte Anwesenheit im Tab Community auf der Seite Steamworks-Einstellungen bereit.
  
  
  
  Verwenden Sie http://www.steamcommunity.com/dev/testrichpresence zum Testen, um den lokalisierten String für erweiterte Anwesenheit für den angemeldeten Benutzer sowie Fehlerinformationen zu unvollständigen oder falschen Daten anzuzeigen. Der String wird in die für die Steam-Website eingestellte Sprache lokalisiert.
  
  Jede Sprache kann einzeln als Datei hochgeladen werden, die wie folgt aussehen:
  
  
  "lang" { "english" { "tokens" { "#StatusWithoutScore" "{#Status_%gamestatus%}" "#StatusWithScore" "{#Status_%gamestatus%}: %score%" "#Status_AtMainMenu" "At the main menu" "#Status_WaitingForMatch" "Waiting for match" "#Status_Winning" "Winning" "#Status_Losing" "Losing" "#Status_Tied" "Tied" } } }
  
  Es können auch mehrere Sprachen in einer Datei enthalten sein. Nur in der Datei vorhandene Sprachen werden überschrieben.
  
  "lang" { "english" { "tokens" { "#StatusWithoutScore" "{#Status_%gamestatus%}" "#StatusWithScore" "{#Status_%gamestatus%}: %score%" "#Status_AtMainMenu" "At the main menu" "#Status_WaitingForMatch" "Waiting for match" "#Status_Winning" "Winning" "#Status_Losing" "Losing" "#Status_Tied" "Tied" } } "french" { "tokens" { "#Status_AtMainMenu" "Au menu principal" "#Status_WaitingForMatch" "En attente de match" "#Status_Winning" "Gagnant" "#Status_Losing" "Perdant" "#Status_Tied" "Egalité" } } }