Add note about required message recycle after message-event
This commit is contained in:
@@ -52,6 +52,7 @@ public:
|
||||
|
||||
/// <summary>
|
||||
/// The message when this event is an "message" event - not valid in any other cases.
|
||||
/// If this is an message-event, make sure to return the message using RecycleMessage function of the peer after processing it!
|
||||
/// </summary>
|
||||
API_FIELD();
|
||||
NetworkMessage Message;
|
||||
|
||||
@@ -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);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user