WoW:API GetNetStats: Difference between revisions

Revision as of 23:32, 9 February 2011

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

Retrieve info about net statistics.

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

lagHome: Floating Point Number - Average roundtrip latency of your connection to the server (only updated every 30 seconds).

lagWorld: Floating Point Number - Average dynamic latency of the area you are in within the world

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 3: / Line 3: @@
 Retrieve info about net statistics.
-	down, up, lag = GetNetStats();
+	down, up, lagHome, lagWorld = GetNetStats();
 ----
@@ Line 12: / Line 12: @@
 :;up : Current outgoing bandwidth (upload) usage, measured in KB/s.
-:;lag : Floating Point Number - Average roundtrip latency to the server (only updated every 30 seconds).
+:;lagHome : Floating Point Number - Average roundtrip latency of your connection to the server (only updated every 30 seconds).
+:;lagWorld : Floating Point Number - Average dynamic latency of the area you are in within the world
 ----
 ;''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 26: / 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...