Class UIModule

java.lang.Object

com.hypixel.hytale.server.core.plugin.PluginBase

com.hypixel.hytale.server.core.plugin.JavaPlugin

com.hypixel.hytale.server.core.modules.ui.UIModule

All Implemented Interfaces:

CommandOwner

public class UIModule
extends JavaPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UIModule.ClassDefinitionBuilder	Fluent builder for a view model class definition.

Field Summary

Fields

Modifier and Type	Field	Description
static final PluginManifest	MANIFEST

Fields inherited from class PluginBase

METRICS_REGISTRY

Constructor Summary

Constructors

Constructor	Description
UIModule(JavaPluginInit init)

Method Summary

Modifier and Type	Method	Description
UIModule.ClassDefinitionBuilder	defineClass(String typeName)	Returns a builder for registering a view model class with the given type name.
static UIModule	get()
boolean	registerClassDefinition(String typeName, Map<String,String> properties)	Registers a view model class with no base type.
boolean	registerClassDefinition(String typeName, Map<String,String> properties, String baseTypeName)	Registers a view model class.
boolean	registerEnumDefinition(String typeName, List<String> values)	Registers a view model enum.
static void	requireServersideNoesisUi()

Methods inherited from class JavaPlugin

getClassLoader, getFile, getType

Methods inherited from class PluginBase

getAssetRegistry, getBasePermission, getChunkStoreRegistry, getClientFeatureRegistry, getCodecRegistry, getCodecRegistry, getCodecRegistry, getCommandRegistry, getDataDirectory, getEntityRegistry, getEntityStoreRegistry, getEventRegistry, getIdentifier, getLogger, getManifest, getName, getState, getTaskRegistry, isDisabled, isEnabled, preLoad

Methods inherited from class Object

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

Field Details

MANIFEST

public static final PluginManifest MANIFEST

Constructor Details

UIModule

public UIModule(@Nonnull
 JavaPluginInit init)

Method Details

get

public static UIModule get()

requireServersideNoesisUi

public static void requireServersideNoesisUi()

registerClassDefinition

public boolean registerClassDefinition(@Nonnull
 String typeName,
 @Nonnull
 Map<String,String> properties,
 @Nullable
 String baseTypeName)

Registers a view model class. The typeName must start with "Server.". Duplicate type names are rejected with a warning. A successful registration sends that class definition to all online players immediately.

Part of an upcoming feature that is still in development and not yet ready for production use. Do not use. The API is not final and may change.

Parameters:

typeName - The fully qualified type name, e.g. "Server.MyMod.GameState".

properties - Property name to property type string map.

baseTypeName - Optional base type name for inheritance.

Returns:

whether the type was registered or not

registerClassDefinition

public boolean registerClassDefinition(@Nonnull
 String typeName,
 @Nonnull
 Map<String,String> properties)

Registers a view model class with no base type. A successful registration sends that class definition to all online players immediately.

Part of an upcoming feature that is still in development and not yet ready for production use. Do not use. The API is not final and may change.

Parameters:

typeName - The fully qualified type name, e.g. "Server.MyMod.GameState".

properties - Property name to property type string map.

Returns:

whether the type was registered or not

registerEnumDefinition

public boolean registerEnumDefinition(@Nonnull
 String typeName,
 @Nonnull
 List<String> values)

Registers a view model enum. The typeName must start with "Server.". Duplicate type names are rejected with a warning. A successful registration sends that enum definition to all online players immediately.

Part of an upcoming feature that is still in development and not yet ready for production use. Do not use. The API is not final and may change.

Parameters:

typeName - The fully qualified enum name, e.g. "Server.MyMod.Direction".

values - The ordered list of enum member names.

Returns:

whether the type was registered or not

defineClass

@Nonnull
public UIModule.ClassDefinitionBuilder defineClass(@Nonnull
 String typeName)

Returns a builder for registering a view model class with the given type name. Call UIModule.ClassDefinitionBuilder.register() to commit the definition. Use UITypes constants (or a static import of it) for property type strings. A successful register() call sends that class definition to all online players immediately.

Part of an upcoming feature that is still in development and not yet ready for production use. Do not use. The API is not final and may change.

Parameters:

typeName - The fully qualified type name; must start with "Server.".

Returns:

the builder