UltimateUIDocs
Archived upstream docs · Features depend on the installed plugin version; not all features have been verified.

UltimateUI guide

Interaction Handling

Handle user interactions and clicks via the Java Event API.

Use the specialized click event to capture detailed interaction data, such as click types and block IDs, allowing you to execute custom logic or override default actions.

MethodReturnsDescription
getPlayer()PlayerThe player who clicked.
getPageName()StringThe name of the GUI page.
getBlockId()StringThe ID of the clicked element (defined in YAML).
getBlockLayer()intThe layer index of the block.
getClickType()ClickTypeEnum: LEFT, RIGHT, SCROLL_UP, SCROLL_DOWN.
getCursorX/Y()intExact cursor position at the moment of click.
setCancelled(boolean)voidIf true, prevents the default YAML action from executing.