stingray.MultiplayerSession ネームスペース リファレンス

説明

Xbox One のセッション機能にアクセスするためのインタフェースです。

その他の関連リファレンス項目

Xbox Live

関数

custom_property_json ( session_id, custom_property_key ) : integer セッションのカスタム プロパティを取得するための非同期要求を開始します。

パラメータ

session_id :	integer	セッションの ID です。
custom_property_key :	string	取得する JSON プロパティ

戻り値

integer

セッション ルック アップ ID。Lua インタフェースで、このセッションのジョブの参照に使用されます。

custom_property_json_result ( session_lookup_id ) : string

パラメータ

session_lookup_id :

integer

ステータスを取得する、セッション ルックアップの ID です。[stingray.MultiplayerSession.custom_properties_json()] によって返されます。

戻り値

string

プロパティまたは NULL の JSON 文字列を返します。

custom_property_json_status ( session_lookup_id ) : integer

パラメータ

session_lookup_id :

integer

ステータスを取得する、セッション ルックアップの ID です。

戻り値

integer

[stingray.MultiplayerSession.custom_properties_json()] によって開始されたセッション ルックアップのステータスを返します。任意の SessionJobStatus(network.xbl.work_status)定数を使用できます。

delete_smartmatch_ticket ( session_id, hopper_name, ticket_id ) SmartMatch マッチメイキングを削除する非同期ジョブを開始します。

パラメータ

session_id :	integer	セッションの ID です。
hopper_name :	string	削除するホッパーの名前
ticket_id :	string	start_smartmatch_result によって返されるチケット ID です。

戻り値

この関数は値を返しません。

その他の関連リファレンス項目

stingray.MultiplayerSession.start_smartmatch()

free_custom_property_json ( session_lookup_id ) [stingray.MultiplayerSession.custom_properties_json()] を使用して開始された非同期タスクに属するリソースを解放します。

パラメータ

session_lookup_id :

integer

解放するセッション ルックアップの ID です。

戻り値

この関数は値を返しません。

[stingray.MultiplayerSession.free_custom_property_json_status()] が stingray.SessionJobStatus.COMPLETE または stingray.SessionJobStatus.FAILED を返す場合にのみ、結果が解放されることに注意してください。

group_id ( session_id ) : integer

パラメータ

session_id :

integer

セッション グループ ID を取得するセッションの ID です。

戻り値

integer

指定されたセッションが属するセッション グループの SessionGroupId です。

has_session_changed ( session_id ) : boolean 前回の呼び出し以降にセッションが変更されたかどうかを返します。

パラメータ

session_id :

integer

キーワードを設定するセッションの ID です。

戻り値

boolean

セッションが変更された場合は true を返します。

この変更は表示されない場合があります。

host_peer ( session_id ) : string?

パラメータ

session_id :

integer

ホストを取得するセッションの ID を取得します。

戻り値

string?

ホストの PeerId です。ホストがない場合、nil が返されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

keywords ( session_id ) : string[]

パラメータ

session_id :

integer

キーワードを取得するセッションの ID です。

戻り値

string[]

セッション キーワードのリスト []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

leave ( session_id ) これは、指定されたセッションをそのままにする非同期ジョブを開始します。

パラメータ

session_id :

integer

そのままにするセッションの ID です。

戻り値

この関数は値を返しません。

stingray.MultiplayerSession.status() が stingray.MultiplayerSession.SHUTDOWN を返す場合、stingray.Network.free_multiplayer_session() を使用するセッションを解放することは安全です。

その他の関連リファレンス項目

stingray.Network.create_multiplayer_session() stingray.Network.create_multiplayer_session_client() stingray.Network.create_multiplayer_session_host()

members ( session_id ) : session_member[]

パラメータ

session_id :

integer

メンバー リストを取得するセッションの ID です。

戻り値

session_member[]

セッション内のメンバー リスト []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

session_id_to_uri ( session_id ) : string

パラメータ

session_id :

string

URI を取得するセッションの ID

戻り値

string

セッションの URI

session_uri_to_description ( session_uri ) : string, string

パラメータ

session_uri :

string

セッションの URI

戻り値

string	セッション名
string	セッションのテンプレート名

set_closed ( session_id, closed ) 非同期で値を設定し、この関数を呼び出す前に単にセッションが準備されていることを確認します。

パラメータ

session_id :	integer	セッションの ID です。
closed :	boolean	新しい閉じた状態

戻り値

この関数は値を返しません。

set_current_user_member_custom_property_json ( session_id, custom_property_key, custom_property_json ) 非同期で値を設定し、この関数を呼び出す前に単にセッションが準備されていることを確認します。

