Monobit Unity Networking ver.2.8.0 Server API Reference (C++)
MatchingRoom Class Reference

マッチングルーム情報. More...

#include <MunMasterMatchingRoom.hpp>

Public Member Functions

uint64 GetId ()
 ルームIDの取得. More...
 
void SetId (uint64 id)
 ルームIDの設定. More...
 
std::string GetName ()
 ルーム名の取得. More...
 
void SetName (std::string name)
 ルーム名の設定. More...
 
uint64 GetLobbyId ()
 所属するロビーIDの取得. More...
 
void SetLobbyId (uint64 lobbyId)
 所属するロビーIDの設定. More...
 
bool GetIsVisible ()
 ルーム情報をロビーに通知するかどうかのフラグの取得. More...
 
void SetIsVisible (bool isVisible)
 ルーム情報をロビーに通知するかどうかのフラグの設定. More...
 
bool GetIsOpen ()
 他プレイヤーのルーム入室を許可するかどうかのフラグの取得. More...
 
void SetIsOpen (bool isOpen)
 他プレイヤーのルーム入室を許可するかどうかのフラグの設定. More...
 
uint32 GetMaxPlayers ()
 ルームに入室可能なプレイヤー人数の上限の取得. More...
 
void SetMaxPlayers (uint32 maxPlayers)
 ルームに入室可能なプレイヤー人数の上限の設定. More...
 
bool GetSummaryInfo (STREAM::SummaryRoomInfo &info)
 ルーム統計情報の取得. More...
 
void GetInfo (STREAM::RoomInfo &info)
 RPCルーム情報の取得. More...
 
std::map< int32, MatchingPlayerInRoom > * GetPlayers ()
 このルーム内にいる全てのプレイヤー情報の取得. More...
 
MatchingPlayerInRoomGetPlayer (int32 id)
 指定されたプレイヤーIDを持つルーム内プレイヤー情報の取得. More...
 
void AddPlayer (int32 playerId, uint32 clientId, std::string clientName, MatchingPlayerInRoom &player)
 指定されたプレイヤーIDの入室処理(ルーム内プレイヤー情報として加える). More...
 
void RemovePlayer (int32 playerId)
 指定されたプレイヤーIDの退室処理(ルーム内プレイヤー情報から削除する). More...
 
int32 GetHostId ()
 ホストIDの取得. More...
 
void SetHostId (int32 hostId)
 ホストIDの設定. More...
 
int32 GetNextPlayerId ()
 次に入室するプレイヤーに割り当てられるプレイヤーIDの取得. More...
 
std::map< std::string, STREAM::Union > & GetRoomParameters ()
 ルームパラメータの取得. More...
 
void SetRoomParameters (std::map< std::string, STREAM::Union > &roomParameters)
 ルームパラメータの設定. More...
 
void SetRoomParameters (STREAM::KeyValue *pRoomParameters, uint16 roomParametersLen)
 ルームパラメータの設定. More...
 
std::vector< std::string > & GetLobbyParameters ()
 ロビー通知パラメータの取得. More...
 
void SetLobbyParameters (std::vector< std::string > &lobbyParameters)
 ロビー通知パラメータの設定. More...
 
void SetLobbyParameters (STREAM::Text *pLobbyParameters, uint16 lobbyParametersLen)
 ロビー通知パラメータの設定. More...
 
std::map< std::string, STREAM::UnionGetVisibleRoomParameters ()
 ロビー通知対象となるルームパラメータの取得. More...
 
uint64 GetRoomUid ()
 mun_roomサーバ上の識別ユニークIDの取得. More...
 
void SetRoomUid (uint64 roomUid)
 mun_roomサーバ上の識別ユニークIDの設定. More...
 
bool GetIsNeedHostPlayer ()
 ホストプレイヤーが必要かどうかのフラグの取得. More...
 
 MatchingRoom (uint64 id=0, std::string name="", uint64 lobbyId=0, bool isVisible=true, bool isOpen=true, uint32 maxPlayers=0, uint64 roomUid=0, bool isNeedHostPlayer=true)
 コンストラクタ. More...
 
