Package com.jtprince.coordinateoffset.provider

Enum Class OffsetProviderContext.ProvideReason

java.lang.Object

java.lang.Enum<OffsetProviderContext.ProvideReason>

com.jtprince.coordinateoffset.provider.OffsetProviderContext.ProvideReason

All Implemented Interfaces:

Serializable, Comparable<OffsetProviderContext.ProvideReason>, Constable

Enclosing class:

OffsetProviderContext

public static enum OffsetProviderContext.ProvideReason
extends Enum<OffsetProviderContext.ProvideReason>

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
COMMAND_REGENERATE	A player's offset is being regenerated immediately because someone executed a command (such as /offset regenerate).
COMMAND_SET	A player's offset is being set immediately because someone executed a command (such as /offset set).
DEATH_RESPAWN	A player's offset is being generated because they died and are about to respawn.
JOIN	A player's offset is being generated because they are joining the server.
PLUGIN_REGENERATE	A player's offset is being generated immediately because a third-party plugin requested it.
PLUGIN_SET	A player's offset is being set immediately because a third-party plugin called a method to set it.
TELEPORT	A player's offset is being generated because they are teleporting within the same world.
WORLD_CHANGE	A player's offset is being generated because they are changing worlds, either through a Nether portal, End portal, or any teleport across worlds.

Method Summary

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

JOIN

public static final OffsetProviderContext.ProvideReason JOIN

A player's offset is being generated because they are joining the server. They may or may not have played on the server previously.

DEATH_RESPAWN

public static final OffsetProviderContext.ProvideReason DEATH_RESPAWN

A player's offset is being generated because they died and are about to respawn.

WORLD_CHANGE

public static final OffsetProviderContext.ProvideReason WORLD_CHANGE

A player's offset is being generated because they are changing worlds, either through a Nether portal, End portal, or any teleport across worlds.

TELEPORT

public static final OffsetProviderContext.ProvideReason TELEPORT

A player's offset is being generated because they are teleporting within the same world.

COMMAND_REGENERATE

public static final OffsetProviderContext.ProvideReason COMMAND_REGENERATE

A player's offset is being regenerated immediately because someone executed a command (such as /offset regenerate).

COMMAND_SET

public static final OffsetProviderContext.ProvideReason COMMAND_SET

A player's offset is being set immediately because someone executed a command (such as /offset set). Note that offset providers are never called to provide an offset for this reason since the offset is predetermined by the command.

See Also:

• OffsetProvider.onOffsetSetByCommand(com.jtprince.coordinateoffset.command.OffsetSetCommand, com.jtprince.coordinateoffset.adapter.OffsetPlayer)

PLUGIN_REGENERATE

public static final OffsetProviderContext.ProvideReason PLUGIN_REGENERATE

A player's offset is being generated immediately because a third-party plugin requested it.

PLUGIN_SET

public static final OffsetProviderContext.ProvideReason PLUGIN_SET

A player's offset is being set immediately because a third-party plugin called a method to set it. Note that offset providers are never called to provide an offset for this reason since the offset is predetermined by the plugin.

Method Details

values

public static OffsetProviderContext.ProvideReason[] 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 OffsetProviderContext.ProvideReason 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