Package com.sk89q.worldedit.command.tool

Enum Class NavigationWand

java.lang.Object

java.lang.Enum<NavigationWand>

com.sk89q.worldedit.command.tool.NavigationWand

All Implemented Interfaces:

DoubleActionTraceTool, Tool, TraceTool, Serializable, Comparable<NavigationWand>, Constable

public enum NavigationWand
extends Enum<NavigationWand>
implements DoubleActionTraceTool

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
INSTANCE

Method Summary

Modifier and Type	Method	Description
boolean	actPrimary(Platform server, LocalConfiguration config, Player player, LocalSession session)	Perform the primary action of this trace tool.
boolean	actSecondary(Platform server, LocalConfiguration config, Player player, LocalSession session)	Perform the secondary function of this tool.
boolean	canUse(Actor actor)	Checks to see if the player can still be using this tool (considering permissions and such).
static NavigationWand	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NavigationWand[]	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

INSTANCE

public static final NavigationWand INSTANCE

Method Details

values

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

actSecondary

public boolean actSecondary(Platform server,
 LocalConfiguration config,
 Player player,
 LocalSession session)

Description copied from interface: DoubleActionTraceTool

Perform the secondary function of this tool.

Specified by:

actSecondary in interface DoubleActionTraceTool

Parameters:

server - The platform

config - The config instance

player - The player

session - The local session

Returns:

true to cancel the original event which triggered this action (if possible)

actPrimary

public boolean actPrimary(Platform server,
 LocalConfiguration config,
 Player player,
 LocalSession session)

Description copied from interface: TraceTool

Perform the primary action of this trace tool.

Specified by:

actPrimary in interface TraceTool

Parameters:

server - The platform

config - The config instance

player - The player

session - The local session

Returns:

true to cancel the original event which triggered this action (if possible)

canUse

public boolean canUse(Actor actor)

Description copied from interface: Tool

Checks to see if the player can still be using this tool (considering permissions and such).

Specified by:

canUse in interface Tool

Parameters:

actor - the actor

Returns:

true if use is permitted