GetNetworkStats: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Info|Function|Server & Client|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Gets the clients' NetworkStats}}


{{FuncSyntax|GetNetworkStats()}}
{{FuncSyntax|GetNetworkStats()}}
Line 8: Line 8:
{{FuncNoParam}}
{{FuncNoParam}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|packetlossTotal, packetlossLastSecond, messagesInResendBuffer, bytesInResendBuffer, bytesSend, bytesReceived, bytesResent, bytesSendTotal, bytesReceivedTotal, bytesResentTotal, isLimitedByCongestionControl, isLimitedByOutgoingBandwidthLimit}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
for name, value in pairs(GetNetworkStats())
  print(name .. " -> " .. value)
do
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[GetPlayerNetworkStats]]
* [[GetNetworkStats]]

Latest revision as of 14:54, 26 June 2021

GetNetworkStats

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Gets the clients' NetworkStats

Syntax

GetNetworkStats()

Parameters

  • This function has no parameters.

Return Value

  • packetlossTotal, packetlossLastSecond, messagesInResendBuffer, bytesInResendBuffer, bytesSend, bytesReceived, bytesResent, bytesSendTotal, bytesReceivedTotal, bytesResentTotal, isLimitedByCongestionControl, isLimitedByOutgoingBandwidthLimit

Example

for name, value in pairs(GetNetworkStats())
  print(name .. " -> " .. value)
do

See also