Open Asterune
NetworkClient

NetworkClient

Reports the client's server connection and network statistics.

Service
game:GetService("NetworkClient")
Inherits
Instance
Replication
Never

Behavior

NetworkClient reports the client's server connection and network statistics.

Summary

Members7
Properties4
  • Connected: boolean = falseparallel readread only

    Whether the client currently has an active server connection.

  • Ping: number = 0parallel readread only

    The measured connection round-trip time, in milliseconds.

  • ReceivedBytes: number = 0parallel readread only

    The cumulative number of bytes received.

  • SentBytes: number = 0parallel readread only

    The cumulative number of bytes sent.

Methods3

Properties

Connected

NetworkClient.Connected: boolean = false

Whether the client currently has an active server connection.

Ping

NetworkClient.Ping: number = 0

The measured connection round-trip time, in milliseconds.

ReceivedBytes

NetworkClient.ReceivedBytes: number = 0

The cumulative number of bytes received.

SentBytes

NetworkClient.SentBytes: number = 0

The cumulative number of bytes sent.

Methods

GetConnections

NetworkClient:GetConnections(): table

Returns information about the active network connections.

GetExecutionGroup

NetworkClient:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

GetStats

NetworkClient:GetStats(): table

Returns network traffic and timing statistics.

Inherited members

Inherited47

Instance