Difference between revisions of "enet.peer:round trip time"

(Created page with "Returns or sets the current round trip time (i.e. ping). If value is nil the current value of the peer is returned. Otherwise the round trip time is set to th...")
 
Line 1: Line 1:
 
Returns or sets the current round trip time (i.e. ping). If value is [[nil]] the current value of the [[enet.peer | peer]] is returned. Otherwise the round trip time is set to the specified value and returned.
 
Returns or sets the current round trip time (i.e. ping). If value is [[nil]] the current value of the [[enet.peer | peer]] is returned. Otherwise the round trip time is set to the specified value and returned.
  
ENet performs some filtering on the round trip times and it takes some time until the parameters are accurate.
+
ENet performs some filtering on the round trip times and it takes some time until the parameters are accurate. To speed it up, set the [[enet.peer:last_round_trip_time | last round trip time]] to an accurate guess.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 15: Line 15:
 
* [[parent::lua-enet]]
 
* [[parent::lua-enet]]
 
* [[enet.peer]]
 
* [[enet.peer]]
 +
* [[enet.peer:last_round_trip_time]]
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|enet.peer:round_trip_time}}
 
{{i18n|enet.peer:round_trip_time}}

Revision as of 05:08, 9 October 2014

Returns or sets the current round trip time (i.e. ping). If value is nil the current value of the peer is returned. Otherwise the round trip time is set to the specified value and returned.

ENet performs some filtering on the round trip times and it takes some time until the parameters are accurate. To speed it up, set the last round trip time to an accurate guess.

Function

Synopsis

peer:round_trip_time(value)

Arguments

number value
Optional integer value to be used as the new round trip time.

Returns

number roundtriptime
The peer's current round trip time in milliseconds.

See Also

Other Languages