Package dev.itsharshxd.zentrix.api.world

Enum Class SkyDropResult

java.lang.Object

java.lang.Enum<SkyDropResult>

dev.itsharshxd.zentrix.api.world.SkyDropResult

All Implemented Interfaces:

Serializable, Comparable<SkyDropResult>, Constable

public enum SkyDropResult
extends Enum<SkyDropResult>

What became of an attempt to put a player back into the sky.

Since:

1.6.0

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
FAILED	Nothing happened: the player was offline, or the teleport was refused.
PLACED_WITHOUT_GLIDER	The player was placed, but no glider was deployed.
SUCCESS	The player was placed and their glider was deployed.

Method Summary

Modifier and Type	Method	Description
boolean	isPlaced()	Whether the player ended up at the drop point.
static SkyDropResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SkyDropResult[]	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

SUCCESS

public static final SkyDropResult SUCCESS

The player was placed and their glider was deployed.

PLACED_WITHOUT_GLIDER

public static final SkyDropResult PLACED_WITHOUT_GLIDER

The player was placed, but no glider was deployed.

Either none was asked for, or Matrix Gliders is not installed. The drop itself stands either way, so a caller only has to react to this if the fall matters to it.

FAILED

public static final SkyDropResult FAILED

Nothing happened: the player was offline, or the teleport was refused.

Method Details

values

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

isPlaced

public boolean isPlaced()

Whether the player ended up at the drop point.