SteamGameServerClient
Classpublic static class SteamGameServerClientMethods
Releases a previously created communications pipe NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling
public static bool BReleaseSteamPipe(HSteamPipe hSteamPipe)- hSteamPipeHSteamPipe
Trigger global shutdown for the DLL
public static bool BShutdownIfAllPipesClosed()connects to an existing global user, failing if none exists used by the game to coordinate with the steamUI NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling
public static HSteamUser ConnectToGlobalUser(HSteamPipe hSteamPipe)- hSteamPipeHSteamPipe
used by game servers, create a steam user that won't be shared with anyone else NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling
public static HSteamUser CreateLocalUser(out HSteamPipe phSteamPipe, EAccountType eAccountType)- phSteamPipeHSteamPipe
- eAccountTypeEAccountType
Creates a communication pipe to the Steam client. NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling
public static HSteamPipe CreateSteamPipe()returns the number of IPC calls made since the last time this function was called Used for perf debugging so you can understand how many IPC calls your game makes per frame Every IPC call is at minimum a thread context switch if not a process one so you want to rate control how often you do them.
public static uint GetIPCCallCount()returns apps interface
public static nint GetISteamApps(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Exposes the ISteamController interface - deprecated in favor of Steam Input
public static nint GetISteamController(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
returns the ISteamFriends interface
public static nint GetISteamFriends(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
game search
public static nint GetISteamGameSearch(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
retrieves the ISteamGameServer interface associated with the handle
public static nint GetISteamGameServer(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
returns the ISteamGameServerStats interface
public static nint GetISteamGameServerStats(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
returns the a generic interface
public static nint GetISteamGenericInterface(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
html page display
public static nint GetISteamHTMLSurface(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Expose HTTP interface
public static nint GetISteamHTTP(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Exposes the Steam Input interface for controller support
public static nint GetISteamInput(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
inventory
public static nint GetISteamInventory(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
returns the ISteamMatchmaking interface
public static nint GetISteamMatchmaking(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
returns the ISteamMatchmakingServers interface
public static nint GetISteamMatchmakingServers(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Music Player
public static nint GetISteamMusic(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Music Player Remote
public static nint GetISteamMusicRemote(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
networking
public static nint GetISteamNetworking(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Parental controls
public static nint GetISteamParentalSettings(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Steam Parties interface
public static nint GetISteamParties(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Steam Remote Play interface
public static nint GetISteamRemotePlay(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
remote storage
public static nint GetISteamRemoteStorage(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
user screenshots
public static nint GetISteamScreenshots(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
Exposes the ISteamUGC interface
public static nint GetISteamUGC(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
retrieves the ISteamUser interface associated with the handle
public static nint GetISteamUser(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
returns the ISteamUserStats interface
public static nint GetISteamUserStats(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
returns the ISteamUtils interface
public static nint GetISteamUtils(HSteamPipe hSteamPipe, string pchVersion)- hSteamPipeHSteamPipe
- pchVersionstring
Video
public static nint GetISteamVideo(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuserHSteamUser
- hSteamPipeHSteamPipe
- pchVersionstring
removes an allocated user NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling
public static void ReleaseUser(HSteamPipe hSteamPipe, HSteamUser hUser)- hSteamPipeHSteamPipe
- hUserHSteamUser
set the local IP and Port to bind to this must be set before CreateLocalUser()
public static void SetLocalIPBinding(ref SteamIPAddress_t unIP, ushort usPort)- unIPSteamIPAddress_t
- usPortushort
API warning handling 'int' is the severity; 0 for msg, 1 for warning 'const char *' is the text of the message callbacks will occur directly after the API function is called that generated the warning or message.
public static void SetWarningMessageHook(SteamAPIWarningMessageHook_t pFunction)- pFunctionSteamAPIWarningMessageHook_t