XboxLive - stingray.XboxLive ネームスペースリファレンス - Stingray Lua API リファレンス
説明
Xbox One で Xbox Live のユーザ機能などのさまざまな機能にアクセスするためのインタフェースです。
ユーザ キャッシュ
システムからローカル ユーザに関する情報を取得するには、多くのパフォーマンス コストがかかるため、ユーザに関する情報はエンジンによって内部のユーザ キャッシュに保存されます。
ユーザ キャッシュはシステムによって提供されるイベントから更新されます。stingray.XboxLive.user_cache_changed() を使用すると、ユーザ キャッシュが更新されているかどうかを確認することができます。
すべてのローカル ユーザのリストを取得するには、stingray.XboxLive.users() を使用し、単一のユーザに関する情報を取得するには、stingray.XboxLive.user_info() を使用します。
user_cached_info の id メンバーは、コンソールに対してローカルの一意の識別子で、Lua インタフェースでは通常、user_id と呼ばれます。
その他の関連リファレンス項目 
関数
 |
has_new_game_invite ( ) : boolean |
| この関数はパラメータを受け入れません。 |
boolean |
前回この関数が呼び出された後に、ユーザがゲームの招待を受け入れた場合は true を返します。 ユーザが招待を受け入れることでゲームを起動した場合、これは起動時に true になります。 |
| |
last_game_invite ( ) : map(string, string)?ゲームの招待の受け入れイベントからの引数を返します。
|
| この関数はパラメータを受け入れません。 |
map(string, string)? |
ゲームの招待を受け入れた場合、これは招待のキーと値のペアを返します。それ以外の場合は、nil が返されます。 注釈 map(...) は、テーブルを示します。このテーブル内の各キーは、表示された最初のタイプのインスタンスで、各値は表示された 2 番目のタイプのインスタンスです。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
この関数の結果の詳細については、XDK ドキュメントの「タイトルのアクティベーションから MPSD セッションに参加する方法」を参照してください。
stingray.MultiplayerSession.invite_friends() を使用している場合、このマップには XDK ドキュメントの受け入れた招待のリストと一致するキーのエントリがあります。
stingray.Network.handle_to_description() を使用して、返されたセッション ハンドルと一致するセッションの名前とセッション テンプレート名を取得することができます。
| |
num_users ( ) : integer |
| この関数はパラメータを受け入れません。 |
integer |
ユーザ キャッシュ内の現在のユーザの数を返します。 |
| |
online_state ( ) : integer |
| この関数はパラメータを受け入れません。 |
integer |
コンソールの現在のオンラインの状態を返します。OnlineState 定数のいずれかになる可能性があります。 |
その他の関連リファレンス項目
| |
show_account_picker ( user_index )指定したユーザのアカウント ピッカーを表示します。
|
user_index : | integer | アカウント ピッカーを表示する必要があるユーザのユーザ インデックスです。Pad1 を使用しているユーザには 1、Pad2 を使用しているユーザには 2 を使用します。 |
| この関数は値を返しません。 |
これは、ユーザのパッドの user_id() が、そのユーザのアカウントに署名がされていないことを示す nil を返した場合に使用できます。
| |
users ( ) : user_cached_info*すべてのローカル ユーザのユーザ キャッシュから情報を取得します。
|
| この関数はパラメータを受け入れません。 |
|
nil が返されるユーザがいない場合には、ユーザ キャッシュ内のすべてのユーザが返されます。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
stingray.XboxLive.user_cache_changed() を使用して、ユーザ キャッシュが変更されているかどうかを確認できます。
| |
user_cache_changed ( ) : boolean |
| この関数はパラメータを受け入れません。 |
boolean |
前回この関数が呼び出された後にユーザ キャッシュが変更された場合には true を返します。 |
その他の関連リファレンス項目
| |
user_info ( user_id ) : user_cached_info指定されたユーザのユーザ キャッシュから情報を取得します。
|