Class WarpListPage

java.lang.Object

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

com.hypixel.hytale.server.core.entity.entities.player.pages.InteractiveCustomUIPage<WarpListPage.WarpListPageEventData>

com.hypixel.hytale.builtin.teleport.WarpListPage

public class WarpListPage
extends InteractiveCustomUIPage<WarpListPage.WarpListPageEventData>

Warp List Page

A custom UI page that displays a searchable list of available warps and allows players to teleport to them.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WarpListPage.WarpListPageEventData	Warp List Page Event Data

Constructor Summary

Constructors

Constructor	Description
WarpListPage(PlayerRef playerRef, Map<String,Warp> warps, Consumer<String> callback)	Default Constructor for a WarpListPage instance.

Method Summary

Modifier and Type	Method	Description
void	build(Ref<EntityStore> ref, UICommandBuilder commandBuilder, UIEventBuilder eventBuilder, Store<EntityStore> store)	Called to build this page
void	handleDataEvent(Ref<EntityStore> ref, Store<EntityStore> store, WarpListPage.WarpListPageEventData eventData)	Called to handle a data event for this page

Methods inherited from class InteractiveCustomUIPage

handleDataEvent

Methods inherited from class CustomUIPage

getLifetime, onDismiss, setLifetime

Methods inherited from class Object

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

Constructor Details

WarpListPage

public WarpListPage(@Nonnull
 PlayerRef playerRef,
 Map<String,Warp> warps,
 Consumer<String> callback)

Default Constructor for a WarpListPage instance.

Parameters:

playerRef - The player reference for the page owner.

warps - A map of all available warps.

callback - The callback function to invoke when a warp is selected.

Method Details

build

public void build(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 UICommandBuilder commandBuilder,
 @Nonnull
 UIEventBuilder eventBuilder,
 @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

commandBuilder - The command builder used while building this UI

eventBuilder - The event builder used while building this UI

store - The entity store for component access

handleDataEvent

public void handleDataEvent(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 WarpListPage.WarpListPageEventData eventData)

Description copied from class: InteractiveCustomUIPage

Called to handle a data event for this page

Overrides:

handleDataEvent in class InteractiveCustomUIPage<WarpListPage.WarpListPageEventData>

Parameters:

ref - The entity reference of the affiliated entity

store - The entity store for component access

eventData - The data event to handle