Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-26 14:13:10 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #52019 from Calinou/doc-enetconnection-compression-mode

Browse Source 
Document ENetConnection compression must match between client and server
This commit is contained in:
Hugo Locurcio 2021-08-23 18:58:33 +02:00 committed by GitHub
commit 40937ffa6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
modules/enet/doc_classes/ENetConnection.xml
View File

@ -40,6 +40,7 @@
<description>
Sets the compression method used for network packets. These have different tradeoffs of compression speed versus bandwidth, you may need to test which one works best for your use case if you use compression at all.
[b]Note:[/b] Most games' network design involve sending many small packets frequently (smaller than 4 KB each). If in doubt, it is recommended to keep the default compression algorithm as it works best on these small packets.
[b]Note:[/b] The compression mode must be set to the same value on both the server and all its clients. Clients will fail to connect if the compression mode set on the client differs from the one set on the server.
</description>
</method>
<method name="connect_to_host">