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 |
Callback for received the battle start.
Param | DESC |
battleInfo | Battle information. |
onBattleEnded
onBattleEnded
void onBattleEnded | |
|
Callback for received tht battle end.
Param | DESC |
battleInfo | Battle information. |
reason | The reason why the PK ended. |
onUserJoinBattle
onUserJoinBattle
void onUserJoinBattle | (String battleId |
|
Callback for received user notification of joined the battle.
Param | DESC |
battleId | Battle ID. |
battleUser |
onUserExitBattle
onUserExitBattle
void onUserExitBattle | (String battleId |
|
Callback for received user notification of exited the battle.
Param | DESC |
battleId | Battle ID. |
battleUser |
onBattleScoreChanged
onBattleScoreChanged
void onBattleScoreChanged | (String battleId |
|
Callback for received score update notification of battle user.
Param | DESC |
battleId | Battle ID. |
battleUserList |
onBattleRequestReceived
onBattleRequestReceived
void onBattleRequestReceived | |
| |
|
Callback for received the battle invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
onBattleRequestCancelled
onBattleRequestCancelled
void onBattleRequestCancelled | |
| |
|
Callback for canceled the connection invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
onBattleRequestTimeout
onBattleRequestTimeout
void onBattleRequestTimeout | |
| |
|
Callback for timeout the battle invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
onBattleRequestAccept
onBattleRequestAccept
void onBattleRequestAccept | |
| |
|
Callback for accpeted the battle invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
inviter |
onBattleRequestReject
onBattleRequestReject
void onBattleRequestReject | |
| |
|
Callback for rejected the battle invitation
Param | DESC |
battleInfo | Battle information. |
invitee | |
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 | |
| 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). |
- TUILiveBattleManager
- StructType
- EnumType
- onBattleStarted
- onBattleEnded
- onUserJoinBattle
- onUserExitBattle
- onBattleScoreChanged
- onBattleRequestReceived
- onBattleRequestCancelled
- onBattleRequestTimeout
- onBattleRequestAccept
- onBattleRequestReject
- addObserver
- removeObserver
- requestBattle
- cancelBattleRequest
- acceptBattle
- rejectBattle
- exitBattle
- TUIBattleCode
- TUIBattleStoppedReason
- TUIBattleUser
- TUIBattleConfig
- TUIBattleInfo