summaryrefslogtreecommitdiff
path: root/modules/enet/doc_classes
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2019-11-26 17:21:19 +0100
committerFabio Alessandrelli <fabio.alessandrelli@gmail.com>2019-11-27 11:48:31 +0100
commit7e592f96417e23c48b815c09e363d973f47b6f7f (patch)
tree299e8cb8b8c64417211613f61238281b4f6cf9ee /modules/enet/doc_classes
parentef1008e53a1409ea34911c293c7fb8ac2b96245e (diff)
Add ENet option to disable server relaying.
It's useless when building fully authoritative servers, and prevents various kinds of abuse.
Diffstat (limited to 'modules/enet/doc_classes')
-rw-r--r--modules/enet/doc_classes/NetworkedMultiplayerENet.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml
index 4c10588aa6..78a8e94012 100644
--- a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml
+++ b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml
@@ -116,6 +116,9 @@
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.
</member>
<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" override="true" default="false" />
+ <member name="server_relay" type="bool" setter="set_server_relay_enabled" getter="is_server_relay_enabled" default="true">
+ Enable or disable the server feature that notifies clients of other peers' connection/disconnection, and relays messages between them. When this option is [code]false[/code], clients won't be automatically notified of other peers and won't be able to send them packets through the server.
+ </member>
<member name="transfer_channel" type="int" setter="set_transfer_channel" getter="get_transfer_channel" default="-1">
Set the default channel to be used to transfer data. By default, this value is [code]-1[/code] which means that ENet will only use 2 channels, one for reliable and one for unreliable packets. Channel [code]0[/code] is reserved, and cannot be used. Setting this member to any value between [code]0[/code] and [member channel_count] (excluded) will force ENet to use that channel for sending data.
</member>