Package me.gamercoder215.starcosmetics.api.cosmetics.pet

Enum Class PetPosition

java.lang.Object

java.lang.Enum<PetPosition>

me.gamercoder215.starcosmetics.api.cosmetics.pet.PetPosition

All Implemented Interfaces:

Serializable, Comparable<PetPosition>, Constable, Function<Player,Location>

public enum PetPosition
extends Enum<PetPosition>
implements Function<Player,Location>

Represents the position that a pet can be in, according to the player.

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
BACKPACK	Position for behind the player like a Backpack
BEHIND	Position for behind the Player
BEHIND_GROUND	Position for the behind the player, on the ground
HEAD	Position for on the head of the Player
SHOULDER	Position for on the shoulder of the Player

Method Summary

Modifier and Type	Method	Description
Location	apply(Player player)	Fetches a Location based on the Player
static PetPosition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PetPosition[]	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

Methods inherited from interface java.util.function.Function

andThen, compose

Enum Constant Details

BEHIND

public static final PetPosition BEHIND

Position for behind the Player

HEAD

public static final PetPosition HEAD

Position for on the head of the Player

BEHIND_GROUND

public static final PetPosition BEHIND_GROUND

Position for the behind the player, on the ground

BACKPACK

public static final PetPosition BACKPACK

Position for behind the player like a Backpack

SHOULDER

public static final PetPosition SHOULDER

Position for on the shoulder of the Player

Method Details

values

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

apply

public Location apply(Player player)

Fetches a Location based on the Player

Specified by:

apply in interface Function<Player,Location>

Parameters:

player - Player to fetch the Location for

Returns:

Pet Position Location for the Player