Package com.thevoxelbox.voxelsniper.brush

Interface Brush

All Superinterfaces:

VoxelCommandElement

All Known Subinterfaces:

PerformerBrush

All Known Implementing Classes:

AbstractBlendBrush, AbstractBrush, AbstractPerformerBrush, AbstractStampBrush, BallBrush, BiomeBrush, BlendBallBrush, BlendDiscBrush, BlendVoxelBrush, BlendVoxelDiscBrush, BlobBrush, BlockResetBrush, BlockResetSurfaceBrush, CanyonBrush, CanyonSelectionBrush, CheckerVoxelDiscBrush, CleanSnowBrush, CloneStampBrush, CometBrush, CopyPastaBrush, CylinderBrush, DiscBrush, DiscFaceBrush, DomeBrush, DrainBrush, EllipseBrush, EllipsoidBrush, EntityBrush, EntityRemovalBrush, EraserBrush, ErodeBlendBrush, ErodeBrush, ExtrudeBrush, FillDownBrush, FlatOceanBrush, GenerateTreeBrush, HeatRayBrush, JaggedLineBrush, JockeyBrush, LightningBrush, LineBrush, MoveBrush, OceanBrush, OverlayBrush, PaintingBrush, PullBrush, PunishBrush, RandomErodeBrush, RegenerateChunkBrush, RingBrush, Rotation2DBrush, Rotation2DVerticalBrush, Rotation3DBrush, RulerBrush, ScannerBrush, SetBrush, SetRedstoneFlipBrush, SetRedstoneRotateBrush, ShellBallBrush, ShellSetBrush, ShellVoxelBrush, SignOverwriteBrush, SnipeBrush, SnowConeBrush, SpiralStaircaseBrush, SplatterBallBrush, SplatterDiscBrush, SplatterOverlayBrush, SplatterVoxelBrush, SplatterVoxelDiscBrush, SplineBrush, StencilBrush, StencilListBrush, ThreePointCircleBrush, TreeSnipeBrush, TriangleBrush, UnderlayBrush, VoltmeterBrush, VoxelBrush, VoxelDiscBrush, VoxelDiscFaceBrush, WarpBrush

public interface Brush
extends VoxelCommandElement

Method Summary

Modifier and Type	Method	Description
BrushProperties	getProperties()	Return brush properties.
void	handleArrowAction(Snipe snipe)	The arrow action.
void	handleGunpowderAction(Snipe snipe)	The gunpowder action.
void	loadProperties()	Load brush properties.
void	perform(Snipe snipe, ToolAction action, EditSession editSession, BlockVector3 targetBlock, BlockVector3 lastBlock)	Perform brush action.
void	sendInfo(Snipe snipe)	Send brush information.
void	setProperties(BrushProperties properties)	Set brush properties.

Method Details

loadProperties

void loadProperties()

Load brush properties.

perform

void perform(Snipe snipe,
 ToolAction action,
 EditSession editSession,
 BlockVector3 targetBlock,
 BlockVector3 lastBlock)

Perform brush action.

Parameters:

snipe - Snipe

action - ToolAction

editSession - EditSession

targetBlock - Target Block

lastBlock - Last Block, preceding Target Block

handleArrowAction

void handleArrowAction(Snipe snipe)

The arrow action. Executed when a player right clicks with an arrow

Parameters:

snipe - Snipe

handleGunpowderAction

void handleGunpowderAction(Snipe snipe)

The gunpowder action. Executed when a player right clicks with gunpowder

Parameters:

snipe - Snipe

sendInfo

void sendInfo(Snipe snipe)

Send brush information.

Parameters:

snipe - Snipe

getProperties

BrushProperties getProperties()

Return brush properties.

Returns:

brush properties

setProperties

void setProperties(BrushProperties properties)

Set brush properties.

Parameters:

properties - brush properties