com.jme3.cinematic

Enum PlayState

java.lang.Object

java.lang.Enum<PlayState>

com.jme3.cinematic.PlayState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PlayState>

public enum PlayState
extends java.lang.Enum<PlayState>

The play state of a cinematic event

Enum Constant Summary

Enum Constants

Enum Constant and Description
Paused The CinematicEvent is paused.
Playing The CinematicEvent is currently being played.
Stopped The CinematicEvent is stopped.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static PlayState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PlayState c : PlayState.values())
    System.out.println(c);

Returns:

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

valueOf

public static PlayState valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null