SteamServerBrowser - stingray.SteamServerBrowser オブジェクト リファレンス - Stingray Lua API リファレンス
説明
SteamServerBrowser を使用すると、Steam で使用可能なゲーム サーバのリストにアクセスできます。
このクラスは、検出されたすべてのゲーム サーバのリストを保持します。ゲーム サーバのリストをリフレッシュするには、[refresh_internet_servers()]または[refresh_lan_servers()]を呼び出します。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
abort_refresh ( self ) サーバ リストのリフレッシュ要求をキャンセルします。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
| |
add_favorite ( self, ip, connection_port, query_port )指定されたサーバがまだお気に入りサーバの個人リストに追加されていない場合は、そのサーバをリストに追加します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
ip : | string | a.b.c.d の形式でサーバの IP アドレスを指定します。 |
connection_port : | integer | ゲーム通信に使用するポートを指定します。 |
query_port : | integer | サーバに情報を問い合わせるために使用するポートを指定します。 |
| この関数は値を返しません。 |
| |
add_filter ( self, value )指定されたテーブル内の基準を使用してサーバのリストをフィルタリングします。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
value : | フィルタ設定を記述したテーブルを指定します。 |
| この関数は値を返しません。 |
注: LAN サーバはフィルタリングできません。
その他の関連リファレンス項目
| |
add_filter ( self, key, value )指定されたキーと値のペアを使用してサーバのリストをフィルタリングします。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | フィルタリングに使用するキーを指定します。steam_server_browser_filter テーブル内の任意のキーを検索できます。 |
value : | string | 指定されたフィルタ キーで使用する文字列値を指定します。 |
| この関数は値を返しません。 |
注: LAN サーバはフィルタリングできません。
| |
clear_filters ( self )以前に追加されたすべてのフィルタを除去します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
| |
data ( self, index, key ) : string?サーバ上で指定されたキーを使用して指定されたインデックスに格納されたデータ値を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
index : | integer | ブラウザから最後に取得したサーバ リスト内でのゼロベースのインデックスを使用して、データを取得するサーバを指定します。 |
key : | string | 取得するデータ値を示す文字列キーを指定します。 |
string? |
指定されたキーの値を返し、サーバ キーがまだ要求されていないか、正常にダウンロードされていない場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| |
is_fetching_data ( self, i ) : boolean, booleanサーバ データの取得が進行中かどうか、および最後の取得処理でエラーが発生したかどうかを示します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
i : | integer | ブラウザから最後に取得したサーバ リスト内での「ゼロベース」のインデックスを使用してサーバを指定します。 |
boolean |
データを取得中の場合は true を返し、そうでない場合は false を返します。 |
boolean |
最後の取得処理が失敗した場合は true を返します。 |
| |
is_fetching_players ( self, index ) : boolean, boolean指定されたサーバ上のプレイヤー リストの取得が進行中かどうか、および最後の取得処理でエラーが発生したかどうかを示します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
index : | integer | ブラウザから最後に取得したサーバ リスト内での「ゼロベース」のインデックスを使用してサーバを指定します。 |
boolean |
プレイヤー データを取得中の場合は true を返し、そうでない場合は false を返します。 |
boolean |
最後の取得処理が失敗した場合は true を返し、そうでない場合は false を返します。 |
| |
is_refreshing ( self ) : booleanリストのリフレッシュが進行中かどうかを示します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
boolean |
リストのリフレッシュが進行中の場合は true を返し、そうでない場合は false を返します。 |
既にリフレッシュ中の場合は、refresh() を呼び出しても何も実行されません。
| |
num_servers ( self ) : integer見つかったゲーム サーバの数を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
利用可能なゲーム サーバの数を返します。 |
| |
players ( self, index ) : steam_server_player[]?指定されたインデックスを持つサーバ上のプレイヤーに関する情報を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
index : | integer | ブラウザから最後に取得したサーバ リスト内でのゼロベースのインデックスを使用して、プレイヤー リストを取得するサーバを指定します。 |
|
プレイヤーごとのテーブルを含むリストを返し、プレイヤー リストのリフレッシュが進行中の場合は nil を返します。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
その他の関連リファレンス項目
| |
refresh ( self, server_type )指定されたタイプに一致するすべてのサーバを含むサーバ リストをリフレッシュします。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
server_type : | integer | 検索するサーバのタイプを指定します。サーバ検索定数のいずれかを指定できます。 |
| この関数は値を返しません。 |
注: 保留中の要求がある場合はこの関数を呼び出せません。先に[abort_request()]を呼び出すか、リフレッシュ要求が完了するまで待つ必要があります。
その他の関連リファレンス項目
| |
refresh_server ( self, i )既に取得したサーバのリスト内で指定されたサーバをリフレッシュします。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
i : | integer | ブラウザから最後に取得したサーバ リスト内でリフレッシュするサーバのインデックスを指定します。 |
| この関数は値を返しません。 |
注: 保留中の要求がある場合はこの関数を呼び出せません。先に[abort_request()]を呼び出すか、リフレッシュ要求が完了するまで待つ必要があります。
| |
remove_favorite ( self, ip, connection_port, query_port )指定されたサーバがお気に入りサーバの個人リストに存在する場合は、そのサーバをリストから除去します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
ip : | string | a.b.c.d の形式でサーバの IP アドレスを指定します。 |
connection_port : | integer | ゲーム通信に使用するポートを指定します。 |
query_port : | integer | サーバに情報を問い合わせるために使用するポートを指定します。 |
| この関数は値を返しません。 |
| |
request_data ( self, i )指定されたインデックスを持つゲーム サーバ上のサーバ データを取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
i : | integer | ブラウザから最後に取得したサーバ リスト内でのゼロベースのインデックスを使用して、データを取得するサーバを指定します。 |
| この関数は値を返しません。 |
| |
request_players ( self, index )指定されたゲーム サーバ上のプレイヤーのリストを取得しますす。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
index : | integer | ブラウザから最後に取得したサーバ リスト内でのゼロベースのインデックスを使用して、データを取得するサーバを指定します。 |
| この関数は値を返しません。 |
| |
server ( self, i ) : steam_server_info指定されたインデックスを持つゲーム サーバに関する情報を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
i : | integer | ブラウザから最後に取得したサーバ リスト内でのインデックスを使用して、データを取得するサーバを指定します。 |
|
指定されたサーバに関する情報を含むテーブルを返します。 |
その他の関連リファレンス項目
サーバ検索定数
このグループの定数は利用可能なサーバのタイプを示します。
refresh() を呼び出すときにこれらの定数を使用すると、取得するサーバのタイプをフィルタリングできます。LAN を除き、すべてのタイプの検索でフィルタリングが行われます。
 |
FAVORITES : integer お気に入りの中からサーバを検索します。
|
| |
FRIENDS : integerプレイヤーの友人が存在するサーバを検索します。
|
| |
HISTORY : integer最近使用したサーバの中からサーバを検索します。
|
| |
INTERNET : integerインターネット上でサーバを検索します。
|
| |
LAN : integerLAN 上でサーバを検索します。
|