Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni.enumerate

Enum Class EGroundState

java.lang.Object

java.lang.Enum<EGroundState>

com.github.stephengold.joltjni.enumerate.EGroundState

All Implemented Interfaces:

Serializable, Comparable<EGroundState>, Constable

public enum EGroundState
extends Enum<EGroundState>

Categorize the possible relationships between a character and its supporting surface. (native type: CharacterBase::EGroundState)

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
InAir	not in contact
NotSupported	in contact but unsupported
OnGround	fully supported
OnSteepGround	in contact but unable to climb

Method Summary

Modifier and Type	Method	Description
static EGroundState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EGroundState[]	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

OnGround

public static final EGroundState OnGround

fully supported

OnSteepGround

public static final EGroundState OnSteepGround

in contact but unable to climb

NotSupported

public static final EGroundState NotSupported

in contact but unsupported

InAir

public static final EGroundState InAir

not in contact

Method Details

values

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