Package com.jme3.cinematic

Enum Class PlayState

java.lang.Object

java.lang.Enum<PlayState>

com.jme3.cinematic.PlayState

All Implemented Interfaces:

Serializable, Comparable<PlayState>, Constable

public enum PlayState
extends Enum<PlayState>

The play state of a cinematic event

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
Paused	The CinematicEvent is paused.
Playing	The CinematicEvent is currently being played.
Stopped	The CinematicEvent is stopped.

Method Summary

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

Playing

public static final PlayState Playing

The CinematicEvent is currently being played.

Paused

public static final PlayState Paused

The CinematicEvent is paused.

Stopped

public static final PlayState Stopped

The CinematicEvent is stopped.

Method Details

values

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