com.sk89q.worldedit.function.util

Class FlatRegionOffset

java.lang.Object

com.sk89q.worldedit.function.util.FlatRegionOffset

All Implemented Interfaces:

FlatRegionFunction

public class FlatRegionOffset
extends Object
implements FlatRegionFunction

Offsets the position parameter by adding a given offset vector.

Constructor Summary

Constructors

Constructor and Description
FlatRegionOffset(Vector2D offset, FlatRegionFunction function) Create a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	apply(Vector2D position) Apply the function to the given position.
Vector2D	getOffset() Get the offset that is added to the position.
void	setOffset(Vector2D offset) Set the offset that is added to the position.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlatRegionOffset

public FlatRegionOffset(Vector2D offset,
                        FlatRegionFunction function)

Create a new instance.

Parameters:

offset - the offset

function - the function that is called with the offset position

Method Detail

getOffset

public Vector2D getOffset()

Get the offset that is added to the position.

Returns:

the offset

setOffset

public void setOffset(Vector2D offset)

Set the offset that is added to the position.

Parameters:

offset - the offset

apply

public boolean apply(Vector2D position)
              throws WorldEditException

Description copied from interface: FlatRegionFunction

Apply the function to the given position.

Specified by:

apply in interface FlatRegionFunction

Parameters:

position - the position

Returns:

true if something was changed

Throws:

WorldEditException - thrown on an error