이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

TUILiveBattleManager

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveBattleManager @ TUIKitEngine
Function: Live-Battle APIs

TUILiveBattleManager

TUILiveBattleManager

FuncList
DESC
Callback for received the battle start.
Callback for received tht battle end.
Callback for received user notification of joined the battle.
Callback for received user notification of exited the battle.
Callback for received score update notification of battle user.
Callback for received the battle invitation
Callback for canceled the connection invitation
Callback for timeout the battle invitation
Callback for accpeted the battle invitation
Callback for rejected the battle invitation
Add event callback
Remove event callback
Request battle invitation.
Cancel request about battle invitation.
Accept the battle invitaion.
Reject the battle invitaion.
Exit the battle

StructType

FuncList
DESC
Battle User Info
Battle Config
Battle Info

EnumType

EnumType
DESC
Battle Request Status
Battle Stopped Reason

onBattleStarted

onBattleStarted
void onBattleStarted
(BattleInfo battleInfo)

Callback for received the battle start.

Param
DESC
battleInfo
Battle information.

onBattleEnded

onBattleEnded
void onBattleEnded
(BattleInfo battleInfo

BattleStoppedReason reason)

Callback for received tht battle end.

Param
DESC
battleInfo
Battle information.
reason
The reason why the PK ended.

onUserJoinBattle

onUserJoinBattle
void onUserJoinBattle
(String battleId

BattleUser battleUser)

Callback for received user notification of joined the battle.

Param
DESC
battleId
Battle ID.
battleUser
The infomration about BattleUser.

onUserExitBattle

onUserExitBattle
void onUserExitBattle
(String battleId

BattleUser battleUser)

Callback for received user notification of exited the battle.

Param
DESC
battleId
Battle ID.
battleUser
The infomration about BattleUser.

onBattleScoreChanged

onBattleScoreChanged
void onBattleScoreChanged
(String battleId

List<BattleUser> battleUserList)

Callback for received score update notification of battle user.

Param
DESC
battleId
Battle ID.
battleUserList
The infomration about BattleUser.

onBattleRequestReceived

onBattleRequestReceived
void onBattleRequestReceived
(BattleInfo battleInfo

BattleUser inviter

BattleUser invitee)

Callback for received the battle invitation

Param
DESC
battleInfo
Battle information.
invitee
The BattleUser about the invitee.
inviter
The BattleUser about the inviter.

onBattleRequestCancelled

onBattleRequestCancelled
void onBattleRequestCancelled
(BattleInfo battleInfo

BattleUser inviter

BattleUser invitee)

Callback for canceled the connection invitation

Param
DESC
battleInfo
Battle information.
invitee
The BattleUser about the invitee.
inviter
The BattleUser about the inviter.

onBattleRequestTimeout

onBattleRequestTimeout
void onBattleRequestTimeout
(BattleInfo battleInfo

BattleUser inviter

BattleUser invitee)

Callback for timeout the battle invitation

Param
DESC
battleInfo
Battle information.
invitee
The BattleUser about the invitee.
inviter
The BattleUser about the inviter.

onBattleRequestAccept

onBattleRequestAccept
void onBattleRequestAccept
(BattleInfo battleInfo

BattleUser inviter

BattleUser invitee)

Callback for accpeted the battle invitation

Param
DESC
battleInfo
Battle information.
invitee
The BattleUser about the invitee.
inviter
The BattleUser about the inviter.

onBattleRequestReject

onBattleRequestReject
void onBattleRequestReject
(BattleInfo battleInfo

BattleUser inviter

BattleUser invitee)

Callback for rejected the battle invitation

Param
DESC
battleInfo
Battle information.
invitee
The BattleUser about the invitee.
inviter
The BattleUser about the inviter.

addObserver

addObserver
void addObserver
(Observer observer)

Add event callback

Param
DESC
observer
The instance being listened to.

removeObserver

removeObserver
void removeObserver
(Observer observer)

Remove event callback

Param
DESC
observer
The instance being listened to.

requestBattle

requestBattle
void requestBattle
(BattleConfig config

List<String> roomIdList

int timeout

BattleRequestCallback callback)

Request battle invitation.

Param
DESC
config
Battle configuration.
roomIdList
The list of room IDs will be invited.
timeout
Timeout time.

cancelBattleRequest

cancelBattleRequest
void cancelBattleRequest
(String battleId

List<String> userIdList

TUIRoomDefine.ActionCallback callback)

Cancel request about battle invitation.

Param
DESC
battleId
Battle ID.
roomIdList
The list of room IDs whose battle requests will be canceled.

acceptBattle

acceptBattle
void acceptBattle
(String battleId

TUIRoomDefine.ActionCallback callback)

Accept the battle invitaion.

Param
DESC
battleId
Battle ID.

rejectBattle

rejectBattle
void rejectBattle
(String battleId

TUIRoomDefine.ActionCallback callback)

Reject the battle invitaion.

Param
DESC
battleId
Battle ID.

exitBattle

exitBattle
void exitBattle
(String battleId

TUIRoomDefine.ActionCallback callback)

Exit the battle

Param
DESC
battleId
Battle ID.

TUIBattleCode

TUIBattleCode

Battle Request Status

Enum
Value
DESC
UNKNOWN
-1
default.
SUCCESS
0
Request success.
ROOM_NOT_EXISTS
1
Request Room not exist.
BATTLING
2
The room you are invited to join the battle is already joined battle.
BATTLING_OTHER_ROOM
3
The room you are invited to battle to is battling with other rooms.
ROOM_EXIT
4
The room is exited.
RETRY
5
An internal error occurs. You are advised to try again.

TUIBattleStoppedReason

TUIBattleStoppedReason

Battle Stopped Reason

Enum
Value
DESC
TIME_OVER
0
The Battle reaches the maximum duration and the timeout ends.
OTHER_EXIT
1
The rest of the users has exited.

TUIBattleUser

TUIBattleUser

Battle User Info

EnumType
DESC
avatarUrl
The user avatar url of the battle user.
roomId
The room id of the battle user.
score
The score of the battle user.
userId
The user id of the battle user.
userName
The user name of the battle user.

TUIBattleConfig

TUIBattleConfig

Battle Config

EnumType
DESC
duration
The maximum duration of the battle (Unit: seconds).
extensionInfo
The extension information of battle.
needResponse
Whether the invited user needs to reply accept/reject.

TUIBattleInfo

TUIBattleInfo

Battle Info

EnumType
DESC
battleId
Battle ID.
config
The configuration of battle.
endTime
The timestamp marking the end of the battle (Unit: seconds).
inviteeList
The people who are invited to join the battle.
inviter
The person who requests the battle.
startTime
The timestamp marking the start of the battle (Unit: seconds).