Package com.github.crashdemons.playerheads.compatibility

Enum SkullBlockAttachment

java.lang.Object

java.lang.Enum<SkullBlockAttachment>

com.github.crashdemons.playerheads.compatibility.SkullBlockAttachment

All Implemented Interfaces:

Serializable, Comparable<SkullBlockAttachment>

public enum SkullBlockAttachment
extends Enum<SkullBlockAttachment>

Enumeration of the different head-block attachment styles supported.

Since:

5.2.14-SNAPSHOT

Author:

crashdemons (crashenator at gmail.com)

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLOOR	Denotes a head that is placed on top of a block (a "floor head").
WALL	Denotes a head that is placed on the side of a block (a "wall head").

Method Summary

Modifier and Type	Method	Description
boolean	isValidOrientation(BlockFace rotation)	Determines if the provided rotation is compatible with this head-block attachment style.
static boolean	isValidOrientation(BlockFace rotation, SkullBlockAttachment attachment)	Determines if the provided rotation is compatible with the provided head block attachment style.
static SkullBlockAttachment	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SkullBlockAttachment[]	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

FLOOR

public static final SkullBlockAttachment FLOOR

Denotes a head that is placed on top of a block (a "floor head"). That is, it is against/aligned-with the top side of the block it is above (a "floor")

WALL

public static final SkullBlockAttachment WALL

Denotes a head that is placed on the side of a block (a "wall head"). That is, it is against/aligned-with the horizontal side of some block (a "wall")

Method Detail

values

public static SkullBlockAttachment[] 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 (SkullBlockAttachment c : SkullBlockAttachment.values())
    System.out.println(c);

Returns:

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

valueOf

public static SkullBlockAttachment valueOf(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:

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

NullPointerException - if the argument is null

isValidOrientation

public static boolean isValidOrientation(BlockFace rotation,
                                         SkullBlockAttachment attachment)

Determines if the provided rotation is compatible with the provided head block attachment style. This is relevant because floor-heads support many directions (Cardinal NSEW, intercardinal - NW,SE,etc and secondary intercardinal - NNW, etc.). However, wall-heads only support four facing directions (NSEW).

Parameters:

rotation - the rotation of the head

attachment - the head block attachment style (FLOOR or WALL)

Returns:

whether the rotation is valid for the attachment style

isValidOrientation

public boolean isValidOrientation(BlockFace rotation)

Determines if the provided rotation is compatible with this head-block attachment style. This is relevant because floor-heads support many directions (Cardinal NSEW, intercardinal - NW,SE,etc and secondary intercardinal - NNW, etc.). However, wall-heads only support four facing directions (NSEW).

Parameters:

rotation - the rotation of the head

Returns:

whether the rotation is valid for the attachment style