Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ReplicatedStorage

A container service for objects that are replicated to all game clients.

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 0

HistoryMember
No members defined by ReplicatedStorage.
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
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()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
647isA(className: string): bool
647Changed(property: string)

Description

ReplicatedStorage is a general container service for objects that are available to both the server and connected game clients. It is ideal for ModuleScript, RemoteFunction, RemoteEvent and other objects that are useful to both server-side Scripts and client-side LocalScripts.

LocalScripts do not run when parented to this service, even if they are Enabled. Similarly, Scripts do not run when parented to this service unless you change their RunContext property from its default value of Legacy.

If a ModuleScript within this service is required by any other script, it runs as normal. Such modules typically house code that is shared by the server and client. Server-side Scripts that run on their own should be parented to ServerScriptService instead. Client-side LocalScripts have various other locations where they eventually run on a Player client: StarterPlayerScripts, StarterCharacterScripts, or StarterGui.

This service behaves similarly to ServerStorage except that its contents are replicated. If you are storing assets which should not be visible on the client or have no use to the client at all, use ServerStorage instead.

Objects parented to this service are fully replicated to clients, and normal replication rules apply: any changes that are made on the client persist, but won't be replicated to the server. Client changes may be overwritten if the server does something that overwrites those changes. For instance, a Part parented to ReplicatedStorage by the server may have a blue BrickColor. A client could change this property to red locally, but this change remains only on the client. If the server changes the color to green, this change is replicated to the client.

History 1

Settings