Add API to disable history tracking in EditSessions (#2189)

* Add API to disable history tracking in EditSessions

* Update worldedit-core/src/main/java/com/sk89q/worldedit/extent/ChangeSetExtent.java

Co-authored-by: Octavia Togami <[email protected]>

Co-authored-by: Octavia Togami <[email protected]>

Author: 2 people

worldedit-core/src/main/java/com/sk89q/worldedit/EditSession.java

@@ -1205,6 +1205,40 @@ public void redo(EditSession editSession) {
     }
     //FAWE end
 
+    /**
+     * Gets whether this EditSession will track history.
+     *
+     * @return whether history is tracked
+     */
+    public boolean isTrackingHistory() {
+        //FAWE start
+        return history;
+        //FAWE end
+    }
+
+    /**
+     * Sets whether this EditSession will track history.
+     *
+     * @param trackHistory whether to track history
+     */
+    public void setTrackingHistory(boolean trackHistory) {
+        //FAWE start
+        if (trackHistory) {
+            if (this.history) {
+                if (this.changeSet == null) {
+                    throw new IllegalStateException("No ChangeSetExtent is available");
+                }
+                enableHistory(this.changeSet);
+            }
+        } else {
+            if (this.history) {
+                disableHistory();
+                this.history = false;
+            }
+        }
+        //FAWE end
+    }
+
     /**
      * Get the number of changed blocks.
      *

worldedit-core/src/main/java/com/sk89q/worldedit/extent/ChangeSetExtent.java

@@ -47,6 +47,7 @@
 public class ChangeSetExtent extends AbstractDelegateExtent {
 
     private final ChangeSet changeSet;
+    private boolean enabled;
 
     /**
      * Create a new instance.
@@ -55,31 +56,65 @@ public class ChangeSetExtent extends AbstractDelegateExtent {
      * @param changeSet the change set
      */
     public ChangeSetExtent(Extent extent, ChangeSet changeSet) {
+        this(extent, changeSet, true);
+    }
+
+    /**
+     * Create a new instance.
+     *
+     * @param extent the extent
+     * @param changeSet the change set
+     * @param enabled if the extent is enabled
+     */
+    public ChangeSetExtent(Extent extent, ChangeSet changeSet, boolean enabled) {
         super(extent);
         checkNotNull(changeSet);
         this.changeSet = changeSet;
+        this.enabled = true;
+    }
+
+    /**
+     * If this extent is enabled and should perform change tracking.
+     *
+     * @return if enabled
+     */
+    public boolean isEnabled() {
+        return this.enabled;
+    }
+
+    /**
+     * Sets whether this extent is enabled and should perform change tracking.
+     *
+     * @param enabled whether to enable
+     */
+    public void setEnabled(boolean enabled) {
+        this.enabled = enabled;
     }
 
     @Override
     public <B extends BlockStateHolder<B>> boolean setBlock(BlockVector3 location, B block) throws WorldEditException {
-        BaseBlock previous = getFullBlock(location);
-        changeSet.add(new BlockChange(location, previous, block));
+        if (enabled) {
+            BaseBlock previous = getFullBlock(location);
+            changeSet.add(new BlockChange(location, previous, block));
+        }
         return super.setBlock(location, block);
     }
 
     @Override
     public boolean setBiome(BlockVector3 position, BiomeType biome) {
-        BiomeType previous = getBiome(position);
-        changeSet.add(new BiomeChange3D(position, previous, biome));
+        if (enabled) {
+            BiomeType previous = getBiome(position);
+            changeSet.add(new BiomeChange3D(position, previous, biome));
+        }
         return super.setBiome(position, biome);
     }
 
     @Nullable
     @Override
     public Entity createEntity(Location location, BaseEntity state) {
         Entity entity = super.createEntity(location, state);
-        if (entity != null) {
-            changeSet.add(new EntityCreate(location, entity.getState(), entity));
+        if (enabled && entity != null) {
+            changeSet.add(new EntityCreate(location, state, entity));
         }
         return entity;
     }
@@ -89,7 +124,7 @@ public Entity createEntity(Location location, BaseEntity state) {
     @Nullable
     public Entity createEntity(Location location, BaseEntity state, UUID uuid) {
         Entity entity = super.createEntity(location, state, uuid);
-        if (entity != null) {
+        if (enabled && entity != null) {
             changeSet.add(new EntityCreate(location, entity.getState(), entity));
         }
         return entity;
@@ -107,6 +142,9 @@ public List<? extends Entity> getEntities(Region region) {
     }
 
     private List<? extends Entity> wrapEntities(List<? extends Entity> entities) {
+        if (!enabled) {
+            return entities;
+        }
         List<Entity> newList = new ArrayList<>(entities.size());
         for (Entity entity : entities) {
             newList.add(new TrackedEntity(entity));