Package com.sk89q.worldedit.function.entity

Class ExtentEntityCopy

java.lang.Object

com.sk89q.worldedit.function.entity.ExtentEntityCopy

All Implemented Interfaces:

EntityFunction

public class ExtentEntityCopy
extends Object
implements EntityFunction

Copies entities provided to the function to the provided destination Extent.

Constructor Summary

Constructors

Constructor	Description
ExtentEntityCopy(Extent source, Vector3 from, Extent destination, Vector3 to, Transform transform)	Create a new instance.
ExtentEntityCopy(Vector3 from, Extent destination, Vector3 to, Transform transform)	Deprecated. FAWE Deprecation - Use method with Extent

Method Summary

Modifier and Type	Method	Description
boolean	apply(Entity entity)	Apply the function to the entity.
boolean	isRemoving()	Return whether entities that are copied should be removed.
void	setRemoving(boolean removing)	Set whether entities that are copied should be removed.

Methods inherited from class java.lang.Object

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

Constructor Details

ExtentEntityCopy

@Deprecated
public ExtentEntityCopy(Vector3 from,
 Extent destination,
 Vector3 to,
 Transform transform)

Deprecated.

FAWE Deprecation - Use method with Extent

Create a new instance.

Parameters:

from - the from position

destination - the destination Extent

to - the destination position

transform - the transformation to apply to both position and orientation

ExtentEntityCopy

public ExtentEntityCopy(Extent source,
 Vector3 from,
 Extent destination,
 Vector3 to,
 Transform transform)

Create a new instance.

Parameters:

source - the source Extent

from - the from position

destination - the destination Extent

to - the destination position

transform - the transformation to apply to both position and orientation

Method Details

isRemoving

public boolean isRemoving()

Return whether entities that are copied should be removed.

Returns:

true if removing

setRemoving

public void setRemoving(boolean removing)

Set whether entities that are copied should be removed.

Parameters:

removing - true if removing

apply

public boolean apply(Entity entity)
              throws WorldEditException

Description copied from interface: EntityFunction

Apply the function to the entity.

Specified by:

apply in interface EntityFunction

Parameters:

entity - the entity

Returns:

true if something was changed

Throws:

WorldEditException - thrown on an error