房间类 More...

Public Member Functions
async Task	SetCustomProperties (PlayObject properties, PlayObject expectedValues=null)
	设置房间的自定义属性

async Task	SetPlayerCustomProperties (int actorId, PlayObject properties, PlayObject expectedValues)
	设置玩家的自定义属性

Player	GetPlayer (int actorId)
	根据 actorId 获取 Player 对象

async Task< bool >	SetOpen (bool open)
	设置开启 / 关闭

async Task< bool >	SetVisible (bool visible)
	设置可见性

async Task< int >	SetMaxPlayerCount (int count)
	设置最大玩家数量

async Task< List< string > >	SetExpectedUserIds (List< string > expectedUserIds)
	设置期望玩家

async Task	ClearExpectedUserIds ()
	清空期望玩家

async Task< List< string > >	AddExpectedUserIds (List< string > expectedUserIds)
	增加期望玩家

async Task< List< string > >	RemoveExpectedUserIds (List< string > expectedUserIds)
	删除期望玩家

async Task< Player >	SetMaster (int newMasterId)
	设置房主

async Task	KickPlayer (int actorId, int code, string reason)
	踢掉玩家

Task	SendEvent (byte eventId, PlayObject eventData, SendEventOptions options)
	发送自定义事件

async Task	Close ()
	关闭

Properties
string	Name `[get, set]`
	房间名称

bool	Open `[get, set]`
	房间是否开启

bool	Visible `[get, set]`
	房间是否可见

int	MaxPlayerCount `[get, set]`
	房间允许的最大玩家数量

int	MasterActorId `[get, set]`
	房间主机玩家 Id

Player	Master `[get]`
	获取房主

List< string >	ExpectedUserIds `[get, set]`
	邀请的好友 ID 列表

PlayObject	CustomProperties `[get, set]`
	获取自定义属性

List< Player >	PlayerList `[get]`
	获取房间内的玩家列表

Player	Player `[get]`

Detailed Description

房间类

Member Function Documentation

◆ AddExpectedUserIds()

async Task< List< string > > LeanCloud.Play.Room.AddExpectedUserIds ( List< string > expectedUserIds )

inline

增加期望玩家

Returns: 期望玩家 Id 列表

Parameters

expectedUserIds 玩家 Id 列表

◆ ClearExpectedUserIds()

async Task LeanCloud.Play.Room.ClearExpectedUserIds ( )

inline

清空期望玩家

◆ Close()

async Task LeanCloud.Play.Room.Close ( )

inline

关闭

Returns

◆ GetPlayer()

Player LeanCloud.Play.Room.GetPlayer ( int actorId )

inline

根据 actorId 获取 Player 对象

Returns: 玩家对象

Parameters

actorId 玩家在房间中的 Id

◆ KickPlayer()

async Task LeanCloud.Play.Room.KickPlayer	(	int	actorId,
		int	code,
		string	reason
	)

inline

踢掉玩家

Parameters

actorId	玩家 Id
code	附加码
reason	附加消息

Returns

◆ RemoveExpectedUserIds()

async Task< List< string > > LeanCloud.Play.Room.RemoveExpectedUserIds ( List< string > expectedUserIds )

inline

删除期望玩家

Returns: 期望玩家 Id 列表

Parameters

expectedUserIds 玩家 Id 列表

◆ SendEvent()

Task LeanCloud.Play.Room.SendEvent	(	byte	eventId,
		PlayObject	eventData,
		SendEventOptions	options
	)

inline

发送自定义事件

Parameters

eventId	事件 Id
eventData	事件参数
options	事件选项

Returns

◆ SetCustomProperties()

async Task LeanCloud.Play.Room.SetCustomProperties	(	PlayObject	properties,
		PlayObject	expectedValues = `null`
	)

inline

设置房间的自定义属性

Parameters

properties	自定义属性
expectedValues	期望属性，用于 CAS 检测

◆ SetExpectedUserIds()

async Task< List< string > > LeanCloud.Play.Room.SetExpectedUserIds ( List< string > expectedUserIds )

inline

设置期望玩家

Returns: 期望玩家 Id 列表

Parameters

expectedUserIds 玩家 Id 列表

◆ SetMaster()

async Task< Player > LeanCloud.Play.Room.SetMaster ( int newMasterId )

inline

设置房主

Parameters

newMasterId 新的房主玩家 Id

Returns

◆ SetMaxPlayerCount()

async Task< int > LeanCloud.Play.Room.SetMaxPlayerCount ( int count )

inline

设置最大玩家数量

Returns: 房间最大玩家数量

Parameters

count 数量

◆ SetOpen()

async Task< bool > LeanCloud.Play.Room.SetOpen ( bool open )

inline

设置开启 / 关闭

Returns: 房间是否开启

Parameters

open 是否开启

◆ SetPlayerCustomProperties()

async Task LeanCloud.Play.Room.SetPlayerCustomProperties	(	int	actorId,
		PlayObject	properties,
		PlayObject	expectedValues
	)

inline

设置玩家的自定义属性

Parameters

actorId	玩家 Id
properties	自定义属性
expectedValues	期望属性，用于 CAS 检测

Returns

◆ SetVisible()

async Task< bool > LeanCloud.Play.Room.SetVisible ( bool visible )

inline

设置可见性

Returns: 房间是否可见

Parameters

visible 是否可见

Property Documentation

◆ CustomProperties

PlayObject LeanCloud.Play.Room.CustomProperties

getset

获取自定义属性

自定义属性

◆ ExpectedUserIds

List<string> LeanCloud.Play.Room.ExpectedUserIds

getset

邀请的好友 ID 列表

期望玩家 Id 列表

◆ Master

Player LeanCloud.Play.Room.Master

get

获取房主

房主玩家

◆ MasterActorId

int LeanCloud.Play.Room.MasterActorId

getset

房间主机玩家 Id

◆ MaxPlayerCount

int LeanCloud.Play.Room.MaxPlayerCount

getset

房间允许的最大玩家数量

◆ Name

string LeanCloud.Play.Room.Name

getset

房间名称

◆ Open

bool LeanCloud.Play.Room.Open

getset

房间是否开启

◆ Player

Player LeanCloud.Play.Room.Player

get

◆ PlayerList

List<Player> LeanCloud.Play.Room.PlayerList

get

获取房间内的玩家列表

房间内玩家列表

◆ Visible

bool LeanCloud.Play.Room.Visible

getset

房间是否可见

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

Play/Play.Unity/Assets/LeanCloud/Play/Public/Room.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddExpectedUserIds()

◆ ClearExpectedUserIds()

◆ Close()

◆ GetPlayer()

◆ KickPlayer()

◆ RemoveExpectedUserIds()

◆ SendEvent()

◆ SetCustomProperties()

◆ SetExpectedUserIds()

◆ SetMaster()

◆ SetMaxPlayerCount()

◆ SetOpen()

◆ SetPlayerCustomProperties()

◆ SetVisible()

Property Documentation

◆ CustomProperties

◆ ExpectedUserIds

◆ Master

◆ MasterActorId

◆ MaxPlayerCount

◆ Name

◆ Open

◆ Player

◆ PlayerList

◆ Visible