Enum Class CaveYawMode

java.lang.Object

java.lang.Enum<CaveYawMode>

com.hypixel.hytale.server.worldgen.cave.CaveYawMode

All Implemented Interfaces:

Serializable, Comparable<CaveYawMode>, Constable

public enum CaveYawMode
extends Enum<CaveYawMode>

Utility for handling how the yaw angle for a child cave-node is determined when its parent is a PrefabCaveNodeShape which may have been rotated by a PrefabRotation.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NODE	Returns the parent node's yaw, ignoring its PrefabRotation.
PREFAB	Returns the parent node's PrefabRotation angle, ignoring its yaw.
SUM	Returns the sum of the parent node's yaw and its PrefabRotation angle.

Method Summary

Modifier and Type	Method	Description
abstract float	combine(float parentYaw, PrefabRotation parentRotation)	Combines the parent cave-node's yaw and rotation into a new angle for a child cave-node to inherit.
static CaveYawMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CaveYawMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NODE

public static final CaveYawMode NODE

Returns the parent node's yaw, ignoring its PrefabRotation.

SUM

public static final CaveYawMode SUM

Returns the sum of the parent node's yaw and its PrefabRotation angle.

PREFAB

public static final CaveYawMode PREFAB

Returns the parent node's PrefabRotation angle, ignoring its yaw.

Method Details

values

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

combine

public abstract float combine(float parentYaw,
 @Nullable
 PrefabRotation parentRotation)

Combines the parent cave-node's yaw and rotation into a new angle for a child cave-node to inherit.

Parameters:

parentYaw - The yaw of the parent cave-node.

parentRotation - The rotation of the parent cave-node if it happens to be a PrefabCaveNodeShape.

Returns:

The resulting yaw angle for a child cave-node to inherit.