From 01ee534a56acbb931219f34042d84a738bd37044 Mon Sep 17 00:00:00 2001
From: Yannik Bretschneider <yannik.bretschneider@uni-ulm.de>
Date: Fri, 30 Apr 2021 23:47:41 +0200
Subject: [PATCH] refactor: changed tuple test variable name to t for
 readability

---
 .../gamelibrary/json/basic/BasicMessage.java  | 39 +++++++++++++++++++
 .../marvelous/gamelibrary/TupleTest.java      |  6 +--
 2 files changed, 42 insertions(+), 3 deletions(-)
 create mode 100644 src/main/java/uulm/teamname/marvelous/gamelibrary/json/basic/BasicMessage.java

diff --git a/src/main/java/uulm/teamname/marvelous/gamelibrary/json/basic/BasicMessage.java b/src/main/java/uulm/teamname/marvelous/gamelibrary/json/basic/BasicMessage.java
new file mode 100644
index 0000000..e28dfc2
--- /dev/null
+++ b/src/main/java/uulm/teamname/marvelous/gamelibrary/json/basic/BasicMessage.java
@@ -0,0 +1,39 @@
+package uulm.teamname.marvelous.gamelibrary.json.basic;
+
+import uulm.teamname.marvelous.gamelibrary.json.MessageType;
+
+/**
+ *  The basic message from the standard, containing all possible expansion keys.
+ *  In other words, one needs to check the messageType, as fields that aren't sent
+ *  are null. Note that ingame messages are not deserialized into the {@link BasicMessage}, but instead
+ *  into the {@link uulm.teamname.marvelous.gamelibrary.json.ingame.MessageStructure}.
+ */
+public class BasicMessage {
+
+    /**
+     * The user ID is (apparently) a MD5 hash made from the username and device IP. It is assigned by the server.
+     */
+    String userID;
+
+    /**
+     * The messageType describes the type of message that might be sent
+     */
+    MessageType messageType;
+
+    /**
+     *  I have no idea what this might be used for, even less the boolean in the answer
+     */
+    String optionals;
+
+    /**
+     *  <b>Exists only in a HelloClient message.</b>
+     * Describes whether the user was in a running game before reconnecting.
+     */
+    boolean runningGame;
+
+    /**
+     *  <b>Exists only in GameAssignment and GeneralAssignment messages.</b>
+     * Used for notifying the player of which party they have been assigned to
+     */
+    String gameID;
+}
diff --git a/src/test/java/uulm/teamname/marvelous/gamelibrary/TupleTest.java b/src/test/java/uulm/teamname/marvelous/gamelibrary/TupleTest.java
index 4adf83e..78b8697 100644
--- a/src/test/java/uulm/teamname/marvelous/gamelibrary/TupleTest.java
+++ b/src/test/java/uulm/teamname/marvelous/gamelibrary/TupleTest.java
@@ -7,8 +7,8 @@ import static org.junit.jupiter.api.Assertions.*;
 class TupleTest {
     @Test
     void basicTest() {
-        Tuple<Integer, Integer> a = new Tuple<>(0, 1);
-        assertEquals((int) a.item1, 0);
-        assertEquals((int) a.item2, 1);
+        Tuple<Integer, Integer> t = new Tuple<>(0, 1);
+        assertEquals((int) t.item1, 0);
+        assertEquals((int) t.item2, 1);
     }
 }