Steamworks-Dokumentation
ISteamUtils-Schnittstelle
Schnittstelle für den Zugriff auf eine Reihe verschiedener Hilfsfunktionen.

Memberfunktionen

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

BOverlayNeedsPresent

bool BOverlayNeedsPresent();
Prüft, ob das Overlay ein Present() benötigt. Nur erforderlich, wenn ereignisgesteuerte Renderaktualisierungen verwendet werden.

Normalerweise wird dieser Aufruf nicht benötigt, wenn Ihr Spiel eine konstant ausgeführte Frame-Schleife aufweist, die in jedem Frame Present() von D3D bzw. SwapBuffers() von OGL aufruft, wie dies bei den meisten Spielen der Fall ist. Wenn Ihr Spiel den Bildschirm jedoch nur bei bestimmten Ereignissen aktualisiert, dann kann das Overlay nicht dargestellt werden, da es Ihre Aufrufe von Present() bzw. SwapBuffers() verwendet, um seine interne Frame-Schleife zu steuern. Außerdem wird Present() bzw. SwapBuffers() benötigt, wenn eine Benachrichtigung erfolgt oder der Nutzer das Overlay aufruft. You can use this API to ask the overlay if it currently need a present in that case, and then you can check for this periodically (roughly 33hz is desirable) and make sure you refresh the screen with Present or SwapBuffers to allow the overlay to do its work.

Rückgabewert: bool
true, wenn das Overlay eine Aktualisierung des Bildschirms erfordert. Andernfalls false.

CheckFileSignature

SteamAPICall_t CheckFileSignature( const char *szFileName );
NameTypBeschreibung
szFileNameconst char *.

Veraltet.

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

GetAPICallFailureReason

ESteamAPICallFailure GetAPICallFailureReason( SteamAPICall_t hSteamAPICall );
NameTypBeschreibung
hSteamAPICallSteamAPICall_tDas Aufruf-Handle der Steam-API, für die der Fehler geprüft werden soll.

Liefert die Ursache für einen Fehler eines Aufrufergebnisses.

Diese Funktion dient hauptsächlich zum Debuggen. Die Fehlerursachen liegen in der Regel außerhalb Ihrer Verantwortung und sind meistens nicht sehr wichtig. Wiederholen Sie einfach Ihren API-Aufruf, bis er funktioniert.

Rückgabewert: ESteamAPICallFailure
[type]ESteamAPICallFailure[/type]

Siehe auch: IsAPICallCompleted, GetAPICallResult

