ISteamMatchmakingServers

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.

List of Functions

• MatchmakingServers.CancelQuery()

• MatchmakingServers.CancelServerQuery()

• MatchmakingServers.GetServerCount()

• MatchmakingServers.IsRefreshing()

• MatchmakingServers.PingServer()

• MatchmakingServers.PlayerDetails()

• MatchmakingServers.RefreshQuery()

• MatchmakingServers.RefreshServer()

• MatchmakingServers.ReleaseRequest()

• MatchmakingServers.RequestFavoritesServerList()

• MatchmakingServers.RequestFriendsServerList()

• MatchmakingServers.RequestHistoryServerList()

• MatchmakingServers.RequestInternetServerList()

• MatchmakingServers.RequestLANServerList()

• MatchmakingServers.RequestSpectatorServerList()

• MatchmakingServers.ServerRules()

Function Reference

MatchmakingServers.CancelQuery(hRequest)

🤖 Auto-generated binding

Parameters:

hRequest (HServerListRequest) –

SteamWorks:

CancelQuery

Example:

Steam.MatchmakingServers.CancelQuery(serverListRequest)

MatchmakingServers.CancelServerQuery(hServerQuery)

🤖 Auto-generated binding

Parameters:

hServerQuery (int - HServerQuery) –

SteamWorks:

CancelServerQuery

MatchmakingServers.GetServerCount(hRequest)

🤖 Auto-generated binding

Parameters:

hRequest (HServerListRequest) –

Returns:

(int) Return value

SteamWorks:

GetServerCount

Example:

local count = Steam.MatchmakingServers.GetServerCount(serverListRequest)
print('Found', count, 'servers')

MatchmakingServers.IsRefreshing(hRequest)

🤖 Auto-generated binding

Parameters:

hRequest (HServerListRequest) –

Returns:

(bool) Return value

SteamWorks:

IsRefreshing

Example:

if Steam.MatchmakingServers.IsRefreshing(serverListRequest) then
    showLoadingSpinner()
end

