com.sk89q.worldedit.function

Class CombinedRegionFunction

java.lang.Object

com.sk89q.worldedit.function.CombinedRegionFunction

All Implemented Interfaces:

RegionFunction

public class CombinedRegionFunction
extends Object
implements RegionFunction

Executes several region functions in order.

Constructor Summary

Constructors

Constructor and Description
CombinedRegionFunction() Create a combined region function.
CombinedRegionFunction(Collection<RegionFunction> functions) Create a combined region function.
CombinedRegionFunction(RegionFunction... function) Create a combined region function.

Method Summary

Modifier and Type	Method and Description
void	add(Collection<RegionFunction> functions) Add the given functions to the list of functions to call.
void	add(RegionFunction... function) Add the given functions to the list of functions to call.
boolean	apply(Vector position) Apply the function to the given position.

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedRegionFunction

public CombinedRegionFunction()

Create a combined region function.

CombinedRegionFunction

public CombinedRegionFunction(Collection<RegionFunction> functions)

Create a combined region function.

Parameters:

functions - a list of functions to match

CombinedRegionFunction

public CombinedRegionFunction(RegionFunction... function)

Create a combined region function.

Parameters:

function - an array of functions to match

Method Detail

add

public void add(Collection<RegionFunction> functions)

Add the given functions to the list of functions to call.

Parameters:

functions - a list of functions

add

public void add(RegionFunction... function)

Add the given functions to the list of functions to call.

Parameters:

function - an array of functions

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