ルームパラメータ

目次

  概要
  事前設定
  MonobitEngine.MonobitNetwork.inRoom プロパティ
  MonobitEngine.MonobitNetwork.room.playerCount プロパティ
  MonobitEngine.MonobitNetwork.room.name プロパティ
  MonobitEngine.MonobitNetwork.room.maxPlayers プロパティ
  MonobitEngine.MonobitNetwork.room.open プロパティ
  MonobitEngine.MonobitNetwork.room.visible プロパティ


概要

ルーム入室中に設定・取得が可能なパラメータ群

  ここでは、ルーム入室中に設定することが出来る、ルームパラメータについて説明します。
  設定パラメータにより、ルームの最大収容人数に制限を加えたり、ルーム入室を許可/不可にしたりすることが出来ます。


事前設定

ルームに入室している状態であること(MonobitEngine.MonobitNetwork.inRoom を除き)

  このパラメータを取り扱うための条件は、自身がルームに入室している状態であることです。
  (ただし、MonobitEngine.MonobitNetwork.inRoom を除きます。)

MonobitEngine.MonobitNetwork.inRoom は制限はありません。

  MUNを利用できる環境下であれば、MonobitEngine.MonobitNetwork.inRoom はどのクラス・メソッドからでも参照可能です。


MonobitEngine.MonobitNetwork.inRoom プロパティ

機能

  自分自身がルームに入っているかどうかを表すフラグです。

出力型

内容
bool ルームに入室していたら true、入室していなければ false を取得します。

記述例

// ルームの入退室状態によって、デバッグログを出力します。
if( MonobitEngine.MonobitNetwork.inRoom )
{
    Debug.Log("You are in room");
}
else
{
    Debug.Log("You aren't in room");
}


MonobitEngine.MonobitNetwork.room.playerCount プロパティ

機能

  現在入室している、自身を含めたプレイヤー人数を取得します。

出力型

内容
int ルームに入室しているプレイヤー人数を取得します。

記述例

// プレイヤー人数をデバッグ表示します。
if( MonobitEngine.MonobitNetwork.inRoom )
{
    Debug.Log("playerCount in room : " + MonobitEngine.MonobitNetwork.room.playerCount );
}


MonobitEngine.MonobitNetwork.room.name プロパティ

機能

  現在入室しているルーム名を取得します。

出力型

内容
string ルーム名を取得します。

記述例

// ルーム名をデバッグ表示します。
if( MonobitEngine.MonobitNetwork.inRoom )
{
    Debug.Log("room name : " + MonobitEngine.MonobitNetwork.room.name );
}


MonobitEngine.MonobitNetwork.room.maxPlayers プロパティ

機能

  現在入室しているルームの、最大収容人数をを設定・取得します。

入出力型

内容
int ルーム内に収容可能なプレイヤー人数を設定・取得します。
設定した値は、リアルタイムにサーバに反映されます。

記述例

// ルームに収容可能なプレイヤー人数をデバッグ表示します。
if( MonobitEngine.MonobitNetwork.inRoom )
{
    Debug.Log("room limit : " + MonobitEngine.MonobitNetwork.room.maxPlayers );
}


MonobitEngine.MonobitNetwork.room.open プロパティ

機能

  ルームが入室可能にするどうかを設定・取得します。

入出力型

内容
bool この値が true であれば、他のプレイヤーは入室できます。false であれば、他のプレイヤーは入室できません。
設定した値は、リアルタイムにサーバに反映されます。

記述例

// 現在入室しているルームが、他プレイヤー入室可能かどうかを表示します。
if( MonobitEngine.MonobitNetwork.inRoom )
{
    Debug.Log("room is " + ( MonobitEngine.MonobitNetwork.room.open ? "open" : "closed" ) );
}


MonobitEngine.MonobitNetwork.room.visible プロパティ

機能

  現在入室しているルームが、可視化されているかどうかのフラグです。
  このフラグは、 MonobitEngine.MonobitNetwork.JoinRandomRoom メソッドで入室可能か、
  また MonobitEngine.MonobitNetwork.GetRoomData メソッドで取得可能な部屋かどうかを、設定・取得することができます。

入出力型

内容
bool この値が true であれば可視化、 false であれば非可視化されます。
設定した値は、リアルタイムにサーバに反映されます。

記述例

// 現在入室しているルームが、ルーム一覧で表示させるかどうかを表示します。
if( MonobitEngine.MonobitNetwork.inRoom )
{
    Debug.Log("room is " + ( MonobitEngine.MonobitNetwork.room.visible ? "visible" : "invisible" ) );
}