ReplicationService
Reports and configures instance replication.
- Service
game:GetService("ReplicationService")- Inherits
- Instance
- Replication
- Never
Behavior
ReplicationService reports and configures instance replication.
Summary
Registers a player interest volume at a Vector3 or Instance and returns its identifier.
Returns the explicit Player audience, or nil when no audience restriction is configured.
Returns this instance if it is an ExecutionGroup.
Returns whether the Instance bypasses distance-based relevance filtering.
Removes an interest volume by identifier and returns whether it existed.
Controls whether the Instance bypasses distance-based relevance filtering.
Sets the Instance replication audience on the server.
Sets a player streaming radius from the server.
Sets the viewing origin for a player to a Vector3 or Instance.
Methods
AddInterestVolume
ReplicationService:AddInterestVolume(player: Player, at: Vector3 | Instance, radius: number): numberRegisters a player interest volume at a Vector3 or Instance and returns its identifier. Radius must be finite and nonnegative, in studs. Available only on the server.
GetAudience
Returns the explicit Player audience, or nil when no audience restriction is configured.
GetExecutionGroup
ReplicationService:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
IsAlwaysRelevant
ReplicationService:IsAlwaysRelevant(subject: Instance): booleanReturns whether the Instance bypasses distance-based relevance filtering.
RemoveInterestVolume
ReplicationService:RemoveInterestVolume(id: number): booleanRemoves an interest volume by identifier and returns whether it existed. Available only on the server.
SetAlwaysRelevant
ReplicationService:SetAlwaysRelevant(subject: Instance, relevant: boolean?): booleanControls whether the Instance bypasses distance-based relevance filtering. The optional flag defaults to true. Available only on the server.
SetAudience
Sets the Instance replication audience on the server. Pass a Player array to restrict visibility. An empty array admits no players; nil removes the audience restriction.
SetStreamingRadius
ReplicationService:SetStreamingRadius(player: Player, radius: number?): ()Sets a player streaming radius from the server.
SetViewingOrigin
Sets the viewing origin for a player to a Vector3 or Instance. Pass nil to clear the override. Available only on the server.
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