WoW:API GetNetStats: Difference between revisions

WoW:API GetNetStats (source)

414 bytes added , 15 August 2023

m

Move page script moved page API GetNetStats to WoW:API GetNetStats without leaving a redirect

Anonymous user

@@ Line 1: / Line 1: @@
- <center>'''GetNetStats''' ''-Documentation by Myrrion (thanks Jooky)-''</center>
+{{wowapi}}
 Retrieve info about net statistics.
-	down, up, lag = GetNetStats();
+	down, up, lagHome, lagWorld = GetNetStats();
-----
-;''Arguments''
-:none
 ----
 ;''Returns''
-:(- down)
+:;down : Current incoming bandwidth (download) usage, measured in KB/s.
-:;down : -
+:;up : Current outgoing bandwidth (upload) usage, measured in KB/s.
-:(- up)
+:;lagHome : Floating Point Number - Average direct latency of the connection from your computer to the Blizzard server in milliseconds (updates every 30 seconds).
-:;up : -
+:;lagWorld : Floating Point Number - Average in-game latency of the connection from your computer to the Game World including TCP overhead (updates every 30 seconds).
-:(Number lag)
-:;lag : The lag (in milliseconds) of your connection.
 ----
 ;''Example''
-  local down, up, lag = GetNetStats();<br>
+  local down, up, lagHome, lagWorld = GetNetStats();<br>
-  message("Lag: "..lag.." milliseconds.");
+  message("Connection Lag: "..lagHome.." milliseconds, World Lag: "..lagWorld );
 ;''Result''
@@ Line 37: / Line 28: @@
 : Retrieve information about your current net statistics.
+: Note that WoW 4.0.6 has added a return value so that two distinct latency values are now returned...
-----
-{{WoW API}}