Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ReplicatedFirst

A container whose contents are replicated to all clients (but not back to the server) first before anything else.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service]

Member index 7

HistoryMember
462IsDefaultLoadingGuiRemoved(): bool
462IsFinishedReplicating(): bool
573RemoveDefaultLoadingScreen(): null
573SetDefaultLoadingGuiRemoved(): null
462DefaultLoadingGuiRemoved()
462FinishedReplicating()
462RemoveDefaultLoadingGuiSignal()
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

ReplicatedFirst is a container whose contents are replicated to all clients (but not back to the server) before anything else. It's most commonly used to store LocalScripts and other elements that are essential for the experience's start such as loading screens.

For objects that do not need to be replicated before anything else, use the ReplicatedStorage container instead.

There are some key considerations for running LocalScripts in ReplicatedFirst:

  • Since its contents replicate before anything else in the experience, LocalScripts running in ReplicatedFirst will need to wait for any objects they require to replicate using Instance:WaitForChild()
  • Any objects that are to be used by a LocalScript in ReplicatedFirst should also be parented to ReplicatedFirst. Otherwise, they may replicate to the client late, yielding the script and negating the benefit of initial replication.

History 17

Members 7

DefaultLoadingGuiRemoved

Parameters (0)
No parameters.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

FinishedReplicating

Parameters (0)
No parameters.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

IsDefaultLoadingGuiRemoved

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

IsFinishedReplicating

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

RemoveDefaultLoadingGuiSignal

Parameters (0)
No parameters.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

RemoveDefaultLoadingScreen

Parameters (0)
No parameters.
Returns (1)
null

Immediately removes the default Roblox loading screen. Note that if any object has been placed in ReplicatedFirst, the default loading screen will be removed after a few seconds regardless if this method has been called or not.

You should not remove the default loading screen unless you want to display your own. If you remove the default screen without a replacement, players will be able to see geometry loading in the background.

Thread safetyUnsafe

History 3

SetDefaultLoadingGuiRemoved

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

Settings