Class WorldEventPanelPage

java.lang.Object

com.hypixel.hytale.server.core.entity.entities.player.pages.CustomUIPage

com.hypixel.hytale.server.core.entity.entities.player.pages.InteractiveCustomUIPage<WorldEventPanelPage.PageData>

com.hypixel.hytale.builtin.adventure.worldevents.ui.WorldEventPanelPage

Direct Known Subclasses:

WorldEventActivePage, WorldEventAssetsPage, WorldEventConfigPage, WorldEventGlobalPage, WorldEventInspectorPage, WorldEventStoragePage

public abstract class WorldEventPanelPage
extends InteractiveCustomUIPage<WorldEventPanelPage.PageData>

Shared shell for the world-event admin panel. Subclasses fill the content pane for one tab.

The panel is read-mostly. It reads the world-event state of the world the player is in, and it runs the same operations as the /worldevent commands. All page callbacks run on the world thread of that world, so direct ECS access is safe.

Text values. A Text or TooltipText property is a plain string on the client. Only two forms decode into it:

• a Java String, and
• a Message.translation(String) whose parameters are all strings, numbers, or booleans.

Message.raw(String) and a Message used as a parameter do not decode. The first disconnects the client, the second drops the parameter. Pass a String for raw data, and give each variant of a sentence its own message id.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WorldEventPanelPage.Action	Every action the panel can send.
static class	WorldEventPanelPage.PageData
static enum	WorldEventPanelPage.Tab	Navigation tabs, in the order they appear in the rail.

Method Summary

Modifier and Type	Method	Description
final void	build(Ref<EntityStore> ref, UICommandBuilder cmd, UIEventBuilder evt, Store<EntityStore> store)	Called to build this page
void	handleDataEvent(Ref<EntityStore> ref, Store<EntityStore> store, WorldEventPanelPage.PageData data)	Called to handle a data event for this page
void	onDismiss(Ref<EntityStore> ref, Store<EntityStore> store)	Called when this page is dismissed

Methods inherited from class InteractiveCustomUIPage

handleDataEvent

Methods inherited from class CustomUIPage

getLifetime, setLifetime

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

public final void build(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 UICommandBuilder cmd,
 @Nonnull
 UIEventBuilder evt,
 @Nonnull
 Store<EntityStore> store)

Description copied from class: CustomUIPage

Called to build this page

Specified by:

build in class CustomUIPage

Parameters:

ref - The entity ref of the affiliated player

cmd - The command builder used while building this UI

evt - The event builder used while building this UI

store - The entity store for component access

onDismiss

public void onDismiss(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 Store<EntityStore> store)

Description copied from class: CustomUIPage

Called when this page is dismissed

Overrides:

onDismiss in class CustomUIPage

handleDataEvent

public void handleDataEvent(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 WorldEventPanelPage.PageData data)

Description copied from class: InteractiveCustomUIPage

Called to handle a data event for this page

Overrides:

handleDataEvent in class InteractiveCustomUIPage<WorldEventPanelPage.PageData>

Parameters:

ref - The entity reference of the affiliated entity

store - The entity store for component access

data - The data event to handle