HBLobbyListQuery
Inherits: RefCounted < Object
A query that returns a list of lobbies.
Methods
order_by_near ( String key, int value ) |
|
with_equal ( String key, int value ) |
|
with_higher ( String key, int value ) |
|
with_key_value ( String key, String value ) |
|
with_lower ( String key, int value ) |
|
with_max_results ( int max_results ) |
|
with_not_equal ( String key, int value ) |
|
with_slots_available ( int min_slots ) |
Signals
received_lobby_list ( HBSteamLobby[] lobbies )
Called when a list of lobbies is received.
Method Descriptions
HBLobbyListQuery filter_distance_close ( )
Only lobbies in the same immediate region will be returned.
HBLobbyListQuery filter_distance_far ( )
For games that don’t have many latency requirements, will return lobbies about half-way around the globe.
HBLobbyListQuery filter_distance_worldwide ( )
No filtering, will match lobbies as far as India to NY (not recommended, expect multiple seconds of latency between the clients).
HBLobbyListQuery order_by_near ( String key, int value )
Sorts the results closest to the specified value.
Near filters don’t actually filter out values, they just influence how the results are sorted. You can specify multiple near filters, with the first near filter influencing the most, and the last near filter influencing the least.
HBLobbyListQuery request_lobby_list ( )
Begins this query.
HBLobbyListQuery with_equal ( String key, int value )
The lobbies value must match this this one exactly.
HBLobbyListQuery with_higher ( String key, int value )
The lobbies value must be greater than this one.
HBLobbyListQuery with_key_value ( String key, String value )
Adds a string comparison filter.
HBLobbyListQuery with_lower ( String key, int value )
The lobbies value must be less than this one.
HBLobbyListQuery with_max_results ( int max_results )
Sets the maximum amount of results possible.
HBLobbyListQuery with_not_equal ( String key, int value )
The lobbies value must not match this value.
HBLobbyListQuery with_slots_available ( int min_slots )
Filters to only return lobbies with the specified number of open slots available.