feat: implement state machine to model game state

assets/prefabs/gameEntity.prefab

@@ -1,8 +1,13 @@
 {
     "LASConfig" : {
-        "maxTeamSizeDifference" : 3
+        "maxTeamSizeDifference": 3,
+        "minTeamSize": 1
     },
     "CurrencyStorage": {
         "amount": 100
+    },
+    // this component is required for the PhaseSystem phase change events to be broadcasted
+    "Network": {
+        "replicateMode": "ALWAYS"
     }
 }

src/main/java/org/terasology/module/lightandshadow/LASUtils.java

@@ -13,6 +13,13 @@
 import java.util.function.Supplier;
 import java.util.stream.Stream;
 
+import org.terasology.engine.core.SimpleUri;
+import org.terasology.engine.unicode.EnclosedAlphanumerics;
+import org.terasology.engine.input.InputSystem;
+import org.terasology.input.Input;
+import org.terasology.nui.Color;
+import org.terasology.nui.FontColor;
+
 import static java.util.Collections.singletonMap;
 
 public final class LASUtils {
@@ -222,4 +229,34 @@ public static String pixel(int x, int y, int r) {
                 .findAny()
                 .orElse("engine:air");
     }
+
+    /**
+     * Get a formatted representation of the primary {@link Input} associated with the given button binding.
+     *
+     * If the display name of the primary bound key is a single character this representation will be the encircled
+     * character. Otherwise the full display name is used. The bound key will be printed in yellow.
+     *
+     * If no key binding was found the text "n/a" in red color is returned.
+     *
+     * @param button the URI of a bindable button
+     * @return a formatted text to be used as representation for the player
+     */
+    //TODO: put this in a common place? Duplicated in Dialogs, EventualSkills, and InGameHelp
+    public static String getActivationKey(InputSystem inputSystem, SimpleUri button) {
+        return inputSystem.getInputsForBindButton(button).stream()
+                .findFirst()
+                .map(Input::getDisplayName)
+                .map(key -> {
+                    if (key.length() == 1) {
+                        // print the key in yellow within a circle
+                        int off = key.charAt(0) - 'A';
+                        char code = (char) (EnclosedAlphanumerics.CIRCLED_LATIN_CAPITAL_LETTER_A + off);
+                        return String.valueOf(code);
+                    } else {
+                        return key;
+                    }
+                })
+                .map(key -> FontColor.getColored(key, Color.yellow))
+                .orElse(FontColor.getColored("n/a", Color.red));
+    }
 }

src/main/java/org/terasology/module/lightandshadow/components/LASConfigComponent.java

@@ -6,9 +6,11 @@
 
 public class LASConfigComponent implements Component<LASConfigComponent> {
     public int maxTeamSizeDifference;
+    public int minTeamSize;
 
     @Override
     public void copyFrom(LASConfigComponent other) {
         this.maxTeamSizeDifference = other.maxTeamSizeDifference;
+        this.minTeamSize = other.minTeamSize;
     }
 }

src/main/java/org/terasology/module/lightandshadow/components/LASTeamStatsComponent.java

@@ -0,0 +1,20 @@
+// Copyright 2022 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.components;
+
+import org.terasology.gestalt.entitysystem.component.Component;
+
+public class LASTeamStatsComponent implements Component<LASTeamStatsComponent> {
+    public int redTeamSize;
+    public int blackTeamSize;
+    public int whiteTeamSize;
+
+    @Override
+    public void copyFrom(LASTeamStatsComponent other) {
+        this.blackTeamSize = other.blackTeamSize;
+        this.redTeamSize = other.redTeamSize;
+        this.whiteTeamSize = other.whiteTeamSize;
+    }
+
+}

src/main/java/org/terasology/module/lightandshadow/events/PlayerExitedArenaEvent.java

@@ -0,0 +1,19 @@
+// Copyright 2022 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.events;
+
+import org.terasology.engine.entitySystem.entity.EntityRef;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+public class PlayerExitedArenaEvent implements Event {
+    private final EntityRef player;
+
+    public PlayerExitedArenaEvent(EntityRef player) {
+        this.player = player;
+    }
+
+    public EntityRef getPlayer() {
+        return player;
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnCountdownPhaseEndedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnCountdownPhaseEndedEvent implements Event {
+
+    public OnCountdownPhaseEndedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnCountdownPhaseStartedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnCountdownPhaseStartedEvent implements Event {
+
+    public OnCountdownPhaseStartedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnIdlePhaseEndedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnIdlePhaseEndedEvent implements Event {
+
+    public OnIdlePhaseEndedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnIdlePhaseStartedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnIdlePhaseStartedEvent implements Event {
+
+    public OnIdlePhaseStartedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnInGamePhaseEndedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnInGamePhaseEndedEvent implements Event {
+
+    public OnInGamePhaseEndedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnInGamePhaseStartedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnInGamePhaseStartedEvent implements Event {
+
+    public OnInGamePhaseStartedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnPostGamePhaseEndedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnPostGamePhaseEndedEvent implements Event {
+
+    public OnPostGamePhaseEndedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnPostGamePhaseStartedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnPostGamePhaseStartedEvent implements Event {
+
+    public OnPostGamePhaseStartedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnPreGamePhaseEndedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnPreGamePhaseEndedEvent implements Event {
+
+    public OnPreGamePhaseEndedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/OnPreGamePhaseStartedEvent.java

@@ -0,0 +1,16 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.engine.network.BroadcastEvent;
+import org.terasology.gestalt.entitysystem.event.Event;
+
+// TODO: Would it make more sense to have a single "OnPhaseTransition" with old and new phase here?
+
+@BroadcastEvent
+public class OnPreGamePhaseStartedEvent implements Event {
+
+    public OnPreGamePhaseStartedEvent() {
+    }
+}

src/main/java/org/terasology/module/lightandshadow/phases/Phase.java

@@ -0,0 +1,24 @@
+// Copyright 2021 The Terasology Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+package org.terasology.module.lightandshadow.phases;
+
+import org.terasology.gestalt.entitysystem.event.Event;
+
+import java.util.function.Supplier;
+
+public enum Phase {
+    IDLE(OnIdlePhaseStartedEvent::new, OnIdlePhaseEndedEvent::new),
+    PRE_GAME(OnPreGamePhaseStartedEvent::new, OnPreGamePhaseEndedEvent::new),
+    COUNTDOWN(OnCountdownPhaseStartedEvent::new, OnCountdownPhaseEndedEvent::new),
+    IN_GAME(OnInGamePhaseStartedEvent::new, OnInGamePhaseEndedEvent::new),
+    POST_GAME(OnPostGamePhaseStartedEvent::new, OnPostGamePhaseEndedEvent::new);
+
+    public final Supplier<Event> endEvent;
+    public final Supplier<Event> startEvent;
+
+    Phase(Supplier<Event> startEvent, Supplier<Event> endEvent) {
+        this.startEvent = startEvent;
+        this.endEvent = endEvent;
+    }
+}