premium banner
Expand on the current user interface; allowing players, server admins, and mod to inject custom menu options or commands.

Description

UnifiedUI:API Logo


Summary

A Hytale API used for developers to describe and define sections with the Unified UI menu. Developers can define custom commands, and embedded UI sections.

Commands: Can be defined as raw commands, or call-backs to bring additional functionality.

Features: can take full advantage of the UICommandBuilder Hytale:Server class, and leverage a flexible event wrapper.

Security: All features are protected with permission filtering, along with world and game mode filtering.

Moderation: Admins can enable/disable sections within the Unified UI page for all players. Additionally, players can also personalize their own view.

Note

This plugin is an API ONLY and will not change the game unless installed with the Unified UI plugin.

Developers

Here is a high-level preview of the interface you would be working with. The main entry point for extensions is three methods. Read more at https://deezmods.com/hytale-unified-ui/developer-section/introduction.

package com.deezmods.unifiedui.api;

public interface UuiExtension {
    CompletableFuture<List<FeatureDefinition>> getFeatures(PlayerRef playerRef);
    CompletableFuture<List<CommandDefinition>> getCommands(PlayerRef playerRef);
    CompletableFuture<Void> onPageClose();
}