Presence - stingray.Presence ネームスペース リファレンス - Stingray Lua API リファレンス
このインタフェースは、Steam のプレゼンスを扱います。
プレゼンスにより、友人がゲーム内で行っていることを確認できます。
|
このプレイヤーがプレイしている同一のゲームに、友人が参加できる方法についてのプレゼンス情報を設定します。
|
パラメータ game : | any(stingray.SteamLobby, string) | プレイヤーが接続する必要のあるアドレスです。SteamLobby オブジェクト、ロビー ID、または「a.b.c.d:port」(port は接続ポート)という形式の IPv4 ゲーム サーバ アドレスのいずれかです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
extra_params : | string? | オプション。招待にその他の情報を追加する文字列パラメータ。Steam はこれをコマンド ラインでパラメータとして使用するため、文字列にスペースおよび引用符は使用しないでください。最大で 31 文字です。簡潔にしてください。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
password : | string? | オプション。パスワードは、ゲーム サーバへの招待専用です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
戻り値
|
指定した友人によって設定された、指定したキーのプレゼンス文字列値を取得します。
|
パラメータ friend : | string | 友人の Stream ID です。 |
key : | string | 取得するキーです。 |
戻り値 string? |
友人のキーの文字列値です。キーが存在しない場合は、nil です。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
パラメータ key : | string | キーと値のペアのキーです。 |
value : | string | キーに設定する値 |
戻り値
キーと値は両方文字列です。19 の異なるキーを使用することができます。空の文字列にキーを設定すると、キーが除去されます。
status キーはマジック キーです。その値は、Steam 友人リストの view game info ダイアログに表示されます。
|
ゲーム サーバまたはロビーに関するプレゼンス情報をクリアします。
|
パラメータ 戻り値
プレイヤーがサーバまたはロビーを退出するときに、これを呼び出します。