SteamGameServerClient
Class SteamGameServerClient
Namespace: SwiftlyS2.Shared.SteamAPI
Assembly: SwiftlyS2.CS2.dll
public static class SteamGameServerClientInheritance
Inherited Members
- object.Equals(object?)
- object.Equals(object?, object?)
- object.GetHashCode()
- object.GetType()
- object.MemberwiseClone()
- object.ReferenceEquals(object?, object?)
- object.ToString()
Methods
BReleaseSteamPipe(HSteamPipe)
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)- hSteamPipe HSteamPipe
BShutdownIfAllPipesClosed()
Trigger global shutdown for the DLL
public static bool BShutdownIfAllPipesClosed()ConnectToGlobalUser(HSteamPipe)
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)- hSteamPipe HSteamPipe
CreateLocalUser(out HSteamPipe, EAccountType)
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)- phSteamPipe HSteamPipe
- eAccountType EAccountType
CreateSteamPipe()
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()GetIPCCallCount()
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()GetISteamApps(HSteamUser, HSteamPipe, string)
returns apps interface
public static nint GetISteamApps(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamController(HSteamUser, HSteamPipe, string)
Exposes the ISteamController interface - deprecated in favor of Steam Input
public static nint GetISteamController(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamFriends(HSteamUser, HSteamPipe, string)
returns the ISteamFriends interface
public static nint GetISteamFriends(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamGameSearch(HSteamUser, HSteamPipe, string)
game search
public static nint GetISteamGameSearch(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamGameServer(HSteamUser, HSteamPipe, string)
retrieves the ISteamGameServer interface associated with the handle
public static nint GetISteamGameServer(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamGameServerStats(HSteamUser, HSteamPipe, string)
returns the ISteamGameServerStats interface
public static nint GetISteamGameServerStats(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamGenericInterface(HSteamUser, HSteamPipe, string)
returns the a generic interface
public static nint GetISteamGenericInterface(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamHTMLSurface(HSteamUser, HSteamPipe, string)
html page display
public static nint GetISteamHTMLSurface(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamHTTP(HSteamUser, HSteamPipe, string)
Expose HTTP interface
public static nint GetISteamHTTP(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamInput(HSteamUser, HSteamPipe, string)
Exposes the Steam Input interface for controller support
public static nint GetISteamInput(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamInventory(HSteamUser, HSteamPipe, string)
inventory
public static nint GetISteamInventory(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamMatchmaking(HSteamUser, HSteamPipe, string)
returns the ISteamMatchmaking interface
public static nint GetISteamMatchmaking(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamMatchmakingServers(HSteamUser, HSteamPipe, string)
returns the ISteamMatchmakingServers interface
public static nint GetISteamMatchmakingServers(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamMusic(HSteamUser, HSteamPipe, string)
Music Player
public static nint GetISteamMusic(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamMusicRemote(HSteamUser, HSteamPipe, string)
Music Player Remote
public static nint GetISteamMusicRemote(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamNetworking(HSteamUser, HSteamPipe, string)
networking
public static nint GetISteamNetworking(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamParentalSettings(HSteamUser, HSteamPipe, string)
Parental controls
public static nint GetISteamParentalSettings(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamParties(HSteamUser, HSteamPipe, string)
Steam Parties interface
public static nint GetISteamParties(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamRemotePlay(HSteamUser, HSteamPipe, string)
Steam Remote Play interface
public static nint GetISteamRemotePlay(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamRemoteStorage(HSteamUser, HSteamPipe, string)
remote storage
public static nint GetISteamRemoteStorage(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamScreenshots(HSteamUser, HSteamPipe, string)
user screenshots
public static nint GetISteamScreenshots(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamUGC(HSteamUser, HSteamPipe, string)
Exposes the ISteamUGC interface
public static nint GetISteamUGC(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamUser(HSteamUser, HSteamPipe, string)
retrieves the ISteamUser interface associated with the handle
public static nint GetISteamUser(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamUserStats(HSteamUser, HSteamPipe, string)
returns the ISteamUserStats interface
public static nint GetISteamUserStats(HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)- hSteamUser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
GetISteamUtils(HSteamPipe, string)
returns the ISteamUtils interface
public static nint GetISteamUtils(HSteamPipe hSteamPipe, string pchVersion)- hSteamPipe HSteamPipe
- pchVersion string
GetISteamVideo(HSteamUser, HSteamPipe, string)
Video
public static nint GetISteamVideo(HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)- hSteamuser HSteamUser
- hSteamPipe HSteamPipe
- pchVersion string
ReleaseUser(HSteamPipe, HSteamUser)
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)- hSteamPipe HSteamPipe
- hUser HSteamUser
SetLocalIPBinding(ref SteamIPAddress_t, ushort)
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)- unIP SteamIPAddress_t
- usPort ushort
SetWarningMessageHook(SteamAPIWarningMessageHook_t)
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)- pFunction SteamAPIWarningMessageHook_t