virtual ~MatchingRoom ()
 デストラクタ.
 
bool IsRandomJoinable (uint32 maxPlayers=0)
 このルームにランダム入室可能かどうかを調べる. More...
 

Protected Attributes

uint64 m_Id
 ルームID. More...
 
std::string m_Name
 ルーム名. More...
 
uint64 m_LobbyId
 所属するロビーID. More...
 
bool m_IsVisible
 ルーム情報をロビーに通知するかどうかのフラグ. More...
 
bool m_IsOpen
 他プレイヤーのルーム入室を許可するかどうかのフラグ. More...
 
uint32 m_MaxPlayers
 ルームに入室可能なプレイヤー人数の上限。0であれば無制限となる. More...
 
std::map< int32, MatchingPlayerInRoomm_PlayersInRoom
 このルーム内にいるプレイヤー情報. More...
 
int32 m_HostId
 ホストID. More...
 
int32 m_NextPlayerId
 次に入室するプレイヤーに割り当てられるプレイヤーID. More...
 
std::map< std::string, STREAM::Unionm_RoomParameters
 ルームパラメータ. More...
 
std::vector< std::string > m_LobbyParameters
 ロビー通知パラメータ. More...
 
uint64 m_RoomUid
 mun_roomサーバ上の識別ユニークID. More...
 
bool m_IsNeedHostPlayer
 ホストプレイヤーが必要かどうかのフラグ. More...
 

Detailed Description

マッチングルーム情報.

Constructor & Destructor Documentation

MatchingRoom::MatchingRoom ( uint64  id = 0,
std::string  name = "",
uint64  lobbyId = 0,
bool  isVisible = true,
bool  isOpen = true,
uint32  maxPlayers = 0,
uint64  roomUid = 0,
bool  isNeedHostPlayer = true 
)

コンストラクタ.

Parameters
idルームID。指定がない場合には 0 が設定される.
nameルーム名。指定がない場合には空文字が設定される.
lobbyId所属するロビーID。指定がない場合には 0 が設定される.
isVisibleルーム情報をロビーに通知するかどうかのフラグ。指定がない場合には true が設定される.
isOpen他プレイヤーのルーム入室を許可するかどうかのフラグ。指定がない場合には true が設定される.
maxPlayersルームに入室可能なプレイヤー人数の上限。指定がない場合には 0 が設定される.
roomUidmun_roomサーバ上の識別ユニークID。指定がない場合には 0 が設定される.
isNeedHostPlayerホストプレイヤーが必要かどうかのフラグ。指定がない場合には true が設定される.

Member Function Documentation

void MatchingRoom::AddPlayer ( int32  playerId,
uint32  clientId,
std::string  clientName,
MatchingPlayerInRoom player 
)

指定されたプレイヤーIDの入室処理(ルーム内プレイヤー情報として加える).

Parameters
playerId入室処理対象となるプレイヤーID.
clientId入室処理対象となるプレイヤー情報をもつMUNクライアントID.
clientName入室処理対象となるプレイヤー情報をもつMUNクライアント名.
player入室処理対象となるプレイヤー情報.

Here is the call graph for this function:

Here is the caller graph for this function:

int32 MatchingRoom::GetHostId ( )

ホストIDの取得.

Returns
ホストID(存在しなければ 0)を返す。

Here is the call graph for this function:

Here is the caller graph for this function:

uint64 MatchingRoom::GetId ( )

ルームIDの取得.

Returns
ルームIDを返す。

Here is the caller graph for this function:

void MatchingRoom::GetInfo ( STREAM::RoomInfo info)

RPCルーム情報の取得.

Returns
RPCルーム情報を返す。

Here is the call graph for this function:

Here is the caller graph for this function:

bool MatchingRoom::GetIsNeedHostPlayer ( )

ホストプレイヤーが必要かどうかのフラグの取得.

Returns
ホストプレイヤーが必要かどうかのフラグを返す。

