LanLobby - stingray.LanLobby オブジェクト リファレンス - Stingray Lua API リファレンス
説明
LAN ゲームのロビーを表します。
Network.create_lan_lobby() を呼び出して新しいロビーを作成するか、Network.join_lan_lobby() を呼び出して既存のロビーに参加することができます。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
data ( self, key ) : string set_data() への呼び出しによってロビーの以前に保存された特定のデータ値を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | 値を表す文字列キーです。 |
string |
キーに格納されている文字列です。 |
その他の関連リファレンス項目
| |
game_session_host ( self ) : string?ロビーのゲーム セッション ホストを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string? |
ロビーのゲーム セッションのホストのピア ID、またはゲーム セッション ホストが設定されていない場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
ピアは、ゲーム セッション ホストが設定されていることを検出した場合、通常は、最初にレベル マップをロードしてから、ゲーム セッション ホストにセッションにドロップすることを伝えるメッセージを送信します。このメッセージを受け取ったら、ゲーム セッション ホストは GameSession.add_peer() を呼び出して、ゲーム セッションにピアを追加する必要があります。
| |
kick ( self, peer )ロビーから指定したピアを除去します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
peer : | any(string, integer) | ピアの文字列 ID、またはロビーのピアのリスト内のピアのゼロを基数とするインデックス値です。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
| この関数は値を返しません。 |
ロビー ホストのみが、この関数を呼び出すことができます。
| |
lobby_host ( self ) : stringロビーのホストとして機能しているピアの ID を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string |
ロビーをホストしているピアの ID です。 |
| |
members ( self ) : string[]現在ロビーに接続されているすべてのピアのリストを取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string[] |
ロビーに接続されているすべてのピアのピア ID のリストです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
| |
member_data ( self, peer_id, key ) : stringロビー内の指定したピアの保存されている指定のデータを取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
peer_id : | string | 取得するデータを持つロビー メンバのピア ID です。 |
key : | string | 取得する値を表す文字列キーです。 |
string |
指定したキーの保存されている文字列キーです。 |
その他の関連リファレンス項目
| |
own_data ( self, key ) : stringこの関数を呼び出しているピアの保存された指定のデータを取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | 取得する値を表す文字列キーです。 |
string |
指定したキーの保存されている文字列キーです。 |
| |
set_data ( self, key, value )ロビーの特定のデータ値を保存します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | 値を表す文字列キーです。 |
value : | string | キーの保存する文字列値です。 |
| この関数は値を返しません。 |
他のピアは、LanLobbyBrowser.lobby() によって返されるデータ テーブル内のこの値にアクセスすることができます。このメカニズムを使用して、ホストの名前、ゲームの名前、プレイされるレベルまたはマップの名前などに関する説明情報を保存することができます。ゲームで、この情報を他の将来のプレイヤーに提示して、プレイヤがロビーに参加するかどうかを決定できるようにすることができます。
ロビーに参加しているピアはすべて、data() を呼び出すことで値にアクセスすることができます。
その他の関連リファレンス項目
| |
set_game_session_host ( self, peer_id )ゲーム セッションのホストを指定したピアに設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
peer_id : | string? | ゲーム セッションのホストにする必要があるピアの ID、またはゲーム セッション ホストをクリアする場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
これは、ゲーム セッションを開始しているすべての接続されたピアに示すために、ロビー ホストによって使用されます。
| |
set_member_data ( self, key, value )この関数を呼び出しているロビーのメンバの特定のデータ値を保存します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | 値を表す文字列キーです。 |
value : | string | キーの保存する文字列値です。 |
| この関数は値を返しません。 |
member_data() を呼び出すことでこのデータにアクセスすることができるロビーの他のメンバです。
| |
state ( self ) : integerロビーの現在の状態と、このピアが正常に参加しているかどうかを示します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
ロビーの現在の状態を示す状態定数からの要素です。 |
その他の関連リファレンス項目
状態定数
このセクションの定数は、ロビーの現在の状態を示すため、LanLobby.state() によって返される場合があります。
| |
CREATING : integer これは Network.create_lan_lobby() を使用して作成された後のロビーの状態です。
|
ロビーが正常に作成された場合、状態は LanLobby.JOINED に変わります。作成に失敗した場合、状態は LanLobby.FAILED になります。
| |
FAILED : integerこの状態は、このピアがロビー ホストによって拒否されたか、接続不良などの問題が原因で、ロビーから脱退させられたことを示します。
|
その他の関連リファレンス項目 
| |
JOINED : integerこの状態は、このピアがロビーへの参加を許可されていることを示します。
|
その他の関連リファレンス項目
| |
JOINING : integerこの状態は、ロビー ホストがこのピアをロビー メンバとして承認することをロビーが待機していることを意味します。
|
このピアが承認されると、状態が LanLobby.JOINED に変わります。このピアが承認されない場合、状態は LanLobby.FAILED に変わります。