rules

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

@@ -0,0 +1,96 @@
+# 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: SerializationService
+type: class
+memory_category: Instances
+summary: ''
+description: ''
+code_samples: []
+inherits:
+  - Instance
+descendants: []
+tags:
+  - NotCreatable
+  - Service
+deprecation_message: ''
+properties: []
+methods:
+  - name: SerializationService:DeserializeInstancesAsync
+    summary: |
+      Deserializes a `Library.buffer` containing `.rbxm` content, returning a
+      list of `Class.Instance|instances`.
+    description: |
+      Deserializes a `Library.buffer` containing `.rbxm` content, returning a
+      list of `Class.Instance|instances`.
+
+      This API can only be called from Studio plugins or Open Cloud Luau
+      Execution Sessions. If non-creatable instances or services are included in
+      the content, an error is thrown.
+
+      No stability contract is offered for the `.rbxm` format and the
+      composition of this data may change at any time. This API will faithfully
+      parse `.rbxm` content that was serialized by the Roblox engine, including
+      `.rbxm` files generated by Studio or via
+      `Class.SerializationService:SerializeInstancesAsync()|SerializeInstancesAsync()`.
+
+      Although it is possible to use this API to deserialize `.rbxm` content
+      generated by any other means, this is done at the user's own risk. The
+      engine may fail to deserialize such content faithfully, or at all.
+    code_samples:
+      - SerializationService-Roundtrip-Sample
+    parameters:
+      - name: buffer
+        type: buffer
+        default:
+        summary: ''
+    returns:
+      - type: Instances
+        summary: ''
+    tags:
+      - Yields
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - PluginOrOpenCloud
+  - name: SerializationService:SerializeInstancesAsync
+    summary: |
+      Serializes a list of `Class.Instance|instances` to the `.rbxm` format,
+      returning a `Library.buffer` or `.rbxm` content.
+    description: |
+      Serializes a list of `Class.Instance|instances` to the `.rbxm` format,
+      returning a `Library.buffer` or `.rbxm` content.
+
+      This API can only be called from Studio plugins or Open Cloud Luau
+      Execution Sessions. If non-creatable instances or services are included in
+      the list of instances, an error is thrown.
+
+      No stability contract is offered for the `.rbxm` format and the
+      composition of this data may change at any time. This API will serialize
+      content according to the serialization behavior of the current engine
+      version.
+
+      Although it is possible for other tools to parse `.rbxm` content, this is
+      done at the user's own risk. The engine may still generate `.rbxm` content
+      that 3rd-party tools fail to parse faithfully.
+    code_samples:
+      - SerializationService-Roundtrip-Sample
+    parameters:
+      - name: inputInstances
+        type: Instances
+        default:
+        summary: ''
+    returns:
+      - type: buffer
+        summary: ''
+    tags:
+      - Yields
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - PluginOrOpenCloud
+events: []
+callbacks: []