Components & Properties
| Name | Description |
|---|---|
| Profile Picture Widget | Player bio |
| Built-In UI Type | \ |
| Built-In UI | \ |
| Custom UI | \ |
| UI Timer Info | \ |
| UI Opening Banner | \ |
| UI Round Start Banner | \ |
| UI Simple Round Start Banner | \ |
| UI Simple Round Score Banner | \ |
| UI Check Point Indicator | \ |
| UI Two-Team Result Panel | \ |
| UI Versus Banner | \ |
| UI Two-Team Round Score Banner | \ |
| UI Win-or-Lose Banner | \ |
| UI Round Number | \ |
| UI Phase Timer | \ |
| UI Match Subtitle | \ |
| UI Two-Team Info | \ |
| UI Team Match Info | \ |
| UI Two-Team Leaderboard[Obsolete] | \ |
| UI Two-Team Leaderboard | \ |
| UI Multi-Team Leaderboard[Obsolete] | \ |
| UI Multi-Team Leaderboard | \ |
| UI Simple Versus Banner | \ |
| UI Icon Notification | \ |
| UI Two-Team Brief Info | \ |
| UI Two-Team Brief Info | \ |
| UI Countdown Reminder | \ |
| UI Tween Tip | \ |
| UI Round Transition | \ |
| UI Solo Leaderboard[Obsolete] | A HUD entity for single-player matches. Modifying the entity’s properties will affect the content to be displayed on the corresponding UI. |
| UI Leaderboard Button | The HUD entity of the scoreboard. Modifying the entity’s properties will affect the content to be displayed on the corresponding UI. |
| UI Monster Level | \ |
| UI Add Score | \ |
| UI Monster UI | \ |
| UI Countdown Hint | \ |
| UI Card Selection Panel | Select card HUD entity |
| UI Identity Notification | \ |
| UI Countdown 5s | \ |
| UI Title Banner | \ |
| UI Built-In Switch | \ |
| UI Skill Button | Skill button HUD entity |
| UI Heartbeat | \ |
| UI Progress Bar | \ |
| UI Health Bar | \ |
| UI Heartbeat | The heartbeat effect entity |
| UI Widget | \ |
| Custom UI or Widget | \ |
| UI Widget Empty | \ |
| UI Widget Image | \ |
| UI Widget Label | \ |
| UI Widget Button | \ |
| UI Widget Input Label | \ |
| UI Widget Layout | The HUD insertion entity. This is the HUD that players modify from the editor. |
| UI Widget Texture | The HUD texture entity. This is the HUD that players modify from the editor. |
| UI Widget Profile | The HUD profile info entity. This is the HUD that players modify from the editor. |
| UI Widget Toggle | The HudToggle entity that players can edit in the HUD editor |
| UI Widget Touchpad | The HUD Touchpad widget that players can edit in the HUD editor |
| UI Widget Joystick | Joystick entity. Players can edit the HUD via the HUD Editor. |
| UI Panel | The HUD insertion entity. It is the HUD that the player edits using the editor. |
| UI Panel Empty | The HUD insertion entity. This is the HUD that players modify from the editor. |
| Grid[Obsolete] | The HUD insertion entity. It is the HUD that the player edits using the editor. |
| UI Scroll Panel | The HUD insertion entity. It is the HUD that the player edits using the editor. |
| UI Transformrt[Obsolete] | The UITransform control entity |
| UI Widget Container | The HUD 3D container entity. This is the HUD that players modify from the editor. |
| UI Text Tip | \ |
| UI Two Team Score Panel | Result of 2 Teams |
| UI Multi-Team Result Panel | Result of Multiple Teams |
| Widget Type | \ |
| Fill Type | Fill type enum |
| Fill Direction Type | Fill direction enum |
| Layout Sort Type | \ |
| UI Score Bar | Scorebar |
| UI Tip Button | Hint button |
| UI Simple Tip | Hint |
| UI Progress Skill Button | The button for the skill progress |
| UI Animation Trigger HUD | Animation Trigger HUD |
| UI Compass | The compass on the top |
| Round Info HUD | Information displayed at the start of a round |
| UI Round Result Banner | Results displayed at the end of each round |
| UI Follow Health Bar | The information displayed above the player’s head |
Event
| Name | Description |
|---|---|
| On Built-In UI Button Tapped | Triggered when a button in the built-in UI is clicked |
| On Tapped | Triggered after clicking the UI button control |
| On Pressed | Triggered after the UI button control is pressed by the player |
| On Released | Triggered after the UI button control is lifted |
| On Double-Tapped | Triggered after the UI button control is double-clicked by the player |
| On Text Change | Triggered when the text content of the UI input box control is changed by the player |
| On Toggle | Triggered when the Toggle control state changes |
| On Touch Down | Triggered when the touchpad is pressed by the player |
| On Touch Up | Triggered when the touchpad is lifted |
| On Drag Start | Triggered when the touchpad starts sliding |
| On Drag | Triggered when sliding the touchpad. During sliding, this event is triggered once per frame. |
| On Drag End | Fired when the touchpad slide ends |
| On Pressed | Triggered when the JoyStick is pressed |
| On Released | Triggered when the JoyStick is lifted |
| On Joystick Move | Triggered when using the joystick |
| On Countdown Finished | Fired when the countdown ends |
| On Camera Raycast | This event is triggered when the camera ray detection is triggered by a client click event |
| On UI Show | Triggered when the shop interface is opened |
| On UI Hide | Triggered when the shop interface is closed. |
| On Friendship Status Update | Triggered when a player adds or deletes a friend |
API
| Name | Description |
|---|---|
| Create Built In UI | Create a built-in UI that only the specified player can see |
| Create Built In UI | Create a built-in UI that will not be synchronized to other clients |
| Destroy Built In UI | Remove built-in UI |
| Create Custom UI | Create a custom UI that only the specified player can see |
| Create Custom UI | Create a custom UI that will not be synchronized to other clients |
| Remove Custom UI | Removed custom game UI |
| Get Widget From Custom UI | Get UI widget from custom UI |
| Get Widget By Path | Get a UI widget from a custom UI using a path |
| Set Widget Parent | Set the parent node of the UI widget |
| Create Custom UI Widget | Creating Custom UI Widget |
| Is Friend | Determine the friend relationship between the target player and the current client player. The current client itself is not a friend of the current client. |