SteamWorks.SteamClient - theace0296/steamworks-node GitHub Wiki

Interface: SteamClient

SteamWorksNamespace.SteamClient

Table of contents

Properties

Properties

BReleaseSteamPipe

• BReleaseSteamPipe: (hSteamPipe: number) => boolean

Type declaration

▸ (hSteamPipe): boolean

Parameters
Name Type
hSteamPipe number
Returns

boolean

Defined in

index.d.ts:2103

BShutdownIfAllPipesClosed

• BShutdownIfAllPipesClosed: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2124

ConnectToGlobalUser

• ConnectToGlobalUser: (hSteamPipe: number) => number

Type declaration

▸ (hSteamPipe): number

Parameters
Name Type
hSteamPipe number
Returns

number

Defined in

index.d.ts:2104

CreateLocalUser

• CreateLocalUser: (phSteamPipe: unknown, eAccountType: EAccountType) => number

Type declaration

▸ (phSteamPipe, eAccountType): number

Parameters
Name Type
phSteamPipe unknown
eAccountType EAccountType
Returns

number

Defined in

index.d.ts:2105

CreateSteamPipe

• CreateSteamPipe: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2102

GetIPCCallCount

• GetIPCCallCount: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2122

GetISteamAppList

• GetISteamAppList: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2128

GetISteamApps

• GetISteamApps: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2117

GetISteamController

• GetISteamController: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2126

GetISteamFriends

• GetISteamFriends: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2110

GetISteamGameSearch

• GetISteamGameSearch: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2121

GetISteamGameServer

• GetISteamGameServer: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2108

GetISteamGameServerStats

• GetISteamGameServerStats: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2116

GetISteamGenericInterface

• GetISteamGenericInterface: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2114

GetISteamHTMLSurface

• GetISteamHTMLSurface: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2131

GetISteamHTTP

• GetISteamHTTP: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2125

GetISteamInput

• GetISteamInput: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2135

GetISteamInventory

• GetISteamInventory: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2132

GetISteamMatchmaking

• GetISteamMatchmaking: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2112

GetISteamMatchmakingServers

• GetISteamMatchmakingServers: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2113

GetISteamMusic

• GetISteamMusic: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2129

GetISteamMusicRemote

• GetISteamMusicRemote: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2130

GetISteamNetworking

• GetISteamNetworking: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2118

GetISteamParentalSettings

• GetISteamParentalSettings: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2134

GetISteamParties

• GetISteamParties: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2136

GetISteamRemotePlay

• GetISteamRemotePlay: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2137

GetISteamRemoteStorage

• GetISteamRemoteStorage: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2119

GetISteamScreenshots

• GetISteamScreenshots: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2120

GetISteamUGC

• GetISteamUGC: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2127

GetISteamUser

• GetISteamUser: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2107

GetISteamUserStats

• GetISteamUserStats: (hSteamUser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamUser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamUser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2115

GetISteamUtils

• GetISteamUtils: (hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2111

GetISteamVideo

• GetISteamVideo: (hSteamuser: number, hSteamPipe: number, pchVersion: string) => unknown

Type declaration

▸ (hSteamuser, hSteamPipe, pchVersion): unknown

Parameters
Name Type
hSteamuser number
hSteamPipe number
pchVersion string
Returns

unknown

Defined in

index.d.ts:2133

ReleaseUser

• ReleaseUser: (hSteamPipe: number, hUser: number) => undefined

Type declaration

▸ (hSteamPipe, hUser): undefined

Parameters
Name Type
hSteamPipe number
hUser number
Returns

undefined

Defined in

index.d.ts:2106

SetLocalIPBinding

• SetLocalIPBinding: (unIP: unknown, usPort: number) => undefined

Type declaration

▸ (unIP, usPort): undefined

Parameters
Name Type
unIP unknown
usPort number
Returns

undefined

Defined in

index.d.ts:2109

SetWarningMessageHook

• SetWarningMessageHook: (pFunction: unknown) => undefined

Type declaration

▸ (pFunction): undefined

Parameters
Name Type
pFunction unknown
Returns

undefined

Defined in

index.d.ts:2123