Skip to main content

​
GUI overview

GUI pages cover interfaces that open, close, receive user input, and exchange actions with the game. They are separate from sprite rendering components. Use GUI when the player interacts with an interface, when the server opens a menu or dialog, or when a screen-level element should live above the game canvas.

​
Choose a GUI pattern

​
GUI or component?

Use Components overview when you only need a passive visual layer around sprites. Use GUI when the element behaves like an interface: it can be opened, hidden, updated with GUI data, or can send interactions back to the server.

​
Attached GUI

An attached GUI follows a sprite in the map, but it still belongs to the GUI system. This makes it useful for tooltips, contextual menus, and interactive widgets that need GUI lifecycle methods. For passive labels or bars around sprites, prefer Sprite Components or Authoritative Sprite Components.