Reference API Roblox

Engine API

Website

Related

Reference API Roblox

NetworkSettings

Settings related to networked engine behaviors.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
This class is not browsable. It is not visible in Studio's object browser.
Tags: [NotCreatable, Service, NotBrowsable]

Member index 12

HistoryMember
553HttpProxyEnabled: bool
553HttpProxyURL: string
553IncomingReplicationLag: double
553PrintJoinSizeBreakdown: bool
553PrintPhysicsErrors: bool
553PrintStreamInstanceQuota: bool
553RandomizeJoinInstanceOrder: bool
553RenderStreamedRegions: bool
553ShowActiveAnimationAsset: bool
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 44

HistoryMember
419ArePhysicsRejectionsReported: bool
334CanSendPacketBufferLimit: int
419ClientPhysicsSendRate: float
419DataGCRate: float
438DataMtuAdjust: int
438DataSendRate: float
331ExperimentalPhysicsEnabled: bool
450IncommingReplicationLag: double
419IsQueueErrorComputed: bool
334IsThrottledByCongestionControl: bool
334IsThrottledByOutgoingBandwidthLimit: bool
334MaxDataModelSendBuffer: int
141MovementHistoryRate: float
419NetworkOwnerRate: float
438PhysicsMtuAdjust: int
334PhysicsReceive: PhysicsReceiveMethod
334PhysicsSend: PhysicsSendMethod
419PhysicsSendRate: float
438PreferredClientPort: int
419PrintBits: bool
419PrintEvents: bool
450PrintFilters: bool
438PrintInstances: bool
419PrintProperties: bool
438PrintSplitMessage: bool
450PrintTouches: bool
413ProxyEnabled: bool
413ProxyURL: string
438ReceiveRate: double
334SendPacketBufferLimit: int
302ShowPartMovementWayPoint: bool
302TotalNumMovementWayPoint: int
438TouchSendRate: float
514TrackDataTypes: bool
514TrackPhysicsDetails: bool
367UseInstancePacketCache: bool
419UsePhysicsPacketCache: bool

Description

NetworkSettings is a settings class that allow you to debug a lot of features with Roblox's server/client networking. It can be found in Roblox Studio's settings, under the Network tab.

History 157

Members 12

HttpProxyEnabled

TypeDefault
bool

History 4

HttpProxyURL

TypeDefault
string

History 4

IncomingReplicationLag

TypeDefault
double

Instruct the engine to simulate additional lag by delaying all incoming messages. Units are seconds.

History 4

PrintJoinSizeBreakdown

TypeDefault
bool

Print diagnostic information to the Output window after connecting. The data will indicate the largest individual Instances sent, as well as aggregate data about data sent by Instance type. The data sent for initial loading is compressed so the contributions are approximate.

History 4

PrintPhysicsErrors

TypeDefault
bool

When set to true, debug messages will be printed into the output, pertaining to physics replication errors. Note that this property is intended for Roblox engineers who are debugging network replication. The following are debug outputs that are made available when this property is set to true.

  • Physics-in old packet prints if the PhysicsReceiver receives a mechanism update packet for a part that has been updated ahead of the packet's submission time. This happens if the packet is received late, and a newer packet has already been processed.
  • Physics-in of unidentified {GUID} prints if the PhysicsReceiver cannot find the part that is trying to be updated because the provided Instance identifier was invalid, where {GUID} is the unknown Instance:GetDebugId() identifier that is supposed to be targeting the part. This typically happens if a part is removed before the physics update packet is received.
  • Physics-in of part not in workspace {GUID} prints if the PhysicsReceiver receives a request to update the physics of a part that is not a descendant of the Workspace, where {GUID} is the Instance:GetDebugId() identifier of the target part. This happens if the part was just moved out of the Workspace, and was previously being simulated.

History 4

PrintStreamInstanceQuota

TypeDefault
bool

When set to true, debug information is printed to the output regarding the replication of instances when Workspace.StreamingEnabled is set to true. There are several debug outputs that are made available when this property is set to true, as listed below.

