com.sk89q.worldedit.command.tool

Class BrushTool

java.lang.Object

com.sk89q.worldedit.command.tool.BrushTool

All Implemented Interfaces:

Tool, TraceTool

Direct Known Subclasses:

DistanceWand, LongRangeBuildTool

public class BrushTool
extends Object
implements TraceTool

Builds a shape at the place being looked at.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_RANGE
protected int	range

Constructor Summary

Constructors

Constructor and Description
BrushTool(String permission) Construct the tool.

Method Summary

Modifier and Type	Method and Description
boolean	actPrimary(Platform server, LocalConfiguration config, Player player, LocalSession session)
boolean	canUse(Actor player) Checks to see if the player can still be using this tool (considering permissions and such).
Brush	getBrush() Get the current brush.
Mask	getMask() Get the filter.
Pattern	getMaterial() Get the material.
int	getRange() Get the set brush range.
double	getSize() Get the set brush size.
void	setBrush(Brush brush, String permission) Set the brush.
void	setFill(Pattern material) Set the material.
void	setMask(Mask filter) Set the block filter used for identifying blocks to replace.
void	setRange(int range) Set the set brush range.
void	setSize(double radius) Set the set brush size.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_RANGE

protected static int MAX_RANGE

range

protected int range

Constructor Detail

BrushTool

public BrushTool(String permission)

Construct the tool.

Parameters:

permission - the permission to check before use is allowed

Method Detail

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

getMask

public Mask getMask()

Get the filter.

Returns:

the filter

setMask

public void setMask(Mask filter)

Set the block filter used for identifying blocks to replace.

Parameters:

filter - the filter to set

setBrush

public void setBrush(Brush brush,
                     String permission)

Set the brush.

Parameters:

brush - tbe brush

permission - the permission

getBrush

public Brush getBrush()

Get the current brush.

Returns:

the current brush

setFill

public void setFill(Pattern material)

Set the material.

Parameters:

material - the material

getMaterial

public Pattern getMaterial()

Get the material.

Returns:

the material

getSize

public double getSize()

Get the set brush size.

Returns:

a radius

setSize

public void setSize(double radius)

Set the set brush size.

Parameters:

radius - a radius

getRange

public int getRange()

Get the set brush range.

Returns:

the range of the brush in blocks

setRange

public void setRange(int range)

Set the set brush range.

Parameters:

range - the range of the brush in blocks

actPrimary

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

Specified by:

actPrimary in interface TraceTool