Package com.sk89q.worldedit.command.tool

Interface BlockTool

All Superinterfaces:

Tool

All Known Subinterfaces:

DoubleActionBlockTool

All Known Implementing Classes:

AreaPickaxe, BlockDataCyler, BlockReplacer, FloatingTreeRemover, FloodFillTool, QueryTool, RecursivePickaxe, SelectionWand, SinglePickaxe, StackTool, TreePlanter

public interface BlockTool
extends Tool

Method Summary

Modifier and Type	Method	Description
default boolean	actPrimary(Platform server, LocalConfiguration config, Player player, LocalSession session, Location clicked)	Deprecated. New subclasses should override actPrimary(Platform, LocalConfiguration, Player, LocalSession, Location, Direction) instead
default boolean	actPrimary(Platform server, LocalConfiguration config, Player player, LocalSession session, Location clicked, Direction face)	Perform the primary action of this tool.

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

canUse

Method Details

actPrimary

@Deprecated
default boolean actPrimary(Platform server,
 LocalConfiguration config,
 Player player,
 LocalSession session,
 Location clicked)

Deprecated.

New subclasses should override actPrimary(Platform, LocalConfiguration, Player, LocalSession, Location, Direction) instead

Perform the primary action of this tool.

Returns:

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

actPrimary

@NonAbstractForCompatibility(delegateName="actPrimary",
                             delegateParams={Platform.class,LocalConfiguration.class,Player.class,LocalSession.class,Location.class})
default boolean actPrimary(Platform server,
 LocalConfiguration config,
 Player player,
 LocalSession session,
 Location clicked,
 @Nullable
 Direction face)

Perform the primary action of this tool.

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)