Використовується для створення нового екземпляру Steam чи для підключення до наявного, незалежно від того, це локальний чи інший процес.
У більшості сценаріїв усі ці процеси обробляються автоматично за допомогою
SteamAPI_Init.
Вам знадобиться цей інтерфейс, лише якщо у вас більш складна система версій, або якщо ви захочете реалізувати мультиплексний ігровий сервер із кількома SteamID, що дозволить керувати кількома іграми за допомогою одного процесу.
Функції-члени
Функції-члени для
ISteamClient
викликаються за допомогою глобальної функції доступу
SteamClient()
.
BReleaseSteamPipe
bool BReleaseSteamPipe( HSteamPipe hSteamPipe );
Назва | Тип | Опис |
hSteamPipe | HSteamPipe | Канал, який слід звільнити. |
Звільнює раніше створений комунікаційний канал.
НЕ ПОТОКОБЕЗПЕЧНО. Переконайтеся, що жоден інший потік не має доступу до API Steamworks під час виклику!
Повернені значення: bool
true — якщо канал дійсний та успішно випущений; інакше
false.
BShutdownIfAllPipesClosed
bool BShutdownIfAllPipesClosed();
Викликає глобальне закриття DLL, якщо всі канали закрито.
Повернені значення: bool
ConnectToGlobalUser
HSteamUser ConnectToGlobalUser( HSteamPipe hSteamPipe );
Назва | Тип | Опис |
hSteamPipe | HSteamPipe | Канал підключення для підключення. |
Підключає до наявного глобального користувача. Якщо таких немає, то виклик не відбувається.
Використовується грою для координації зі SteamUI.
НЕ ПОТОКОБЕЗПЕЧНО. Переконайтеся, що жоден інший потік не має доступу до API Steamworks під час виклику!
Повернені значення: HSteamUserДескриптор HSteamUser глобального користувача. Повертає 0, якщо виклик не вдався (хибний канал чи відсутній глобальний користувач).
CreateLocalUser
HSteamUser CreateLocalUser( HSteamPipe *phSteamPipe, EAccountType eAccountType );
Створює користувача Steam, якого не бачитиме ніхто інший. Використовується лише ігровими серверами.
НЕ ПОТОКОБЕЗПЕЧНО. Переконайтеся, що жоден інший потік не має доступу до API Steamworks під час виклику!
Повернені значення: HSteamUserНовий дескриптор для SteamUser.
CreateSteamPipe
HSteamPipe CreateSteamPipe();
Створює комунікаційний канал до клієнта Steam.
НЕ ПОТОКОБЕЗПЕЧНО. Переконайтеся, що жоден інший потік не має доступу до API Steamworks під час виклику!
Повернені значення: HSteamPipeGetIPCCallCount
uint32 GetIPCCallCount();
Повертає кількість міжпроцесових викликів (IPC), що були зроблені з часу останнього виклику цієї функції.
Використовується для налагодження швидкодії й розуміння того, як багато міжпроцесових викликів робить ваша гра за один кадр. Кожен міжпроцесовий виклик перемикає якщо не сам процес, то принаймні контекст потоку, тож рекомендується виконувати виклики обережно й контролювати їхню частоту.
Повернені значення: uint32GetISteamApps
ISteamApps * GetISteamApps( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamApps, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMAPPS_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamApps()
.
Повернені значення: ISteamApps *
Вказівник на впровадження SteamApps, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamController
ISteamController * GetISteamController( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamController, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMCONTROLLER_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamController()
.
Повернені значення: ISteamController *
Вказівник на впровадження SteamController, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamFriends
ISteamFriends * GetISteamFriends( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamFriends, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMFRIENDS_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamFriends()
.
Повернені значення: ISteamFriends *
Вказівник на впровадження SteamFriends, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamGameServer
ISteamGameServer * GetISteamGameServer( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamGameServer, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMGAMESERVER_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamGameServer()
.
Повернені значення: ISteamGameServer *
Вказівник на впровадження SteamGameServer, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamGameServerStats
ISteamGameServerStats * GetISteamGameServerStats( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamGameServerStats, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMGAMESERVERSTATS_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamGameServerStats()
.
Повернені значення: ISteamGameServerStats *
Вказівник на впровадження SteamGameServerStats, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamGenericInterface
void * GetISteamGenericInterface( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує звичайний інтерфейс, пов’язаний із вказаним дескриптором користувача.
За звичайних умов вам ніколи не доведеться це використовувати.
Повернені значення: void *
Вказівник на впровадження інтерфейсу, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamHTMLSurface
ISteamHTMLSurface * GetISteamHTMLSurface( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamHTMLSurface, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMHTMLSURFACE_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamHTMLSurface()
.
Повернені значення: ISteamHTMLSurface *
Вказівник на впровадження SteamHTMLSurface, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamHTTP
ISteamHTTP * GetISteamHTTP( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamHTTP, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMHTTP_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamHTTP()
.
Повернені значення: ISteamHTTP *
Вказівник на впровадження SteamHTTP, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamInventory
ISteamInventory * GetISteamInventory( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamInventory, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMINVENTORY_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamInventory()
.
Повернені значення: ISteamInventory *
Вказівник на впровадження SteamInventory, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamMatchmaking
ISteamMatchmaking * GetISteamMatchmaking( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamMatchmaking, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMMATCHMAKING_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamMatchmaking()
.
Повернені значення: ISteamMatchmaking *
Вказівник на впровадження SteamMatchmaking, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamMatchmakingServers
ISteamMatchmakingServers * GetISteamMatchmakingServers( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamMatchmakingServers, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMMATCHMAKINGSERVERS_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamMatchmakingServers()
.
Повернені значення: ISteamMatchmakingServers *
Вказівник на впровадження SteamMatchmakingServers, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamMusic
ISteamMusic * GetISteamMusic( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamMusic, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMMUSIC_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamMusic()
.
Повернені значення: ISteamMusic *
Вказівник на впровадження SteamMusic, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamMusicRemote
ISteamMusicRemote * GetISteamMusicRemote( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamMusicRemote, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMMUSICREMOTE_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamMusicRemote()
.
Повернені значення: ISteamMusicRemote *
Вказівник на впровадження SteamMusicRemote, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamNetworking
ISteamNetworking * GetISteamNetworking( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamNetworking, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMNETWORKING_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamNetworking()
.
Повернені значення: ISteamNetworking *
Вказівник на впровадження SteamNetworking, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamRemoteStorage
ISteamRemoteStorage * GetISteamRemoteStorage( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamRemoteStorage, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMREMOTESTORAGE_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamRemoteStorage()
.
Повернені значення: ISteamRemoteStorage *
Вказівник на впровадження SteamRemoteStorage, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamScreenshots
ISteamScreenshots * GetISteamScreenshots( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamScreenshots, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMSCREENSHOTS_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamScreenshots()
.
Повернені значення: ISteamScreenshots *
Вказівник на впровадження SteamScreenshots, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamUGC
ISteamUGC * GetISteamUGC( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamUGC, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMUGC_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamUGC()
.
Повернені значення: ISteamUGC *
Вказівник на впровадження SteamUGC, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamUnifiedMessages
ISteamUnifiedMessages * GetISteamUnifiedMessages( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamUnifiedMessages, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMUNIFIEDMESSAGES_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamUnifiedMessages()
.
Повернені значення: ISteamUnifiedMessages *
Вказівник на впровадження SteamUnifiedMessages, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamUser
ISteamUser * GetISteamUser( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamUser, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMUSER_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamUser()
.
Повернені значення: ISteamUser *
Вказівник на впровадження SteamUser, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamUserStats
ISteamUserStats * GetISteamUserStats( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamUserStats, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMUSERSTATS_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamUserStats()
.
Повернені значення: ISteamUserStats *
Вказівник на впровадження SteamUserStats, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamUtils
ISteamUtils * GetISteamUtils( HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamUtils, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMUTILS_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamUtils()
.
Повернені значення: ISteamUtils *
Вказівник на впровадження SteamUtils, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
GetISteamVideo
ISteamVideo * GetISteamVideo( HSteamUser hSteamUser, HSteamPipe hSteamPipe, const char *pchVersion );
Назва | Тип | Опис |
hSteamUser | HSteamUser | Дескриптор користувача, з якого отримується інтерфейс. |
hSteamPipe | HSteamPipe | Канал для доступу до інтерфейсу. |
pchVersion | const char * | Рядок версії, що визначає версію отриманого вами інтерфейсу. |
Отримує інтерфейс
ISteamVideo, пов’язаний із вказаним дескриптором користувача.
Константа, що містить поточну версію інтерфейсу: STEAMVIDEO_INTERFACE_VERSION.
За звичайних умов вам ніколи не доведеться цим користуватися, бо, як правило, функціональним еквівалентом є виклик глобальної функції доступу:
SteamVideo()
.
Повернені значення: ISteamVideo *
Вказівник на впровадження SteamVideo, пов’язаного з наданим HSteamUser.
Повертає NULL, якщо якийсь з аргументів недійсний.
ReleaseUser
void ReleaseUser( HSteamPipe hSteamPipe, HSteamUser hUser );
Назва | Тип | Опис |
hSteamPipe | HSteamPipe | Канал підключення для вилучення користувача. |
hUser | HSteamUser | Користувач, якого слід вилучити. |
Вилучає призначеного користувача.
НЕ ПОТОКОБЕЗПЕЧНО. Переконайтеся, що жоден інший потік не має доступу до API Steamworks під час виклику!
SetLocalIPBinding
void SetLocalIPBinding( uint32 unIP, uint16 usPort );
Назва | Тип | Опис |
unIP | uint32 | Локальний IP для призначення. |
usPort | uint16 | Порт для призначення. |
Встановлює локальний IP і порт для призначення.
Це необхідно встановити до виклику
CreateLocalUser!
SetWarningMessageHook
void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );
Назва | Тип | Опис |
pFunction | SteamAPIWarningMessageHook_t | Вказівник функції на функцію зворотного виклику. |
Установлює перехоплення повідомлень із попередженнями для отримання попереджень SteamAPI й інформаційних повідомлень у функції зворотного виклику.
Прототип функції повинен збігатися з визначенням у SteamAPIWarningMessageHook_t. Включає зв’язок із «C» і угоду про виклики __cdecl.
«int nSeverity» — критичність; 0 — повідомлення, 1 — попередження. Якщо запускаєте через налагоджувач, то надсилатимуться тільки попередження. Якщо ви додаєте -debug_steamapi до командного рядка, то інформаційні повідомлення також надсилатимуться.
«const char * pchDebugText» — це текст повідомлення.
Зворотні виклики відбуваються безпосередньо після виклику функції API, яка генерує попередження чи повідомлення.
Передавання NULL видаляє перехоплення.
Приклад:extern "C" void __cdecl SteamAPIDebugTextHook( int nSeverity, const char *pchDebugText )
{
::OutputDebugString( pchDebugText );
if ( nSeverity >= 1 )
{
// місце для перехоплення помилок API
int x = 3;
x = x;
}
}
void EnableWarningMessageHook()
{
SteamUtils()->SetWarningMessageHook( &SteamAPIDebugTextHook );
}
Typedefs
Це typedefs, які визначені для використання з ISteamClient.
Назва | Базовий тип | Опис |
HSteamPipe | int32 | Дескриптор для каналу комунікації з клієнтом Steam. |
HSteamUser | int32 | Дескриптор для одного екземпляру користувача Steam. |