PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

NetworkSettings

Show deprecated

NetworkSettings

Show deprecated

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.


Properties

bool

ArePhysicsRejectionsReported

When set to true, a blue debug message will be printed to the output in cases where the physics receiver rejects a request that it received.

float

ClientPhysicsSendRate

The rate per second that the client can send physics changes to the server.

float

DataGCRate

The rate per second in which old replication data is garbage collected.

int

DataMtuAdjust

Adjusts the size of the maximum transmission unit for replication data.

PacketPriority

DataSendPriority

[Hidden] [NotReplicated]

Sets the data send priority of Roblox’s underlying Raknet replication layer.

float

DataSendRate

The rate per second at which data is sent back and forth between the server and the client.

int

ExtraMemoryUsed

[Hidden] [NotReplicated]

An unused debug property intended for streaming.

float

FreeMemoryMBytes

[Hidden] [ReadOnly] [NotReplicated]

Describes how much free memory is available, in MBs.

double

IncommingReplicationLag

Adds latency between the server and client in seconds. Allows you to simulate high-latency situations.

bool

IsQueueErrorComputed

.The purpose of this property is unknown, as it does not appear to be used anywhere in the engine.

float

NetworkOwnerRate

.The rate per second at which network ownership can be automatically changed.

int

PhysicsMtuAdjust

Adjusts the size of a physic packet’s maximum transmission unit size.

PacketPriority

PhysicsSendPriority

[Hidden] [NotReplicated]

Sets the data send priority of Roblox’s underlying RakNet replication layer, but specifically for physics packets.

float

PhysicsSendRate

The rate per second at which physics packets are sent back and forth between the server and the client.

int

PreferredClientPort

The preferred port to be used by the client when connecting to a local server.

bool

PrintBits

A diagnostics property that no longer appears to be in use. Would likely print information about bits being streamed between the server and client.

bool

PrintEvents

A diagnostics property that no longer appears to be in use. Would likely print information about events being replicated across the server/client boundary.

bool

PrintFilters

When set to true, warning messages will be printed to the output if an object or property is filtered due to Workspace/FilteringEnabled being set to true.

bool

PrintInstances

When set to true, debug messages will be printed into the output, pertaining to the replication of instances being created and destroyed.

bool

PrintPhysicsErrors

When set to true, debug messages will be printed into the output pertaining to physics replication errors.

bool

PrintProperties

A diagnostics property that no longer appears to be in use. Would likely print information about property changes being streamed between the server and client.

bool

PrintSplitMessage

When set to true, debug information is printed about internal packets that have been split.

bool

PrintStreamInstanceQuota

When set to true, debug information is printed to the output regarding the replication of instances when Workspace/StreamingEnabled is set to true.

bool

PrintTouches

When set to true, a debug message will be printed to the output, when a physics Touched event is replicated. This includes the BasePart/Touched event, and the BasePart/TouchEnded event.

double

ReceiveRate

The maximum rate per second at which the network replicator is willing to receive packets.

bool

RenderStreamedRegions

When set to true, regions of space that are being streamed to the client will be outlined in red.

bool

ShowActiveAnimationAsset

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.

float

TouchSendRate

The rate per second at which Touched events are replicated back and forth between the server and the client.

bool

TrackDataTypes

When set to true, the replicator stats will sample data about packets that are being sent.

bool

TrackPhysicsDetails

When set to true, this tells the replicator stats to sample replication physics details.

bool

UseInstancePacketCache

When set to true, the InstancePacketCache service will be created alongside the NetworkServer when a server is being initialized.

bool

UsePhysicsPacketCache

When set to true, the PhysicsPacketCache service will be created alongside the NetworkServer when a server is being initialized.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Instance: Show Hide

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.