パラメータ

session_id :	integer	セッションの ID です。
custom_property_key :	string	設定する JSON プロパティ
custom_property_json :	string	キーの JSON 値を含む文字列

戻り値

この関数は値を返しません。

set_custom_property_json ( session_id, custom_property_key, custom_property_json ) 非同期で値を設定し、この関数を呼び出す前に単にセッションが準備されていることを確認します。

パラメータ

session_id :	integer	セッションの ID です。
custom_property_key :	string	設定する JSON プロパティ
custom_property_json :	string	キーの JSON 値を含む文字列

戻り値

この関数は値を返しません。

set_keywords ( user_id, session_id, session_keywords ) セッションのキーワード設定の非同期ジョブが開始されます。

パラメータ

user_id :	integer	キーワードを設定するユーザの ID です。
session_id :	integer	キーワードを設定するセッションの ID です。
session_keywords :	string[]?	セッションのキーワードを表す、オプションの文字列のテーブルです。文字列を空にすることはできません。また、最大 63 文字以内で構成する必要があります。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

この関数は値を返しません。

stingray.MultiplayerSession.status() を使用してセッションのステータスを追跡できます。session_keywords が提供されていない場合、キーワードは空の配列に設定されます。

smartmatch_result ( session_id ) : string, string, number SmartMatch マッチメイキングで見つかったセッションを返します。

パラメータ

session_id :

integer

セッションの ID です。

戻り値

string	一致したセッションの名前です。
string	一致したセッションのセッション テンプレートに名前を付けます。
number	SmartMatch によって標準待機時間が返されます。

smartmatch_status ( session_id ) : integer 現在の SmartMatch ステータスを返します。

パラメータ

session_id :

integer

セッションの ID です。

戻り値

integer

SmartMatch マッチメイキングのステータス。stingray.SmartMatchStatus 定数のいずれかになります。

その他の関連リファレンス項目

stingray.MultiplayerSession.start_smartmatch()

start_smartmatch ( session_id, hopper_name, timeout, preserve_mode, ticket_attributes_json ) SmartMatch マッチメイキング チケットを作成する非同期ジョブを開始します。

パラメータ

session_id :	integer	セッションの ID です。
hopper_name :	string	SmartMatch に使用するホッパーの名前です。
timeout :	number	SmartMatch タイム アウトです。
preserve_mode :	integer	SmartMatch の保持モードです。stingray.PreserveSessionMode 定数のいずれかである必要があります。
ticket_attributes_json :	string?	SmartMatch チケット属性を持つオプションの JSON 文字列です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

この関数は値を返しません。

ジョブが完了したときに、チケットを start_smartmatch_result で開始してから結果を取得することができます。

smartmatch_statusのセッションで matchmaking ステータスを追跡することができます。

delete_smartmatch_ticket を使用してマッチメイキングをキャンセルするか、または完了したチケットを削除します。

start_smartmatch_result ( session_id ) : string, number マッチメイキング チケットの開始からの結果を返します。

パラメータ

session_id :

integer

セッションの ID です。

戻り値

string	SmartMatch マッチメイキング チケットのチケット ID です。
number	SmartMatch によって返された推定待機時間です。

その他の関連リファレンス項目

stingray.MultiplayerSession.delete_smartmatch_ticket() stingray.MultiplayerSession.start_smartmatch()

status ( session_id ) : integer

パラメータ

session_id :

integer

ステータスを取得する、セッションの ID です。

戻り値

integer

セッションの現在の状態を示します。任意の SessionStatus 定数を使用できます。

その他の関連リファレンス項目

	stingray.MultiplayerSession.leave() stingray.MultiplayerSession.set_keywords() stingray.Network.create_multiplayer_session() stingray.Network.create_multiplayer_session_client() stingray.Network.create_multiplayer_session_host() stingray.Network.free_multiplayer_session() stingray.Network.join_local_multiplayer_session() stingray.Network.set_activity()
	SessionStatus

SessionStatus

セッションの現在のステータスについて説明します。

stingray.MultiplayerSession.status() の呼び出しによって返される場合があります。

BROKEN : integer 非同期ジョブ中にエラーが発生しました。

READY : integer セッションはアイドル状態であり、操作することができます。

その他の関連リファレンス項目

stingray.Network.set_activity()

SHUTDOWN : integer セッションは、非同期シャットダウン タスクを完了しており、解放を待機しています。

その他の関連リファレンス項目

stingray.MultiplayerSession.leave() stingray.Network.free_multiplayer_session()

WORKING : integer セッションは、非同期ジョブの完了を待機しています。