MatchmakingServers.PingServer(unIP, usPort, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• unIP (int) –

• usPort (int) –

• pRequestServersResponse – (ISteamMatchmakingPingResponse)

Returns:

(int - HServerQuery) Return value

SteamWorks:

PingServer

Example:

local pingCallbacks = Steam.newISteamMatchmakingPingResponse {
    ServerResponded = function(server)
        print('Server:', server.m_szServerName, 'Ping:', server.m_nPing)
    end,
    ServerFailedToRespond = function()
        print('Server did not respond to ping')
    end,
}
Steam.MatchmakingServers.PingServer(serverIP, serverPort, pingCallbacks)

MatchmakingServers.PlayerDetails(unIP, usPort, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• unIP (int) –

• usPort (int) –

• pRequestServersResponse – (ISteamMatchmakingPlayersResponse)

Returns:

(int - HServerQuery) Return value

SteamWorks:

PlayerDetails

MatchmakingServers.RefreshQuery(hRequest)

🤖 Auto-generated binding

Parameters:

hRequest (HServerListRequest) –

SteamWorks:

RefreshQuery

Example:

Steam.MatchmakingServers.RefreshQuery(serverListRequest)

MatchmakingServers.RefreshServer(hRequest, iServer)

🤖 Auto-generated binding

Parameters:

• hRequest (HServerListRequest) –

• iServer (int) –

SteamWorks:

RefreshServer

MatchmakingServers.ReleaseRequest(hServerListRequest)

🤖 Auto-generated binding

Parameters:

hServerListRequest (HServerListRequest) –

SteamWorks:

ReleaseRequest

Example:

Steam.MatchmakingServers.ReleaseRequest(serverListRequest)
serverListRequest = nil

MatchmakingServers.RequestFavoritesServerList(iApp, ppchFilters, nFilters, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• iApp (int - AppId_t) –

• ppchFilters – (MatchMakingKeyValuePair_t[])

• nFilters (int) – size of the input array ppchFilters

• pRequestServersResponse – (ISteamMatchmakingServerListResponse)

Returns:

(HServerListRequest) Return value

SteamWorks:

RequestFavoritesServerList

MatchmakingServers.RequestFriendsServerList(iApp, ppchFilters, nFilters, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• iApp (int - AppId_t) –

• ppchFilters – (MatchMakingKeyValuePair_t[])

• nFilters (int) – size of the input array ppchFilters

• pRequestServersResponse – (ISteamMatchmakingServerListResponse)

Returns:

(HServerListRequest) Return value

SteamWorks:

RequestFriendsServerList

Example:

local callbacks = Steam.newISteamMatchmakingServerListResponse {
    ServerResponded = function(req, idx)
        local info = Steam.MatchmakingServers.getServerDetails(req, idx)
        print('Friend server:', info.m_szServerName)
    end,
    RefreshComplete = function(req, resp)
        Steam.MatchmakingServers.ReleaseRequest(req)
    end,
}
local req = Steam.MatchmakingServers.RequestFriendsServerList(appID, {}, 0, callbacks)

MatchmakingServers.RequestHistoryServerList(iApp, ppchFilters, nFilters, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• iApp (int - AppId_t) –

• ppchFilters – (MatchMakingKeyValuePair_t[])

• nFilters (int) – size of the input array ppchFilters

• pRequestServersResponse – (ISteamMatchmakingServerListResponse)

Returns:

(HServerListRequest) Return value

SteamWorks:

RequestHistoryServerList

MatchmakingServers.RequestInternetServerList(iApp, ppchFilters, nFilters, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• iApp (int - AppId_t) –

• ppchFilters – (MatchMakingKeyValuePair_t[])

• nFilters (int) – size of the input array ppchFilters

• pRequestServersResponse – (ISteamMatchmakingServerListResponse)

Returns:

(HServerListRequest) Return value

SteamWorks:

RequestInternetServerList

Example:

local filters = {{'gamedir', 'mygame'}, {'map', 'de_dust2'}}
local callbacks = Steam.newISteamMatchmakingServerListResponse {
    ServerResponded = function(request, index)
        local info = Steam.MatchmakingServers.getServerDetails(request, index)
        print(info.m_szServerName .. ' - ' .. info.m_nPlayers .. '/' .. info.m_nMaxPlayers)
    end,
    RefreshComplete = function(request, response)
        print('Server list refresh complete')
        Steam.MatchmakingServers.ReleaseRequest(request)
    end,
}
local request = Steam.MatchmakingServers.RequestInternetServerList(appID, filters, #filters, callbacks)

MatchmakingServers.RequestLANServerList(iApp, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• iApp (int - AppId_t) –

• pRequestServersResponse – (ISteamMatchmakingServerListResponse)

Returns:

(HServerListRequest) Return value

SteamWorks:

RequestLANServerList

MatchmakingServers.RequestSpectatorServerList(iApp, ppchFilters, nFilters, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• iApp (int - AppId_t) –

• ppchFilters – (MatchMakingKeyValuePair_t[])

• nFilters (int) – size of the input array ppchFilters

• pRequestServersResponse – (ISteamMatchmakingServerListResponse)

Returns:

(HServerListRequest) Return value

SteamWorks:

RequestSpectatorServerList

MatchmakingServers.ServerRules(unIP, usPort, pRequestServersResponse)

🤖 Auto-generated binding

Parameters:

• unIP (int) –

• usPort (int) –

• pRequestServersResponse – (ISteamMatchmakingRulesResponse)

Returns:

(int - HServerQuery) Return value

SteamWorks:

ServerRules

Unimplemented Methods

MatchmakingServers.GetServerDetails()

✋ Not implemented - unsupported type: gameserveritem_t *

SteamWorks:

GetServerDetails