Package com.sk89q.worldedit.command.tool

Enum Class SelectionWand

java.lang.Object

java.lang.Enum<SelectionWand>

com.sk89q.worldedit.command.tool.SelectionWand

All Implemented Interfaces:

BlockTool, DoubleActionBlockTool, Tool, Serializable, Comparable<SelectionWand>, Constable

public enum SelectionWand
extends Enum<SelectionWand>
implements DoubleActionBlockTool

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, Location clicked, Direction face)	Perform the primary action of this tool.
boolean	actSecondary(Platform server, LocalConfiguration config, Player player, LocalSession session, Location clicked, Direction face)	Perform the secondary action of this block tool.
boolean	canUse(Actor actor)	Checks to see if the player can still be using this tool (considering permissions and such).
static SelectionWand	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SelectionWand[]	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 com.sk89q.worldedit.command.tool.BlockTool

actPrimary

Methods inherited from interface com.sk89q.worldedit.command.tool.DoubleActionBlockTool

actSecondary

Enum Constant Details

INSTANCE

public static final SelectionWand INSTANCE

Method Details

values

public static SelectionWand[] 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 SelectionWand 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,
 Location clicked,
 @Nullable
 Direction face)

Description copied from interface: DoubleActionBlockTool

Perform the secondary action of this block tool.

Specified by:

actSecondary in interface DoubleActionBlockTool

Parameters:

server - The platform

config - The config instance

player - The player

session - The local session

clicked - The location that was clicked

face - The face that was clicked

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,
 Location clicked,
 @Nullable
 Direction face)

Description copied from interface: BlockTool

Perform the primary action of this tool.

Specified by:

actPrimary in interface BlockTool

Parameters:

server - The platform

config - The config instance

player - The player

session - The local session

clicked - The location that was clicked

face - The face that was clicked

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