WoW API: GetNetStats

From AddOn Studio
Revision as of 23:32, 9 February 2011 by WoWWiki>Spiel2001 (Clarifying print message example)
Jump to navigation Jump to search

WoW API < GetNetStats

Retrieve info about net statistics.

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


Returns
down
Current incomming 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).
lagWorld
Floating Point Number - Average dynamic latency of the area you are in within the world

Example
local down, up, lagHome, lagWorld = GetNetStats();
message("Connection Lag: "..lagHome.." milliseconds, World Lag: "..lagWorld );
Result

Message box appears with amount of lag in milliseconds.


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