Here is the caller graph for this function:

bool MatchingRoom::GetIsOpen ( )

他プレイヤーのルーム入室を許可するかどうかのフラグの取得.

Returns
他プレイヤーのルーム入室を許可するかどうかのフラグを返す。

Here is the caller graph for this function:

bool MatchingRoom::GetIsVisible ( )

ルーム情報をロビーに通知するかどうかのフラグの取得.

Returns
ルーム情報をロビーに通知するかどうかのフラグを返す。

Here is the caller graph for this function:

uint64 MatchingRoom::GetLobbyId ( )

所属するロビーIDの取得.

Returns
所属するロビーIDを返す。

Here is the caller graph for this function:

std::vector< std::string >& MatchingRoom::GetLobbyParameters ( )

ロビー通知パラメータの取得.

Returns
ロビー通知パラメータを返す。
uint32 MatchingRoom::GetMaxPlayers ( )

ルームに入室可能なプレイヤー人数の上限の取得.

Returns
ルームに入室可能なプレイヤー人数の上限(0であれば無制限)を返す。

Here is the caller graph for this function:

std::string MatchingRoom::GetName ( )

ルーム名の取得.

Returns
ルーム名を返す。

Here is the caller graph for this function:

int32 MatchingRoom::GetNextPlayerId ( )

次に入室するプレイヤーに割り当てられるプレイヤーIDの取得.

Returns
次に入室するプレイヤーに割り当てられるプレイヤーIDを返す。

Here is the caller graph for this function:

MatchingPlayerInRoom* MatchingRoom::GetPlayer ( int32  id)

指定されたプレイヤーIDを持つルーム内プレイヤー情報の取得.

Parameters
id取得対象となるプレイヤーID.
Returns
指定されたプレイヤーIDを持つルーム内プレイヤー情報(存在しなければNULL)を返す。

Here is the caller graph for this function:

std::map<int32, MatchingPlayerInRoom >* MatchingRoom::GetPlayers ( )

このルーム内にいる全てのプレイヤー情報の取得.

Returns
このルーム内にいる全てのプレイヤー情報を返す。

Here is the caller graph for this function:

std::map< std::string, STREAM::Union >& MatchingRoom::GetRoomParameters ( )

ルームパラメータの取得.

Returns
ルームパラメータを返す。

Here is the caller graph for this function:

uint64 MatchingRoom::GetRoomUid ( )

mun_roomサーバ上の識別ユニークIDの取得.

Returns
mun_roomサーバ上の識別ユニークIDを返す。

Here is the caller graph for this function:

bool MatchingRoom::GetSummaryInfo ( STREAM::SummaryRoomInfo info)

ルーム統計情報の取得.

Parameters
info取得するルーム統計情報.
Returns
取得できたら true、取得できなかったら false を返す。

Here is the call graph for this function:

Here is the caller graph for this function:

std::map<std::string, STREAM::Union> MatchingRoom::GetVisibleRoomParameters ( )

ロビー通知対象となるルームパラメータの取得.

Returns
ロビー通知対象となるルームパラメータを返す。
bool MatchingRoom::IsRandomJoinable ( uint32  maxPlayers = 0)

このルームにランダム入室可能かどうかを調べる.

Parameters
maxPlayers想定されるルーム入室可能人数上限(指定がない場合には 0 が設定される)。 この値より入室可能人数上限が少ないルームには入室不可となる.
Returns
ランダム入室可能であれば true、不可能であれば false を返す。

Here is the caller graph for this function:

void MatchingRoom::RemovePlayer ( int32  playerId)

指定されたプレイヤーIDの退室処理(ルーム内プレイヤー情報から削除する).

Parameters
playerId退室処理対象となるプレイヤーID.

Here is the caller graph for this function:

void MatchingRoom::SetHostId ( int32  hostId)

ホストIDの設定.

Parameters
hostIdホストID.

Here is the caller graph for this function:

void MatchingRoom::SetId ( uint64  id)

