feat(core): let user omit transforms from spawned object contents. (#250)

Author: pkaminski

MLAPI/Core/NetworkedObject.cs

@@ -158,6 +158,17 @@ internal set
         /// </summary>
         public VisibilityDelegate CheckObjectVisibility = null;
 
+        /// <summary>
+        /// Delegate type for checking spawn options
+        /// </summary>
+        /// <param name="clientId">The clientId to check spawn options for</param>
+        public delegate bool SpawnDelegate(ulong clientId);
+
+        /// <summary>
+        /// Delegate invoked when the MLAPI needs to know if it should include the transform when spawning the object, if null it will assume true
+        /// </summary>
+        public SpawnDelegate IncludeTransformWhenSpawning = null;
+
         /// <summary>
         /// Whether or not to destroy this object if it's owner is destroyed.
         /// If false, the objects ownership will be given to the server.

MLAPI/Core/NetworkingManager.cs

@@ -1082,15 +1082,16 @@ internal void HandleApproval(ulong clientId, ulong? prefabHash, bool approved, V
 
                         for (int i = 0; i < _observedObjects.Count; i++)
                         {
-                            writer.WriteBool(_observedObjects[i].IsPlayerObject);
-                            writer.WriteUInt64Packed(_observedObjects[i].NetworkId);
-                            writer.WriteUInt64Packed(_observedObjects[i].OwnerClientId);
+                            NetworkedObject observedObject = _observedObjects[i];
+                            writer.WriteBool(observedObject.IsPlayerObject);
+                            writer.WriteUInt64Packed(observedObject.NetworkId);
+                            writer.WriteUInt64Packed(observedObject.OwnerClientId);
 
                             NetworkedObject parent = null;
 
-                            if (!_observedObjects[i].AlwaysReplicateAsRoot && _observedObjects[i].transform.parent != null)
+                            if (!observedObject.AlwaysReplicateAsRoot && observedObject.transform.parent != null)
                             {
-                                parent = _observedObjects[i].transform.parent.GetComponent<NetworkedObject>();
+                                parent = observedObject.transform.parent.GetComponent<NetworkedObject>();
                             }
 
                             if (parent == null)
@@ -1105,34 +1106,42 @@ internal void HandleApproval(ulong clientId, ulong? prefabHash, bool approved, V
 
                             if (NetworkConfig.UsePrefabSync)
                             {
-                                writer.WriteUInt64Packed(_observedObjects[i].PrefabHash);
+                                writer.WriteUInt64Packed(observedObject.PrefabHash);
                             }
                             else
                             {
                                 // Is this a scene object that we will soft map
-                                writer.WriteBool(_observedObjects[i].IsSceneObject == null ? true : _observedObjects[i].IsSceneObject.Value);
+                                writer.WriteBool(observedObject.IsSceneObject == null ? true : observedObject.IsSceneObject.Value);
 
-                                if (_observedObjects[i].IsSceneObject == null || _observedObjects[i].IsSceneObject.Value == true)
+                                if (observedObject.IsSceneObject == null || observedObject.IsSceneObject.Value == true)
                                 {
-                                    writer.WriteUInt64Packed(_observedObjects[i].NetworkedInstanceId);
+                                    writer.WriteUInt64Packed(observedObject.NetworkedInstanceId);
                                 }
                                 else
                                 {
-                                    writer.WriteUInt64Packed(_observedObjects[i].PrefabHash);
+                                    writer.WriteUInt64Packed(observedObject.PrefabHash);
                                 }
                             }
 
-                            writer.WriteSinglePacked(_observedObjects[i].transform.position.x);
-                            writer.WriteSinglePacked(_observedObjects[i].transform.position.y);
-                            writer.WriteSinglePacked(_observedObjects[i].transform.position.z);
+                            if (observedObject.IncludeTransformWhenSpawning == null || observedObject.IncludeTransformWhenSpawning(clientId))
+                            {
+                                writer.WriteBool(true);
+                                writer.WriteSinglePacked(observedObject.transform.position.x);
+                                writer.WriteSinglePacked(observedObject.transform.position.y);
+                                writer.WriteSinglePacked(observedObject.transform.position.z);
 
-                            writer.WriteSinglePacked(_observedObjects[i].transform.rotation.eulerAngles.x);
-                            writer.WriteSinglePacked(_observedObjects[i].transform.rotation.eulerAngles.y);
-                            writer.WriteSinglePacked(_observedObjects[i].transform.rotation.eulerAngles.z);
+                                writer.WriteSinglePacked(observedObject.transform.rotation.eulerAngles.x);
+                                writer.WriteSinglePacked(observedObject.transform.rotation.eulerAngles.y);
+                                writer.WriteSinglePacked(observedObject.transform.rotation.eulerAngles.z);
+                            }
+                            else
+                            {
+                                writer.WriteBool(false);
+                            }
 
                             if (NetworkConfig.EnableNetworkedVar)
                             {
-                                _observedObjects[i].WriteNetworkedVarData(stream, clientId);
+                                observedObject.WriteNetworkedVarData(stream, clientId);
                             }
                         }
 

MLAPI/Messaging/InternalMessageHandler.cs

@@ -265,8 +265,13 @@ void DelayedSpawnAction(Stream continuationStream)
                                 }
                             }
 
-                            Vector3 pos = new Vector3(continuationReader.ReadSinglePacked(), continuationReader.ReadSinglePacked(), continuationReader.ReadSinglePacked());
-                            Quaternion rot = Quaternion.Euler(continuationReader.ReadSinglePacked(), continuationReader.ReadSinglePacked(), continuationReader.ReadSinglePacked());
+                            Vector3? pos = null;
+                            Quaternion? rot = null;
+                            if (continuationReader.ReadBool())
+                            {
+                                pos = new Vector3(continuationReader.ReadSinglePacked(), continuationReader.ReadSinglePacked(), continuationReader.ReadSinglePacked());
+                                rot = Quaternion.Euler(continuationReader.ReadSinglePacked(), continuationReader.ReadSinglePacked(), continuationReader.ReadSinglePacked());
+                            }
 
                             NetworkedObject netObject = SpawnManager.CreateLocalNetworkedObject(softSync, instanceId, prefabHash, parentNetworkId, pos, rot);
                             SpawnManager.SpawnNetworkedObjectLocally(netObject, networkId, softSync, isPlayerObject, ownerId, continuationStream, false, 0, true, false);
@@ -320,11 +325,11 @@ internal static void HandleAddObject(ulong clientId, Stream stream)
                 {
                     parentNetworkId = reader.ReadUInt64Packed();
                 }
-                
+
                 ulong prefabHash;
                 ulong instanceId;
                 bool softSync;
-                    
+
                 if (NetworkingManager.Singleton.NetworkConfig.UsePrefabSync)
                 {
                     softSync = false;
@@ -347,8 +352,13 @@ internal static void HandleAddObject(ulong clientId, Stream stream)
                     }
                 }
 
