NetworkSettings
Configures connection, bandwidth, and replication defaults.
- Service
game:GetService("NetworkSettings")- Inherits
- Instance
- Replication
- Never
Behavior
NetworkSettings configures connection, bandwidth, and replication defaults.
Summary
The time allowed without a valid connection response before timing out.
The default bandwidth budget assigned to a connection.
The transport selected for new connections.
Whether players can join an already running session.
The interval between connection keepalive messages.
The default player limit for new sessions.
The configured frequency of replication updates.
Returns this instance if it is an ExecutionGroup.
Returns the runtime mutability category of the named network setting.
Properties
ConnectionTimeout
NetworkSettings.ConnectionTimeout: number = 10The time allowed without a valid connection response before timing out.
DefaultBandwidthBudget
NetworkSettings.DefaultBandwidthBudget: number = 0The default bandwidth budget assigned to a connection.
DefaultTransport
NetworkSettings.DefaultTransport: string = "Auto"The transport selected for new connections.
JoinInProgress
NetworkSettings.JoinInProgress: boolean = trueWhether players can join an already running session.
KeepaliveInterval
NetworkSettings.KeepaliveInterval: number = 1The interval between connection keepalive messages.
MaxPlayersDefault
NetworkSettings.MaxPlayersDefault: number = 16The default player limit for new sessions.
ReplicationRate
NetworkSettings.ReplicationRate: number = 20The configured frequency of replication updates.
Methods
GetExecutionGroup
NetworkSettings:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
GetMutability
NetworkSettings:GetMutability(property: string): stringReturns the runtime mutability category of the named network setting.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying