WoW:API GetNetStats: Difference between revisions

Revision as of 22:51, 10 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 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 8: / Line 8: @@
 ;''Returns''
-:;down : Current incomming bandwidth (download) usage, measured in KB/s.
+:;down : Current incoming bandwidth (download) usage, measured in KB/s.
 :;up : Current outgoing bandwidth (upload) usage, measured in KB/s.
-:;lagHome : Floating Point Number - Average roundtrip latency of your connection to the server (only updated every 30 seconds).
+:;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 dynamic latency of the area you are in within the world
+:;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).
 ----
 ;''Example''