-                Vector3 pos = new Vector3(reader.ReadSinglePacked(), reader.ReadSinglePacked(), reader.ReadSinglePacked());
-                Quaternion rot = Quaternion.Euler(reader.ReadSinglePacked(), reader.ReadSinglePacked(), reader.ReadSinglePacked());
+                Vector3? pos = null;
+                Quaternion? rot = null;
+                if (reader.ReadBool())
+                {
+                    pos = new Vector3(reader.ReadSinglePacked(), reader.ReadSinglePacked(), reader.ReadSinglePacked());
+                    rot = Quaternion.Euler(reader.ReadSinglePacked(), reader.ReadSinglePacked(), reader.ReadSinglePacked());
+                }
 
                 bool hasPayload = reader.ReadBool();
                 int payLoadLength = hasPayload ? reader.ReadInt32Packed() : 0;

MLAPI/SceneManagement/NetworkSceneManager.cs

@@ -335,8 +335,13 @@ private static void OnSceneUnloadClient(Guid switchSceneGuid, Stream objectStrea
 
                         ulong prefabHash = reader.ReadUInt64Packed();
 
-                        Vector3 position = new Vector3(reader.ReadSinglePacked(), reader.ReadSinglePacked(), reader.ReadSinglePacked());
-                        Quaternion rotation = Quaternion.Euler(reader.ReadSinglePacked(), reader.ReadSinglePacked(), reader.ReadSinglePacked());
+                        Vector3? position = null;
+                        Quaternion? rotation = null;
+                        if (reader.ReadBool())
+                        {
+                            position = new Vector3(reader.ReadSinglePacked(), reader.ReadSinglePacked(), reader.ReadSinglePacked());
+                            rotation = Quaternion.Euler(reader.ReadSinglePacked(), reader.ReadSinglePacked(), reader.ReadSinglePacked());
+                        }
 
                         NetworkedObject networkedObject = SpawnManager.CreateLocalNetworkedObject(false, 0, prefabHash, parentNetworkId, position, rotation);
                         SpawnManager.SpawnNetworkedObjectLocally(networkedObject, networkId, true, isPlayerObject, owner, objectStream, false, 0, true, false);

MLAPI/Spawning/SpawnManager.cs

@@ -437,13 +437,20 @@ internal static void WriteSpawnCallForObject(Serialization.BitStream stream, ulo
                     }
                 }
 
-                writer.WriteSinglePacked(netObject.transform.position.x);
-                writer.WriteSinglePacked(netObject.transform.position.y);
-                writer.WriteSinglePacked(netObject.transform.position.z);
-
-                writer.WriteSinglePacked(netObject.transform.rotation.eulerAngles.x);
-                writer.WriteSinglePacked(netObject.transform.rotation.eulerAngles.y);
-                writer.WriteSinglePacked(netObject.transform.rotation.eulerAngles.z);
+                if (netObject.IncludeTransformWhenSpawning == null || netObject.IncludeTransformWhenSpawning(clientId))
+                {
+                    writer.WriteBool(true);
+                    writer.WriteSinglePacked(netObject.transform.position.x);
+                    writer.WriteSinglePacked(netObject.transform.position.y);
+                    writer.WriteSinglePacked(netObject.transform.position.z);
+
+                    writer.WriteSinglePacked(netObject.transform.rotation.eulerAngles.x);
+                    writer.WriteSinglePacked(netObject.transform.rotation.eulerAngles.y);
+                    writer.WriteSinglePacked(netObject.transform.rotation.eulerAngles.z);
+                } else
+                {
+                    writer.WriteBool(false);
+                }
 
                 writer.WriteBool(payload != null);