rules

.cursor/rules/roblox/reference/engine/enums/StreamingIntegrityMode.yaml

@@ -0,0 +1,56 @@
+# 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: StreamingIntegrityMode
+type: enum
+summary: |
+  Determines how a user's client should handle not having enough content
+  streamed in.
+description: |
+  This enum is used to control `Class.Workspace.StreamingIntegrityMode`
+  behavior. The default behavior is currently equivalent to **Disabled** but may
+  change in the future. For all modes, the replication focus defaults to be the
+  local character model unless explicitly set via
+  `Class.Player.ReplicationFocus`.
+
+  Most experiences should use **PauseOutsideLoadedArea**, however if your
+  experience relies on raycasts, or otherwise requires a certain amount of
+  content to be loaded in, then **MinimumRadiusPause** might be a better choice.
+
+  Note that **MinimumRadiusPause** and **PauseOutsideLoadedArea** both set the
+  `Class.Player.GameplayPaused` property when their respective pause logic is
+  triggered, and a default message is displayed on the client. The default pause
+  UI can be overridden as outlined in
+  [Instance streaming](../../../workspace/streaming.md#customize-the-pause-screen).
+code_samples: []
+tags: []
+deprecation_message: ''
+items:
+  - name: Default
+    summary: |
+      Default behavior (currently equivalent to **Disabled**).
+    value: 0
+    tags: []
+    deprecation_message: ''
+  - name: Disabled
+    summary: |
+      Simulation of the replication focus is never paused, regardless of the
+      amount of content streamed in on the client.
+    value: 1
+    tags: []
+    deprecation_message: ''
+  - name: MinimumRadiusPause
+    summary: |
+      All client-side simulation is paused when content is not streamed in up to
+      the minimum radius.
+    value: 2
+    tags: []
+    deprecation_message: ''
+  - name: PauseOutsideLoadedArea
+    summary: |
+      Simulation of the replication focus is paused when any part of its
+      bounding box is not in a streamed-in area.
+    value: 3
+    tags: []
+    deprecation_message: ''