stingray.SteamServerBrowser object reference

Description

The SteamServerBrowser provides access to the list of game servers available on Steam.

The class keeps a list of all game servers found. Call [refresh_internet_servers()] or [refresh_lan_servers()] to refresh the list of game servers.

Constructors and accessors

stingray.SteamClient.server_browser()

Other related reference items

stingray.SteamClient.server_browser()

Functions

abort_refresh ( self ) Cancels a request to refresh the server list.

Parameters

self :

stingray.SteamServerBrowser

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

add_favorite ( self, ip, connection_port, query_port ) Adds the specified server to the personal list of favorite servers, if the server is not already a favorite.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
ip :	string	The IP address of the server, in the form a.b.c.d.
connection_port :	integer	The port that the game communicates on.
query_port :	integer	The port that is used to query the server for information.

Returns

This function does not return any values.

add_filter ( self, value ) Filters the list of servers using the criteria in the specified table.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
value :	steam_server_browser_filter	A table that provides filter settings.

Returns

This function does not return any values.

Note: LAN servers cannot be filtered.

Other related reference items

	steam_server_browser_filter
	steam_server_browser_filter.dedicated steam_server_browser_filter.empty steam_server_browser_filter.full steam_server_browser_filter.noplayers steam_server_browser_filter.proxy steam_server_browser_filter.secure

add_filter ( self, key, value ) Filters the list of servers using the specified key/value pair.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
key :	string	A key to use for filtering. May match any key in the steam_server_browser_filter table.
value :	string	A string value to use for the specified filter key.

Returns

This function does not return any values.

Note: LAN servers cannot be filtered.

clear_filters ( self ) Removes all previously added filters.

Parameters

self :

stingray.SteamServerBrowser

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

data ( self, index, key ) : string? Returns the data value previously stored with the specified key on the server with the specified index.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
index :	integer	The zero-based index of the server whose data you want to retrieve within the list of servers last retrieved from the browser.
key :	string	A string key that describes the data value you want to retrieve.

Returns

string?

The value stored for the key, or nil if the server keys have not yet been requested or successfully downloaded. The ? notation indicates that this type is optional: there may be zero or one instances of it.

is_fetching_data ( self, i ) : boolean, boolean Indicates whether or not the server data is currently being fetched, and whether or not the last fetch operation encountered an error.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
i :	integer	The zero-based index of the server within the list of servers last retrieved from the browser.

Returns

boolean	Returns true if data is being fetched, or false otherwise.
boolean	Returns true if the last fetch failed.

is_fetching_players ( self, index ) : boolean, boolean Indicates whether or not the list of players on the specfied server are currently being fetched, and whether or not the last fetch operation encountered an error.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
index :	integer	The zero-based index of the server within the list of servers last retrieved from the browser.

Returns

boolean	Returns true if the player data is currently being retrieved, or false otherwise.
boolean	Returns true if the last retrieval failed, or false otherwise.

is_refreshing ( self ) : boolean Indicates whether or not the list is currently refreshing.

Parameters

self :

stingray.SteamServerBrowser

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

boolean

Returns true if the list is refreshing, or false otherwise.

If you are already refreshing, refresh() will do nothing.

num_servers ( self ) : integer Returns the number of game servers found.

Parameters

self :

stingray.SteamServerBrowser

Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

integer

The number of available game servers.

players ( self, index ) : steam_server_player[]? Returns information about the players on the server with the specified index.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
index :	integer	The zero-based index of the server whose list of players you want to retrieve within the list of servers last retrieved from the browser.

Returns

steam_server_player[]?

A list that contains a separate table for each player, or nil if the list of players is being refreshed. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Other related reference items

steam_server_player

refresh ( self, server_type ) Refreshes the server list with all servers that match the specified type.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
server_type :	integer	The type of server to search for. Can be one of the server search constants.

Returns

This function does not return any values.

NOTE: You cannot call this function while you have a pending request. Call [abort_request()] before, or wait for the first refresh request to finish.

Other related reference items

stingray.SteamServerBrowser.is_refreshing()

refresh_server ( self, i ) Refresh the specifed server from the list of already fetched servers.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
i :	integer	The index of the server to refresh within the list of servers last retrieved from the browser.

Returns

This function does not return any values.

NOTE: You cannot call this function while you have a pending request. Call [abort_request()] before, or wait for the first refresh request to finish.

remove_favorite ( self, ip, connection_port, query_port ) Removes the specified server from the personal list of favorite servers, if it is present.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
ip :	string	The IP address of the server, in the form a.b.c.d.
connection_port :	integer	The port that the game communicates on.
query_port :	integer	The port that is used to query the server for information.

Returns

This function does not return any values.

request_data ( self, i ) Fetches the server data set in the game server with the specified index.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
i :	integer	The zero-based index of the server whose data you want to retrieve within the list of servers last retrieved from the browser.

Returns

This function does not return any values.

request_players ( self, index ) Fetches the list players on the specified game server.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
index :	integer	The zero-based index of the server whose data you want to retrieve within the list of servers last retrieved from the browser.

Returns

This function does not return any values.

server ( self, i ) : steam_server_info Returns information about the game server with the specified index.

Parameters

self :	stingray.SteamServerBrowser	Specifies the object instance that this function will act on. You may use the colon : calling syntax to call this function on an instance of this object. If you do so, you must omit this parameter. For more information, see this Stingray help topic, or this page in the Lua documentation.
i :	integer	The index of the server whose data you want to retrieve within the list of servers last retrieved from the browser.

Returns

steam_server_info

A table that contains information about the specified server.

Other related reference items

steam_server_info

Server search constants

The constants in this group enumerate the types of servers that are available.

May be used in calls to refresh() in order to filter the types of servers that you want to retrieve. All search types respect filtering except LAN.

FAVORITES : integer Search for servers amongst favorites.

FRIENDS : integer Search for servers where the player's friends are.

HISTORY : integer Search for servers amongst recently used servers.

INTERNET : integer Search for servers on the Internet.

LAN : integer Search for servers on the LAN.