Class SteamClient

Constructors

constructor

new SteamClient(): SteamClient
Returns SteamClient
- Defined in index.d.ts:192

Accessors

workshop

get workshop(): UgcClient
Returns UgcClient
- Defined in index.d.ts:193

Methods

addFriend

addFriend(steamId: number): Promise<boolean>
Parameters
- steamId: number
Returns Promise<boolean>
- Defined in index.d.ts:206

clearRichPresence

clearRichPresence(): void
Returns void
- Defined in index.d.ts:211

getAllRichPresence

getAllRichPresence(): RichPresenceInfo[]
Returns RichPresenceInfo[]
- Defined in index.d.ts:215

getCurrentUser

getCurrentUser(): UserInfo
Returns UserInfo
- Defined in index.d.ts:194

getFriendCount

getFriendCount(flags?: FriendRelationshipEnum[]): number
Parameters
- Optionalflags: FriendRelationshipEnum[]
Returns number
- Defined in index.d.ts:196

getFriendGamePlayed

getFriendGamePlayed(steamId: number): string
Parameters
- steamId: number
Returns string
- Defined in index.d.ts:201

getFriendPersonaName

getFriendPersonaName(steamId: number): string
Parameters
- steamId: number
Returns string
- Defined in index.d.ts:198

getFriendPersonaState

getFriendPersonaState(steamId: number): PersonaStateEnum
Parameters
- steamId: number
Returns PersonaStateEnum
- Defined in index.d.ts:199

getFriendRelationship

getFriendRelationship(steamId: number): FriendRelationshipEnum
Parameters
- steamId: number
Returns FriendRelationshipEnum
- Defined in index.d.ts:200

getFriendRichPresence

getFriendRichPresence(steamId: number, key: string): string
Parameters
- steamId: number
- key: string
Returns string
- Defined in index.d.ts:213

getFriends

getFriends(flags?: FriendRelationshipEnum[]): FriendInfo[]
Parameters
- Optionalflags: FriendRelationshipEnum[]
Returns FriendInfo[]
- Defined in index.d.ts:197

getPersonaName

getPersonaName(): string
Returns string
- Defined in index.d.ts:204

getPersonaState

getPersonaState(): PersonaStateEnum
Returns PersonaStateEnum
- Defined in index.d.ts:205

getRichPresence

getRichPresence(key: string): string
Parameters
- key: string
Returns string
- Defined in index.d.ts:212

getRichPresenceKeys

getRichPresenceKeys(): string[]
Returns string[]
- Defined in index.d.ts:214

getSubscriptions

getSubscriptions(): number[]
Returns number[]
- Defined in index.d.ts:195

hasFriend

hasFriend(steamId: number, flags?: FriendRelationshipEnum[]): boolean
Parameters
- steamId: number
- Optionalflags: FriendRelationshipEnum[]
Returns boolean
- Defined in index.d.ts:208

inviteUserToGame

inviteUserToGame(steamId: number, connectString: string): boolean
Parameters
- steamId: number
- connectString: string
Returns boolean
- Defined in index.d.ts:216

removeFriend

removeFriend(steamId: number): boolean
Parameters
- steamId: number
Returns boolean
- Defined in index.d.ts:207

requestUserInformation

requestUserInformation(steamId: number, nameOnly: boolean): boolean
Parameters
- steamId: number
- nameOnly: boolean
Returns boolean
- Defined in index.d.ts:209

setPersonaName

setPersonaName(name: string): void
Parameters
- name: string
Returns void
- Defined in index.d.ts:202

setPersonaState

setPersonaState(state: PersonaStateEnum): void
Parameters
- state: PersonaStateEnum
Returns void
- Defined in index.d.ts:203

setRichPresence

setRichPresence(key: string, value: string): boolean
Parameters
- key: string
- value: string
Returns boolean
- Defined in index.d.ts:210