Update SpeckleReceiver.cs

2023-09-26 22:17:28 +01:00
parent 0bb1591624
commit 5ee498afce
1 changed files with 5 additions and 1 deletions
@@ -79,14 +79,18 @@ namespace Speckle.ConnectorUnity.Components

        /// <summary>
        /// Receive the selected <see cref="Commit"/> object, and converts ToNative as children of <paramref name="parent"/>
+        /// This function is designed to be run as a coroutine
        /// </summary>
+        /// <example><c>
+        /// StartCoroutine(mySpeckleReceiver.ReceiveAndConvert_Routine(null);
+        /// </c></example
        /// <param name="parent">Optional parent <see cref="Transform"/> for the created root <see cref="GameObject"/>s</param>
        /// <param name="predicate">A filter function to allow for selectively excluding certain objects from being converted</param>
        /// <remarks>function does not throw, instead calls <see cref="OnErrorAction"/>, and calls <see cref="OnComplete"/> upon completion</remarks>
        /// <seealso cref="ReceiveAsync(System.Threading.CancellationToken)"/>
        /// <seealso cref="RecursiveConverter.RecursivelyConvertToNative_Enumerable"/>
        public IEnumerator ReceiveAndConvert_Routine(
-            Transform? parent,
+            Transform? parent = null,
            Predicate<TraversalContext>? predicate = null
        )
        {