Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Static Public Member Functions | List of all members
Steamworks.SteamClient Class Reference

Static Public Member Functions

static bool BReleaseSteamPipe (HSteamPipe hSteamPipe)
 
static bool BShutdownIfAllPipesClosed ()
 
static HSteamUser ConnectToGlobalUser (HSteamPipe hSteamPipe)
 
static HSteamUser CreateLocalUser (out HSteamPipe phSteamPipe, EAccountType eAccountType)
 
static HSteamPipe CreateSteamPipe ()
 
static uint GetIPCCallCount ()
 
static IntPtr GetISteamAppList (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamApps (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamController (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamFriends (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamGameServer (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamGameServerStats (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamGenericInterface (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamHTMLSurface (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamHTTP (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamInventory (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamMatchmaking (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamMatchmakingServers (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamMusic (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamMusicRemote (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamNetworking (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamParentalSettings (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamRemoteStorage (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamScreenshots (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamUGC (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamUnifiedMessages (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamUser (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamUserStats (HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamUtils (HSteamPipe hSteamPipe, string pchVersion)
 
static IntPtr GetISteamVideo (HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion)
 
static void ReleaseUser (HSteamPipe hSteamPipe, HSteamUser hUser)
 
static void SetLocalIPBinding (uint unIP, ushort usPort)
 
static void SetWarningMessageHook (SteamAPIWarningMessageHook_t pFunction)
 

Member Function Documentation

static bool Steamworks.SteamClient.BReleaseSteamPipe ( HSteamPipe  hSteamPipe)
inlinestatic

Releases a previously created communications pipe

NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling

static bool Steamworks.SteamClient.BShutdownIfAllPipesClosed ( )
inlinestatic

Trigger global shutdown for the DLL

static HSteamUser Steamworks.SteamClient.ConnectToGlobalUser ( HSteamPipe  hSteamPipe)
inlinestatic

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

static HSteamUser Steamworks.SteamClient.CreateLocalUser ( out HSteamPipe  phSteamPipe,
EAccountType  eAccountType 
)
inlinestatic

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

static HSteamPipe Steamworks.SteamClient.CreateSteamPipe ( )
inlinestatic

Creates a communication pipe to the Steam client.

NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling

static uint Steamworks.SteamClient.GetIPCCallCount ( )
inlinestatic

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.

static IntPtr Steamworks.SteamClient.GetISteamAppList ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns app list interface, only available on specially registered apps

static IntPtr Steamworks.SteamClient.GetISteamApps ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns apps interface

static IntPtr Steamworks.SteamClient.GetISteamController ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

Exposes the ISteamController interface

static IntPtr Steamworks.SteamClient.GetISteamFriends ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns the ISteamFriends interface

static IntPtr Steamworks.SteamClient.GetISteamGameServer ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

retrieves the ISteamGameServer interface associated with the handle

static IntPtr Steamworks.SteamClient.GetISteamGameServerStats ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns the ISteamGameServerStats interface

static IntPtr Steamworks.SteamClient.GetISteamGenericInterface ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns the a generic interface

static IntPtr Steamworks.SteamClient.GetISteamHTMLSurface ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

html page display

static IntPtr Steamworks.SteamClient.GetISteamHTTP ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

Expose HTTP interface

static IntPtr Steamworks.SteamClient.GetISteamInventory ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

inventory

static IntPtr Steamworks.SteamClient.GetISteamMatchmaking ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns the ISteamMatchmaking interface

static IntPtr Steamworks.SteamClient.GetISteamMatchmakingServers ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns the ISteamMatchmakingServers interface

static IntPtr Steamworks.SteamClient.GetISteamMusic ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

Music Player

static IntPtr Steamworks.SteamClient.GetISteamMusicRemote ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

Music Player Remote

static IntPtr Steamworks.SteamClient.GetISteamNetworking ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

networking

static IntPtr Steamworks.SteamClient.GetISteamParentalSettings ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

Parental controls

static IntPtr Steamworks.SteamClient.GetISteamRemoteStorage ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

remote storage

static IntPtr Steamworks.SteamClient.GetISteamScreenshots ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

user screenshots

static IntPtr Steamworks.SteamClient.GetISteamUGC ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

Exposes the ISteamUGC interface

static IntPtr Steamworks.SteamClient.GetISteamUnifiedMessages ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

Exposes the ISteamUnifiedMessages interface

static IntPtr Steamworks.SteamClient.GetISteamUser ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

retrieves the ISteamUser interface associated with the handle

static IntPtr Steamworks.SteamClient.GetISteamUserStats ( HSteamUser  hSteamUser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns the ISteamUserStats interface

static IntPtr Steamworks.SteamClient.GetISteamUtils ( HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

returns the ISteamUtils interface

static IntPtr Steamworks.SteamClient.GetISteamVideo ( HSteamUser  hSteamuser,
HSteamPipe  hSteamPipe,
string  pchVersion 
)
inlinestatic

Video

static void Steamworks.SteamClient.ReleaseUser ( HSteamPipe  hSteamPipe,
HSteamUser  hUser 
)
inlinestatic

removes an allocated user

NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling

static void Steamworks.SteamClient.SetLocalIPBinding ( uint  unIP,
ushort  usPort 
)
inlinestatic

set the local IP and Port to bind to

this must be set before CreateLocalUser()

static void Steamworks.SteamClient.SetWarningMessageHook ( SteamAPIWarningMessageHook_t  pFunction)
inlinestatic

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.


The documentation for this class was generated from the following file: