fix: add ECS EventReceiver injection and fix associated tests

Author: BenjaminAmos

engine/src/main/java/org/destinationsol/EventReceiverServiceRegistry.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2022 The Terasology Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.destinationsol;
+
+import org.destinationsol.entitysystem.EventReceiver;
+import org.terasology.context.Lifetime;
+import org.terasology.gestalt.di.ServiceRegistry;
+import org.terasology.gestalt.module.ModuleEnvironment;
+
+public class EventReceiverServiceRegistry extends ServiceRegistry {
+    public EventReceiverServiceRegistry(ModuleEnvironment environment) {
+        for (Class<? extends EventReceiver> receiver : environment.getSubtypesOf(EventReceiver.class)) {
+            this.with(receiver).lifetime(Lifetime.Singleton);
+        }
+    }
+}

engine/src/main/java/org/destinationsol/SolApplication.java

@@ -332,12 +332,12 @@ private void draw() {
     }
 
     public void play(boolean tut, String shipName, boolean isNewGame, WorldConfig worldConfig) {
-
+        ModuleManager moduleManager = appContext.getBean(ModuleManager.class);
         gameContext = appContext.getNestedContainer(
                 new GameConfigurationServiceRegistry(worldConfig),
+                new EventReceiverServiceRegistry(moduleManager.getEnvironment()),
                 new SolGameServiceRegistry(tut),
                 new ContextWrapperService());
-        ModuleManager moduleManager = appContext.getBean(ModuleManager.class);
         solGame = gameContext.getBean(SolGame.class);
 
         //TODO: rework how system will trigger preBegin
@@ -347,6 +347,7 @@ public void play(boolean tut, String shipName, boolean isNewGame, WorldConfig wo
         systems.forEach(ComponentSystem::preBegin);
 
         entitySystemManager = gameContext.getBean(EntitySystemManager.class);
+        entitySystemManager.initialise();
 
         solGame.createUpdateSystems();
         solGame.startGame(shipName, isNewGame, worldConfig, entitySystemManager);

engine/src/main/java/org/destinationsol/asteroids/systems/AsteroidBodyCreationSystem.java

@@ -20,14 +20,14 @@
 import com.badlogic.gdx.physics.box2d.Body;
 import com.badlogic.gdx.physics.box2d.BodyDef;
 import com.badlogic.gdx.physics.box2d.FixtureDef;
-import com.badlogic.gdx.physics.box2d.World;
 import org.destinationsol.Const;
 import org.destinationsol.asteroids.components.AsteroidMesh;
 import org.destinationsol.body.events.BodyCreatedEvent;
 import org.destinationsol.body.events.GenerateBodyEvent;
 import org.destinationsol.entitysystem.EntitySystemManager;
 import org.destinationsol.entitysystem.EventReceiver;
 import org.destinationsol.game.CollisionMeshLoader;
+import org.destinationsol.game.ObjectManager;
 import org.destinationsol.game.UpdateAwareSystem;
 import org.destinationsol.location.components.Angle;
 import org.destinationsol.location.components.Position;
@@ -59,7 +59,7 @@ public class AsteroidBodyCreationSystem implements EventReceiver {
     EntitySystemManager entitySystemManager;
 
     @Inject
-    World world;
+    ObjectManager objectManager;
 
     private final CollisionMeshLoader collisionMeshLoader = new CollisionMeshLoader("engine:asteroids");
 
@@ -83,7 +83,7 @@ public EventResult onGenerateBody(GenerateBodyEvent event, EntityRef entity) {
         bd.angularDamping = 0;
         bd.position.set(position);
         bd.linearDamping = 0;
-        Body body = world.createBody(bd);
+        Body body = objectManager.getWorld().createBody(bd);
 
         //This sets a reference to an entity in the Body, so that the entity can be retrieved from the body during collision handling.
         body.setUserData(entity);

engine/src/main/java/org/destinationsol/entitysystem/EntitySystemManager.java

@@ -17,6 +17,7 @@
 
 import com.google.common.collect.Lists;
 import org.destinationsol.modules.ModuleManager;
+import org.terasology.gestalt.di.BeanContext;
 import org.terasology.gestalt.entitysystem.component.Component;
 import org.terasology.gestalt.entitysystem.component.management.ComponentManager;
 import org.terasology.gestalt.entitysystem.component.store.ArrayComponentStore;
@@ -40,10 +41,11 @@ public class EntitySystemManager {
 
     private static EntityManager entityManager;
     private final EventSystem eventSystem = new EventSystemImpl();
+    private final BeanContext context;
     private static final EventReceiverMethodSupport eventReceiverMethodSupport = new EventReceiverMethodSupport();
 
     @Inject
-    public EntitySystemManager(ModuleManager moduleManager, ComponentManager componentManager, List<EventReceiver> eventReceivers) {
+    public EntitySystemManager(ModuleManager moduleManager, ComponentManager componentManager, BeanContext context) {
         List<ComponentStore<?>> stores = Lists.newArrayList();
         for (Class<? extends Component> componentType : moduleManager.getEnvironment().getSubtypesOf(Component.class)) {
             //This filters out abstract components, which would create exceptions
@@ -54,7 +56,11 @@ public EntitySystemManager(ModuleManager moduleManager, ComponentManager compone
         }
         entityManager = new CoreEntityManager(stores);
 
-        for (EventReceiver eventReceiver : eventReceivers) {
+        this.context = context;
+    }
+
+    public void initialise() {
+        for (EventReceiver eventReceiver : context.getBeans(EventReceiver.class)) {
             eventReceiverMethodSupport.register(eventReceiver, eventSystem);
         }
     }

engine/src/main/java/org/destinationsol/entitysystem/EventReceiver.java

@@ -15,5 +15,8 @@
  */
 package org.destinationsol.entitysystem;
 
+import org.terasology.context.annotation.IndexInherited;
+
+@IndexInherited
 public interface EventReceiver {
 }

engine/src/main/java/org/destinationsol/game/SolGame.java

@@ -67,6 +67,7 @@
 import org.destinationsol.ui.Waypoint;
 import org.destinationsol.ui.nui.screens.MainGameScreen;
 import org.destinationsol.world.GalaxyBuilder;
+import org.terasology.context.exception.BeanNotFoundException;
 import org.terasology.gestalt.assets.ResourceUrn;
 import org.terasology.gestalt.di.BeanContext;
 import org.terasology.gestalt.entitysystem.entity.EntityRef;
@@ -206,7 +207,12 @@ public void createUpdateSystems() {
                 }
                 RegisterUpdateSystem registerAnnotation = updateSystemClass.getDeclaredAnnotation(RegisterUpdateSystem.class);
                 UpdateAwareSystem system = (UpdateAwareSystem) updateSystemClass.newInstance();
-                beanContext.inject(system);
+                try {
+                    beanContext.inject(system);
+                } catch (BeanNotFoundException e) {
+                    e.printStackTrace();
+                    continue;
+                }
                 if (!registerAnnotation.paused()) {
                     if (!updateSystems.containsKey(registerAnnotation.priority())) {
                         ArrayList<UpdateAwareSystem> systems = new ArrayList<UpdateAwareSystem>();

engine/src/main/java/org/destinationsol/game/screens/ConsoleScreen.java

@@ -105,10 +105,10 @@ public class ConsoleScreen implements SolUiScreen, ConsoleSubscriber {
     private StringBuilder inputLine;
 
     @Inject
-    public ConsoleScreen(Context context) {
+    public ConsoleScreen(Console console) {
         font = Assets.getFont("engine:main").getBitmapFont();
 
-        this.console = new ConsoleImpl( context);
+        this.console = console;
 
         exitControl = new SolUiControl(null, true, Input.Keys.ESCAPE);
         commandHistoryUpControl = new SolUiControl(null, true, Input.Keys.UP);

engine/src/main/java/org/destinationsol/game/screens/GameScreens.java

@@ -16,6 +16,7 @@
 package org.destinationsol.game.screens;
 
 import org.destinationsol.SolApplication;
+import org.destinationsol.game.console.Console;
 import org.destinationsol.game.context.Context;
 import org.destinationsol.ui.SolLayouts;
 
@@ -40,7 +41,7 @@ public GameScreens(SolApplication cmp, Context context) {
         inventoryScreen = new InventoryScreen(cmp.getOptions());
         talkScreen = new TalkScreen(layouts.menuLayout, cmp.getOptions());
         waypointCreationScreen = new WaypointCreationScreen(layouts.menuLayout, cmp.getOptions(), mapScreen);
-        consoleScreen = new ConsoleScreen(context);
+        consoleScreen = new ConsoleScreen(context.get(Console.class));
     }
 
     // This was added for PlayerCreatorTest.java (used in PlayerCreator)

engine/src/main/java/org/destinationsol/removal/systems/DestroyOnZeroHealthSystem.java

@@ -21,6 +21,7 @@
 import org.destinationsol.removal.events.ShouldBeDestroyedEvent;
 import org.destinationsol.removal.events.ZeroHealthEvent;
 import org.terasology.gestalt.entitysystem.entity.EntityRef;
+import org.terasology.gestalt.entitysystem.event.EventResult;
 import org.terasology.gestalt.entitysystem.event.ReceiveEvent;
 
 import javax.inject.Inject;
@@ -38,7 +39,8 @@ public DestroyOnZeroHealthSystem() {
     }
 
     @ReceiveEvent
-    public void onZeroHealth(ZeroHealthEvent event, EntityRef entity) {
+    public EventResult onZeroHealth(ZeroHealthEvent event, EntityRef entity) {
         entitySystemManager.sendEvent(new ShouldBeDestroyedEvent(), entity);
+        return EventResult.COMPLETE;
     }
 }

engine/src/main/java/org/destinationsol/rubble/systems/RubbleBodyCreationSystem.java

@@ -27,6 +27,7 @@
 import org.destinationsol.entitysystem.EntitySystemManager;
 import org.destinationsol.entitysystem.EventReceiver;
 import org.destinationsol.game.CollisionMeshLoader;
+import org.destinationsol.game.ObjectManager;
 import org.destinationsol.location.components.Angle;
 import org.destinationsol.location.components.Position;
 import org.destinationsol.rendering.RenderableElement;
@@ -51,7 +52,7 @@ public class RubbleBodyCreationSystem implements EventReceiver {
     protected EntitySystemManager entitySystemManager;
 
     @Inject
-    protected World world;
+    protected ObjectManager objectManager;
 
     private final CollisionMeshLoader collisionMeshLoader = new CollisionMeshLoader("engine:miscCollisionMeshes");
 
@@ -75,7 +76,7 @@ public EventResult onGenerateBody(GenerateBodyEvent event, EntityRef entity) {
         bd.angularDamping = 0;
         bd.position.set(position);
         bd.linearDamping = 0;
-        Body body = world.createBody(bd);
+        Body body = objectManager.getWorld().createBody(bd);
 
         //This sets a reference to an entity in the Body, so that the entity can be retrieved from the body during collision handling.
         body.setUserData(entity);