Package net.risingworld.api.ui

Enum Class UITarget

java.lang.Object

java.lang.Enum<UITarget>

net.risingworld.api.ui.UITarget

All Implemented Interfaces:

Serializable, Comparable<UITarget>, Constable

public enum UITarget
extends Enum<UITarget>

When adding a root UI element to the player UI, this flag determines where the element will be attached to.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Announcements	Attach element to announcement layer (so it's only visible while a "yell" message is shown)
Blueprints	Attach element to the blueprints menu
Crafting	Attach element to the crafting menu
DeathScreen	Attach element to the game over screen
DebugScreen	Attach element to the F3 debug screen
FpsCounter	Attach element to the fps counter layer
HUD	Attach element to the HUD (default)
HUDBars	Attach element to the lower left bar container (health bar, stamina, breath etc)
HUDCrosshair	Attach element to the crosshair on the HUD
HUDIndicators	Attach element to the status bar on HUD (hunger/thirst icons etc)
IngameMenu	Attach element to the ingame menu (ESC)
Inventory	Attach element to the inventory screen
LoadingScreen	Attach element to the loading screen (when player connects to the server)
RadialMenus	Attach element to radial menu layer (so it's only visible while a radial menu is open)
Scoreboard	Attach element to the playerlist/scoreboard
Storages	Attach element to the storage/chest screen

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HUD

public static final UITarget HUD

Attach element to the HUD (default)

HUDIndicators

public static final UITarget HUDIndicators

Attach element to the status bar on HUD (hunger/thirst icons etc)

HUDBars

public static final UITarget HUDBars

Attach element to the lower left bar container (health bar, stamina, breath etc)

HUDCrosshair

public static final UITarget HUDCrosshair

Attach element to the crosshair on the HUD

Inventory

public static final UITarget Inventory

Attach element to the inventory screen

Storages

public static final UITarget Storages

Attach element to the storage/chest screen

Crafting

public static final UITarget Crafting

Attach element to the crafting menu

Blueprints

public static final UITarget Blueprints

Attach element to the blueprints menu

IngameMenu

public static final UITarget IngameMenu

Attach element to the ingame menu (ESC)

Scoreboard

public static final UITarget Scoreboard

Attach element to the playerlist/scoreboard

FpsCounter

public static final UITarget FpsCounter

Attach element to the fps counter layer

DebugScreen

public static final UITarget DebugScreen

Attach element to the F3 debug screen

DeathScreen

public static final UITarget DeathScreen

Attach element to the game over screen

LoadingScreen

public static final UITarget LoadingScreen

Attach element to the loading screen (when player connects to the server)

RadialMenus

public static final UITarget RadialMenus

Attach element to radial menu layer (so it's only visible while a radial menu is open)

Announcements

public static final UITarget Announcements

Attach element to announcement layer (so it's only visible while a "yell" message is shown)

Method Details

values

public static UITarget[] 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 UITarget 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