SteamLobbyBrowser - stingray.SteamLobbyBrowser オブジェクト リファレンス - Stingray Lua API リファレンス
説明
SteamLobbyBrowser を使用することで、Steam で使用可能なゲーム ロビーのリストにアクセスできます。
refresh() を呼び出して、リストを更新します。
num_lobbies() を呼び出して使用可能なロビーの数を取得し、lobby() を呼び出してこれらの各ロビーに関する詳細な情報を取得します。これらの詳細情報はロビーに参加するかどうかを判断する際に利用でき、接続に必要な Steam ID を確認する際にも利用できます。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
add_distance_filter ( self, distance ) プレイヤーからの地理的距離に基づいて利用可能なロビーを制限するためのフィルタを追加します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
distance : | integer | プレイヤーとロビーの間に必要なリレーションシップを示す距離フィルタ定数を指定します。 |
| この関数は値を返しません。 |
その他の関連リファレンス項目
| |
add_filter ( self, key, value, comp )指定されたキーに対する文字列フィルタまたは数値フィルタを追加します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | フィルタを適用するキーを指定します。 |
value : | any(string, integer) | ロビーに格納された値と比較する文字列または整数値を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
comp : | integer | フィルタ値をロビーの値と比較する方法を示す比較定数を指定します。 |
| この関数は値を返しません。 |
その他の関連リファレンス項目
| |
add_near_filter ( self, key, value )ロビーの特定のキーに関して近似する一致を検索する数値フィルタを追加します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | フィルタを適用するキーを指定します。 |
value : | integer | 検索する数値を指定します。どのくらい近い整数までを一致と見なすかの指定ではありません。 |
| この関数は値を返しません。 |
| |
add_slots_filter ( self, slots )ロビー内に必要な空きスロットの最小数を設定するフィルタを追加します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
slots : | integer | 空きスロットの最小数を指定します。 |
| この関数は値を返しません。 |
| |
clear_filters ( self )ロビーのリストを制限するためにブラウザで使用されているフィルタをすべて除去します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
| |
data ( self, index, key ) : string指定されたロビーに関して設定されたデータを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
index : | integer | ブラウザで管理されているリスト内のインデックスを使用して、データを取得するロビーを指定します。 |
key : | string | 値を表す文字列キーです。 |
string |
指定されたキーに対して格納されている値を返します。 |
| |
is_refreshing ( self ) : booleanロビー ブラウザでロビー リストのリフレッシュが進行中かどうかを示します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
boolean |
リストのリフレッシュが進行中の場合は true を返し、そうでない場合は false を返します。 |
この関数が true を返す場合、refresh() を呼び出しても効果はありません。
| |
lobby ( self, i ) : network_steam_lobby_info指定されたロビーに関する情報(ロビーへの参加に使用できるアドレスなど)を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
i : | integer | ブラウザで管理されているリスト内のインデックスを使用して、データを取得するロビーを指定します。 |
|
取得したロビーの情報を含むテーブルを返します。 |
その他の関連リファレンス項目
| |
num_lobbies ( self ) : integerロビー ブラウザで見つかったロビーの数を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
使用可能なロビーの数です。 |
| |
refresh ( self )ゲーム ロビーのリストをリフレッシュします。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
その他の関連リファレンス項目
ロビー フィルタ定数
add_filter() を呼び出して比較フィルタをロビー ブラウザに追加するときに使用できる定数です。
 |
EQUAL : integer ～に等しい。
|
| |
GREATER : integer～より大きい。
|
| |
GREATER_OR_EQUAL : integer～以上。
|
| |
LESS : integer～より小さい。
|
| |
LESS_OR_EQUAL : integer～以下。
|
| |
NOT_EQUAL : integer～に等しくない。
|
ロビー フィルタ定数
add_distance_filter() を呼び出して距離に基づくフィルタをロビー ブラウザに追加するときに使用できる定数です。
| |
CLOSE : integer同一地域内のみ。
|
| |
DEFAULT : integer同一地域内または近隣地域内のみ。ただし、現在の地域内でロビーのアクティビティが活発でない場合は、さらに遠方の地域も検索します。
|
これは既定値です。
| |
FAR : integer地球全体の約半分(遅延が高くなることが予想されます)。
|
| |
WORLD : integerフィルタリングを行いません(クライアント間で数秒の遅延が発生することが予想されるため、推奨されません)。
|