Changes: API GetNetStats

Latest revision as of 22:51, February 10, 2011

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Changes Battle.net API HOWTOs Snippets UI tech. Categories

Retrieve info about net statistics.

down, up, lagHome, lagWorld = GetNetStats();

lagHome: Floating Point Number - Average direct latency of the connection from your computer to the Blizzard server in milliseconds (updates every 30 seconds).

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).

local down, up, lagHome, lagWorld = GetNetStats();

message("Connection Lag: "..lagHome.." milliseconds, World Lag: "..lagWorld );

Message box appears with amount of lag in milliseconds.

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...

@@ 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();
+ local down, up, lagHome, lagWorld = GetNetStats();<br>
+ message("Connection Lag: "..lagHome.." milliseconds, World Lag: "..lagWorld );
 ;''Result''
-For lag variable, retrieves the amount of lag in milliseconds.
+Message box appears with amount of lag in milliseconds.
 ----
@@ Line 27: / Line 27: @@
 : 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...
-----
-{{Template:WoW API}}