Package com.sk89q.worldedit.command.tool

Class BlockReplacer

java.lang.Object

com.sk89q.worldedit.command.tool.BlockReplacer

All Implemented Interfaces:

BlockTool, DoubleActionBlockTool, Tool

public class BlockReplacer
extends Object
implements DoubleActionBlockTool

A mode that replaces one block.

Constructor Summary

Constructors

Constructor	Description
BlockReplacer(Pattern pattern)

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 player)	Checks to see if the player can still be using this tool (considering permissions and such).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Details

BlockReplacer

public BlockReplacer(Pattern pattern)

Method Details

canUse

public boolean canUse(Actor player)

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:

player - the actor

Returns:

true if use is permitted

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)

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)