Enum Class CutsceneEndReason

java.lang.Object

java.lang.Enum<CutsceneEndReason>

net.ixdarklord.coolcatcanvas.api.cutscene.CutsceneEndReason

All Implemented Interfaces:

Serializable, Comparable<CutsceneEndReason>, Constable

public enum CutsceneEndReason
extends Enum<CutsceneEndReason>

Why a cutscene stopped playing.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FINISHED	It ran to its end.
LEFT_WORLD	The player left the world.
REPLACED	Another cutscene started in its place.
SKIPPED	The player skipped it.
STOPPED	Code or the server stopped it.

Method Summary

Modifier and Type	Method	Description
boolean	completed()	Whether the player saw it through.
static CutsceneEndReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CutsceneEndReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FINISHED

public static final CutsceneEndReason FINISHED

It ran to its end.

SKIPPED

public static final CutsceneEndReason SKIPPED

The player skipped it.

STOPPED

public static final CutsceneEndReason STOPPED

Code or the server stopped it.

REPLACED

public static final CutsceneEndReason REPLACED

Another cutscene started in its place.

LEFT_WORLD

public static final CutsceneEndReason LEFT_WORLD

The player left the world.

Method Details

values

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

completed

public boolean completed()

Whether the player saw it through.