Note that this property is intended for Roblox engineers who are debugging network replication. This documentation may become outdated in the future, as Roblox's network code is always changing behind the scenes.

Streaming Capacity Update

When the client's streaming capacity is updated, the following debug message will be printed: clientInstanceQuota {1}, packet in queue {2}, predictedTotalInstanceProcessTime {3}, avgStreamDataReadTime {4}, avgInstancesPerStreamData {5}

The numbers in curly braces are substituted, and can be described as:

  • {1} – The id of the client instance quota.
  • {2} – The current number of incoming packets that have been queued.
  • {3} – A prediction for how long it will take to update the quota.
  • {4} – The current average time it takes to read the stream data.
  • {5} – The average number of instances in the stream data.

Instance Quota Update

When the client receives an instance quota update, the following debug message will be printed: Received new client instance quota: {1}, max region radius: {2}

The numbers in curly braces are substituted, and can be described as:

  • {1} – The id of the client instance quota.
  • {2} – The maximum radius of space around the client's Player.ReplicationFocus that can have physical instances streamed in.

History 4

RandomizeJoinInstanceOrder

TypeDefault
bool

Emulate the behavior of a server that has been online a long time by randomizing the order that instances initially arrive on clients. It is recommended to keep this setting enabled to help discover potential bugs while testing in Studio.

History 3

RenderStreamedRegions

TypeDefault
bool

When set to true, regions of space that are being streamed to the client will be outlined in red. This will only be shown if Workspace.StreamingEnabled is set to true.

History 4

ShowActiveAnimationAsset

TypeDefault
bool

When set to true, a label will be shown above each player's head, showing the current animation being played by the Player's Humanoid, if any.

History 4

Removed members 44

ArePhysicsRejectionsReported

TypeDefault
bool

History 2

CanSendPacketBufferLimit

TypeDefault
int

History 2

ClientPhysicsSendRate

TypeDefault
float

History 2

DataGCRate

TypeDefault
float

History 2

DataMtuAdjust

TypeDefault
int

History 2

DataSendRate

TypeDefault
float

History 2

ExperimentalPhysicsEnabled

TypeDefault
bool

History 2

IncommingReplicationLag

TypeDefault
double

History 2

IsQueueErrorComputed

TypeDefault
bool

History 2

IsThrottledByCongestionControl

TypeDefault
bool

History 2

IsThrottledByOutgoingBandwidthLimit

TypeDefault
bool

History 2

MaxDataModelSendBuffer

TypeDefault
int
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

MovementHistoryRate

TypeDefault
float

History 2

NetworkOwnerRate

TypeDefault
float

History 2

PhysicsMtuAdjust

TypeDefault
int

History 2

PhysicsReceive

TypeDefault
PhysicsReceiveMethod

History 2

PhysicsSend

TypeDefault
PhysicsSendMethod

History 2

PhysicsSendRate

TypeDefault
float

History 2

PreferredClientPort

TypeDefault
int

History 2

PrintBits

TypeDefault
bool

History 2

PrintEvents

TypeDefault
bool

History 2

PrintFilters

TypeDefault
bool

History 4

PrintInstances

TypeDefault
bool

History 2

PrintProperties

TypeDefault
bool

History 2

PrintSplitMessage

TypeDefault
bool

History 2

PrintTouches

TypeDefault
bool

History 2

ProxyEnabled

TypeDefault
bool

History 2

ProxyURL

TypeDefault
string

History 2

ReceiveRate

TypeDefault
double

History 2

SendPacketBufferLimit

TypeDefault
int

History 2

ShowPartMovementWayPoint

TypeDefault
bool

History 4

TotalNumMovementWayPoint

TypeDefault
int

History 4

TouchSendRate

TypeDefault
float

History 2

TrackDataTypes

TypeDefault
bool

History 6

TrackPhysicsDetails

TypeDefault
bool

History 4

UseInstancePacketCache

TypeDefault
bool

History 2

UsePhysicsPacketCache

TypeDefault
bool

History 2

Settings