ルームIDの設定.

Parameters
idルームID.

Here is the caller graph for this function:

void MatchingRoom::SetIsOpen ( bool  isOpen)

他プレイヤーのルーム入室を許可するかどうかのフラグの設定.

Parameters
isOpen他プレイヤーのルーム入室を許可するかどうかのフラグ.

Here is the caller graph for this function:

void MatchingRoom::SetIsVisible ( bool  isVisible)

ルーム情報をロビーに通知するかどうかのフラグの設定.

Parameters
isVisibleルーム情報をロビーに通知するかどうかのフラグ.

Here is the caller graph for this function:

void MatchingRoom::SetLobbyId ( uint64  lobbyId)

所属するロビーIDの設定.

Parameters
lobbyId所属するロビーID.

Here is the caller graph for this function:

void MatchingRoom::SetLobbyParameters ( std::vector< std::string > &  lobbyParameters)

ロビー通知パラメータの設定.

Parameters
lobbyParametersロビー通知パラメータ.

Here is the caller graph for this function:

void MatchingRoom::SetLobbyParameters ( STREAM::Text pLobbyParameters,
uint16  lobbyParametersLen 
)

ロビー通知パラメータの設定.

Parameters
pLobbyParametersロビー通知パラメータの先頭アドレス.
lobbyParametersLenpLobbyParameters に登録されているロビー通知パラメータの数.
void MatchingRoom::SetMaxPlayers ( uint32  maxPlayers)

ルームに入室可能なプレイヤー人数の上限の設定.

Parameters
maxPlayersルームに入室可能なプレイヤー人数の上限(0であれば無制限).

Here is the caller graph for this function:

void MatchingRoom::SetName ( std::string  name)

ルーム名の設定.

Parameters
nameルーム名.

Here is the caller graph for this function:

void MatchingRoom::SetRoomParameters ( std::map< std::string, STREAM::Union > &  roomParameters)

ルームパラメータの設定.

Parameters
roomParametersルームパラメータ.

Here is the caller graph for this function:

void MatchingRoom::SetRoomParameters ( STREAM::KeyValue pRoomParameters,
uint16  roomParametersLen 
)

ルームパラメータの設定.

Parameters
pRoomParametersルームパラメータの先頭アドレス.
roomParametersLenpRoomParameters に含まれるルームパラメータの数.
void MatchingRoom::SetRoomUid ( uint64  roomUid)

mun_roomサーバ上の識別ユニークIDの設定.

Parameters
roomUidmun_roomサーバ上の識別ユニークID.

Here is the caller graph for this function:

Member Data Documentation

int32 MatchingRoom::m_HostId
protected

ホストID.

uint64 MatchingRoom::m_Id
protected

ルームID.

bool MatchingRoom::m_IsNeedHostPlayer
protected

ホストプレイヤーが必要かどうかのフラグ.

bool MatchingRoom::m_IsOpen
protected

他プレイヤーのルーム入室を許可するかどうかのフラグ.

bool MatchingRoom::m_IsVisible
protected

ルーム情報をロビーに通知するかどうかのフラグ.

uint64 MatchingRoom::m_LobbyId
protected

所属するロビーID.

std::vector< std::string > MatchingRoom::m_LobbyParameters
protected

ロビー通知パラメータ.

uint32 MatchingRoom::m_MaxPlayers
protected

ルームに入室可能なプレイヤー人数の上限。0であれば無制限となる.

std::string MatchingRoom::m_Name
protected

ルーム名.

int32 MatchingRoom::m_NextPlayerId
protected

次に入室するプレイヤーに割り当てられるプレイヤーID.

std::map< int32, MatchingPlayerInRoom > MatchingRoom::m_PlayersInRoom
protected

このルーム内にいるプレイヤー情報.

std::map< std::string, STREAM::Union > MatchingRoom::m_RoomParameters
protected

ルームパラメータ.

uint64 MatchingRoom::m_RoomUid
protected

mun_roomサーバ上の識別ユニークID.


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