SteamGameServerLobby - stingray.SteamGameServerLobby オブジェクト リファレンス - Stingray Lua API リファレンス
説明
ゲーム サーバのロビーを表します。
ロビーを作成するには、Network.join_steam_server() を使用してゲーム サーバに参加します。ロビーの状態をポーリングすると接続に成功したかどうかを確認できます。接続に成功するとサーバ スロットが割り当てられ、プレイ可能な状態になります。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
auto_update_data ( self ) サーバ データの自動更新を有効にします。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
この関数を呼び出してからしばらくすると、サーバ上で設定されたサーバ データが[get_data()]関数によって返され始めます。
その他の関連リファレンス項目
| |
data ( self, key ) : string?以前に格納されたロビーに関する特定のサーバ データ値を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | 値を表す文字列キーです。 |
string? |
キーに格納されている文字列です。ロビーがクエリ ポートに接続されていない場合、この関数は何も返しません。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
サーバ データは常に文字列として格納されます。
注: ロビーに参加してからサーバ データが送信されるまでの間にはわずかな遅延があり、その間はデータを取得できません。
サーバから正しい最新のデータを確実に取得するには、一度 auto_update_data() を呼び出して自動データ更新を実行するか、data() の前に request_data() を呼び出します。
| |
fail_reason ( self ) : integerゲーム サーバとの接続に失敗した理由を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
接続失敗の理由を示す状態定数の要素を返します。 |
その他の関連リファレンス項目
| |
game_description ( self ) : stringサーバからゲームの説明を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string |
ゲームの説明を返し、ロビーがまだ接続されていない場合は空の文字列を返します。 |
| |
game_session_host ( self ) : integerゲーム サーバの Steam ID を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
サーバの Steam ID を返します。 |
| |
members ( self ) : string[]ロビーの全メンバーの ID を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string[] |
ロビーの全メンバーのピア ID をリストしたテーブルを返します。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
ピアが参加してからロビーが通知されるまでの間にはわずかな遅延があります。したがって、このリストは不完全な場合があるため、メンバーや重要度の低い情報を表示する目的にのみ使用することを推奨します。
| |
request_data ( self )要求されたサーバ データの送信を開始します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
この関数を呼び出してからしばらくすると、サーバ上で設定されたサーバ データが[get_data()]関数によって返され始めます。
その他の関連リファレンス項目
| |
server_name ( self ) : stringサーバからサーバ名を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string |
ゲーム サーバの名前を返し、ロビーがまだ接続されていない場合は空の文字列を返します。 |
| |
state ( self ) : integerサーバ接続の現在の状態を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
ロビーの現在の状態を示す状態定数からの要素です。 |
その他の関連リファレンス項目
| |
version ( self ) : stringサーバからサーバのバージョンを取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string |
サーバのバージョンを示す文字列を返し、ロビーがまだ接続されていない場合は空の文字列を返します。 |
状態定数
このセクションの定数は、ロビーの現在の状態または接続の失敗を示すために SteamGameServerLobby.state() および SteamGameServerLobby.fail_reason() によって返されます。
| |
FAILED : integer この状態は、ロビーとサーバの接続が失われたか、サーバによってアクセスが拒否されたことを示します。
|
ロビーからサーバへの接続は、サーバが満杯などの理由により拒否される場合があります。
| |
JOINED : integerこの状態は、このロビーがサーバに接続されていることを示します。
|
現在、ロビーにはサーバ スロットが割り当てられていて、プレイ可能な状態になっています。
 |
JOINING : integerこの状態は、ロビーがサーバへの接続を試行中で、スロットの割り当てを要求していることを示します。
|
| |
SERVER_IS_FULL : integerこの状態は、サーバが満杯であることを示します。
|
| |
TIMEOUT : integerこの状態は、サーバが時間内に応答しなかったことを示します。
|