stingray.SteamLobby オブジェクト リファレンス

説明

Steam ゲームのロビーを表します。

Network.create_steam_lobby() を使用するとロビーを新規に作成でき、Network.join_steam_lobby() を使用すると既存のロビーに参加できます。

コンストラクタとアクセサ

stingray.Network.create_steam_lobby() stingray.Network.join_steam_lobby()

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

	stingray.Friends.invite() stingray.Network.create_steam_lobby() stingray.Network.leave_steam_lobby() stingray.Presence.advertise_playing() stingray.SteamClient.lobby_browser()
	Steam

関数

data ( self, key ) : string set_data() への呼び出しによってロビーの以前に保存された特定のデータ値を取得します。

パラメータ

self :	stingray.SteamLobby	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
key :	string	値を表す文字列キーです。

戻り値

string

キーに格納されている文字列です。

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

stingray.SteamLobby.set_data()

game_session_host ( self ) : string? ロビーのゲーム セッション ホストを返します。

パラメータ

self :

stingray.SteamLobby

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

string?

ロビーのゲーム セッションのホストのピア ID、またはゲーム セッション ホストが設定されていない場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

ピアは、ゲーム セッション ホストが設定されていることを検出した場合、通常は、最初にレベル マップをロードしてから、ゲーム セッション ホストにセッションにドロップすることを伝えるメッセージを送信します。このメッセージを受け取ったら、ゲーム セッション ホストは GameSession.add_peer() を呼び出して、ゲーム セッションにピアを追加する必要があります。

lobby_host ( self ) : string ロビーのホストとして機能しているピアの ID を返します。

パラメータ

self :

stingray.SteamLobby

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

string

ロビーをホストしているピアの ID です。

members ( self ) : string[] 現在ロビーに接続されているすべてのピアのリストを取得します。

パラメータ

self :

stingray.SteamLobby

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

string[]

ロビーに接続されているすべてのピアのピア ID のリストです。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。

member_data ( self, peer_id, key ) : string ロビー内の指定したピアの保存されている指定のデータを取得します。

パラメータ

self :	stingray.SteamLobby	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
peer_id :	string	取得するデータを持つロビー メンバのピア ID です。
key :	string	取得する値を表す文字列キーです。

戻り値

string

指定したキーの保存されている文字列キーです。

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

stingray.SteamLobby.set_member_data()

own_data ( self, key ) : string この関数を呼び出しているピアの保存された指定のデータを取得します。

パラメータ

self :	stingray.SteamLobby	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
key :	string	取得する値を表す文字列キーです。

戻り値

string

指定したキーの保存されている文字列キーです。

set_data ( self, key, value ) ロビーの特定のデータ値を保存します。

パラメータ

self :	stingray.SteamLobby	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
key :	string	値を表す文字列キーです。
value :	string	キーの保存する文字列値です。

戻り値

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

SteamLobbyBrowser.lobby() によって返されるデータ テーブル内のこの値は他のピアからも参照できます。このメカニズムを使用して、ホストの名前、ゲームの名前、プレイされるレベルまたはマップの名前などに関する説明情報を保存することができます。ゲームで、この情報を他の将来のプレイヤーに提示して、プレイヤがロビーに参加するかどうかを決定できるようにすることができます。

ロビーに参加しているピアはすべて、data() を呼び出すことで値にアクセスすることができます。

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

stingray.SteamLobby.data()

set_game_session_host ( self, peer_id ) ゲーム セッションのホストを指定したピアに設定します。

パラメータ

self :	stingray.SteamLobby	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
peer_id :	string?	ゲーム セッションのホストにする必要があるピアの ID、またはゲーム セッション ホストをクリアする場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

これは、ゲーム セッションを開始しているすべての接続されたピアに示すために、ロビー ホストによって使用されます。

set_member_data ( self, key, value ) この関数を呼び出しているロビーのメンバの特定のデータ値を保存します。

パラメータ

self :	stingray.SteamLobby	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
key :	string	値を表す文字列キーです。
value :	string	キーの保存する文字列値です。

戻り値

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

member_data() を呼び出すことでこのデータにアクセスすることができるロビーの他のメンバです。

state ( self ) : integer ロビーの現在の状態と、このピアが参加に成功したかどうかを示します。

パラメータ

self :

stingray.SteamLobby

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

integer

ロビーの現在の状態を示す状態定数からの要素です。

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

状態定数

状態定数

このセクションの定数は、ロビーの現在の状態を示すために、SteamLobby.state() によって返されます。

CREATING : integer これは Network.create_steam_lobby() でロビーの作成が開始された後のロビーの状態です。

ロビーが正常に作成されると、状態が SteamLobby.JOINED に変わります。作成に失敗すると、状態が SteamLobby.FAILED に変わります。

FAILED : integer この状態は、このピアがロビー ホストによって拒否されたか、接続不良などの問題が原因で、ロビーから脱退させられたことを示します。

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

stingray.SteamLobby.CREATING stingray.SteamLobby.JOINING

JOINED : integer この状態は、このピアがロビーへの参加を許可されていることを示します。

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

stingray.SteamLobby.CREATING stingray.SteamLobby.JOINING

JOINING : integer この状態は、ロビー ホストがこのピアをロビー メンバとして承認することをロビーが待機していることを意味します。

このピアが承認された場合は、状態が SteamLobby.JOINED に変わります。このピアが承認されなかった場合は、状態が SteamLobby.FAILED に変わります。