godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document that ENet compression mode must match between client and server

Browse Source 
(cherry picked from commit c2945365d8)
This commit is contained in:
Hugo Locurcio 2021-08-23 17:05:04 +02:00 committed by Rémi Verschelde
parent d8138c6f4a
commit 44bda5351c
No known key found for this signature in database
GPG Key ID: C3336907360768E1
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/NetworkedMultiplayerENet.xml
View File

@ -117,6 +117,7 @@
</member>
<member name="compression_mode" type="int" setter="set_compression_mode" getter="get_compression_mode" enum="NetworkedMultiplayerENet.CompressionMode" default="0">
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] [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.
</member>
<member name="dtls_verify" type="bool" setter="set_dtls_verify_enabled" getter="is_dtls_verify_enabled" default="true">
Enable or disable certificate verification when [member use_dtls] [code]true[/code].