Friends - stingray.Friends ネームスペース リファレンス - Stingray Lua API リファレンス
説明
このインタフェースは、Steam の友人を扱います。
その他の関連リファレンス項目 
友人情報
 |
in_category ( id, category ) : boolean 指定されたプレイヤーが指定された友人カテゴリ内かどうかを示します。
|
id : | string | プレイヤーの Steam ID です。 |
category : | integer | friend relations グループからの値です。 |
boolean |
指定されたプレイヤーがそのカテゴリ内である場合は True、それ以外の場合は false です。 |
| |
name ( id ) : string指定された Steam ID を使用して、友人の名前を取得します。
|
id : | string | Steam ID。 |
string |
友人の名前です。 |
| |
playing_game ( id ) : steam_friend_game_info?指定されたプレイヤーが現在プレイしているゲームに関する情報を取得します。
|
id : | string | プレイヤーの Steam ID です。 |
|
プレイヤーが現在プレイしているゲームを説明するテーブル、またはその友人がゲームをプレイしていない場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
その他の関連リファレンス項目
| |
relationship ( id ) : integer指定された ID を持つプレイヤーとのリレーションシップを取得します。
|
| |
status ( id ) : integer指定されたプレイヤーのオンライン ステータスを取得します。
|
友人招待タイプ
| |
INVITE_LOBBY : integer ロビーに招待します。
|
その他の関連リファレンス項目 
| |
INVITE_SERVER : integerサーバに招待します。
|
その他の関連リファレンス項目
| |
NO_INVITE : integer招待なし。
|
その他の関連リファレンス項目
友人関係
 |
BLOCKED : integerブロックされた友人。
|
| |
FRIEND : integer友人。
|
| |
IGNORED : integer無視されたプレイヤー。
|
| |
IGNORED_FRIEND : integer無視された友人。
|
| |
NONE : integer友人以外。
|
| |
REQUEST_INITIATOR : integer友人関係を要求しているプレイヤー。
|
| |
REQUEST_RECIPIENT : integer要求された友人。
|
| |
SUGGESTED : integer提案された友人。
|
友人関係フラグ
| |
BLOCKED_FLAG = 1 : integerブロックされた友人。
|
| |
CLAN_MEMBER_FLAG = 8 : integerクラン メンバー。
|
| |
FRIENDSHIP_REQUESTED_FLAG = 2 : integer要求された友人。
|
| |
FRIEND_FLAG = 4 : integer友人。
|
その他の関連リファレンス項目
| |
IGNORED_FLAG = 256 : integer無視されたプレイヤー。
|
| |
IGNORED_FRIEND_FLAG = 512 : integer無視された友人。
|
| |
ON_GAME_SERVER_FLAG = 16 : integerゲーム サーバ上のプレイヤー。
|
| |
REQUESTING_FRIENDSHIP_FLAG = 32 : integer友人関係を要求しているプレイヤー。
|
| |
REQUESTING_INFO_FLAG = 128 : integer情報の要求中。
|
| |
SUGGESTED_FLAG = 1024 : integer提案された友人。
|
友人ステータス
| |
AWAY : integer不在。
|
| |
BUSY : integerプレイ中。
|
| |
LOOKING_TO_PLAY : integerプレイ待機中。
|
| |
OFFLINE : integerオフライン。
|
| |
ONLINE : integerオンライン。
|
| |
SNOOZE : integer休眠中。
|
| |
TRADING : integerトレード中。
|
招待
| |
boot_invite ( ) : integer, stringこのゲームが招待から起動されたかどうかを確認します。
|
| この関数はパラメータを受け入れません。 |
integer |
招待タイプ。invite type 定数の 1 つに一致します。これが NO_INVITE である場合、招待を受け取っていません。 |
string |
接続するゲームのアドレス。
|
その場合は、指定されたサーバまたはロビーにすぐに参加する必要があります。
| |
invite ( id, game, extra_params, password )指定された ID を持つユーザに、ロビーまたはゲーム サーバに参加するように招待状を送信します。
|
id : | string | プレイヤーの Steam ID です。 |
game : | any(stingray.SteamLobby, string) | プレイヤーが接続するゲーム。SteamLobby オブジェクト、ロビー ID、または「a.b.c.d:port」(port は接続ポート)という形式の IPv4 ゲーム サーバ アドレスのいずれかです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
extra_params : | string? | オプション。招待にその他の情報を追加する文字列パラメータ。Steam はこれをコマンド ラインでパラメータとして使用するため、文字列にスペースおよび引用符は使用しないでください。最大で 31 文字です。簡潔にしてください。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
password : | string? | オプション。パスワードは、ゲーム サーバへの招待専用です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
next_invite ( ) : integer, string, string, stringこのプレイヤーが友人からゲームへの参加の招待状を受け取っているかどうかを確認します。
|
| この関数はパラメータを受け入れません。 |
integer |
招待タイプ。invite type 定数の 1 つに一致します。これが NO_INVITE である場合、招待を受け取っていません。 |
string |
接続するゲームのアドレス。
|
string |
招待で指定された追加パラメータを含む文字列。 |
string |
招待を受けるプレイヤー: 招待した友人の ID。 |
その場合、ゲームにおいて、指定されたサーバまたはロビーに参加するかどうかを対象プレイヤーに尋ねる必要があります。これが動作するには、招待先のロビーまたはサーバを示すために、招待を受けるプレイヤーが Presence.advertise_playing()を既に呼び出している必要もあります。そうしないと、Steam クライアントからの招待は正しく動作しません。
友人のリスト
| |
id ( index ) : string前回の Friends.num_friends()の呼び出しで指定されたカテゴリ内の友人のリストから、指定された友人の Stream ID を取得します。
|
index : | integer | 前回の Friends.num_friends()の呼び出しで取得されたリスト内の 1 から始まるインデックス。 |
string |
指定されたインデックスの友人の Steam ID。 |
その他の関連リファレンス項目
| |
num_friends ( category_mask ) : integer指定されたカテゴリ内の友人の数を返します。
|
category_mask : | integer? | オプション。1 つまたは複数のカテゴリを表す値です。friend relation flags グループ内の任意の数の定数を加算してマスクを形成します。マスクが指定されていない場合、FRIEND_FLAG が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
カテゴリ内の友人の数を返します。 |
この関数を呼び出した後で、id()を呼び出して指定されたカテゴリ内の友人の ID を取得できます。
その他の関連リファレンス項目