ISteamClient

Note

This documentation is auto-generated. Methods marked with 🤖 are automatically generated bindings. Methods marked with ✍️ are manually implemented and methods marked with ✋ are currently not implemented.

Note

This interface can be accessed has multiple accessors (e.g. a GameServer variant), the documentation shows Client everywhere but it can also be accessed with GameServerClient.

List of Functions

Client.BReleaseSteamPipe()
Client.BShutdownIfAllPipesClosed()
Client.ConnectToGlobalUser()
Client.CreateLocalUser()
Client.CreateSteamPipe()
Client.GetIPCCallCount()
Client.ReleaseUser()
Client.SetLocalIPBinding()
Client.SetWarningMessageHook()

Function Reference

Client.BReleaseSteamPipe(hSteamPipe)

🤖 Auto-generated binding

Parameters:: hSteamPipe (int - HSteamPipe) –
Returns:: (bool) Return value
SteamWorks:: BReleaseSteamPipe

Example:

Steam.Client.BReleaseSteamPipe(hPipe)

Client.BShutdownIfAllPipesClosed()

🤖 Auto-generated binding

Returns:: (bool) Return value
SteamWorks:: BShutdownIfAllPipesClosed

Example:

Steam.Client.BShutdownIfAllPipesClosed()

Client.ConnectToGlobalUser(hSteamPipe)

🤖 Auto-generated binding

Parameters:: hSteamPipe (int - HSteamPipe) –
Returns:: (int - HSteamUser) Return value
SteamWorks:: ConnectToGlobalUser

Example:

local hUser = Steam.Client.ConnectToGlobalUser(hPipe)

Client.CreateLocalUser(eAccountType)

🤖 Auto-generated binding

Parameters:: eAccountType (int - EAccountType) –
Returns:: (int - HSteamUser) Return value
Returns:: (int) phSteamPipe
SteamWorks:: CreateLocalUser

Signature differences from C++ API:

Parameter phSteamPipe is not a parameter in Lua — it is an output-only pointer in C++ and is returned as an additional return value.

Example:

local hUser, hPipe = Steam.Client.CreateLocalUser(Steam.k_EAccountTypeIndividual)

Client.CreateSteamPipe()

🤖 Auto-generated binding

Returns:: (int - HSteamPipe) Return value
SteamWorks:: CreateSteamPipe

Example:

local hPipe = Steam.Client.CreateSteamPipe()

Client.GetIPCCallCount()

🤖 Auto-generated binding

Returns:: (int) Return value
SteamWorks:: GetIPCCallCount

Client.ReleaseUser(hSteamPipe, hUser)

🤖 Auto-generated binding

Parameters:

hSteamPipe (int - HSteamPipe) –
hUser (int - HSteamUser) –

SteamWorks:

Example:

Steam.Client.ReleaseUser(hPipe, hUser)

Client.SetLocalIPBinding(unIP, usPort)

🤖 Auto-generated binding

Parameters:

unIP – (SteamIPAddress_t)
usPort (int) –

SteamWorks:

SetLocalIPBinding

Client.SetWarningMessageHook(callback)

✍️ Manually implemented

Parameters:: callback (function?) – Function receiving (severity: integer, message: string). Pass nil to clear the hook.
Returns:: nothing
SteamWorks:: SetWarningMessageHook

Sets a callback to receive Steam API warning and info messages.

Notes:

Also available as Steam.GameServerClient.SetWarningMessageHook with identical signature.

Unimplemented Methods

Client.GetISteamUser()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamUser

Client.GetISteamGameServer()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamGameServer

Client.GetISteamFriends()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamFriends

Client.GetISteamUtils()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamUtils

Client.GetISteamMatchmaking()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamMatchmaking

Client.GetISteamMatchmakingServers()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamMatchmakingServers

Client.GetISteamGenericInterface()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamGenericInterface

Client.GetISteamUserStats()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamUserStats

Client.GetISteamGameServerStats()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamGameServerStats

Client.GetISteamApps()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamApps

Client.GetISteamNetworking()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamNetworking

Client.GetISteamRemoteStorage()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamRemoteStorage

Client.GetISteamScreenshots()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamScreenshots

Client.GetISteamHTTP()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamHTTP

Client.GetISteamController()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamController

Client.GetISteamUGC()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamUGC

Client.GetISteamMusic()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamMusic

Client.GetISteamHTMLSurface()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamHTMLSurface

Client.GetISteamInventory()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamInventory

Client.GetISteamVideo()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamVideo

Client.GetISteamParentalSettings()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamParentalSettings

Client.GetISteamInput()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamInput

Client.GetISteamParties()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamParties

Client.GetISteamRemotePlay()

✋ Not implemented - blocklist: Custom acessors are not supported

SteamWorks:: GetISteamRemotePlay