feat: Allow sending spawnData when spawning entities using the MultiplayerService

Author: NotBjoggisAtAll

fxgl/src/main/kotlin/com/almasb/fxgl/multiplayer/MultiplayerService.kt

@@ -104,14 +104,18 @@ class MultiplayerService : EngineService() {
     }
 
     fun spawn(connection: Connection<Bundle>, entity: Entity, entityName: String) {
+        spawn(connection, entity, entityName, SpawnData(entity.x, entity.y, entity.z))
+    }
+
+    fun spawn(connection: Connection<Bundle>, entity: Entity, entityName: String, spawnData: SpawnData) {
         if (!entity.hasComponent(NetworkComponent::class.java)) {
             log.warning("Attempted to network-spawn entity $entityName, but it does not have NetworkComponent")
             return
         }
 
         val networkComponent = entity.getComponent(NetworkComponent::class.java)
 
-        val event = EntitySpawnEvent(networkComponent.id, entityName, entity.x, entity.y, entity.z)
+        val event = EntitySpawnEvent(networkComponent.id, entityName, NetworkSpawnData(spawnData))
 
         // TODO: if not available
         val data = replicatedEntitiesMap[connection]!!
@@ -129,7 +133,12 @@ class MultiplayerService : EngineService() {
                         val id = event.networkID
                         val entityName = event.entityName
 
-                        val e = gameWorld.spawn(entityName, SpawnData(event.x, event.y, event.z))
+                        val networkSpawnData = event.networkSpawnData
+                        val data = networkSpawnData.bundle.data
+                        val spawnData = SpawnData(networkSpawnData.x, networkSpawnData.y, networkSpawnData.z)
+                        data.forEach(spawnData::put)
+
+                        val e = gameWorld.spawn(entityName, spawnData)
 
                         // TODO: show warning if not present
                         e.getComponentOptional(NetworkComponent::class.java)

fxgl/src/main/kotlin/com/almasb/fxgl/multiplayer/NetworkSpawnData.kt

@@ -0,0 +1,36 @@
+/*
+ * FXGL - JavaFX Game Library. The MIT License (MIT).
+ * Copyright (c) AlmasB ([email protected]).
+ * See LICENSE for details.
+ */
+
+package com.almasb.fxgl.multiplayer
+
+import com.almasb.fxgl.core.serialization.Bundle
+import com.almasb.fxgl.entity.SpawnData
+import java.io.Serializable
+
+/**
+ * Wrapper around SpawnData to be sent over network.
+ *
+ * @author Jonas Andersen ([email protected])
+ */
+class NetworkSpawnData(spawnData: SpawnData) : Serializable {
+
+    val bundle = Bundle("NetworkSpawnData")
+    var x: Double = 0.0
+    var y: Double = 0.0
+    var z: Double = 0.0
+
+    init {
+        x = spawnData.x
+        y = spawnData.y
+        z = spawnData.z
+
+        spawnData.data.forEach { (key, value) ->
+            if (value is Serializable) {
+                bundle.put(key, value)
+            }
+        };
+    }
+}

fxgl/src/main/kotlin/com/almasb/fxgl/multiplayer/ReplicationEvent.kt

@@ -6,6 +6,7 @@
 
 package com.almasb.fxgl.multiplayer
 
+import com.almasb.fxgl.entity.SpawnData
 import javafx.event.Event
 import javafx.event.EventType
 import javafx.scene.input.KeyCode
@@ -36,13 +37,10 @@ abstract class ReplicationEvent(eventType: EventType<out ReplicationEvent>) : Ev
     }
 }
 
-// TODO: consider SpawnData properties in the future
 class EntitySpawnEvent(
         val networkID: Long,
         val entityName: String,
-        val x: Double,
-        val y: Double,
-        val z: Double
+        val networkSpawnData: NetworkSpawnData,
 ) : ReplicationEvent(ENTITY_SPAWN)
 
 class EntityUpdateEvent(