NetworkSettings
Settings related to networked engine behaviors.
Memory category | Instances |
---|
Member index 12
Removed member index 44
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 170
- 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 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 from to
- 653 Change Default of 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
- 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 from to
- 553 Change Default of 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 from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 479 Remove
- 475 Add
- 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 from to ReadOnly
- 462 Change ThreadSafety of 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
- 438 Remove PhysicsMtuAdjust
- 438 Remove DataSendRate
- 438 Remove
- 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
- 334 Remove SendPacketBufferLimit
- 334 Remove
- 334 Remove PhysicsSend
- 334 Remove PhysicsReceive
- 334 Remove MaxDataModelSendBuffer
- 334 Remove IsThrottledByOutgoingBandwidthLimit
- 334 Remove IsThrottledByCongestionControl
- 334 Remove
- 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
- 162 Add ShowActiveAnimationAsset
- 152 Change WriteSecurity of from LocalUserSecurity to PluginSecurity
- 152 Change ReadSecurity of from LocalUserSecurity to PluginSecurity
- 152 Change WriteSecurity of from LocalUserSecurity to PluginSecurity
- 152 Change ReadSecurity of from LocalUserSecurity to PluginSecurity
- 151 Change WriteSecurity of from LocalUserSecurity to PluginSecurity
- 151 Change ReadSecurity of 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
- 125 Add
- 125 Add
- 125 Add DataGCRate
- 118 Add
- 79 Add TrackDataTypes
- 78 Remove TrackDataTypes
- 79 Add TrackDataTypes
- 64 Add
- 64 Add
- 60 Add PrintSplitMessage
- 51 Add SendPacketBufferLimit
- 51 Change Tags of MaxDataModelSendBuffer from [] to [Deprecated]
- 51 Add CanSendPacketBufferLimit
- 50 Change Tags of from [Deprecated] to [Hidden, Deprecated]
- 50 Change Tags of from [Deprecated] to [Hidden, Deprecated]
- 49 Change Tags of from [] to [Deprecated]
- 49 Change Tags of from [] to [Deprecated]
- 48 Add IncommingReplicationLag
- 48 Add ArePhysicsRejectionsReported
- 47 Add
- 47 Add UsePhysicsPacketCache
- 47 Add UseInstancePacketCache
- 47 Add TouchSendRate
- 47 Add
- 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
Members 12
HttpProxyEnabled
Type | Default | |
---|---|---|
bool |
Write security | RobloxScriptSecurity |
---|---|
Thread safety | ReadSafe |
Category | Proxy Settings |
Loaded/Saved | true |
History 5
- 653 Change Default of HttpProxyEnabled from to
- 553 Change Default of HttpProxyEnabled from to
- 486 Change ThreadSafety of HttpProxyEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of HttpProxyEnabled from to ReadOnly
- 413 Add HttpProxyEnabled
HttpProxyURL
Type | Default | |
---|---|---|
string |
Write security | RobloxScriptSecurity |
---|---|
Thread safety | ReadSafe |
Category | Proxy Settings |
Loaded/Saved | true |
History 5
- 653 Change Default of HttpProxyURL from to
- 553 Change Default of HttpProxyURL from to
- 486 Change ThreadSafety of HttpProxyURL from ReadOnly to ReadSafe
- 462 Change ThreadSafety of HttpProxyURL from to ReadOnly
- 413 Add HttpProxyURL
IncomingReplicationLag
Type | Default | |
---|---|---|
double |
Instruct the engine to simulate additional lag by delaying all incoming messages. Units are seconds.
Thread safety | ReadSafe |
---|---|
Category | Diagnostics |
Loaded/Saved | true |
History 5
- 653 Change Default of IncomingReplicationLag from to
- 553 Change Default of IncomingReplicationLag from to
- 486 Change ThreadSafety of IncomingReplicationLag from ReadOnly to ReadSafe
- 462 Change ThreadSafety of IncomingReplicationLag from to ReadOnly
- 450 Add IncomingReplicationLag
PrintJoinSizeBreakdown
Type | Default | |
---|---|---|
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.
Thread safety | ReadSafe |
---|---|
Category | Diagnostics |
Loaded/Saved | true |
History 5
- 653 Change Default of PrintJoinSizeBreakdown from to
- 553 Change Default of PrintJoinSizeBreakdown from to
- 486 Change ThreadSafety of PrintJoinSizeBreakdown from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PrintJoinSizeBreakdown from to ReadOnly
- 398 Add PrintJoinSizeBreakdown
PrintPhysicsErrors
Type | Default | |
---|---|---|
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.
Thread safety | ReadSafe |
---|---|
Category | Diagnostics |
Loaded/Saved | true |
History 5
- 653 Change Default of PrintPhysicsErrors from to
- 553 Change Default of PrintPhysicsErrors from to
- 486 Change ThreadSafety of PrintPhysicsErrors from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PrintPhysicsErrors from to ReadOnly
- 47 Add PrintPhysicsErrors
PrintStreamInstanceQuota
Type | Default | |
---|---|---|
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.
Thread safety | ReadSafe |
---|---|
Category | Diagnostics |
Loaded/Saved | true |
History 5
- 653 Change Default of PrintStreamInstanceQuota from to
- 553 Change Default of PrintStreamInstanceQuota from to
- 486 Change ThreadSafety of PrintStreamInstanceQuota from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PrintStreamInstanceQuota from to ReadOnly
- 125 Add PrintStreamInstanceQuota
RandomizeJoinInstanceOrder
Type | Default | |
---|---|---|
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.
Thread safety | ReadSafe |
---|---|
Category | Advanced |
Loaded/Saved | true |
History 4
- 653 Change Default of RandomizeJoinInstanceOrder from to
- 553 Change Default of RandomizeJoinInstanceOrder from to
- 486 Change ThreadSafety of RandomizeJoinInstanceOrder from ReadOnly to ReadSafe
- 464 Add RandomizeJoinInstanceOrder
RenderStreamedRegions
Type | Default | |
---|---|---|
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.
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
History 5
- 653 Change Default of RenderStreamedRegions from to
- 553 Change Default of RenderStreamedRegions from to
- 486 Change ThreadSafety of RenderStreamedRegions from ReadOnly to ReadSafe
- 462 Change ThreadSafety of RenderStreamedRegions from to ReadOnly
- 125 Add RenderStreamedRegions
ShowActiveAnimationAsset
Type | Default | |
---|---|---|
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.
Thread safety | ReadSafe |
---|---|
Category | Appearance |
Loaded/Saved | true |
History 5
- 653 Change Default of ShowActiveAnimationAsset from to
- 553 Change Default of ShowActiveAnimationAsset from to
- 486 Change ThreadSafety of ShowActiveAnimationAsset from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ShowActiveAnimationAsset from to ReadOnly
- 162 Add ShowActiveAnimationAsset
Removed members 44
ArePhysicsRejectionsReported
Type | Default | |
---|---|---|
bool |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
History 2
CanSendPacketBufferLimit
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
ClientPhysicsSendRate
Type | Default | |
---|---|---|
float |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 419 Remove ClientPhysicsSendRate
- 141 Add ClientPhysicsSendRate
DataGCRate
Type | Default | |
---|---|---|
float |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 419 Remove DataGCRate
- 125 Add DataGCRate
DataMtuAdjust
Type | Default | |
---|---|---|
int |
Category | Data |
---|---|
Loaded/Saved | true |
History 2
- 438 Remove DataMtuAdjust
- 47 Add DataMtuAdjust
DataSendRate
Type | Default | |
---|---|---|
float |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 438 Remove DataSendRate
- 47 Add DataSendRate
ExperimentalPhysicsEnabled
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 2
IncommingReplicationLag
Type | Default | |
---|---|---|
double |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
History 2
- 450 Remove IncommingReplicationLag
- 48 Add IncommingReplicationLag
IsQueueErrorComputed
Type | Default | |
---|---|---|
bool |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 419 Remove IsQueueErrorComputed
- 47 Add IsQueueErrorComputed
IsThrottledByCongestionControl
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 2
IsThrottledByOutgoingBandwidthLimit
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 2
MaxDataModelSendBuffer
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 3
- 334 Remove MaxDataModelSendBuffer
- 51 Change Tags of MaxDataModelSendBuffer from [] to [Deprecated]
- 47 Add MaxDataModelSendBuffer
MovementHistoryRate
Type | Default | |
---|---|---|
float |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 141 Remove MovementHistoryRate
- 136 Add MovementHistoryRate
NetworkOwnerRate
Type | Default | |
---|---|---|
float |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 419 Remove NetworkOwnerRate
- 47 Add NetworkOwnerRate
PhysicsMtuAdjust
Type | Default | |
---|---|---|
int |
Category | Physics |
---|---|
Loaded/Saved | true |
History 2
- 438 Remove PhysicsMtuAdjust
- 47 Add PhysicsMtuAdjust
PhysicsReceive
Type | Default | |
---|---|---|
PhysicsReceiveMethod |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 334 Remove PhysicsReceive
- 47 Add PhysicsReceive
PhysicsSend
Type | Default | |
---|---|---|
PhysicsSendMethod |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 334 Remove PhysicsSend
- 47 Add PhysicsSend
PhysicsSendRate
Type | Default | |
---|---|---|
float |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 419 Remove PhysicsSendRate
- 47 Add PhysicsSendRate
PreferredClientPort
Type | Default | |
---|---|---|
int |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 438 Remove PreferredClientPort
- 47 Add PreferredClientPort
PrintBits
Type | Default | |
---|---|---|
bool |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
PrintEvents
Type | Default | |
---|---|---|
bool |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
History 2
- 419 Remove PrintEvents
- 47 Add PrintEvents
PrintFilters
Type | Default | |
---|---|---|
bool |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
History 4
- 450 Remove PrintFilters
- 146 Add PrintFilters
- 145 Remove PrintFilters
- 146 Add PrintFilters
PrintInstances
Type | Default | |
---|---|---|
bool |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
History 2
- 438 Remove PrintInstances
- 47 Add PrintInstances
PrintProperties
Type | Default | |
---|---|---|
bool |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
History 2
- 419 Remove PrintProperties
- 47 Add PrintProperties
PrintSplitMessage
Type | Default | |
---|---|---|
bool |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
History 2
- 438 Remove PrintSplitMessage
- 60 Add PrintSplitMessage
PrintTouches
Type | Default | |
---|---|---|
bool |
Category | Diagnostics |
---|---|
Loaded/Saved | true |
History 2
- 450 Remove PrintTouches
- 47 Add PrintTouches
ProxyEnabled
Type | Default | |
---|---|---|
bool |
Category | Proxy Settings |
---|---|
Loaded/Saved | true |
History 2
- 413 Remove ProxyEnabled
- 367 Add ProxyEnabled
ProxyURL
Type | Default | |
---|---|---|
string |
Category | Proxy Settings |
---|---|
Loaded/Saved | true |
ReceiveRate
Type | Default | |
---|---|---|
double |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 438 Remove ReceiveRate
- 47 Add ReceiveRate
SendPacketBufferLimit
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 334 Remove SendPacketBufferLimit
- 51 Add SendPacketBufferLimit
ShowPartMovementWayPoint
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 4
TotalNumMovementWayPoint
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 4
TouchSendRate
Type | Default | |
---|---|---|
float |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 438 Remove TouchSendRate
- 47 Add TouchSendRate
TrackDataTypes
Type | Default | |
---|---|---|
bool |
Thread safety | ReadSafe |
---|---|
Category | Diagnostics |
Loaded/Saved | true |
History 6
- 514 Remove TrackDataTypes
- 486 Change ThreadSafety of TrackDataTypes from ReadOnly to ReadSafe
- 462 Change ThreadSafety of TrackDataTypes from to ReadOnly
- 79 Add TrackDataTypes
- 78 Remove TrackDataTypes
- 79 Add TrackDataTypes
TrackPhysicsDetails
Type | Default | |
---|---|---|
bool |
Thread safety | ReadSafe |
---|---|
Category | Diagnostics |
Loaded/Saved | true |
History 4
- 514 Remove TrackPhysicsDetails
- 486 Change ThreadSafety of TrackPhysicsDetails from ReadOnly to ReadSafe
- 462 Change ThreadSafety of TrackPhysicsDetails from to ReadOnly
- 126 Add TrackPhysicsDetails
UseInstancePacketCache
Type | Default | |
---|---|---|
bool |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 367 Remove UseInstancePacketCache
- 47 Add UseInstancePacketCache
UsePhysicsPacketCache
Type | Default | |
---|---|---|
bool |
Category | Network |
---|---|
Loaded/Saved | true |
History 2
- 419 Remove UsePhysicsPacketCache
- 47 Add UsePhysicsPacketCache