Enum Class CustomUI.CustomUILifetime

java.lang.Object

java.lang.Enum<CustomUI.CustomUILifetime>

fr.hytale.loader.api.ui.CustomUI.CustomUILifetime

All Implemented Interfaces:

Serializable, Comparable<CustomUI.CustomUILifetime>, Constable

Enclosing class:

CustomUI

public static enum CustomUI.CustomUILifetime
extends Enum<CustomUI.CustomUILifetime>

UI lifetime options.

Since:

1.0.5

Version:

1.0.6

Author:

HytaleLoader

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAN_DISMISS	Player can dismiss the UI (e.g., pressing escape).
CAN_DISMISS_OR_CLOSE_THROUGH_INTERACTION	UI can be dismissed or closed through interaction.
CANNOT_CLOSE	Player cannot close the UI.

Method Summary

Modifier and Type	Method	Description
static CustomUI.CustomUILifetime	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CustomUI.CustomUILifetime[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CAN_DISMISS

public static final CustomUI.CustomUILifetime CAN_DISMISS

Player can dismiss the UI (e.g., pressing escape).

CANNOT_CLOSE

public static final CustomUI.CustomUILifetime CANNOT_CLOSE

Player cannot close the UI.

CAN_DISMISS_OR_CLOSE_THROUGH_INTERACTION

public static final CustomUI.CustomUILifetime CAN_DISMISS_OR_CLOSE_THROUGH_INTERACTION

UI can be dismissed or closed through interaction.

Method Details

values

public static CustomUI.CustomUILifetime[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CustomUI.CustomUILifetime valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null