Add note about required message recycle after message-event

2021-06-21 22:00:09 +02:00
parent 25fe03f5a5
commit 6aece4e388
2 changed files with 2 additions and 0 deletions
--- a/Source/Engine/Networking/NetworkPeer.h
+++ b/Source/Engine/Networking/NetworkPeer.h
@@ -76,6 +76,7 @@ public:
    /// </summary>
    /// <param name="eventRef">The reference to event structure.</param>
    /// <returns>True when succeeded and the event can be processed.</returns>
+    /// <remarks>If this returns message event, make sure to recycle the message using <see cref="RecycleMessage"/> function after processing it!</remarks>
    API_FUNCTION()
    bool PopEvent(API_PARAM(out) NetworkEvent& eventRef);