Skip to main content

HUD Compatibility

GroupManager displays the group HUD using Hytale's native multi-HUD support (server 0.7+). Each HUD is registered under its own key and the client keeps them side by side, so the group HUD coexists with the HUDs of other plugins without any extra mod.

How It Works​

  • The group HUD is registered under the key GroupHud.
  • When another plugin shows its own HUD (under a different key), the group HUD is not replaced — both stay visible.
  • Periodic HUD updates are sent under the GroupHud key, so they always reach the group HUD.
  • No external HUD plugin and no configuration are required.

HUD Mods​

GroupManager does not integrate with third-party multi-HUD mods.

PluginRecommendation
MultipleHUDNot needed — Hytale handles multiple HUDs natively.
AutoMultiHudDo not install on Hytale 0.7+ servers. Version 1.16 (latest) relies on HUD methods removed in Hytale 0.7 and fails every time the server sends a HUD.

HUD Content​

The group HUD panel displays:

ElementDescription
Group title"Group" header with member count
LeaderLeader name highlighted
MembersAll member names with online/offline indicators
Prefix/SuffixCustom text before/after names (set via API by external plugins)
Health barsReal-time health for each member
Energy barsReal-time energy for each member
Mana barsReal-time mana for each member

The HUD updates automatically every 250ms using GroupTracker, which caches health, energy, mana, position, level, and XP for each group member.

API Control​

External plugins can control the group HUD per-player:

GroupService api = GroupManagerProvider.get();

// Hide HUD during a match
api.pauseHud(playerUuid);

// Restore HUD after match
api.resumeHud(playerUuid);
MethodBehavior
pauseHud()Always hides the player's group HUD.
resumeHud()Recreates the group HUD if the player is in a group, following the same rules as normal display (e.g., the ShowHudWhenAlone setting).

These methods are always safe to call — no detection code is needed in your plugin. Since HUDs coexist natively, pausing is optional: use it when the group HUD should be hidden during your activity. For example, ArenaPvP keeps the group HUD visible during a match, so players see their team next to the match timer: it calls resumeHud() when the match starts to show the team's temporary group.

Complete Example: Activity HUD Management​

public class MyActivityHud {

private final GroupService groupApi;

/** Called when a player enters the activity */
public void onActivityStart(Player player) {
// Hide the GroupHud while the activity runs
groupApi.pauseHud(player.getUuid());

// Show your activity HUD (coexists with other HUDs under its own key)
showMyHud(player);
}

/** Called when a player exits the activity */
public void onActivityEnd(Player player) {
hideMyHud(player);

// Bring the GroupHud back (only if the player is in a group)
groupApi.resumeHud(player.getUuid());
}

/** Called when a player reconnects to an active activity */
public void onActivityReconnect(Player player) {
groupApi.pauseHud(player.getUuid());
showMyHud(player);
}
}
Key Rule

Call pauseHud when your activity starts and resumeHud when it ends if the group HUD should be hidden in between. If you are fine with both HUDs on screen, you don't need to call either.