diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2018-09-30 16:46:33 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-30 16:46:33 +0200 |
| commit | 3ee657e7a7ffdcdb1fd46e095fef97622b99e909 (patch) | |
| tree | 2d51f98bcb80b4fc18c0ebd937ede51f6d9bf9ab /doc/classes | |
| parent | d3f01a22817a76fbb73d4021090cddee695b7b09 (diff) | |
| parent | 84b6394a4d64ae67e068f5df2018727580402bea (diff) | |
Merge pull request #22557 from mhilbrunner/docs-transfermodes
[DOCS] NetworkedMultiplayerPeer: TransferMode(s)
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/NetworkedMultiplayerPeer.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index e878b3a746..ea6fe6d11c 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -92,13 +92,13 @@ </signals> <constants> <constant name="TRANSFER_MODE_UNRELIABLE" value="0" enum="TransferMode"> - Packets are sent via unordered UDP packets. + Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [code]TRANSFER_MODE_UNRELIABLE_ORDERED[/code]. Use for non-critical data, and always consider whether the order matters. </constant> <constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1" enum="TransferMode"> - Packets are sent via ordered UDP packets. + Packets are not acknowledged, no resend attempts are made for lost packets. Packets are received in the order they were sent in. Potentially faster than [code]TRANSFER_MODE_RELIABLE[/code]. Use for non-critical data or data that would be outdated if received late due to resend attempt(s) anyway, for example movement and positional data. </constant> <constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode"> - Packets are sent via TCP packets. + Packets must be received and resend attempts should be made until the packets are acknowledged. Packets must be received in the order they were sent in. Most reliable transfer mode, but potentially slowest due to the overhead. Use for critical data that must be transmitted and arrive in order, for example an ability being triggered or a chat message. Consider carefully if the information really is critical, and use sparingly. </constant> <constant name="CONNECTION_DISCONNECTED" value="0" enum="ConnectionStatus"> The ongoing connection disconnected. |