Package com.sk89q.worldedit.function.visitor

Class EntityVisitor

java.lang.Object
com.sk89q.worldedit.function.visitor.EntityVisitor
All Implemented Interfaces:
Operation
public class EntityVisitor extends Object implements Operation
Visits entities as provided by an Iterator.

  • Constructor Details

    • EntityVisitor

      public EntityVisitor(Iterator<? extends Entity> iterator, EntityFunction function)
      Create a new instance.
      Parameters:
      iterator - the iterator
      function - the function

  • Method Details

    • getAffected

      public int getAffected()
      Get the number of affected objects.
      Returns:
      the number of affected

    • resume

      public Operation resume(RunContext run) throws WorldEditException
      Description copied from interface: Operation
      Complete the next step. If this method returns true, then the method may be called again in the future, or possibly never. If this method returns false, then this method should not be called again.
      Specified by:
      resume in interface Operation
      Parameters:
      run - describes information about the current run
      Returns:
      another operation to run that operation again, or null to stop
      Throws:
      WorldEditException - an error

    • cancel

      public void cancel()
      Description copied from interface: Operation
      Abort the current task. After the this method is called, Operation.resume(RunContext) should not be called at any point in the future. This method should not be called after successful completion of the operation. This method must be called if the operation is interrupted before completion.
      Specified by:
      cancel in interface Operation

    • getStatusMessages

      public Iterable<com.sk89q.worldedit.util.formatting.text.Component> getStatusMessages()
      Description copied from interface: Operation
      Gets an iterable of messages that describe the current status of the operation.
      Specified by:
      getStatusMessages in interface Operation
      Returns:
      The status messages