Reference API Roblox

Engine API

Website

Related

Reference API Roblox

InstanceFileSyncService

A service for interacting with file sync from a plugin.

This class is not replicated. Its interface does not cross the network boundary.
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, NotReplicated]

Member index 5

HistoryMember
703GetAllInstances(): Instances
703GetStatus(instance: Instance): InstanceFileSyncStatus
703GetSyncedInstance(filePath: string): Instance
705GetTooltip(instance: Instance): string?
703StatusChanged(instance: Instance, status: InstanceFileSyncStatus)
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
706GetStyled(name: string, selector: 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

The InstanceFileSyncService service provides an interface for plugins to interact with the file sync system (currently known as Script Sync). It allows querying the sync status of instances and retrieving instances based on file paths.

History 6

Members 5

GetAllInstances

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

Returns an array containing every Instance that is currently being tracked or synchronized by file sync.

SecurityPluginSecurity
Thread safetyUnsafe

History 1

GetStatus

Parameters (1)
instanceInstance
Returns (1)
InstanceFileSyncStatus

Returns the current InstanceFileSyncStatus of the provided Instance. This indicates whether the instance is synced as a root, as a descendant, or if it is in an error state.

SecurityPluginSecurity
Thread safetyUnsafe

History 1

GetSyncedInstance

Parameters (1)
filePathstring
Returns (1)
Instance

Returns the Instance associated with the specified absolute file path. Returns nil if the path is not mapped to any instance.

SecurityPluginSecurity
Thread safetyUnsafe

History 1

GetTooltip

Parameters (1)
instanceInstance
Returns (1)
string?
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

StatusChanged

Parameters (2)
instanceInstance
statusInstanceFileSyncStatus

This event fires when the InstanceFileSyncStatus of an Instance changes. It passes the affected instance and the new file sync status enum value.

SecurityPluginSecurity
Thread safetyUnsafe

History 1

Settings