Package org.openpatch.scratch

Enum Class Layer

java.lang.Object

java.lang.Enum<Layer>

org.openpatch.scratch.Layer

All Implemented Interfaces:

Serializable, Comparable<Layer>, Constable

public enum Layer
extends Enum<Layer>

One of the three layers a stage draws, from back to front.

Sprites live between the background and the foreground. Anything stamped onto a layer stays there until the layer is erased.

 map.stampLayer("ground", Layer.BACKGROUND);
 

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
BACKGROUND	Behind the sprites.
FOREGROUND	In front of the sprites.
UI	In front of everything, and unaffected by the camera.

Method Summary

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

BACKGROUND

public static final Layer BACKGROUND

Behind the sprites.

FOREGROUND

public static final Layer FOREGROUND

In front of the sprites.

UI

public static final Layer UI

In front of everything, and unaffected by the camera.

Method Details

values

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