Skip to content

Commit

Permalink
Merge pull request #52018 from Calinou/doc-networkedmultiplayerenet-c…
Browse files Browse the repository at this point in the history
…ompression-mode

Document that ENet compression mode must match between client and server
  • Loading branch information
Calinou authored Aug 23, 2021
2 parents 27bcd06 + c294536 commit 3bd682c
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions modules/enet/doc_classes/NetworkedMultiplayerENet.xml
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@
<member name="compression_mode" type="int" setter="set_compression_mode" getter="get_compression_mode" enum="NetworkedMultiplayerENet.CompressionMode" default="1">
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] [member compression_mode] must be set to the same value on both the server and all its clients. Clients will fail to connect if the [member compression_mode] set on the client differs from the one set on the server. Prior to Godot 3.4, the default [member compression_mode] was [constant COMPRESS_NONE]. Nonetheless, mixing engine versions between clients and server is not recommended and not officially supported.
</member>
<member name="dtls_hostname" type="String" setter="set_dtls_hostname" getter="get_dtls_hostname" default="&quot;&quot;">
The hostname used for DTLS verification, to be compared against the "CN" value in the certificate provided by the server.
Expand Down

0 comments on commit 3bd682c

Please sign in to comment.