diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-02-27 16:45:29 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-27 16:45:29 +0100 |
| commit | 21609c3bfd26f7cab41d5ddec61d5d09b7ef1960 (patch) | |
| tree | 60eb252b56ce8218f09544b523bec79bf65c929c /modules/enet/doc_classes/NetworkedMultiplayerENet.xml | |
| parent | 8abc79e909c5f4cf002445d15076d77c13af6f12 (diff) | |
| parent | 1b54de3039d39bae6ec381321888d211fafaef2e (diff) | |
Merge pull request #46470 from Faless/net/4.x_enet_timeout
Add set_peer_timeout to NetworkedMultiplayerENet.
Diffstat (limited to 'modules/enet/doc_classes/NetworkedMultiplayerENet.xml')
| -rw-r--r-- | modules/enet/doc_classes/NetworkedMultiplayerENet.xml | 16 |
1 files changed, 16 insertions, 0 deletions
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]. </description> </method> + <method name="set_peer_timeout"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="timeout_limit" type="int"> + </argument> + <argument index="2" name="timeout_min" type="int"> + </argument> + <argument index="3" name="timeout_max" type="int"> + </argument> + <description> + 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. + </description> + </method> </methods> <members> <member name="always_ordered" type="bool" setter="set_always_ordered" getter="is_always_ordered" default="false"> |