From 1b54de3039d39bae6ec381321888d211fafaef2e Mon Sep 17 00:00:00 2001 From: Fabian Date: Mon, 20 Jan 2020 17:13:12 +1030 Subject: Add set_peer_timeout to NetworkedMultiplayerENet. --- modules/enet/doc_classes/NetworkedMultiplayerENet.xml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'modules/enet/doc_classes') diff --git a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml index 6c713fa1ce..c8f32ffde6 100644 --- a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml +++ b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml @@ -124,6 +124,22 @@ Configure the [CryptoKey] to use when [member use_dtls] is [code]true[/code]. Remember to also call [method set_dtls_certificate] to setup your [X509Certificate]. + + + + + + + + + + + + + Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds. + The [code]timeout_limit[/code] is a factor that, multiplied by a value based on the avarage round trip time, will determine the timeout limit for a reliable packet. When that limit is reached, the timeout will be doubled, and the peer will be disconnected if that limit has reached [code]timeout_min[/code]. The [code]timeout_max[/code] parameter, on the other hand, defines a fixed timeout for which any packet must be acknowledged or the peer will be dropped. + + -- cgit v1.2.3