WoW:API GetNetStats: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Move page script moved page API GetNetStats to API GetNetStats without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
Retrieve info about net statistics. | Retrieve info about net statistics. | ||
down, up, | down, up, lagHome, lagWorld = GetNetStats(); | ||
---- | ---- | ||
;''Returns'' | ;''Returns'' | ||
:;down : Current incoming bandwidth (download) usage, measured in KB/s. | |||
:;down : | |||
:;up : | :;up : Current outgoing bandwidth (upload) usage, measured in KB/s. | ||
:( | :;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). | ||
---- | ---- | ||
;''Example'' | ;''Example'' | ||
local down, up, | local down, up, lagHome, lagWorld = GetNetStats();<br> | ||
message("Lag: ".. | message("Connection Lag: "..lagHome.." milliseconds, World Lag: "..lagWorld ); | ||
;''Result'' | ;''Result'' | ||
| Line 37: | Line 28: | ||
: Retrieve information about your current net statistics. | : 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... | |||
Latest revision as of 04:46, 15 August 2023
← WoW API < GetNetStats
Retrieve info about net statistics.
down, up, lagHome, lagWorld = GetNetStats();
- Returns
- 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 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).
- 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...