PsnRoom - stingray.PsnRoom オブジェクト リファレンス - Stingray Lua API リファレンス
説明
PlayStation Network (PSN)ゲームのルームを表します。
Network.create_psn_room() を呼び出して新しいルームを作成することも、Network.join_psn_room() を呼び出して既存のルームに参加することもできます。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
game_session_host ( room ) : string? ルームのゲーム セッション ホストを返します。
|
room : | ホストを設定する PSN ルームです。 |
string? |
ルームのゲーム セッションのホストのピア ID を返します。ゲーム セッションのホストが設定がされていない場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
ピアは、ゲーム セッション ホストが設定されていることを検出した場合、通常は、最初にレベル マップをロードしてから、ゲーム セッション ホストにセッションにドロップすることを伝えるメッセージを送信します。このメッセージを受け取ったら、ゲーム セッション ホストは GameSession.add_peer() を呼び出して、ゲーム セッションにピアを追加する必要があります。
| |
member ( room, index ) : network_psn_room_member指定されたインデックスが割り当てられているルーム メンバーの詳細情報を取得します。
|
room : | メンバーを取得する PSN ルームです。 | |
index : | integer | 取得するメンバーのインデックスです。 |
|
メンバーに関する情報を含むテーブルです。 |
その他の関連リファレンス項目
| |
num_members ( room ) : integer現在ルーム内に存在するメンバーの人数を返します。
|
| |
owner ( room ) : stringPSN ルームの現在の所有者を取得します。
|
| |
set_data ( room, value )ルームの不透明データ値を 1 つ格納します。
|
room : | データを設定する PSN ルームです。 | |
value : | string | ルームに関する文字列値です(最大 255 バイト)。 |
| この関数は値を返しません。 |
PsnRoomBrowser.room() によって返されるデータ テーブル内のこの値には他のピアからも参照できます。この仕組みを利用すると、ホストの名前、ゲームの名前、プレイするレベルやマップの名前など、ルームに関する説明情報を格納できます。ルームに参加しようとしている他のプレイヤーにこの情報を提示すると、ルームに参加するかどうかの判断に役立ちます。
この文字列で説明するデータや形式には特に決まりがないので、任意の内容を指定できます。
その他の関連リファレンス項目
| |
set_game_session_host ( room, peer_id )ゲーム セッションのホストを指定したピアに設定します。
|
room : | ホストを設定する PSN ルームです。 | |
peer_id : | string? | ゲーム セッションのホストにする必要があるピアの ID、またはゲーム セッション ホストをクリアする場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
これは、接続しているすべてのピアにゲーム セッションが開始されたことを通知するためにルール ホストによって使用されます。
| |
set_name ( room, name )ルームの名前を格納します。
|
room : | 名前を設定する PSN ルームです。 | |
name : | string | このルームの名前です。この名前はルームに参加しようとしている他のピアにも表示されます。 |
| この関数は値を返しません。 |
PsnRoomBrowser.room() によって返されるデータ テーブル内のこの値には他のピアからも参照できます。ゲームで、この情報を他の将来のプレイヤーに提示して、プレイヤがロビーに参加するかどうかを決定できるようにすることができます。
その他の関連リファレンス項目
| |
state ( room ) : integerルームの現在の状態と、このピアが参加に成功したかどうかを示します。
|
状態定数
ルームの現在の状態を説明するために PsnRoom.state() によってこのセクションの定数が返される場合があります。
| |
CREATING : integer ルームの作成が開始されたかどうかを示します。
|
ルームの作成に成功すると、状態が PsnRoom.JOINED に変わります。作成に失敗すると、状態が PsnRoom.FAILED に変わります。
その他の関連リファレンス項目
| |
FAILED : integerこの状態は、このピアがルーム ホストによって拒否されたか、接続障害などの問題によりルームから切断されたことを示します。
|
その他の関連リファレンス項目 
| |
JOINED : integerプレイヤーがルームに参加しているかどうかを示します。
|
その他の関連リファレンス項目
| |
JOINING : integerNetwork.join_psn_room() を呼び出してルームに参加した後のルームの状態です。
|
この状態は、ルーム所有者がこのピアをルーム メンバーとして承認するのを待っている状態を示します。このピアが承認されると、状態が PsnRoom.JOINED に変わります。 このピアが承認されなかった場合は、状態が PsnRoom.FAILED に変わります。
| |
WAITING_TO_CREATE : integerルーム作成待ちの状態で、PsnClient.ready() がまだ true を返していないことを示します。
|
これは Network.create_psn_room() でルームが作成された後のルームの状態です。PsnClient.ready() が true を返すと、状態が PsnRoom.CREATING に変わります。