Class HytaleMenuDefinition
java.lang.Object
net.blueva.arcade.api.ui.menu.hytale.HytaleMenuDefinition
- Record Components:
layoutPath- the path to the.uilayout file relative toCommon/UI/Custom/(e.g."MyPlugin/Menu.ui")title- the logical title of the menu (used for logging/identification)elements- the list of named UI elements whose values can be set from the servereventBindings- the list of event bindings that connect UI elements to server-side actionsdismissable- whether the player can dismiss the UI without triggering an action
Static menu definition for Hytale's custom UI system.
Hytale menus are backed by .ui layout files that are downloaded
to the client when the player connects. The server manipulates the UI
by sending commands to set values and by receiving events for user
interactions.
- Since:
- 3.2
-
Constructor Summary
ConstructorsConstructorDescriptionHytaleMenuDefinition(String layoutPath, String title, List<HytaleUIElement> elements, List<HytaleUIEventBinding> eventBindings, boolean dismissable) -
Method Summary
Modifier and TypeMethodDescriptionbooleanelements()booleaninthashCode()static HytaleMenuDefinitionof(String layoutPath, String title, List<HytaleUIElement> elements, List<HytaleUIEventBinding> eventBindings) Creates a simple dismissable menu definition.title()toString()
-
Constructor Details
-
HytaleMenuDefinition
public HytaleMenuDefinition(String layoutPath, String title, List<HytaleUIElement> elements, List<HytaleUIEventBinding> eventBindings, boolean dismissable)
-
-
Method Details
-
layoutPath
-
title
-
elements
-
eventBindings
-
dismissable
public boolean dismissable() -
equals
-
hashCode
public int hashCode() -
toString
-
of
public static HytaleMenuDefinition of(String layoutPath, String title, List<HytaleUIElement> elements, List<HytaleUIEventBinding> eventBindings) Creates a simple dismissable menu definition.- Parameters:
layoutPath- the layout file pathtitle- the menu titleelements- the settable UI elementseventBindings- the event bindings- Returns:
- a new dismissable HytaleMenuDefinition
-