ルームカスタムパラメータ

目次

概要▲

ルームに設定可能な任意の情報群

注意事項▲

１ルームに対して設定可能な、ルームカスタムパラメータの最大数は 15 です。

Room parameters max over: 16/15

ルームカスタムパラメータのkeyは、アルファベットから始まる文字列のみ指定可能です

ルームカスタムパラメータのvalueは、特定のデータ型のみ指定可能です

・bool（Boolean）
・byte（Byte）
・char（SByte）
・short（Int16）
・unsingned short（UInt16）
・int（Int32）
・unsigned int（UInt32）
・long（Int64）
・unsigned long（UInt64）
・float（Single）
・double（Double）
・string（String）

事前設定▲

MonobitEngine.RoomSetting による設定はルームに入室前に行なうこと

ルーム入室後のルームカスタムパラメータの変更は MonobitEngine.MonobitNetwork.room.SetCustomParameters メソッドを使うこと

MonobitEngine.RoomSettings.roomParameters プロパティ▲

機能

入出力型

型	内容
Hashtable	ルームカスタムパラメータについて、そのハッシュテーブル（KeyおよびValue）を設定します。

記述例

// ルームカスタムパラメータの Key および Value を設定します。
MonobitEngine.RoomSettings settings = new MonobitEngine.RoomSettings();
settings.roomParameters["username"] = "MUN";
settings.roomParameters["password"] = "monobit";

MonobitEngine.RoomSettings.lobbyParameters プロパティ▲

機能

出力型

型	内容
string[]	ルームカスタムパラメータについて、ロビー内ユーザーに通知するパラメータキーを文字列配列として設定します。 MonobitEngine.RoomSettings.roomParameters.Keys 情報内に含まれているKeyである必要があります。

記述例

// ルームカスタムパラメータのうち、"username"と"password"をロビー内ユーザーに通知します。
MonobitEngine.RoomSettings settings = new MonobitEngine.RoomSettings();
settings.lobbyParameters = new string[] { "username", "password" };

MonobitEngine.MonobitNetwork.room.SetCustomParameters メソッド▲

機能

引数

型	変数名	内容
Hashtable	parametersToSet	更新・設定・同期するカスタムパラメータのハッシュテーブルを設定します。
Hashtable	expectedValues	このパラメータは将来の拡張のため用意されています。 現時点ではnullを設定してください。（省略可能で、その場合にはnullが設定されます）
bool	webForward	このパラメータは将来の拡張のために用意されています。 現時点ではfalseを設定してください。（省略可能で、その場合にはfalseが設定されます）

戻り値

型	内容
void	-

記述例

// ルーム入室中にカスタムパラメータ"password"を更新します。
if( MonobitEngine.MonobitNetwork.inRoom )
{
    Hashtable customParams = new Hashtable();
    customParams["password"] = "monobitengine";
    MonobitEngine.MonobitNetwork.room.SetCustomParameters( customParams );
}

【応用例】カスタムルームパラメータを使用したルーム作成▲

MonobitEngine.MonobitNetwork.CreateRoom メソッド実行時にカスタムルームパラメータを適用する

// ルーム作成時に使用するカスタムルームパラメータを定義
MonobitEngine.RoomSettings settings = new MonobitEngine.RoomSettings();
settings.roomParameters["username"] = "MUN";
settings.roomParameters["password"] = "monobit";
settings.roomParameters["version"] = 1.0;
settings.lobbyParameters = new string[] { "username", "password", "version" };

// ルーム名を「RoomName」としてルーム作成
MonobitEngine.MonobitNetwork.CreateRoom( null, settings, null );

【応用例】カスタムルームパラメータを使用したルーム一致検索▲

MonobitEngine.MonobitNetwork.JoinRandomRoom メソッド実行時にカスタムルームパラメータによるフィルタリングを実行する

// ルーム入室時に使用するカスタムルームパラメータを定義
MonobitEngine.RoomSettings settings = new MonobitEngine.RoomSettings();
settings.roomParameters["username"] = "MUN";
settings.roomParameters["password"] = "monobit";

// "username"と"password"が一致したルームのうち、ランダムに１つ選択して入室する
MonobitEngine.MonobitNetwork.JoinRandomRoom( settings, 0 );

【応用例】カスタムルームパラメータを使用したクエリー範囲検索▲

MonobitEngine.MonobitNetwork.JoinRandomRoom メソッド実行時にクエリーロビー用カスタムルームパラメータによるフィルタリングを実行する

// クエリー検索ワードの設定
string filter = "username = MUN AND password = monobit AND version >= 1.0";

// クエリーに合致するルームのうち、ランダムに１つ選択して入室する
MonobitEngine.MonobitNetwork.JoinRandomRoom( null, 0,
    MonobitEngine.Definitions.MatchmakingMode.SerialMatching,
    new MonobitEngine.LobbyInfo() { Kind = MonobitEngine.LobbyKind.Query },
    filter );