Beispiel
void CHTMLSurface::OnBrowserReady( HTML_BrowserReady_t *pBrowserReady, bool bIOFailure ) { if ( bIOFailure ) { SteamUtils()->GetAPICallFailureReason( handle ); // Handle muss separat gespeichert werden. return; } }

GetAPICallResult

bool GetAPICallResult( SteamAPICall_t hSteamAPICall, void *pCallback, int cubCallback, int iCallbackExpected, bool *pbFailed );
NameTypBeschreibung
hSteamAPICallSteamAPICall_tHandle zum API-Aufruf.
pCallbackvoid *Gibt die Rückruffunktion an den angegebenen reservierten Speicher zurück.
cubCallbackintDie reservierte Größe von pCallback.
iCallbackExpectedintDie Rückruf-ID (k_iCallback) des Rückrufs
pbFailedbool *Gibt zurück, ob beim API-Aufruf ein Fehler aufgetreten ist.

Ruft den Inhalt eines abgeschlossenen API-Aufrufs ab. Stellt das Backend des CallResult-Wrappers bereit.

Es wird grundsätzlich nicht empfohlen, diese Funktion manuell aufzurufen.

Rückgabewert: bool
true bei Erfolg, wenn der API-Aufruf gültig war und abgeschlossen wurde. Andernfalls false.

Wenn der Aufruf erfolgreich ist, kopiert er den Rückruf nach pCallback und gibt aufgetretene Fehler in pbFailed zurück.

Siehe auch: IsAPICallCompleted, GetAPICallFailureReason

GetAppID

uint32 GetAppID();
Ruft die App-ID des aktuellen Prozesses ab.

Rückgabewert: uint32
Liefert die App-ID.

GetConnectedUniverse

EUniverse GetConnectedUniverse();
Ruft das Universe ab, mit dem sich der aktuelle Client verbindet. (Nur zur Verwendung durch Valve.)

Rückgabewert: EUniverse
[type]EUniverse[/type]

GetCSERIPPort

bool GetCSERIPPort( uint32 *unIP, uint16 *usPort );
NameTypBeschreibung
unIPuint32 *Gibt die IP-Adresse zurück, mit der der Client verbunden ist.
usPortuint16 *Gibt den Port zurück, mit dem der Client verbunden ist.

Gets the IP of the reporting server for Valve - currently only used in Source engine games

Rückgabewert: bool
true, wenn der Nutzer derzeit verbunden ist. Andernfalls false.

GetCurrentBatteryPower

uint8 GetCurrentBatteryPower();
Ruft den Ladestand des Akkus vom Computer ab.

Rückgabewert: uint8
Der Ladestand des Akkus im Intervall von 0 bis 100 %. Gibt 255 zurück, wenn der Benutzer mit Netzstrom versorgt wird.

GetEnteredGamepadTextInput

bool GetEnteredGamepadTextInput( char *pchText, uint32 cchText );
NameTypBeschreibung
pchTextchar *Ein reservierter Puffer, in den die eingegebene Textzeichenfolge kopiert wird.
cchTextuint32Größe des Puffers pchText

Ruft die Controller-Texteingabe aus dem Big-Picture-Overlay ab.

Dieser Aufruf muss innerhalb des Rückrufs GamepadTextInputDismissed_t erfolgen und nur, wenn GamepadTextInputDismissed_t.m_bSubmitted „true” ist.

Provides the text input as UTF-8.

Rückgabewert: bool
true, wenn es zu empfangenden Text gab und cchText der Größe von GamepadTextInputDismissed_t.m_unSubmittedText entspricht. Andernfalls false.

Siehe auch: ShowGamepadTextInput, GetEnteredGamepadTextLength

Beispiel:
void OnGamepadTextInputDismissed_t( GamepadTextInputDismissed_t* pCallback ) { // Abbruch durch Benutzer if ( !pCallback.m_bSubmitted ) return; // Max. Eingabelänge sollte der an ShowGamepadTextInput übergebenen Länge entsprechen, +1 für das Nullabschlusszeichen. const uint32 MAX_INPUT_LENGTH = 64 + 1; uint32 length = SteamUtils()->GetEnteredGamepadTextLength(); char* szTextInput[MAX_INPUT_LENGTH]; bool success = SteamUtils()->GetEnteredGamepadTextInput( szTextInput, length ); if ( !success ) { // Fehler protokollieren. Dies sollte nur passieren, wenn die Länge > MaxInputLength ist. return; } // Aktualisierten String anzeigen }

GetEnteredGamepadTextLength

uint32 GetEnteredGamepadTextLength();
Ruft die Länge der Controller-Texteingabe aus dem Big-Picture-Overlay ab.

Dieser Aufruf muss innerhalb des Rückrufs GamepadTextInputDismissed_t erfolgen und nur, wenn GamepadTextInputDismissed_t.m_bSubmitted „true” ist.

Rückgabewert: uint32


Siehe auch: ShowGamepadTextInput, GetEnteredGamepadTextInput

Beispiel:
void OnGamepadTextInputDismissed_t( GamepadTextInputDismissed_t* pCallback ) { // Abbruch durch Benutzer if ( !pCallback.m_bSubmitted ) return; // Max. Eingabelänge sollte der an ShowGamepadTextInput übergebenen Länge entsprechen, +1 für das Nullabschlusszeichen. const uint32 MAX_INPUT_LENGTH = 64 + 1; uint32 length = SteamUtils()->GetEnteredGamepadTextLength(); const char* szTextInput[MAX_INPUT_LENGTH]; bool success = SteamUtils()->GetEnteredGamepadTextInput( szTextInput, length ); if ( !success ) { // Fehler protokollieren. Dies sollte nur passieren, wenn die Länge > MaxInputLength ist. return; } // Aktualisierten String anzeigen }

GetImageRGBA

bool GetImageRGBA( int iImage, uint8 *pubDest, int nDestBufferSize );
NameTypBeschreibung
iImageintHandle zum Bild, das abgerufen werden soll.
pubDestuint8 *Der Puffer, in den geschrieben wird.
nDestBufferSizeintGröße des Puffers pubDest

Ruft die Bild-Bytes von einem Bild-Handle ab.

Vor diesem Aufruf müssen Sie die Größe des Bilds mit GetImageSize abrufen, damit Sie einen Puffer mit entsprechender Größe erstellen können. Anschließend können Sie mithilfe von Breite und Höhe die Größe Ihres Puffers ermitteln: Breite * Höhe * 4. Das Bild wird im RGBA-Format bereitgestellt. Dieser Aufruf kann ressourcenintensiv sein, da eine Konvertierung aus komprimierten Datentypen (JPG, PNG, TGA) erfolgt und der zurückgegebene Puffer nicht intern im Cache gespeichert wird. Daher wird dringend empfohlen, diesen Aufruf nur einmal pro Bild-Handle zu verwenden und das Ergebnis zwischenzuspeichern. Diese Funktion wird nur für Steam-Avatare und Bilder von Errungenschaften verwendet, die sich während des Spielens nicht ändern sollten.

Rückgabewert: bool
true bei Erfolg, wenn das Bild-Handle gültig ist und der Puffer gefüllt wurde. Andernfalls false.

Siehe auch: ISteamFriends::GetSmallFriendAvatar, ISteamFriends::GetMediumFriendAvatar, ISteamFriends::GetLargeFriendAvatar, ISteamUserStats::GetAchievementIcon

Beispiel:
HGAMETEXTURE GetSteamImageAsTexture( int iImage ) { HGAMETEXTURE hTexture = 0; // Sie sollten zunächst überprüfen, ob Sie dieses Bild bereits über etwas wie ein Wörterbuch oder eine Map // mit iImage als Schlüssel zwischengespeichert haben. Geben Sie den damit verknüpften Texture-Handle zurück, falls einer existiert. // Falls nicht, fahren Sie fort und fügen Sie die Textur zur Map hinzu, bevor Sie diese am Ende der Funktion zurückgeben. // Falls wir die Bildgröße überprüfen müssen. uint32 uAvatarWidth, uAvatarHeight; bool success = SteamUtils()->GetImageSize( iImage, &uAvatarWidth, &uAvatarHeight ); if ( !success ) { // Protokollieren Sie eine Warnmeldung. return hTexture; } // Rufen Sie die tatsächlichen RGBA-Rohdaten von Steam ab und wandeln Sie sie in unserer Spielengine in eine Textur um. const int uImageSizeInBytes = uAvatarWidth * uAvatarHeight * 4; uint8 *pAvatarRGBA = new uint8[uImageSizeInBytes]; success = SteamUtils()->GetImageRGBA( iImage, pAvatarRGBA, uImageSizeInBytes ); if( !success ) { // Tun Sie etwas, um die RGBA-Textur in Ihr internes Texturformat zur Anzeige umzuwandeln. // hTexture = m_pGameEngine->HCreateTexture( pAvatarRGBA, uAvatarWidth, uAvatarHeight ); // Und fügen Sie die Texture zum Zwischenspeicher hinzu. } // Vergessen Sie nicht, den Speicher freizugeben! delete[] pAvatarRGBA; return hTexture; }

GetImageSize

bool GetImageSize( int iImage, uint32 *pnWidth, uint32 *pnHeight );
NameTypBeschreibung
iImageintBild-Handle, dessen Größe abgerufen werden soll.
pnWidthuint32 *Gibt die Breite des Bilds zurück.
pnHeightuint32 *Gibt die Höhe des Bilds zurück.

Ruft die Größe eines Steam-Bild-Handles ab.

Dies muss vor dem Aufruf von GetImageRGBA erfolgen, um einen ausreichend großen Puffer zu erstellen, der mit den Rohdaten des Bilds gefüllt wird.

Rückgabewert: bool
true bei Erfolg, wenn das Bild-Handle gültig ist und die Bildmaße eingelesen wurde. Andernfalls false.

Siehe auch: ISteamFriends::GetSmallFriendAvatar, ISteamFriends::GetMediumFriendAvatar, ISteamFriends::GetLargeFriendAvatar, ISteamUserStats::GetAchievementIcon

GetIPCCallCount

uint32 GetIPCCallCount();
Gibt die Anzahl der IPC-Aufrufe seit der letzten Ausführung dieser Funktion zurück.

Wird zur Leistungsanalyse verwendet, damit Sie feststellen können, wie viele IPC-Aufrufe (Interprozesskommunikation / Inter-Process Communication) Ihr Spiel pro Frame macht.
Jeder IPC-Aufruf ist mindestens ein Thread-Kontextwechsel, wenn nicht sogar ein Prozesswechsel. Daher sollten Sie regulieren, wie oft Sie diese Aufrufe durchführen.

Rückgabewert: uint32

GetIPCountry

const char * GetIPCountry();
Gibt den Ländercode im zweistelligen ISO-3166-1-Alpha-2-Format für das Land zurück, in dem der Client ausgeführt wird.
Beispiel: „US”, „UK” oder „DE”

Der Code wird aus einer IP-zu-Standort-Datenbank bezogen.

Rückgabewert: const char *

GetSecondsSinceAppActive

uint32 GetSecondsSinceAppActive();
Gibt die Zeit in Sekunden zurück, seitdem die Anwendung aktiv ist.

Rückgabewert: uint32

GetSecondsSinceComputerActive

uint32 GetSecondsSinceComputerActive();
Gibt die Zeit in Sekunden zurück, seitdem der Benutzer zuletzt die Maus bewegt hat.

Rückgabewert: uint32

GetServerRealTime

uint32 GetServerRealTime();
Gibt die Steam-Serverzeit in Unixzeit zurück. (Anzahl der Sekunden seit dem 1. Januar 1970 UTC)

Rückgabewert: uint32

GetSteamUILanguage

const char * GetSteamUILanguage();
Gibt die Sprache zurück, in der der Steam-Client ausgeführt wird.

Diesen Aufruf sollte nur in sehr speziellen Fällen erforderlich sein. Verwenden Sie stattdessen ISteamApps::GetCurrentGameLanguage.

Eine vollständige Liste aller unterstützten Sprachen finden Sie hier: Unterstützte Sprachen.

Rückgabewert: const char *


Siehe auch: ISteamApps::GetCurrentGameLanguage, ISteamApps::GetAvailableGameLanguages

IsAPICallCompleted

bool IsAPICallCompleted( SteamAPICall_t hSteamAPICall, bool *pbFailed );
NameWertBeschreibung
hSteamAPICallSteamAPICall_tDas zu prüfende API-Aufruf-Handle.
pbFailedbool *Gibt zurück, ob beim API-Aufruf ein Fehler aufgetreten ist (true) oder nicht (false).

Prüft, ob ein API-Aufruf abgeschlossen wurde. Stellt das Backend des CallResult-Wrappers bereit.

Es wird grundsätzlich nicht empfohlen, diese Funktion manuell aufzurufen.

Rückgabewert: bool
true, wenn der API-Aufruf gültig war und abgeschlossen wurde. Andernfalls false.

Siehe auch: GetAPICallResult, GetAPICallFailureReason

IsOverlayEnabled

bool IsOverlayEnabled();
Prüft, ob das Steam-Overlay ausgeführt wird und vom Nutzer aufgerufen werden kann.

Möglicherweise dauert es einige Sekunden, bis der Overlay-Prozess startet und den Hook zum Spielprozess herstellt, sodass diese Funktion „false“ zurückgibt, während das Overlay geladen wird.

Rückgabewert: bool

IsSteamChinaLauncher

bool IsSteamChinaLauncher();
Gibt zurück, ob der aktuelle Launcher von Steam China ist. Sie können den Client dazu bringen, sich wie der Steam-China-Launcher zu verhalten, indem Sie „-dev -steamchina” als Startparameter in die Befehlszeile von Steam einfügen.

InitFilterText

bool InitFilterText();
Initialisiert die Textfilterung und lädt Wörterbücher für die Sprache, in der das Spiel läuft.

Nutzer können das Verhalten des Textfilters in ihren Steam-Accounteinstellungen anpassen.

Rückgabewert: bool
true, wenn die Initialisierung erfolgreich war. false, wenn Textfilterung für die Sprache des Spiels nicht verfügbar ist. In letzterem Fall agiert FilterText() als Durchgangsfunktion.

Siehe auch: FilterText

FilterText

int FilterText( ETextFilteringContext eContext, CSteamID sourceSteamID, const char *pchInputMessage, char *pchOutFilteredText, uint32 nByteSizeOutFilteredText );
NameTypBeschreibung
eContextETextFilteringContextDer Typ des Inhalts der übergebenen Zeichenfolge.
sourceSteamIDCSteamIDDie Steam-ID, welche die Quelle der Zeichenfolge darstellt (z. B. Spielername oder Chatnachricht des Nutzers).
pchInputTextconst char*Die zu filternde Zeichenfolge im ASCII- oder UTF-8-Format.
pchOutFilteredTextchar*Auszugebende Zeichenfolge, auch wenn keine Filterung vorgenommen wurde.
nByteSizeOutFilteredText uint32Die Größe von pchOutFilteredText in Bytes. Sollte mindestens strlen(pchInputText)+1 sein.
Filtert die angegebene Nachricht und liest die gefilterte Zeichenfolge in pchOutFilteredText ein. Aus rechtlichen Gründen erforderliche Filter werden immer angewendet. Je nach Kontext und Nutzereinstellungen können zusätzliche Filter angewendet werden.

Rückgabewert: int
Liefert die Anzahl der gefilterten Zeichen (nicht Bytes).

Siehe auch: InitFilterText

IsSteamInBigPictureMode

bool IsSteamInBigPictureMode();
Prüft, ob Steam und das Steam-Overlay im Big-Picture-Modus ausgeführt werden.

Games must be launched through the Steam client to enable the Big Picture overlay.
During development, a game can be added as a non-steam game to the developer's library to test this feature.

Rückgabewert: bool
true, wenn das Big-Picture-Overlay verfügbar ist. Andernfalls false.
Diese Funktion gibt immer false zurück, wenn Ihre Anwendung nicht vom Anwendungstyp „Spiel” ist.

IsSteamRunningInVR

bool IsSteamRunningInVR();
Prüft, ob Steam im VR-Modus ausgeführt wird.

Rückgabewert: bool
true, wenn Steam selbst im VR-Modus ausgeführt wird. Andernfalls false.

IsVRHeadsetStreamingEnabled

bool IsVRHeadsetStreamingEnabled();
Checks if the HMD view is being streamed via Steam Remote Play.

Rückgabewert: bool
true, wenn VR aktiviert ist und die VR-Headset-Ansicht derzeit übertragen wird. Andernfalls false.

Siehe auch: SetVRHeadsetStreamingEnabled

IsSteamRunningOnSteamDeck

bool IsSteamRunningOnSteamDeck();
Prüft, ob Steam auf einem Steam Deck ausgeführt wird.

Rückgabewert: bool
true, wenn Steam selbst auf einem Steam Deck ausgeführt wird. Andernfalls false.

SetOverlayNotificationInset

void SetOverlayNotificationInset( int nHorizontalInset, int nVerticalInset );
NameTypBeschreibung
nHorizontalInsetintDer horizontale Abstand (links-rechts) von der Ecke in Pixeln.
nVerticalInsetintDer vertikale Abstand (oben-unten) von der Ecke in Pixeln.

Stellt die Position des Overlay-Benachrichtigungsfensters relativ zur über SetOverlayNotificationPosition festgelegten Ecke ein.

Der Wert (0, 0) setzt die Position auf die Ecke zurück.

Diese Position gilt nur für das jeweilige Spiel und wird beim Start zurückgesetzt.

SetOverlayNotificationPosition

void SetOverlayNotificationPosition( ENotificationPosition eNotificationPosition );
NameTypBeschreibung
eNotificationPositionENotificationPosition

Stellt ein, in welcher Ecke das Benachrichtigungsfenster des Steam-Overlays angezeigt werden soll.

Sie können auch den Abstand von der angegebenen Ecke mit SetOverlayNotificationInset einstellen.

Diese Position gilt nur für das jeweilige Spiel und wird beim Start zurückgesetzt.

SetVRHeadsetStreamingEnabled

void SetVRHeadsetStreamingEnabled( bool bEnabled );
NameTypBeschreibung
bEnabledboolAktiviert (true) oder deaktiviert (false) das Streamen des VR-Headsets.

Stellt ein, ob die VR-Headset-Inhalte über Steam Remote Play gestreamt werden.

Wenn aktiviert, wird die Szene im VR-Headset gestreamt und Ferneingaben werden blockiert. Wenn deaktiviert, wird stattdessen das Anwendungsfenster gestreamt und Ferneingaben werden zugelassen. Bei VR-Spielen ist diese Funktion standardmäßig aktiviert, sofern in der erweiterten AppInfo für ein Spiel nicht „VRHeadsetStreaming 0” angegeben ist.

Dies ist sinnvoll für Spiele mit asymmetrischem Mehrspieler-Gameplay.

Siehe auch: IsVRHeadsetStreamingEnabled

SetWarningMessageHook

void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );
NameTypBeschreibung
pFunctionSteamAPIWarningMessageHook_tFunktionszeiger zur Rückruffunktion.

Erzeugt einen Hook für den Empfang von Warnungen und Infonachrichten in einem Rückruf von der Steam-API.

Der Funktionsprototyp muss der Definition in SteamAPIWarningMessageHook_t entsprechen. Dies schließt auch die externe C-Verknüpfung und die Anrufkonvention __cdecl ein.

„int nSeverity“ ist der Schweregrad: „0“ für Nachricht, „1“ für Warnung. Wenn Sie diesen Aufruf über einen Debugger ausführen, werden nur Warnungen gesendet. Wenn Sie der Befehlszeile „-debug_steamapi“ hinzufügen, werden auch Infonachrichten gesendet.
„const char * pchDebugText“ ist der Text der Nachricht.
Rückrufe werden direkt nach Aufruf der API-Funktion, die die Nachricht oder Warnung generiert, durchgeführt.

Die Übergabe von NULL entfernt den Hook.

Beispiel:
extern "C" void __cdecl SteamAPIDebugTextHook( int nSeverity, const char *pchDebugText ) { ::OutputDebugString( pchDebugText ); if ( nSeverity >= 1 ) { // Platz zur Einrichtung eines Haltepunkts zum Abfangen von API-Fehlern int x = 3; x = x; } } void EnableWarningMessageHook() { SteamUtils()->SetWarningMessageHook( &SteamAPIDebugTextHook ); }

ShowGamepadTextInput

bool ShowGamepadTextInput( EGamepadTextInputMode eInputMode, EGamepadTextInputLineMode eLineInputMode, const char *pchDescription, uint32 unCharMax, const char *pchExistingText );
NameTypBeschreibung
eInputModeEGamepadTextInputModeWählt den zu verwendenden Eingabemodus, entweder „Normal“ oder „Password“ (Text wird verborgen).
eLineInputModeEGamepadTextInputLineModeLegt fest, ob eine einzeilige oder mehrzeilige Eingabe verwendet wird.
pchDescriptionconst char *Legt die Beschreibung fest, mit der der Nutzer über den Zweck des Eingabedialogfelds informiert wird.
unCharMaxuint32Die maximale Anzahl von Zeichen, die der Nutzer eingeben kann.
pchExistingTextconst char *Legt den vordefinierten Text fest, den der Nutzer bearbeiten kann.

Aktiviert das Dialogfeld zur Texteingabe im Big-Picture-Modus. Dieses unterstützt nur Controllereingaben.

Rückgabewert: bool
true, wenn das Big-Picture-Overlay ausgeführt wird. Andernfalls false.

Siehe auch: GetEnteredGamepadTextLength, GetEnteredGamepadTextInput

ShowFloatingGamepadTextInput

bool ShowFloatingGamepadTextInput( EFloatingGamepadTextInputMode eKeyboardMode, int nTextFieldXPosition, int nTextFieldYPosition, int nTextFieldWidth, int nTextFieldHeight );
NameTypBeschreibung
eKeyboardModeEFloatingGamepadTextInputModeWählt den zu verwendenden Tastaturtyp.
nTextFieldXPositionintX-Koordinate des Textfelds, das von der Bildschirmtastatur nicht verdeckt werden sollte.
nTextFieldYPositionintY-Koordinate des Textfelds, das von der Bildschirmtastatur nicht verdeckt werden sollte.
nTextFieldWidthintBreite des Textfelds, das von der Bildschirmtastatur nicht verdeckt werden sollte.
nTextFieldHeight intHöhe des Textfelds, das von der Bildschirmtastatur nicht verdeckt werden sollte.

Öffnet eine Bildschirmtastatur über dem Spielinhalt und sendet Tastensignale der Tastatur vom Betriebssystem direkt an das Spiel.
Die Position der Bildschirmtastatur in Pixeln ist relativ zum Ursprung des Spielfensters und kann so positioniert werden, dass sie das Textfeld nicht verdeckt.

Rückgabewert: bool
true, wenn die Bildschirmtastatur angezeigt wurde. Andernfalls false.

Siehe auch: FloatingGamepadTextInputDismissed_t

StartVRDashboard

void StartVRDashboard();
Fordert Steam dazu auf, das OpenVR-Dashboard zu erstellen und zu rendern.

SetGameLauncherMode

void SetGameLauncherMode( bool bLauncherMode);
NameTypBeschreibung
bLauncherModeboolOb der Launcher aktiv ist oder nicht.
Spiel-Launcher ohne Controllerunterstützung können diese Funktion aufrufen, damit die Steam-Eingabe die Controllereingaben zur Navigation des Launchers in Maus- und Tastatureingaben übersetzt.

Rückrufe

These are callbacks which can be fired by calling SteamAPI_RunCallbacks. Many of these will be fired directly in response to the member functions of ISteamUtils.

CheckFileSignature_t

CallResult for CheckFileSignature.

NameTypBeschreibung
m_eCheckFileSignatureECheckFileSignatureContains the result of the file signature check.
k_ECheckFileSignatureNoSignaturesFoundForThisApp - This app has not been configured on the signing tab of the partner site to enable this function.
k_ECheckFileSignatureNoSignaturesFoundForThisFile - This file is not listed on the signing tab for the partner site.
k_ECheckFileSignatureFileNotFound - The file does not exist on disk.
k_ECheckFileSignatureInvalidSignature - The file exists, and the signing tab has been set for this file, but the file is either not signed or the signature does not match.
k_ECheckFileSignatureValidSignature - The file is signed and the signature is valid.

Verknüpfte Funktionen: CheckFileSignature

GamepadTextInputDismissed_t

Called when the big picture gamepad text input has been closed.

NameTypBeschreibung
m_bSubmittedbooltrue, wenn der Nutzer Text eingegeben und gesendet hat. (Der Text kann mit GetEnteredGamepadTextInput abgefragt werden.) false, wenn die Eingabe abgebrochen wurde.
m_unSubmittedTextuint32Enthält die Länge in Bytes, wenn Text gesendet wurde.

FloatingGamepadTextInputDismissed_t

Called when the floating keyboard invoked from ShowFloatingGamepadTextInput has been closed.

IPCountry_t

Called when the country of the user changed. The country should be updated with GetIPCountry.

This callback has no fields.

LowBatteryPower_t

Called when running on a laptop and less than 10 minutes of battery is left, and then fires then every minute afterwards.

NameTypBeschreibung
m_nMinutesBatteryLeftuint8Geschätzte verbleibende Akkulaufzeit in Minuten.

SteamAPICallCompleted_t

Called when a SteamAPICall_t has completed (or failed)

NameTypBeschreibung
m_hAsyncCallSteamAPICall_tHandle des abgeschlossenen Steam-API-Aufrufs.
m_iCallbackintDies ist die Konstante k_iCallback, die die abgeschlossene Rückruffunktion eindeutig identifiziert.
m_cubParamuint32Größe der abgeschlossenen Rückruffunktion in Bytes.

AppResumingFromSuspend_t

Sent after the device returns from sleep/suspend mode.

This callback has no fields.

SteamShutdown_t

Called when Steam wants to shutdown.

Dieser Rückruf hat keine Variablen.

Aufzählungstypen

These are enums which are defined for use with ISteamUtils.

ECheckFileSignature

The result of a call to CheckFileSignature

NameWertBeschreibung
k_ECheckFileSignatureInvalidSignature0
k_ECheckFileSignatureValidSignature1
k_ECheckFileSignatureFileNotFound2
k_ECheckFileSignatureNoSignaturesFoundForThisApp3
k_ECheckFileSignatureNoSignaturesFoundForThisFile4

EGamepadTextInputLineMode

Controls number of allowed lines for the Big Picture gamepad text entry

NameWertBeschreibung
k_EGamepadTextInputLineModeSingleLine0
k_EGamepadTextInputLineModeMultipleLines1

EGamepadTextInputMode

Input modes for the Big Picture gamepad text entry

NameWertBeschreibung
k_EGamepadTextInputModeNormal0
k_EGamepadTextInputModePassword1

EFloatingGamepadTextInputMode

Controls the mode for the floating keyboard

NameWertBeschreibung
k_EFloatingGamepadTextInputModeModeSingleLine0Die Rückgabetaste schließt die Tastatur.
k_EFloatingGamepadTextInputModeModeMultipleLines1Der Nutzer muss die Tastatur explizit schließen.
k_EFloatingGamepadTextInputModeModeEmail2Die Tastatur wird in einem speziellen Modus angezeigt, der das Verfassen von E-Mails vereinfacht.
k_EFloatingGamepadTextInputModeModeNumeric3Zeigt die numerische Tastatur.

ESteamAPICallFailure

Steam API call failure results returned by GetAPICallFailureReason.

NameWertBeschreibung
k_ESteamAPICallFailureNone-1Kein Fehler
k_ESteamAPICallFailureSteamGone0Der lokale Steam-Prozess reagiert nicht mehr. Möglicherweise wurde die Beendigung des Prozesses erzwungen oder er ist eingefroren.
k_ESteamAPICallFailureNetworkFailure1Die Netzwerkverbindung zu den Steam-Servern wurde unterbrochen oder war bereits unterbrochen.
Der Rückruf SteamServersDisconnected_t wird etwa zur selben Zeit gesendet und der Rückruf SteamServersConnected_t wird gesendet, wenn der Client wieder mit den Steam-Servern kommunizieren kann.
k_ESteamAPICallFailureInvalidHandle2Das übergebene Handle von SteamAPICall_t existiert nicht mehr.
k_ESteamAPICallFailureMismatchedCallback3GetAPICallResult wurde mit dem falschen Rückruftyp aufgerufen.

Konstanten

These are constants which are defined for use with ISteamUtils.

NameTypWertBeschreibung
STEAMUTILS_INTERFACE_VERSIONconst char *"SteamUtils009"