C# 클래스 Steamworks.SteamClient

파일 보기 프로젝트 열기: rlabrecque/Steamworks.NET 1 사용 예제들

공개 메소드들

메소드 설명
BReleaseSteamPipe ( HSteamPipe hSteamPipe ) : bool

Releases a previously created communications pipe

NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling
BShutdownIfAllPipesClosed ( ) : bool

Trigger global shutdown for the DLL
ConnectToGlobalUser ( HSteamPipe hSteamPipe ) : HSteamUser

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
CreateLocalUser ( HSteamPipe &phSteamPipe, EAccountType eAccountType ) : HSteamUser

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
CreateSteamPipe ( ) : HSteamPipe

Creates a communication pipe to the Steam client.

NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling
GetIPCCallCount ( ) : uint

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.
GetISteamAppList ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns app list interface, only available on specially registered apps
GetISteamApps ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns apps interface
GetISteamController ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

Exposes the ISteamController interface
GetISteamFriends ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns the ISteamFriends interface
GetISteamGameServer ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

retrieves the ISteamGameServer interface associated with the handle
GetISteamGameServerStats ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns the ISteamGameServerStats interface
GetISteamGenericInterface ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns the a generic interface
GetISteamHTMLSurface ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

html page display
GetISteamHTTP ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

Expose HTTP interface
GetISteamInventory ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

inventory
GetISteamMatchmaking ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns the ISteamMatchmaking interface
GetISteamMatchmakingServers ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns the ISteamMatchmakingServers interface
GetISteamMusic ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

Music Player
GetISteamMusicRemote ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

Music Player Remote
GetISteamNetworking ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

networking
GetISteamRemoteStorage ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

remote storage
GetISteamScreenshots ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

user screenshots
GetISteamUGC ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

Exposes the ISteamUGC interface
GetISteamUnifiedMessages ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

Exposes the ISteamUnifiedMessages interface
GetISteamUser ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

retrieves the ISteamUser interface associated with the handle
GetISteamUserStats ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns the ISteamUserStats interface
GetISteamUtils ( HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

returns the ISteamUtils interface
GetISteamVideo ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr

Video
ReleaseUser ( HSteamPipe hSteamPipe, HSteamUser hUser ) : void

removes an allocated user

NOT THREADSAFE - ensure that no other threads are accessing Steamworks API when calling
SetLocalIPBinding ( uint unIP, ushort usPort ) : void

set the local IP and Port to bind to

this must be set before CreateLocalUser()
SetWarningMessageHook ( SteamAPIWarningMessageHook_t pFunction ) : void

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.

메소드 상세

BReleaseSteamPipe() 공개 정적인 메소드

Releases a previously created communications pipe

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

public static BReleaseSteamPipe ( HSteamPipe hSteamPipe ) : bool
hSteamPipe HSteamPipe
리턴 bool

BShutdownIfAllPipesClosed() 공개 정적인 메소드

Trigger global shutdown for the DLL

public static BShutdownIfAllPipesClosed ( ) : bool
리턴 bool

ConnectToGlobalUser() 공개 정적인 메소드

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 ConnectToGlobalUser ( HSteamPipe hSteamPipe ) : HSteamUser
hSteamPipe HSteamPipe
리턴 HSteamUser

CreateLocalUser() 공개 정적인 메소드

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 CreateLocalUser ( HSteamPipe &phSteamPipe, EAccountType eAccountType ) : HSteamUser
phSteamPipe HSteamPipe
eAccountType EAccountType
리턴 HSteamUser

CreateSteamPipe() 공개 정적인 메소드

Creates a communication pipe to the Steam client.

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

public static CreateSteamPipe ( ) : HSteamPipe
리턴 HSteamPipe

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 GetIPCCallCount ( ) : uint
리턴 uint

GetISteamAppList() 공개 정적인 메소드

returns app list interface, only available on specially registered apps

public static GetISteamAppList ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamApps() 공개 정적인 메소드

returns apps interface

public static GetISteamApps ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamController() 공개 정적인 메소드

Exposes the ISteamController interface

public static GetISteamController ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamFriends() 공개 정적인 메소드

returns the ISteamFriends interface

public static GetISteamFriends ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamGameServer() 공개 정적인 메소드

retrieves the ISteamGameServer interface associated with the handle

public static GetISteamGameServer ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamGameServerStats() 공개 정적인 메소드

returns the ISteamGameServerStats interface

public static GetISteamGameServerStats ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamGenericInterface() 공개 정적인 메소드

returns the a generic interface

public static GetISteamGenericInterface ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamHTMLSurface() 공개 정적인 메소드

html page display

public static GetISteamHTMLSurface ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamHTTP() 공개 정적인 메소드

Expose HTTP interface

public static GetISteamHTTP ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamInventory() 공개 정적인 메소드

inventory

public static GetISteamInventory ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamMatchmaking() 공개 정적인 메소드

returns the ISteamMatchmaking interface

public static GetISteamMatchmaking ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamMatchmakingServers() 공개 정적인 메소드

returns the ISteamMatchmakingServers interface

public static GetISteamMatchmakingServers ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamMusic() 공개 정적인 메소드

Music Player

public static GetISteamMusic ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamMusicRemote() 공개 정적인 메소드

Music Player Remote

public static GetISteamMusicRemote ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamNetworking() 공개 정적인 메소드

networking

public static GetISteamNetworking ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamRemoteStorage() 공개 정적인 메소드

remote storage

public static GetISteamRemoteStorage ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamScreenshots() 공개 정적인 메소드

user screenshots

public static GetISteamScreenshots ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamUGC() 공개 정적인 메소드

Exposes the ISteamUGC interface

public static GetISteamUGC ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamUnifiedMessages() 공개 정적인 메소드

Exposes the ISteamUnifiedMessages interface

public static GetISteamUnifiedMessages ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamUser() 공개 정적인 메소드

retrieves the ISteamUser interface associated with the handle

public static GetISteamUser ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamUserStats() 공개 정적인 메소드

returns the ISteamUserStats interface

public static GetISteamUserStats ( HSteamUser hSteamUser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamUser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamUtils() 공개 정적인 메소드

returns the ISteamUtils interface

public static GetISteamUtils ( HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

GetISteamVideo() 공개 정적인 메소드

Video

public static GetISteamVideo ( HSteamUser hSteamuser, HSteamPipe hSteamPipe, string pchVersion ) : IntPtr
hSteamuser HSteamUser
hSteamPipe HSteamPipe
pchVersion string
리턴 System.IntPtr

ReleaseUser() 공개 정적인 메소드

removes an allocated user

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

public static ReleaseUser ( HSteamPipe hSteamPipe, HSteamUser hUser ) : void
hSteamPipe HSteamPipe
hUser HSteamUser
리턴 void

SetLocalIPBinding() 공개 정적인 메소드

set the local IP and Port to bind to

this must be set before CreateLocalUser()

public static SetLocalIPBinding ( uint unIP, ushort usPort ) : void
unIP uint
usPort ushort
리턴 void

SetWarningMessageHook() 공개 정적인 메소드

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 SetWarningMessageHook ( SteamAPIWarningMessageHook_t pFunction ) : void
pFunction SteamAPIWarningMessageHook_t
리턴 void