Merge pull request #4132 from DarkWeird/refactor-relevance

chore: Extract relevance code for ChunkProvider's to RelevanceSystem

Author: DarkWeird

engine-tests/src/test/java/org/terasology/world/propagation/BetweenChunkPropagationTest.java

@@ -238,26 +238,6 @@ public Collection<Chunk> getAllChunks() {
             return this.chunks.values();
         }
 
-        @Override
-        public void addRelevanceEntity(EntityRef entity, Vector3i distance) {
-            // do nothing
-        }
-
-        @Override
-        public void addRelevanceEntity(EntityRef entity, Vector3i distance, ChunkRegionListener listener) {
-            // do nothing
-        }
-
-        @Override
-        public void updateRelevanceEntity(EntityRef entity, Vector3i distance) {
-            // do nothing
-        }
-
-        @Override
-        public void removeRelevanceEntity(EntityRef entity) {
-            // do nothing
-        }
-
         @Override
         public void completeUpdate() {
             // do nothing

engine/src/main/java/org/terasology/engine/modes/loadProcesses/InitialiseWorld.java

@@ -139,7 +139,10 @@ public boolean step() {
         context.put(StorageManager.class, storageManager);
         LocalChunkProvider chunkProvider = new LocalChunkProvider(storageManager, entityManager, worldGenerator,
                 blockManager, extraDataManager);
-        context.get(ComponentSystemManager.class).register(new RelevanceSystem(chunkProvider), "engine:relevanceSystem");
+        RelevanceSystem relevanceSystem = new RelevanceSystem(chunkProvider);
+        context.put(RelevanceSystem.class, relevanceSystem);
+        context.get(ComponentSystemManager.class).register(relevanceSystem, "engine:relevanceSystem");
+        chunkProvider.setRelevanceSystem(relevanceSystem);
         Block unloadedBlock = blockManager.getBlock(BlockManager.UNLOADED_ID);
         WorldProviderCoreImpl worldProviderCore = new WorldProviderCoreImpl(worldInfo, chunkProvider, unloadedBlock, context);
         EntityAwareWorldProvider entityWorldProvider = new EntityAwareWorldProvider(worldProviderCore, context);

engine/src/main/java/org/terasology/logic/players/PlayerSystem.java

@@ -50,6 +50,7 @@
 import org.terasology.rendering.world.viewDistance.ViewDistance;
 import org.terasology.world.WorldProvider;
 import org.terasology.world.chunks.ChunkProvider;
+import org.terasology.world.chunks.localChunkProvider.RelevanceSystem;
 import org.terasology.world.generator.WorldGenerator;
 
 import java.util.Iterator;
@@ -68,6 +69,8 @@ public class PlayerSystem extends BaseComponentSystem implements UpdateSubscribe
     @In
     private ChunkProvider chunkProvider;
     @In
+    private RelevanceSystem relevanceSystem;
+    @In
     private NetworkSystem networkSystem;
     private List<SpawningClientInfo> clientsPreparingToSpawn = Lists.newArrayList();
     private List<SpawningClientInfo> clientsPreparingToRespawn = Lists.newArrayList();
@@ -191,20 +194,20 @@ private void updateRelevanceEntity(EntityRef entity, Vector3ic chunkDistance) {
         //RelevanceRegionComponent relevanceRegion = new RelevanceRegionComponent();
         //relevanceRegion.distance = chunkDistance;
         //entity.saveComponent(relevanceRegion);
-        chunkProvider.updateRelevanceEntity(entity, JomlUtil.from(chunkDistance));
+        relevanceSystem.updateRelevanceEntityDistance(entity, JomlUtil.from(chunkDistance));
     }
 
     private void removeRelevanceEntity(EntityRef entity) {
         //entity.removeComponent(RelevanceRegionComponent.class);
-        chunkProvider.removeRelevanceEntity(entity);
+        relevanceSystem.removeRelevanceEntity(entity);
     }
 
 
     private void addRelevanceEntity(EntityRef entity, Vector3ic chunkDistance, Client owner) {
         //RelevanceRegionComponent relevanceRegion = new RelevanceRegionComponent();
         //relevanceRegion.distance = chunkDistance;
         //entity.addComponent(relevanceRegion);
-        chunkProvider.addRelevanceEntity(entity, JomlUtil.from(chunkDistance), owner);
+        relevanceSystem.addRelevanceEntity(entity, JomlUtil.from(chunkDistance), owner);
     }
 
     @ReceiveEvent(components = ClientComponent.class)

engine/src/main/java/org/terasology/rendering/world/viewDistance/ServerViewDistanceSystem.java

@@ -25,7 +25,7 @@
 import org.terasology.network.ClientComponent;
 import org.terasology.network.NetworkSystem;
 import org.terasology.registry.In;
-import org.terasology.world.chunks.ChunkProvider;
+import org.terasology.world.chunks.localChunkProvider.RelevanceSystem;
 
 /**
  * Handles view distance changes on the server
@@ -37,14 +37,14 @@ public class ServerViewDistanceSystem extends BaseComponentSystem {
     private NetworkSystem networkSystem;
 
     @In
-    private ChunkProvider chunkProvider;
+    private RelevanceSystem relevanceSystem;
 
     @ReceiveEvent(components = ClientComponent.class)
     public void onChangeViewDistanceChanged(ViewDistanceChangedEvent request, EntityRef entity) {
         Client client = networkSystem.getOwner(entity);
         if (client != null) {
             client.setViewDistanceMode(request.getNewViewRange());
-            chunkProvider.updateRelevanceEntity(entity, JomlUtil.from(client.getViewDistance().getChunkDistance()));
+            relevanceSystem.updateRelevanceEntityDistance(entity, JomlUtil.from(client.getViewDistance().getChunkDistance()));
         }
     }
 

engine/src/main/java/org/terasology/world/chunks/ChunkProvider.java

@@ -54,37 +54,6 @@ public interface ChunkProvider {
      */
     void setWorldEntity(EntityRef entity);
 
-    /**
-     * Requests that a region around the given entity be maintained in near cache
-     *
-     * @param entity
-     * @param distance The region (in chunks) around the entity that should be near cached
-     */
-    void addRelevanceEntity(EntityRef entity, Vector3i distance);
-
-    /**
-     * Requests that a region around the given entity be maintained in near cache
-     *
-     * @param entity
-     * @param distance The region (in chunks) around the entity that should be near cached
-     * @param listener A listener to chunk region events
-     */
-    void addRelevanceEntity(EntityRef entity, Vector3i distance, ChunkRegionListener listener);
-
-    /**
-     * Retrieves the ChunkRelevanceRegion object for the given entity
-     *
-     * @param entity
-     */
-    void updateRelevanceEntity(EntityRef entity, Vector3i distance);
-
-    /**
-     * Removes an entity from producing a caching region
-     *
-     * @param entity
-     */
-    void removeRelevanceEntity(EntityRef entity);
-
     /**
      * Finish adding any pending chunks
      */