rules

.cursor/rules/roblox/reference/engine/classes/InstanceFileSyncService.yaml

@@ -0,0 +1,114 @@
+# This file is automatically generated. Please don't edit it manually.
+# To submit a bug report on the content, see
+# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
+
+name: InstanceFileSyncService
+type: class
+memory_category: Instances
+summary: |
+  A service for interacting with file sync from a plugin.
+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.
+code_samples: []
+inherits:
+  - Instance
+descendants: []
+tags:
+  - NotCreatable
+  - Service
+  - NotReplicated
+deprecation_message: ''
+properties: []
+methods:
+  - name: InstanceFileSyncService:GetAllInstances
+    summary: |
+      Returns an array of all instances currently involved in file
+      synchronization.
+    description: |
+      Returns an array containing every `Class.Instance` that is currently being
+      tracked or synchronized by file sync.
+    code_samples: []
+    parameters: []
+    returns:
+      - type: Instances
+        summary: |
+          Returns an array of `Class.Instance|Instances`.
+    tags: []
+    deprecation_message: ''
+    security: PluginSecurity
+    thread_safety: Unsafe
+    capabilities: []
+  - name: InstanceFileSyncService:GetStatus
+    summary: |
+      Returns the synchronization status of a specific instance.
+    description: |
+      Returns the current `Enum.InstanceFileSyncStatus` of the provided
+      `Class.Instance`. This indicates whether the instance is synced as a root,
+      as a descendant, or if it is in an error state.
+    code_samples: []
+    parameters:
+      - name: instance
+        type: Instance
+        default:
+        summary: |
+          The instance to check.
+    returns:
+      - type: InstanceFileSyncStatus
+        summary: |
+          Returns the `Enum.InstanceFileSyncStatus` for the instance.
+    tags: []
+    deprecation_message: ''
+    security: PluginSecurity
+    thread_safety: Unsafe
+    capabilities: []
+  - name: InstanceFileSyncService:GetSyncedInstance
+    summary: |
+      Returns the instance corresponding to a given file path.
+    description: |
+      Returns the `Class.Instance` associated with the specified absolute file
+      path. Returns `nil` if the path is not mapped to any instance.
+    code_samples: []
+    parameters:
+      - name: filePath
+        type: string
+        default:
+        summary: |
+          The absolute path to the file.
+    returns:
+      - type: Instance
+        summary: |
+          Returns the Instance being synced to the file path, if one exists.
+          Otherwise, returns nil.
+    tags: []
+    deprecation_message: ''
+    security: PluginSecurity
+    thread_safety: Unsafe
+    capabilities: []
+events:
+  - name: InstanceFileSyncService.StatusChanged
+    summary: |
+      Fires when the synchronization status of an instance changes.
+    description: |
+      This event fires when the `Enum.InstanceFileSyncStatus` of an
+      `Class.Instance` changes. It passes the affected instance and the new file
+      sync status enum value.
+    code_samples: []
+    parameters:
+      - name: instance
+        type: Instance
+        default:
+        summary: |
+          The instance whose status changed.
+      - name: status
+        type: InstanceFileSyncStatus
+        default:
+        summary: |
+          The new synchronization status.
+    tags: []
+    deprecation_message: ''
+    security: PluginSecurity
+    capabilities: []
+callbacks: []