Monobit Unity Networking ver.2.8.0 Client API Reference
MonobitEngine.Room Class Reference

Roomクラス More...

Inheritance diagram for MonobitEngine.Room:
Collaboration diagram for MonobitEngine.Room:

Public Member Functions

void SetCustomParameters (Hashtable parametersToSet, Hashtable expectedValues=null, bool webForward=false)
 ルームパラメータのkey-value値を生成/更新します。 More...
 
void SetParametersListedInLobby (string[] paramsListedInLobby)
 ルームパラメータのうち、ロビーに通知(ロビーに入室したプレイヤーがで閲覧(検索)可能な)パラメータキーを定義します. More...
 
override string ToString ()
 ルームに関する情報について文字列を出力します。 More...
 
override bool Equals (object obj)
 指定されたルーム情報とルーム名が一致するか調べます。 More...
 
override int GetHashCode ()
 自身のルーム名のハッシュコードを取得します。 More...
 

Protected Attributes

bool autoCleanUpField = MonobitEngineBase.MonobitNetwork.autoRemoveInLeftRoom
 プレイヤーが退室したとき、バッファリングされたRPCと生成されたGameObjectを破棄するかどうかのフラグです。 More...
 
bool openField = true
 ルームが入室可能状態になっているかどうかのフラグです。 More...
 
Hashtable m_customParameters = new Hashtable()
 ルームパラメータを保有します。 More...
 
string nameField
 ルーム名を保有する変数です。 More...
 
int playerCountField
 ルーム内の(自分を含めない)プレイヤー数。 More...
 
UInt32 maxPlayersField = 0
 このルームに入室可能なプレイヤー数の上限を保有します。 More...
 
bool visibleField = true
 このルームをロビーで閲覧可能にするかどうかのフラグです。 More...
 
string[] parametersListedInLobbyField = new string[0]
 ロビーに通知するルームカスタムパラメータキー情報のリストです。 More...
 

Properties

new int playerCount [get]
 このルーム内に入室しているプレイヤーの数です。 More...
 
new string name [get, set]
 ルーム名を保有する変数です。 More...
 
new UInt32 maxPlayers [get, set]
 このルームに入室可能なプレイヤー数の上限を保有します。 More...
 
new bool open [get, set]
 ルームが入室可能状態になっているかどうかのフラグです。 More...
 
new bool visible [get, set]
 このルームをロビーで閲覧可能にするかどうかのフラグです。 More...
 
bool autoCleanUp [get]
 プレイヤーが退室したとき、バッファリングされたRPCと生成されたGameObjectを破棄するかどうかのフラグです。 More...
 
bool removedFromList [get, set]
 ロビーから閲覧可能なリストに記載されなくなったルームに対しtrueを設定します。 More...
 
Hashtable customParameters [get]
 ルームパラメータの読み込み専用キャッシュです。 More...
 
bool isLocalClientInside [get, set]
 自身が既にルームに入室か、またはルームに入室しようとしているかどうかのフラグです。 More...
 
string[] parametersListedInLobby [get, set]
 ルームパラメータとして登録された情報のうち、ロビーに公開するキーの一覧. More...
 

Detailed Description

Roomクラス

Member Function Documentation

override bool MonobitEngine.RoomData.Equals ( object  obj)
inherited

指定されたルーム情報とルーム名が一致するか調べます。

Parameters
obj比較対象となるルーム情報。
Returns
一致したらtrueを返します。

Here is the call graph for this function:

Here is the caller graph for this function:

override int MonobitEngine.RoomData.GetHashCode ( )
inherited

自身のルーム名のハッシュコードを取得します。

Returns
ハッシュコードを返します。
void MonobitEngine.Room.SetCustomParameters ( Hashtable  parametersToSet,
Hashtable  expectedValues = null,
bool  webForward = false 
)

ルームパラメータのkey-value値を生成/更新します。

Parameters
parametersToSet更新・設定・同期する、ルームパラメータのHashtable情報.
expectedValues省略可(省略した場合にはnullが設定されます)。 このパラメータは、チェック・アンド・スワップ(CAS)の機能を使うために使用します。
webForward省略可(省略した場合にはfalseが設定されます)。
void MonobitEngine.Room.SetParametersListedInLobby ( string[]  paramsListedInLobby)

ルームパラメータのうち、ロビーに通知(ロビーに入室したプレイヤーがで閲覧(検索)可能な)パラメータキーを定義します.

Parameters
paramsListedInLobbyロビーに転送されるルームパラメータのキー情報。
override string MonobitEngine.Room.ToString ( )

ルームに関する情報について文字列を出力します。

Returns
文字列を返します。

Member Data Documentation

bool MonobitEngine.RoomData.autoCleanUpField = MonobitEngineBase.MonobitNetwork.autoRemoveInLeftRoom
protectedinherited

プレイヤーが退室したとき、バッファリングされたRPCと生成されたGameObjectを破棄するかどうかのフラグです。

Hashtable MonobitEngine.RoomData.m_customParameters = new Hashtable()
protectedinherited

ルームパラメータを保有します。

UInt32 MonobitEngine.RoomData.maxPlayersField = 0
protectedinherited

このルームに入室可能なプレイヤー数の上限を保有します。

string MonobitEngine.RoomData.nameField
protectedinherited

ルーム名を保有する変数です。

bool MonobitEngine.RoomData.openField = true
protectedinherited

ルームが入室可能状態になっているかどうかのフラグです。

string [] MonobitEngine.RoomData.parametersListedInLobbyField = new string[0]
protectedinherited

ロビーに通知するルームカスタムパラメータキー情報のリストです。

int MonobitEngine.RoomData.playerCountField
protectedinherited

ルーム内の(自分を含めない)プレイヤー数。

bool MonobitEngine.RoomData.visibleField = true
protectedinherited

このルームをロビーで閲覧可能にするかどうかのフラグです。

Property Documentation

bool MonobitEngine.Room.autoCleanUp
get

プレイヤーが退室したとき、バッファリングされたRPCと生成されたGameObjectを破棄するかどうかのフラグです。

Hashtable MonobitEngine.RoomData.customParameters
getinherited

ルームパラメータの読み込み専用キャッシュです。

bool MonobitEngine.RoomData.isLocalClientInside
getsetinherited

自身が既にルームに入室か、またはルームに入室しようとしているかどうかのフラグです。

new UInt32 MonobitEngine.Room.maxPlayers
getset

このルームに入室可能なプレイヤー数の上限を保有します。

new string MonobitEngine.Room.name
getset

ルーム名を保有する変数です。

new bool MonobitEngine.Room.open
getset

ルームが入室可能状態になっているかどうかのフラグです。

string [] MonobitEngine.RoomData.parametersListedInLobby
getsetinherited

ルームパラメータとして登録された情報のうち、ロビーに公開するキーの一覧.

new int MonobitEngine.Room.playerCount
get

このルーム内に入室しているプレイヤーの数です。

bool MonobitEngine.RoomData.removedFromList
getsetinherited

ロビーから閲覧可能なリストに記載されなくなったルームに対しtrueを設定します。

new bool MonobitEngine.Room.visible
getset

このルームをロビーで閲覧可能にするかどうかのフラグです。


The documentation for this class was generated from the following file: