com.sk89q.worldedit.function.util

Class RegionOffset

java.lang.Object

com.sk89q.worldedit.function.util.RegionOffset

All Implemented Interfaces:

RegionFunction

public class RegionOffset
extends Object
implements RegionFunction

Offsets the position parameter by adding a given offset vector.

Constructor Summary

Constructors

Constructor and Description
RegionOffset(Vector offset, RegionFunction function) Create a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	apply(Vector position) Apply the function to the given position.
Vector	getOffset() Get the offset that is added to the position.
void	setOffset(Vector 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

RegionOffset

public RegionOffset(Vector offset,
                    RegionFunction function)

Create a new instance.

Parameters:

offset - the offset

function - the function that is called with the offset position

Method Detail

getOffset

public Vector getOffset()

Get the offset that is added to the position.

Returns:

the offset

setOffset

public void setOffset(Vector offset)

Set the offset that is added to the position.

Parameters:

offset - the offset

apply

public boolean apply(Vector position)
              throws WorldEditException

Description copied from interface: RegionFunction

Apply the function to the given position.

Specified by:

apply in interface RegionFunction

Parameters:

position - the position

Returns:

true if something was changed

Throws:

WorldEditException - thrown on an error