Skip to content

InstanceFileSyncService

Not yet Class Services NotCreatable NotReplicated Service

A service for interacting with file sync from a plugin.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 13 modern Roblox members not implemented yet

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.

Inheritance

Object → Instance → InstanceFileSyncService

Methods

Member Signature Summary
GetAllInstances InstanceFileSyncService:GetAllInstances(): Instances Returns an array of all instances currently involved in file synchronization.
GetStatus InstanceFileSyncService:GetStatus(instance: Instance): InstanceFileSyncStatus Returns the synchronization status of a specific instance.
GetSyncedInstance InstanceFileSyncService:GetSyncedInstance(filePath: string): Instance Returns the instance corresponding to a given file path.
GetSyncingCollaborators InstanceFileSyncService:GetSyncingCollaborators(instance: Instance): Array —
GetTooltip InstanceFileSyncService:GetTooltip(instance: Instance): string? —

Events

Member Signature Summary
StatusChanged StatusChanged(instance: Instance, status: InstanceFileSyncStatus) Fires when the synchronization status of an instance changes.
SyncingCollaboratorsChanged SyncingCollaboratorsChanged(instance: Instance) —

Roblox reference: InstanceFileSyncService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.