Relay SDK 回调事件

函数定义

// uint code, 表示连接的结果，可参考RelayCode
// RelayRoom room, 连接成功返回当前房间信息，失败返回null
public Action<uint, RelayRoom> OnConnectToRelayServerCallback;

// uint newMasterClientID, 新的MasterClient的TransportId
// 在MasterClient在退出房间或掉线时会触发，(对于Netcode，如果未勾选DisableDisconnectRemoteClient，则仅会在被动掉线时触发）
// 注册该回调函数后，如果MasterClient离开，当前玩家不会断开连接，后续流程会由OnMasterClientMigrateCallback处理
public Action<uint> OnMasterClientMigrateCallback;

// RelayPlayer player, 表示更新的玩家信息
public Action<RelayPlayer> OnPlayerInfoUpdateCallback;

// RelayRoom room, 表示更新后的房间信息
public Action<RelayRoom> OnRoomInfoUpdateCallback;

// uint code, 表示玩家被踢掉的原因，可参考RelayCode
// string reason, 表示玩家被踢掉的原因
public Action<uint, string> OnPlayerKickedCallback;

// RelayPlayer player, 表示加入房间的玩家信息
public Action<RelayPlayer> OnPlayerEnterRoom;

// RelayPlayer player, 表示离开房间的玩家信息
public Action<RelayPlayer> OnPlayerLeaveRoom;

// 当客户端到Relay Server的心跳超时时会触发
public Action OnHeartbeatTimeout;

// 调用SetHeartbeat完成后触发
// uint code, 表示设置的结果，可参考RelayCode
// uint timeout, 心跳超时时间，单位为s
public Action<uint, uint> OnSetHeartbeat;

详细说明

回调函数名称	参数说明	功能描述
OnConnectToRelayServerCallback	• uint code：连接的结果，可参考RelayCode • RelayRoom room：连接成功返回当前房间信息，失败返回null	用于接收连接中继服务器的结果回调
OnMasterClientMigrateCallback	• uint newMasterClientID：新的MasterClient的TransportId	在MasterClient退出房间或掉线时会触发（对于Netcode，如果未勾选DisableDisconnectRemoteClient，则仅会在被动掉线时触发）。注册该回调函数后，如果MasterClient离开，当前玩家不会断开连接，后续流程会由OnMasterClientMigrateCallback处理
OnPlayerInfoUpdateCallback	• RelayPlayer player：表示更新的玩家信息	当玩家信息发生更新时触发
OnRoomInfoUpdateCallback	• RelayRoom room：表示更新后的房间信息	当房间信息发生更新时触发
OnPlayerKickedCallback	• uint code：表示玩家被踢掉的原因，可参考RelayCode • string reason：表示玩家被踢掉的原因	当当前玩家被踢出房间时触发
OnPlayerEnterRoom	• RelayPlayer player：表示加入房间的玩家信息	有新玩家加入房间时触发
OnPlayerLeaveRoom	• RelayPlayer player：表示离开房间的玩家信息	有玩家离开房间时触发
OnHeartbeatTimeout	-	当客户端到Relay Server的心跳超时时会触发
OnSetHeartbeat	• uint code：表示设置的结果，可参考RelayCode • uint timeout：心跳超时时间，单位为s	调用SetHeartbeat完成后触发，返回设置结果和超时时间