Enum Class ScreenEffectScope

java.lang.Object

java.lang.Enum<ScreenEffectScope>

net.ixdarklord.coolcatcanvas.api.client.effect.ScreenEffectScope

All Implemented Interfaces:

Serializable, Comparable<ScreenEffectScope>, Constable

public enum ScreenEffectScope
extends Enum<ScreenEffectScope>

When in the frame a screen effect is drawn.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SCREEN	Over everything, HUD and screens included.
WORLD	Over the world and the held item, under the HUD and screens: where vanilla draws its creeper and spider views.

Method Summary

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

WORLD

public static final ScreenEffectScope WORLD

Over the world and the held item, under the HUD and screens: where vanilla draws its creeper and spider views. Only while a world is being rendered. The depth buffer still holds the world's depth here.

SCREEN

public static final ScreenEffectScope SCREEN

Over everything, HUD and screens included. Also runs in menus, with no world loaded.

Method Details

values

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