Settings related to networked engine behaviors.
Its interface does not cross the network boundary.
Instances of this class cannot be created with Instance.new.
It is a singleton that may be acquired with GetService.
It is not visible in Studio's object browser.
Tags: [NotCreatable, Service, NotReplicated, NotBrowsable]
NetworkSettings is a class that allows you to debug several features with
Roblox's server/client networking. It can be found in Roblox Studio's settings
under the Network tab.
- 719
Change WriteSecurity of OutboundNetworkMinDelayMs
from
NotAccessibleSecurity
to
PluginSecurity
- 719
Change ValueType of OutboundNetworkMinDelayMs
from
int
to
float
- 719
Change Tags of OutboundNetworkMinDelayMs
from
[Hidden, NotReplicated, NotScriptable]
to
[NotReplicated]
- 719
Change ReadSecurity of OutboundNetworkMinDelayMs
from
NotAccessibleSecurity
to
PluginSecurity
- 719
Remove OutboundNetworkMaxDelayMs
- 719
Change WriteSecurity of OutboundNetworkLossPercent
from
NotAccessibleSecurity
to
PluginSecurity
- 719
Change Tags of OutboundNetworkLossPercent
from
[Hidden, NotReplicated, NotScriptable]
to
[NotReplicated]
- 719
Change ReadSecurity of OutboundNetworkLossPercent
from
NotAccessibleSecurity
to
PluginSecurity
- 719
Add OutboundNetworkJitterMs
- 719
Remove NetworkEmulationEnabled
- 719
Change Tags of InboundNetworkMinDelayMs
from
[Hidden, NotReplicated, NotScriptable]
to
[NotReplicated]
- 719
Change ValueType of InboundNetworkMinDelayMs
from
int
to
float
- 719
Change WriteSecurity of InboundNetworkMinDelayMs
from
NotAccessibleSecurity
to
PluginSecurity
- 719
Change ReadSecurity of InboundNetworkMinDelayMs
from
NotAccessibleSecurity
to
PluginSecurity
- 719
Remove InboundNetworkMaxDelayMs
- 719
Change WriteSecurity of InboundNetworkLossPercent
from
NotAccessibleSecurity
to
PluginSecurity
- 719
Change Tags of InboundNetworkLossPercent
from
[Hidden, NotReplicated, NotScriptable]
to
[NotReplicated]
- 719
Change ReadSecurity of InboundNetworkLossPercent
from
NotAccessibleSecurity
to
PluginSecurity
- 719
Add InboundNetworkJitterMs
- 714
Change CanSave of OutboundNetworkMinDelayMs
from
false
to
true
- 714
Change CanLoad of OutboundNetworkMinDelayMs
from
false
to
true
- 714
Change CanLoad of OutboundNetworkMaxDelayMs
from
false
to
true
- 714
Change CanSave of OutboundNetworkMaxDelayMs
from
false
to
true
- 714
Change CanSave of OutboundNetworkLossPercent
from
false
to
true
- 714
Change CanLoad of OutboundNetworkLossPercent
from
false
to
true
- 714
Change CanSave of NetworkEmulationEnabled
from
false
to
true
- 714
Change CanLoad of NetworkEmulationEnabled
from
false
to
true
- 714
Change CanSave of InboundNetworkMinDelayMs
from
false
to
true
- 714
Change CanLoad of InboundNetworkMinDelayMs
from
false
to
true
- 714
Change CanLoad of InboundNetworkMaxDelayMs
from
false
to
true
- 714
Change CanSave of InboundNetworkMaxDelayMs
from
false
to
true
- 714
Change CanLoad of InboundNetworkLossPercent
from
false
to
true
- 714
Change CanSave of InboundNetworkLossPercent
from
false
to
true
- 709
Add OutboundNetworkMinDelayMs
- 709
Add OutboundNetworkMaxDelayMs
- 709
Add OutboundNetworkLossPercent
- 709
Add NetworkEmulationEnabled
- 709
Add InboundNetworkMinDelayMs
- 709
Add InboundNetworkMaxDelayMs
- 709
Add InboundNetworkLossPercent
- 653
Change Default of ShowActiveAnimationAsset
from
to
- 653
Change Default of RenderStreamedRegions
from
to
- 653
Change Default of RandomizeJoinInstanceOrder
from
to
- 653
Change Default of PrintStreamInstanceQuota
from
to
- 653
Change Default of PrintPhysicsErrors
from
to
- 653
Change Default of PrintJoinSizeBreakdown
from
to
- 653
Change Default of OpenCertManagerDialog
from
to
- 653
Change Default of IncomingReplicationLag
from
to
- 653
Change Default of HttpProxyURL
from
to
- 653
Change Default of HttpProxyEnabled
from
to
- 653
Change Default of FreeMemoryMBytes
from
to
- 653
Change Default of EmulatedTotalMemoryInMB
from
to
- 653
Change Tags of NetworkSettings
from
[NotCreatable, Service, NotBrowsable]
to
[NotCreatable, Service, NotReplicated, NotBrowsable]
- 553
Change Default of ShowActiveAnimationAsset
from
to
- 553
Change Default of RenderStreamedRegions
from
to
- 553
Change Default of RandomizeJoinInstanceOrder
from
to
- 553
Change Default of PrintStreamInstanceQuota
from
to
- 553
Change Default of PrintPhysicsErrors
from
to
- 553
Change Default of PrintJoinSizeBreakdown
from
to
- 553
Add OpenCertManagerDialog
- 553
Change Default of IncomingReplicationLag
from
to
- 553
Change Default of HttpProxyURL
from
to
- 553
Change Default of HttpProxyEnabled
from
to
- 553
Change Default of FreeMemoryMBytes
from
to
- 553
Change Default of EmulatedTotalMemoryInMB
from
to
- 514
Remove TrackPhysicsDetails
- 514
Remove TrackDataTypes
- 486
Change ThreadSafety of TrackPhysicsDetails
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of TrackDataTypes
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of ShowActiveAnimationAsset
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of RenderStreamedRegions
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of RandomizeJoinInstanceOrder
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of PrintStreamInstanceQuota
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of PrintPhysicsErrors
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of PrintJoinSizeBreakdown
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of IncomingReplicationLag
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of HttpProxyURL
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of HttpProxyEnabled
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of FreeMemoryMBytes
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of EmulatedTotalMemoryInMB
from
ReadOnly
to
ReadSafe
- 479
Remove ExtraMemoryUsed
- 475
Add EmulatedTotalMemoryInMB
- 464
Add RandomizeJoinInstanceOrder
- 462
Change ThreadSafety of TrackPhysicsDetails
from
to
ReadOnly
- 462
Change ThreadSafety of TrackDataTypes
from
to
ReadOnly
- 462
Change ThreadSafety of ShowActiveAnimationAsset
from
to
ReadOnly
- 462
Change ThreadSafety of RenderStreamedRegions
from
to
ReadOnly
- 462
Change ThreadSafety of PrintStreamInstanceQuota
from
to
ReadOnly
- 462
Change ThreadSafety of PrintPhysicsErrors
from
to
ReadOnly
- 462
Change ThreadSafety of PrintJoinSizeBreakdown
from
to
ReadOnly
- 462
Change ThreadSafety of IncomingReplicationLag
from
to
ReadOnly
- 462
Change ThreadSafety of HttpProxyURL
from
to
ReadOnly
- 462
Change ThreadSafety of HttpProxyEnabled
from
to
ReadOnly
- 462
Change ThreadSafety of FreeMemoryMBytes
from
to
ReadOnly
- 462
Change ThreadSafety of ExtraMemoryUsed
from
to
ReadOnly
- 450
Remove PrintTouches
- 450
Remove PrintFilters
- 450
Remove IncommingReplicationLag
- 450
Add IncomingReplicationLag
- 438
Remove TouchSendRate
- 438
Remove ReceiveRate
- 438
Remove PrintSplitMessage
- 438
Remove PrintInstances
- 438
Remove PreferredClientPort
- 438
Remove PhysicsSendPriority
- 438
Remove PhysicsMtuAdjust
- 438
Remove DataSendRate
- 438
Remove DataSendPriority
- 438
Remove DataMtuAdjust
- 419
Remove UsePhysicsPacketCache
- 419
Remove PrintProperties
- 419
Remove PrintEvents
- 419
Remove PrintBits
- 419
Remove PhysicsSendRate
- 419
Remove NetworkOwnerRate
- 419
Remove IsQueueErrorComputed
- 419
Remove DataGCRate
- 419
Remove ClientPhysicsSendRate
- 419
Remove ArePhysicsRejectionsReported
- 413
Remove ProxyURL
- 413
Remove ProxyEnabled
- 413
Add HttpProxyURL
- 413
Add HttpProxyEnabled
- 413
Change Tags of NetworkSettings
from
[Service, NotBrowsable]
to
[NotCreatable, Service, NotBrowsable]
- 398
Add PrintJoinSizeBreakdown
- 367
Remove UseInstancePacketCache
- 367
Add ProxyURL
- 367
Add ProxyEnabled
- 334
Remove WaitingForCharacterLogRate
- 334
Remove SendPacketBufferLimit
- 334
Remove ReportStatURL
- 334
Remove PhysicsSend
- 334
Remove PhysicsReceive
- 334
Remove MaxDataModelSendBuffer
- 334
Remove IsThrottledByOutgoingBandwidthLimit
- 334
Remove IsThrottledByCongestionControl
- 334
Remove EnableHeavyCompression
- 334
Remove CanSendPacketBufferLimit
- 331
Remove ExperimentalPhysicsEnabled
- 302
Remove TotalNumMovementWayPoint
- 302
Remove ShowPartMovementWayPoint
- 301
Add TotalNumMovementWayPoint
- 301
Add ShowPartMovementWayPoint
- 302
Remove TotalNumMovementWayPoint
- 302
Remove ShowPartMovementWayPoint
- 287
Remove FreeMemoryPoolMBytes
- 162
Add ShowActiveAnimationAsset
- 152
Change WriteSecurity of FreeMemoryPoolMBytes
from
LocalUserSecurity
to
PluginSecurity
- 152
Change ReadSecurity of FreeMemoryPoolMBytes
from
LocalUserSecurity
to
PluginSecurity
- 152
Change WriteSecurity of FreeMemoryMBytes
from
LocalUserSecurity
to
PluginSecurity
- 152
Change ReadSecurity of FreeMemoryMBytes
from
LocalUserSecurity
to
PluginSecurity
- 151
Change WriteSecurity of ExtraMemoryUsed
from
LocalUserSecurity
to
PluginSecurity
- 151
Change ReadSecurity of ExtraMemoryUsed
from
LocalUserSecurity
to
PluginSecurity
- 149
Add PrintBits
- 146
Add PrintFilters
- 145
Remove PrintFilters
- 146
Add PrintFilters
- 141
Remove MovementHistoryRate
- 141
Add ClientPhysicsSendRate
- 136
Add MovementHistoryRate
- 134
Add TotalNumMovementWayPoint
- 134
Add ShowPartMovementWayPoint
- 126
Add TrackPhysicsDetails
- 125
Add RenderStreamedRegions
- 125
Add PrintStreamInstanceQuota
- 125
Add FreeMemoryPoolMBytes
- 125
Add FreeMemoryMBytes
- 125
Add ExtraMemoryUsed
- 125
Add DataGCRate
- 118
Add EnableHeavyCompression
- 79
Add TrackDataTypes
- 78
Remove TrackDataTypes
- 79
Add TrackDataTypes
- 64
Add PhysicsSendPriority
- 64
Add DataSendPriority
- 60
Add PrintSplitMessage
- 51
Add SendPacketBufferLimit
- 51
Change Tags of MaxDataModelSendBuffer
from
[]
to
[Deprecated]
- 51
Add CanSendPacketBufferLimit
- 50
Change Tags of WaitingForCharacterLogRate
from
[Deprecated]
to
[Hidden, Deprecated]
- 50
Change Tags of ReportStatURL
from
[Deprecated]
to
[Hidden, Deprecated]
- 49
Change Tags of WaitingForCharacterLogRate
from
[]
to
[Deprecated]
- 49
Change Tags of ReportStatURL
from
[]
to
[Deprecated]
- 48
Add IncommingReplicationLag
- 48
Add ArePhysicsRejectionsReported
- 47
Add WaitingForCharacterLogRate
- 47
Add UsePhysicsPacketCache
- 47
Add UseInstancePacketCache
- 47
Add TouchSendRate
- 47
Add ReportStatURL
- 47
Add ReceiveRate
- 47
Add PrintTouches
- 47
Add PrintProperties
- 47
Add PrintPhysicsErrors
- 47
Add PrintInstances
- 47
Add PrintEvents
- 47
Add PreferredClientPort
- 47
Add PhysicsSendRate
- 47
Add PhysicsSend
- 47
Add PhysicsReceive
- 47
Add PhysicsMtuAdjust
- 47
Add NetworkOwnerRate
- 47
Add MaxDataModelSendBuffer
- 47
Add IsThrottledByOutgoingBandwidthLimit
- 47
Add IsThrottledByCongestionControl
- 47
Add IsQueueErrorComputed
- 47
Add ExperimentalPhysicsEnabled
- 47
Add DataSendRate
- 47
Add DataMtuAdjust
- 47
Add NetworkSettings
Sets the total amount of memory, in MiB, that the client pretends the
device has when testing under a simulated device. Studio's device emulator
writes this property when you select a device to emulate. Values are
clamped to a minimum of 0, and the property defaults to the machine's
actual total physical memory.
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 4
Tags: [Hidden, NotReplicated]
FreeMemoryMBytes is a read-only property that describes how much free
memory is available, in MiBs.
Its interface does not cross the network boundary.
Its value can be read, but it cannot be modified.
It is not meant to be used, and may have unresolved issues.
History 7
Tags: [Hidden, ReadOnly, NotReplicated]
When true, the client routes its HTTP traffic through the proxy server
specified by HttpProxyURL. This
property defaults to false.
History 5
Specifies the address of the proxy server through which the client routes
its HTTP traffic when
HttpProxyEnabled is true. This
property defaults to an empty string.
History 5
On playtest connections, this
property adds variability (jitter) in milliseconds to the latency added to
packets sent from server to client. This variable latency is in addition
to any latency introduced by
InboundNetworkMinDelayMs.
Per-packet delay sampled from delay and jitter is rounded to 1
millisecond. See
network simulation for
additional details.
Its interface does not cross the network boundary.
History 1
Tags: [NotReplicated]
InboundNetworkLossPercent
On playtest connections, this
property sets a percent probability that packets sent from server to
client are dropped. To maintain a stable test environment, the value is
capped at 0.5%. See
network simulation for
additional details.
Its interface does not cross the network boundary.
History 6
Tags: [NotReplicated]
On playtest connections, this
property adds a minimum latency in milliseconds for packets sent from
server to client. Per-packet delay sampled from delay and jitter is
rounded to 1 millisecond. See
network simulation for
additional details.
Its interface does not cross the network boundary.
History 7
Tags: [NotReplicated]
This property instructs the engine to simulate additional replication lag
by delaying all incoming messages. Units are seconds.
History 5
It cannot be accessed by script code.
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 2
Tags: [Hidden, NotReplicated, NotScriptable]
On playtest connections, this
property adds variability (jitter) in milliseconds to the latency added to
packets sent from client to server. This variable latency is in addition
to any latency introduced by
OutboundNetworkMinDelayMs.
Per-packet delay sampled from delay and jitter is rounded to 1
millisecond. See
network simulation for
additional details.
Its interface does not cross the network boundary.
History 1
Tags: [NotReplicated]
OutboundNetworkLossPercent
On playtest connections, this
property sets a percent probability that packets sent from client to
server are dropped. To maintain a stable test environment, the value is
capped at 0.5%. See
network simulation for
additional details.
Its interface does not cross the network boundary.
History 6
Tags: [NotReplicated]
OutboundNetworkMinDelayMs
On playtest connections, this
property adds a minimum latency in milliseconds for packets sent from
client to server. Per-packet delay sampled from delay and jitter is
rounded to 1 millisecond. See
network simulation for
additional details.
Its interface does not cross the network boundary.
History 7
Tags: [NotReplicated]
Prints 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 5
When set to true, debug messages will be printed to the Output
window pertaining to physics replication errors. The following are debug
outputs that are made available:
Physics-in old packet prints 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 for an unfound 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 for 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 5
When set to true, debug information is printed to the Output window
regarding the replication of instances when
Workspace.StreamingEnabled is set to true.
History 5
RandomizeJoinInstanceOrder
Emulates 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 4
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 5
When set to true, a label will be shown above each player character's
head, showing the current animation (if any) being played by the
character's Humanoid.
History 5
ArePhysicsRejectionsReported
History 2
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 2
Tags: [Hidden, NotReplicated]
It is not meant to be used, and may have unresolved issues.
History 2
Tags: [Hidden]
ExperimentalPhysicsEnabled
History 2
Its value can be read, but it cannot be modified.
It is not meant to be used, and may have unresolved issues.
History 4
Tags: [Hidden, ReadOnly]
It cannot be accessed by script code.
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 4
Tags: [Hidden, NotReplicated, NotScriptable]
IsThrottledByCongestionControl
History 2
IsThrottledByOutgoingBandwidthLimit
History 2
It exists only for backward compatibility, and should not be used for new work.
History 3
Tags: [Deprecated]
It cannot be accessed by script code.
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 4
Tags: [Hidden, NotReplicated, NotScriptable]
OutboundNetworkMaxDelayMs
It cannot be accessed by script code.
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 4
Tags: [Hidden, NotReplicated, NotScriptable]
Its interface does not cross the network boundary.
It is not meant to be used, and may have unresolved issues.
History 2
Tags: [Hidden, NotReplicated]
It exists only for backward compatibility, and should not be used for new work.
It is not meant to be used, and may have unresolved issues.
History 4
Tags: [Hidden, Deprecated]
WaitingForCharacterLogRate
It exists only for backward compatibility, and should not be used for new work.
It is not meant to be used, and may have unresolved issues.
History 4
Tags: [Hidden, Deprecated]